WebObjectTree for PHP
Public Member Functions | List of all members
Coalesys\WebObjectTree\WebControl Class Reference

WebControl class. More...

Inheritance diagram for Coalesys\WebObjectTree\WebControl:
Coalesys\WebObjectTree\WebObjectTree

Public Member Functions

 getAbout ()
 Returns about information for the control. More...
 
 getAccessKey ()
 Gets the access key that allows you to quickly navigate to the control. More...
 
 getBackColor ()
 Gets the background color of the control. More...
 
 getBorderColor ()
 Gets the border color of the control. More...
 
 getBorderStyle ()
 Gets the border color of the control. More...
 
 getBorderWidth ()
 Gets the border width of the control. More...
 
 getControlData ()
 Gets the item data to display in the control. More...
 
 getCustomClassPrefix ()
 Gets the prefix string to use for custom css class names. More...
 
 getDataRetrievalUrl ()
 Gets the location to retrieve item data. More...
 
 getEnabled ()
 Gets a value indicating whether the control is enabled. More...
 
 getEnableOutline ()
 Gets whether to enable outline for keyboard focus. More...
 
 getFont ()
 Gets the font properties associated with the control. More...
 
 getForeColor ()
 Gets the text color for the control. More...
 
 getHeight ()
 Gets the height of the control. More...
 
 getID ()
 Gets the programmatic identifier assigned to the control. More...
 
 getName ()
 Gets the name of the control. More...
 
 getRetentionPeriod ()
 Gets the number of seconds before the item data is discarded (zero or less for infinite). More...
 
 getTabIndex ()
 Gets the tab order of the control. More...
 
 getToolTip ()
 Gets the tooltip displayed when the mouse is over the control. More...
 
 getUserData ()
 Gets the user data for the control. More...
 
 getWidth ()
 Gets the width of the control. More...
 
 loadState ($source)
 Loads the control state from the specified file or stream. More...
 
 renderControl ()
 Renders the required code for this control instance. More...
 
 saveState ($destination)
 Saves the control state to the specified file or stream. More...
 
 setAccessKey ($value)
 Sets the access key that allows you to quickly navigate to the control. More...
 
 setBackColor ($value)
 Sets the background color of the control. More...
 
 setBorderColor ($value)
 Sets the border color of the control. More...
 
 setBorderStyle ($value)
 Sets the border color of the control. More...
 
 setBorderWidth ($value)
 Sets the border width of the control. More...
 
 setControlData ($value)
 Sets the item data to display in the control. More...
 
 setCustomClassPrefix ($value)
 Sets the prefix string to use for custom css class names. More...
 
 setDataRetrievalUrl ($value)
 Sets the location to retrieve item data. More...
 
 setEnabled ($value)
 Sets a value indicating whether the control is enabled. More...
 
 setEnableOutline ($value)
 Sets whether to enable outline for keyboard focus. More...
 
 setForeColor ($value)
 Sets the text color for the control. More...
 
 setHeight ($value)
 Sets the height of the control. More...
 
 setID ($value)
 Sets the programmatic identifier assigned to the control. More...
 
 setName ($value)
 Sets the name of the control. More...
 
 setRetentionPeriod ($value)
 Sets the number of seconds before the item data is discarded (zero or less for infinite). More...
 
 setTabIndex ($value)
 Sets the tab order of the control. More...
 
 setToolTip ($value)
 Sets the tooltip displayed when the mouse is over the control. More...
 
 setUserData ($value)
 Sets the user data for the control. More...
 
 setWidth ($value)
 Sets the width of the control. More...
 

Detailed Description

WebControl class.

Member Function Documentation

Coalesys\WebObjectTree\WebControl::getAbout ( )

Returns about information for the control.

Coalesys\WebObjectTree\WebControl::getAccessKey ( )

Gets the access key that allows you to quickly navigate to the control.

Coalesys\WebObjectTree\WebControl::getBackColor ( )

Gets the background color of the control.

Coalesys\WebObjectTree\WebControl::getBorderColor ( )

Gets the border color of the control.

Coalesys\WebObjectTree\WebControl::getBorderStyle ( )

Gets the border color of the control.

Coalesys\WebObjectTree\WebControl::getBorderWidth ( )

Gets the border width of the control.

Coalesys\WebObjectTree\WebControl::getControlData ( )

