Docs For Class StylePropertyInterface

Description

A StyleProperty (SP) is one of the tree building pieces of CSS styles. It stores information about a single CSS style property by storing one or more

StyleComponents

.

The other two CSS styles building pieces are

StyleComponents

and

StyleCollections

. To clarify the relationship between these three building pieces, consider the following example:

 div {
     margin: 20px;
     border: 1px solid #000;
 }

div

is a

StyleCollection

consisting of 2

StyleProperties

:

margin

and

border

. Each of the latter consists of one or more

StyleComponents

. In specific,

margin

consists of one

StyleComponent

with the value

20px

, and

border

has three

StyleComponents

with values

1px

,

solid

, and

#000

correspondingly.

version: $Id: StyleProperty.interface.php,v 1.6 2007/09/04 20:25:21 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/GUIManager/StyleProperty.interface.php (line 33)

Direct descendents

Class	Description
StyleProperty	This StyleProperty generic class allows one to create a StyleProperty of arbitrary nature from scratch. It has no default StyleComponents attached.

Method Summary

void addSC (ref $sc)

string getCSS ()

string getDescription ()

string getDisplayName ()

string getName ()

array getSCs ()

Methods

addSC (line 76)

Adds one StyleComponent to this StyleProperty.

access: public

void addSC (ref $sc)

ref $sc: object A StyleComponent object.

Redefined in descendants as:

StyleProperty::addSC() : Adds one StyleComponent to this StyleProperty.

getCSS (line 40)

Returns the CSS code for this StyleProperty.

return: The CSS code for this StyleProperty.
access: public

string getCSS ()

Redefined in descendants as:

StyleProperty::getCSS() : Returns the CSS code for this StyleProperty.

getDescription (line 67)

Returns the description of this StlyeProperty.

return: The description of this StlyeProperty.
access: public

string getDescription ()

Redefined in descendants as:

StyleProperty::getDescription() : Returns the description of this StlyeProperty.

getDisplayName (line 58)

Returns the display name of this StyleProperty.

return: The display name of this StyleProperty.
access: public

string getDisplayName ()

Redefined in descendants as:

StyleProperty::getDisplayName() : Returns the display name of this StyleProperty.

getName (line 49)

Returns the name of this StyleProperty.

return: The name of this StyleProperty.
access: public

string getName ()

Redefined in descendants as:

StyleProperty::getName() : Returns the name of this StyleProperty.

getSCs (line 86)

Returns the StyleComponents of this StyleProperty in a suitable for CSS generation order.

return: An array of the StyleComponents of this StyleProperty.
access: public

array getSCs ()

Redefined in descendants as:

StyleProperty::getSCs() : Returns the StyleComponents of this StyleProperty in a suitable for CSS generation order.