Class: CustomStyleSheet

Source Location: /styles.inc.php

Class Overview

Object
   |
   --Persistent
      |
      --Component
         |
         --CustomStyleSheet

Base class for StyleSheet component

Author(s):

Variables

Methods

Child classes:

StyleSheet: A class to allow import and use stylesheets

Inherited Variables

Class: Component

Component::$alreadycreated
Component::$components
Component::$lastresourceread
Component::$owner
Component::$reallastresourceread
Component::$_childnames
Component::$_controlstate
Component::$_name
Component::$_namepath
Component::$_tag

Class: Object

Object::$input

Inherited Methods

Class: Component

Component::__construct(): Component constructor
Component::ajaxCall(): Dumps the javascript code to make an ajax call to the server.
Component::callEvent(): Calls a server event.
Component::defaultName()
Component::defaultTag()
Component::dumpChildrenFormItems(): This method is called by the page just after dumping the starting form tag.
Component::dumpChildrenHeaderCode(): Dumps the header code for all the children
Component::dumpChildrenJavascript(): Dumps the javascript code for all the children
Component::dumpFormItems(): Dumps code just after the form tag, useful to dump hidden fields for state retrieving for non visible components
Component::dumpHeaderCode(): Dumps header code required
Component::dumpHiddenKeyFields(): Dumps hidden field values for the key record
Component::dumpJavascript(): Dumps the javascript code needed by this component
Component::dumpJSEvent(): Dumps javascript code for an event
Component::fixupProperty(): Resolves the right reference to an object property
Component::generateAjaxEvent(): Returns the javascript code to generate an ajax call.
Component::getName(): Specifies the name for the component. The name is used as an identifier and should be unique.
Component::getTag(): A versatile property of every Component that can be used in any way you want
Component::hasValidDataField(): Returns true if a valid data field is attached to the component
Component::init(): Initializes a component
Component::insertComponent(): Inserts a component into the component's collection
Component::loaded(): Initializes the component after the form file has been read into memory.
Component::loadedChildren(): Calls childrens loaded
Component::loadResource(): Loads this component from a string
Component::preinit(): Method called before init()
Component::readAccessibility(): Provides accessibility info to the embedded RPC engine.
Component::readComponentCount(): Indicates the number of components owned by the component.
Component::readComponents(): Lists all the components owned by this component.
Component::readControlState(): A flag to know the state of the control, csLoading, csDesigning
Component::readDataFieldValue(): This property returns the value of the datafield if any.
Component::readFromResource(): Reads a component from a resource file
Component::readNamePath(): Specifies the path to uniquely identify a component, qualified by the owner when required.
Component::readOwner(): Indicates the component that is responsible for streaming and freeing this component.
Component::removeComponent(): Removes a component from the component's collection
Component::serializeChildren(): Serializes all children
Component::setName()
Component::setTag()
Component::unserializeChildren(): Unserializes all children by calling unserialize for all the components
Component::updateDataField(): Updates the field on the dataset attached, if any
Component::writeControlState()

Class: Persistent

Persistent::allowserialize(): This method provides an opportunity for the component developer to prevent the serialization/unserialization of a property.
Persistent::assign(): Assigns the source properties to this object.
Persistent::assignError(): Raises an assignation error.
Persistent::assignTo(): Assigns this object to another object.
Persistent::inSession(): This method determines if this object exists in the current session.
Persistent::readNamePath(): Used to serialize/unserialize. It returns the full path to identify this component.
Persistent::readOwner(): Owner of the component.
Persistent::serialize(): Stores this object into the session.
Persistent::unserialize(): This method uses PHP reflection to iterate through published properties (the ones starting with get) and retrieve the properties stored by a previous serialize() call.

Class: Object

Object::__construct(): Constructs an object and initializes its data before the object is first used.
Object::className(): Returns a string indicating the type of the object instance (as opposed to the type of the variable passed as an argument).
Object::classNameIs(): Determines whether an object is of a specific type.
Object::classParent(): Returns the type of the immediate ancestor of a class.
Object::inheritsFrom(): Determines the relationship of two object types.
Object::methodExists(): Check if a method exists declared on this object instance.
Object::readProperty(): Reads a property from the streams
Object::__get(): To virtualize properties
Object::__set(): To virtualize properties