Gets the item data to display in the control.

Coalesys\WebObjectTree\WebControl::getCustomClassPrefix ( )

Gets the prefix string to use for custom css class names.

Coalesys\WebObjectTree\WebControl::getDataRetrievalUrl ( )

Gets the location to retrieve item data.

Coalesys\WebObjectTree\WebControl::getEnabled ( )

Gets a value indicating whether the control is enabled.

Coalesys\WebObjectTree\WebControl::getEnableOutline ( )

Gets whether to enable outline for keyboard focus.

Coalesys\WebObjectTree\WebControl::getFont ( )

Gets the font properties associated with the control.

Coalesys\WebObjectTree\WebControl::getForeColor ( )

Gets the text color for the control.

Coalesys\WebObjectTree\WebControl::getHeight ( )

Gets the height of the control.

Coalesys\WebObjectTree\WebControl::getID ( )

Gets the programmatic identifier assigned to the control.

Coalesys\WebObjectTree\WebControl::getName ( )

Gets the name of the control.

Coalesys\WebObjectTree\WebControl::getRetentionPeriod ( )

Gets the number of seconds before the item data is discarded (zero or less for infinite).

Coalesys\WebObjectTree\WebControl::getTabIndex ( )

Gets the tab order of the control.

Coalesys\WebObjectTree\WebControl::getToolTip ( )

Gets the tooltip displayed when the mouse is over the control.

Coalesys\WebObjectTree\WebControl::getUserData ( )

Gets the user data for the control.

Coalesys\WebObjectTree\WebControl::getWidth ( )

Gets the width of the control.

Coalesys\WebObjectTree\WebControl::loadState (   $source)

Loads the control state from the specified file or stream.

Parameters
$sourceThe source file name or stream object.
Coalesys\WebObjectTree\WebControl::renderControl ( )

Renders the required code for this control instance.

Returns
The control generated code.
Coalesys\WebObjectTree\WebControl::saveState (   $destination)

Saves the control state to the specified file or stream.

Parameters
$destinationThe destination file name or stream object.
Coalesys\WebObjectTree\WebControl::setAccessKey (   $value)

Sets the access key that allows you to quickly navigate to the control.

Coalesys\WebObjectTree\WebControl::setBackColor (   $value)

Sets the background color of the control.

Coalesys\WebObjectTree\WebControl::setBorderColor (   $value)

Sets the border color of the control.

Coalesys\WebObjectTree\WebControl::setBorderStyle (   $value)

Sets the border color of the control.

Coalesys\WebObjectTree\WebControl::setBorderWidth (   $value)

Sets the border width of the control.

Coalesys\WebObjectTree\WebControl::setControlData (   $value)

Sets the item data to display in the control.

Coalesys\WebObjectTree\WebControl::setCustomClassPrefix (   $value)

Sets the prefix string to use for custom css class names.

Coalesys\WebObjectTree\WebControl::setDataRetrievalUrl (   $value)

Sets the location to retrieve item data.

Coalesys\WebObjectTree\WebControl::setEnabled (   $value)

Sets a value indicating whether the control is enabled.

Coalesys\WebObjectTree\WebControl::setEnableOutline (   $value)

Sets whether to enable outline for keyboard focus.

Coalesys\WebObjectTree\WebControl::setForeColor (   $value)

Sets the text color for the control.

Coalesys\WebObjectTree\WebControl::setHeight (   $value)

Sets the height of the control.

Coalesys\WebObjectTree\WebControl::setID (   $value)

Sets the programmatic identifier assigned to the control.

Coalesys\WebObjectTree\WebControl::setName (   $value)

Sets the name of the control.

Coalesys\WebObjectTree\WebControl::setRetentionPeriod (   $value)

Sets the number of seconds before the item data is discarded (zero or less for infinite).

Coalesys\WebObjectTree\WebControl::setTabIndex (   $value)

Sets the tab order of the control.

Coalesys\WebObjectTree\WebControl::setToolTip (   $value)

Sets the tooltip displayed when the mouse is over the control.

Coalesys\WebObjectTree\WebControl::setUserData (   $value)

Sets the user data for the control.

Coalesys\WebObjectTree\WebControl::setWidth (   $value)

Sets the width of the control.


The documentation for this class was generated from the following file: