Class: Font

Source Location: /graphics.inc.php

Class Overview

Object
   |
   --Persistent
      |
      --Font

Font encapsulates all properties required to represent a font on the browser.

Author(s):

Variables

Methods

Inherited Variables

Class: Object

Object::$input

Inherited Methods

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 729]
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.

Tags:

see:

Control::readFont()

[ Top ]

Class Variables

$_align = "taNone"

[line 735]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_case = ""

[line 737]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_color = ""

[line 733]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_control = null

[line 741]

Tags:

access:

public

Type:

mixed

[ Top ]

$_family = "Verdana"

[line 731]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_lineheight = ""

[line 739]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_size = "10px"

[line 732]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_style = ""

[line 736]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_variant = ""

[line 738]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_weight = ""

[line 734]

Tags:

access:

protected

Type:

mixed

[ Top ]

Class Methods

method assignTo [line 751]

void assignTo(
object
$dest)

Assign Font object to another Font object, this is done by assigning all Font properties from one object to another

Overrides Persistent::assignTo() (Assigns this object to another object.)

Parameters:

object

$dest

Destination, where the new font settings are assigned to.

[ Top ]

method defaultAlign [line 936]

void defaultAlign(
)

[ Top ]

method defaultCase [line 909]

void defaultCase(
)

[ Top ]

method defaultColor [line 928]

void defaultColor(
)

[ Top ]

method defaultFamily [line 861]

void defaultFamily(
)

[ Top ]

method defaultLineHeight [line 884]

void defaultLineHeight(
)

[ Top ]

method defaultSize [line 873]

void defaultSize(
)

[ Top ]

method defaultStyle [line 897]

void defaultStyle(
)

[ Top ]

method defaultVariant [line 920]

void defaultVariant(
)

[ Top ]

method defaultWeight [line 944]

void defaultWeight(
)

[ Top ]

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.

[ Top ]

method getAlign [line 934]

string getAlign(
)

Specifies the alignment to be used for this font

[ Top ]

method getCase [line 907]

string getCase(
)

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

Tags:

link:

http://www.w3.org/TR/REC-CSS2/text.html#propdef-text-transform

[ Top ]

method getColor [line 926]

string getColor(
)

Color for this font, it should be an HTML valid color, i.e. #FF0000

[ Top ]

method getFamily [line 859]

string getFamily(
)

Font list to be used to render this font, this should be an HTML font family specifier

Tags:

link:

http://www.w3.org/TR/REC-CSS2/fonts.html#font-family-prop

[ Top ]

method getLineHeight [line 882]

string getLineHeight(
)

Height for this font, this correspond to the line paragraph

Tags:

link:

http://www.w3.org/TR/REC-CSS2/visudet.html#propdef-line-height

[ Top ]

method getSize [line 871]

string getSize(
)

Size to be used to render this font, you can use a unit specifier, for example px, or em

Tags:

link:

http://www.w3.org/TR/REC-CSS2/fonts.html#font-size-props

[ Top ]

method getStyle [line 895]

string getStyle(
)

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

[ Top ]

method getVariant [line 918]

string getVariant(
)

Variant conversion to be used to render this font

Tags:

link:

http://www.w3.org/TR/REC-CSS2/fonts.html#propdef-font-variant

[ Top ]

method getWeight [line 942]

enum getWeight(
)

Specifies the weight (boldness) for this font

[ Top ]

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.

[ Top ]

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

[ Top ]

method readFontString [line 952]

string readFontString(
)

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

[ Top ]

method readOwner [line 769]

void readOwner(
)

Overrides Persistent::readOwner() (Owner of the component.)

[ Top ]

method setAlign [line 935]

void setAlign(

$value)

Parameters:

$value

[ Top ]

method setCase [line 908]

void setCase(

$value)

Parameters:

$value

[ Top ]

method setColor [line 927]

void setColor(

$value)

Parameters:

$value

[ Top ]

method setFamily [line 860]

void setFamily(

$value)

Parameters:

$value

[ Top ]

method setLineHeight [line 883]

void setLineHeight(

$value)

Parameters:

$value

[ Top ]

method setSize [line 872]

void setSize(

$value)

Parameters:

$value

[ Top ]

method setStyle [line 896]

void setStyle(

$value)

Parameters:

$value

[ Top ]

method setVariant [line 919]

void setVariant(

$value)

Parameters:

$value

[ Top ]

method setWeight [line 943]

void setWeight(

$value)

Parameters:

$value

[ Top ]

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.

[ Top ]

Documentation generated on Sat, 13 Jun 2009 10:51:44 -0700 by phpDocumentor 1.4.1