Class Details

[line 37]
Base class for StyleSheet component

This component allows you to link a StyleSheet file stored on a .css file, components having Style property will show available styles populated by this component.

Tags:

link:

http://www.w3.org/Style/CSS/

[ Top ]

Class Variables

$_filename = ""

[line 39]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_inclid = 0

[line 42]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_inclstandard = 0

[line 41]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_incsubstyle = 0

[line 43]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_stylelist = array()

[line 40]

Tags:

access:

protected

Type:

mixed

[ Top ]

Class Methods

method BuildStyleList [line 55]

array BuildStyleList(
string
$FileName, boolean
$InclStandard, boolean
$InclID, boolean
$InclSubStyle)

Builds and returs back an array of Style names based on specified parameters

Tags:

return:

Array with styles available on $filename

Parameters:

string	$FileName	Name of the css file to parse
boolean	$InclStandard	If true, will include standard styles
boolean	$InclID	If true, will also include ID
boolean	$InclSubStyle	If true, will include substyles

[ Top ]

method defaultFileName [line 234]

void defaultFileName(
)

[ Top ]

method defaultIncludeID [line 256]

void defaultIncludeID(
)

[ Top ]

method defaultIncludeStandard [line 247]

void defaultIncludeStandard(
)

[ Top ]

method defaultIncludeSubStyle [line 265]

void defaultIncludeSubStyle(
)

[ Top ]

method dumpHeaderCode [line 213]

void dumpHeaderCode(
)

Overrides Component::dumpHeaderCode() (Dumps header code required)

[ Top ]

method loaded [line 218]

void loaded(
)

Overrides Component::loaded() (Initializes the component after the form file has been read into memory.)

[ Top ]

method ParseCSSFile [line 208]

void ParseCSSFile(
)

This method parses the CSS file and populates the stylelist

This method is used internally by the component to build the list of styles available to other components.

Tags:

access:

protected

[ Top ]

method readFileName [line 232]

string readFileName(
)

Specifies CSS File Name

Point this property to the filename of the .css file you want to include in your page. While you can use full paths, it's recommended you use relative paths, so the page will be more portable.

Tags:

access:

protected

[ Top ]

method readIncludeID [line 254]

boolean readIncludeID(
)

Specifies if Styles array should include class IDs If set to True, then to work properly IncludeSubStyle should be set to True also

Tags:

access:

protected

[ Top ]

method readIncludeStandard [line 245]

boolean readIncludeStandard(
)

Specifies if Styles array should include style names for HTML tags

Use this property to specify if the array of style names fetched from the .css file should include names for the standard HTML tags, that is, for tags like BODY, H1, etc.

Tags:

access:

protected

[ Top ]

method readIncludeSubStyle [line 263]

boolean readIncludeSubStyle(
)

Specifies if Styles array should include Class Names only or full class definitions including tag elements

Tags:

access:

protected

[ Top ]

method readStyles [line 271]

array readStyles(
)

Array of Style Names from specified CSS File

[ Top ]

method writeFileName [line 233]

void writeFileName(

$value)

Tags:

access:

protected

Parameters:

$value

[ Top ]

method writeIncludeID [line 255]

void writeIncludeID(

$value)

Tags:

access:

protected

Parameters:

$value

[ Top ]

method writeIncludeStandard [line 246]

void writeIncludeStandard(

$value)

Tags:

access:

protected

Parameters:

$value

[ Top ]

method writeIncludeSubStyle [line 264]

void writeIncludeSubStyle(

$value)

Tags:

access:

protected

Parameters:

$value

[ Top ]

method writeStyles [line 273]

void writeStyles(

$value)

Parameters:

$value

[ Top ]

Documentation generated on Sat, 13 Jun 2009 10:52:11 -0700 by phpDocumentor 1.4.1