Description
Object | --Persistent | --Font
Located in File: /graphics.inc.php
Font encapsulates all properties required to represent a font on the browser.
Font describes font characteristics used when displaying text. Font defines a set of characters by specifying the height, font name (typeface), attributes (such as bold or italic) and so on.
- see: - Control::Font
Properties
Summary: | Align | Specifies the alignment to be used for this font |
| Case | Case conversion to be used to render this font, it allows you to set a modifier to the case the user will see without affecting the information |
| Color | Color for this font, it should be an HTML valid color, i.e. #FF0000 |
| Family | Font list to be used to render this font, this should be an HTML font family specifier |
| LineHeight | Height for this font, this correspond to the line paragraph |
| Size | Size to be used to render this font, you can use a unit specifier, for example px, or em |
| Style | Style to be used to render this font, can be one of these values: |
| Variant | Variant conversion to be used to render this font |
| Weight | Specifies the weight (boldness) for this font |
 | FontString | Returns an style string to be asigned to the tag, it uses all the Font properties to create an style string to be used with an HTML tag |
| Owner | Owner of the component. [Publishes Persistent::Owner] |
Defined in class Persistent |
||
| NamePath | Used to serialize/unserialize. It returns the full path to identify this component. |
| Owner | Owner of the component. |
property Case (line 907)
string Case
Case conversion to be used to render this font, it allows you to set a modifier to the case the user will see without affecting the information
Info
property Color (line 926)
string Color
Color for this font, it should be an HTML valid color, i.e. #FF0000
property Family (line 859)
string Family
Font list to be used to render this font, this should be an HTML font family specifier
Info
property LineHeight (line 882)
string LineHeight
Height for this font, this correspond to the line paragraph
Info
property Size (line 871)
string Size
Size to be used to render this font, you can use a unit specifier, for example px, or em
Info
property Style (line 895)
string Style
Style to be used to render this font, can be one of these values:
fsNormal - No changes applied to the font face fsItalic - Text is rendered in Italic fsOblique - Text is rendered in Oblique
property FontString (line 952)
string FontString
Returns an style string to be asigned to the tag, it uses all the Font properties to create an style string to be used with an HTML tag
property NamePath
Used to serialize/unserialize. It returns the full path to identify this component.
This property is implemented in Persistent::NamePathMethods
Summary: | assignTo | Assigns this object to another object. [Overrides Persistent::assignTo()] |
| | endUpdate | Re-enables the notification mechanism to the control. |
| | isUpdating | Indicates if the Font object is in update mode. If true, the control where the Font is assigned to will not be notified when a property changes. |
| | modified | Check if the font has been modified to set to false the parentfont |
| | startUpdate | Call startUpdate() when multiple properties of the Font are updated at the same time. Once finished updating, call endUpdate(). |
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 assignTo (line 751)
void assignTo( object $dest)
Overrides : Persistent::assignTo() Assigns this object to another object.
Method endUpdate (line 790)
void endUpdate( )
Re-enables the notification mechanism to the control.
Note: endUpdate() has to be called as many times as startUpdate() was called on the same Font object.
Method isUpdating (line 811)
bool isUpdating( )
Indicates if the Font object is in update mode. If true, the control where the Font is assigned to will not be notified when a property changes.
Method modified (line 820)
void modified( )
Check if the font has been modified to set to false the parentfont
property of the control, if any
Method startUpdate (line 780)
void startUpdate( )
Call startUpdate() when multiple properties of the Font are updated at the same time. Once finished updating, call endUpdate().
It prevents the updating of the control where the Font is assigned to until the endUpdate() function is called.