Class: Brush

Source Location: /graphics.inc.php

Class Overview

Object
   |
   --Persistent
      |
      --Brush

Brush represents the color and pattern used to fill solid shapes.

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 1112]
Brush represents the color and pattern used to fill solid shapes.

Brush encapsulates several properties to hold all the attributes to fill solid shapes, such as rectangles and ellipses, with a color or pattern.

Tags:

see:

Canvas::getBrush()

[ Top ]

Class Variables

$_color = "#FFFFFF"

[line 1114]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_control = null

[line 1116]

Tags:

access:

public

Type:

mixed

[ Top ]

$_modified = 0

[line 1115]

Tags:

access:

protected

Type:

mixed

[ Top ]

Class Methods

method assignTo [line 1123]

void assignTo(

$dest)

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

Parameters:

$dest

[ Top ]

method defaultColor [line 1170]

void defaultColor(
)

[ Top ]

method getColor [line 1168]

string getColor(
)

Indicates the color of the brush.

The Color property determines the color of the brush. This is the color that is used to draw the pattern.

[ Top ]

method isModified [line 1148]

integer isModified(
)

Returns the status of the internal flag for modified state

This function returns the status of the internal flag that marks this brush as modified

Tags:

see:	Brush::resetModified()
see:	Brush::modified()

[ Top ]

method modified [line 1136]

void modified(
)

Mark the brush as modified.

This method marks the brush as modified by setting an internal flag to 1

Tags:

see:	Brush::resetModified()
see:	Brush::isModified()

[ Top ]

method readOwner [line 1118]

void readOwner(
)

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

[ Top ]

method resetModified [line 1158]

void resetModified(
)

Mark the brush as not modified.

This method resets the internal flag to specify it has not been modified

Tags:

see:	Brush::modified()
see:	Brush::isModified()

[ Top ]

method setColor [line 1169]

void setColor(

$value)

Parameters:

$value

[ Top ]

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