Description
Object | --Persistent | --Component | --CustomStyleSheet
Located in File: /styles.inc.php
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.
- link: - http://www.w3.org/Style/CSS/
Classes extended from CustomStyleSheet:
- StyleSheet
- A class to allow import and use stylesheets
Properties
Summary: | FileName | Specifies CSS File Name |
| IncludeID | Specifies if Styles array should include class IDs If set to True, then to work properly IncludeSubStyle should be set to True also |
| IncludeStandard | Specifies if Styles array should include style names for HTML tags |
| IncludeSubStyle | Specifies if Styles array should include Class Names only or full class definitions including tag elements |
| Styles | Array of Style Names from specified CSS File |
Defined in class Component |
||
 | Name | Specifies the name for the component. The name is used as an identifier and should be unique. |
| Tag | A versatile property of every Component that can be used in any way you want |
| ComponentCount | Indicates the number of components owned by the component. |
| Components | Lists all the components owned by this component. |
| ControlState | A flag to know the state of the control, csLoading, csDesigning |
| DataFieldValue | This property returns the value of the datafield if any. |
| NamePath | Specifies the path to uniquely identify a component, qualified by the owner when required. |
| Owner | Indicates the component that is responsible for streaming and freeing this component. |
Defined in class Persistent |
||
| NamePath | Used to serialize/unserialize. It returns the full path to identify this component. |
| Owner | Owner of the component. |
property FileName (line 232)
string FileName
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.
Info
- access - protected
property IncludeID (line 254)
boolean IncludeID
Specifies if Styles array should include class IDs If set to True, then to work properly IncludeSubStyle should be set to True also
Info
- access - protected
property IncludeStandard (line 245)
boolean IncludeStandard
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.
Info
- access - protected
property IncludeSubStyle (line 263)
boolean IncludeSubStyle
Specifies if Styles array should include Class Names only or full class definitions including tag elements
Info
- access - protected
property Name
Specifies the name for the component. The name is used as an identifier and should be unique.
This property is implemented in Component::Name
property Tag
A versatile property of every Component that can be used in any way you want
This property is implemented in Component::Tag
property ComponentCount
Indicates the number of components owned by the component.
This property is implemented in Component::ComponentCount
property Components
Lists all the components owned by this component.
This property is implemented in Component::Components
property ControlState
A flag to know the state of the control, csLoading, csDesigning
This property is implemented in Component::ControlState
property DataFieldValue
This property returns the value of the datafield if any.
This property is implemented in Component::DataFieldValue
property NamePath
Specifies the path to uniquely identify a component, qualified by the owner when required.
This property is implemented in Component::NamePath
property Owner
Indicates the component that is responsible for streaming and freeing this component.
This property is implemented in Component::Owner
property NamePath
Used to serialize/unserialize. It returns the full path to identify this component.
This property is implemented in Persistent::NamePathMethods
Summary: | BuildStyleList | Builds and returs back an array of Style names based on specified parameters |
| | dumpHeaderCode | Dumps header code required [Overrides Component::dumpHeaderCode()] |
| | loaded | Initializes the component after the form file has been read into memory. [Overrides Component::loaded()] |
| | ParseCSSFile | This method parses the CSS file and populates the stylelist |
Defined in class Component |
||
| dumpChildrenJavascript | Dumps the javascript code for all the children |
| dumpFormItems | Dumps code just after the form tag, useful to dump hidden fields for state retrieving for non visible components |
| dumpHeaderCode | Dumps header code required |
| dumpJavascript | Dumps the javascript code needed by this component |
| hasValidDataField | Returns true if a valid data field is attached to the component |
| init | Initializes a component |
| loaded | Initializes the component after the form file has been read into memory. |
| loadedChildren | Calls childrens loaded |
| preinit | Method called before init() |
| serializeChildren | Serializes all children |
| unserializeChildren | Unserializes all children by calling unserialize for all the components |
Defined in class Persistent |
||
| serialize | Stores this object into the session. |
| 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. |
Defined in class Object |
||
| __construct | Constructs an object and initializes its data before the object is first used. |
| className | Returns a string indicating the type of the object instance (as opposed to the type of the variable passed as an argument). |
| classParent | Returns the type of the immediate ancestor of a class. |
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
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
Info
- return - Array with styles available on $filename
Method dumpHeaderCode (line 213)
void dumpHeaderCode( )
Overrides : Component::dumpHeaderCode() Dumps header code required
Method loaded (line 218)
void loaded( )
Overrides : Component::loaded() Initializes the component after the form file has been read into memory.
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.
Info
- access - protected