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

WebObjectTree class. More...

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

Public Member Functions

 __construct ($id, $request)
 WebObjectTree constructor. More...
 
 addItem ($text=null, $hint=null)
 Adds a new item to the items collection. More...
 
 getClosedIconImageUrl ()
 Gets the image to display for closed parent items. More...
 
 getCollapsedImageUrl ()
 Gets the image used when an item has been collapsed. More...
 
 getCustomData ()
 Gets the custom tree data that is persisted during postbacks. More...
 
 getExpandedImageUrl ()
 Gets the image used when an item has been expanded. More...
 
 getFullPath ()
 Gets the current full path selected in the webobjecttree control. More...
 
 getInnerIndentImageUrl ()
 Gets the image to display before a set of indented items. More...
 
 getItemIndentImageUrl ()
 Gets the image to display before an indented item. More...
 
 getItems ()
 Gets the items collection. More...
 
 getLastIndentImageUrl ()
 Gets the image to display before the last indented item. More...
 
 getLeafIconImageUrl ()
 Gets the image to display for leaf children items. More...
 
 getLoadingImageUrl ()
 Gets the image to display when retrieving the children items. More...
 
 getLoadingText ()
 Gets the text to display when retrieving the children items. More...
 
 getOpenedIconImageUrl ()
 Gets the image to display for opened parent items. More...
 
 getSelectedBackColor ()
 Gets the color of the background of the selected item. More...
 
 getSelectedForeColor ()
 Gets the color of the text within the selected item. More...
 
 getSelectInitialItem ()
 Gets whether to select the first item when the control initially loads. More...
 
 getShowIndentImages ()
 Gets whether to show the item indent images. More...
 
 getShowItemExpanders ()
 Gets whether to show the item expander elements. More...
 
 getShowItemIcons ()
 Gets whether to show the item icon elements. More...
 
 getSpacerImageUrl ()
 Gets the spacer image used for items that have no children. More...
 
 setBorderWidth ($value)
 Sets the border width of the control. More...
 
 setClosedIconImageUrl ($value)
 Sets the image to display for closed parent items. More...
 
 setCollapsedImageUrl ($value)
 Sets the image used when an item has been collapsed. More...
 
 setCustomData ($value)
 Sets the custom tree data that is persisted during postbacks. More...
 
 setExpandedImageUrl ($value)
 Sets the image used when an item has been expanded. More...
 
 setFullPath ($value)
 Sets the current full path selected in the webobjecttree control. More...
 
 setInnerIndentImageUrl ($value)
 Sets the image to display before a set of indented items. More...
 
 setItemIndentImageUrl ($value)
 Sets the image to display before an indented item. More...
 
 setLastIndentImageUrl ($value)
 Sets the image to display before the last indented item. More...
 
 setLeafIconImageUrl ($value)
 Sets the image to display for leaf children items. More...
 
 setLoadingImageUrl ($value)
 Sets the image to display when retrieving the children items. More...
 
 setLoadingText ($value)
 Sets the text to display when retrieving the children items. More...
 
 setOpenedIconImageUrl ($value)
 Sets the image to display for opened parent items. More...
 
 setSelectedBackColor ($value)
 Sets the color of the background of the selected item. More...
 
 setSelectedForeColor ($value)
 Sets the color of the text within the selected item. More...
 
 setSelectInitialItem ($value)
 Sets whether to select the first item when the control initially loads. More...
 
 setShowIndentImages ($value)
 Sets whether to show the item indent images. More...
 
 setShowItemExpanders ($value)
 Sets whether to show the item expander elements. More...
 
 setShowItemIcons ($value)
 Sets whether to show the item icon elements. More...
 
 setSpacerImageUrl ($value)
 Sets the spacer image used for items that have no children. More...
 
- Public Member Functions inherited from Coalesys\WebObjectTree\WebControl
 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...
 

Static Public Member Functions

static appendKeyValue ($sourcePath, $keyString, $valueString)
 Appends a new key/value pair to the end of the path string. More...
 
static extractKeys ($sourcePath)
 Extracts the key portion(s) of a string that contains key/value pair(s). More...
 
static extractValues ($sourcePath)
 Extracts the value portion(s) of a string that contains key/value pair(s). More...
 

Detailed Description

WebObjectTree class.

Constructor & Destructor Documentation

Coalesys\WebObjectTree\WebObjectTree::__construct (   $id,
  $request 
)

WebObjectTree constructor.

Parameters
$idThe control identifier.
$requestThe request parameters.

Member Function Documentation

Coalesys\WebObjectTree\WebObjectTree::addItem (   $text = null,
  $hint = null 
)

Adds a new item to the items collection.

Parameters
$textThe text string displayed for the item.
$hintThe user-defined hint for applying custom styles.
Returns
The item object.
static Coalesys\WebObjectTree\WebObjectTree::appendKeyValue (   $sourcePath,
  $keyString,
  $valueString 
)
static

Appends a new key/value pair to the end of the path string.

Parameters
$sourcePathThe source path to append the new key/value pair.
$keyStringThe new key string to append to the end of the path.
$valueStringThe new value string to append to the end of the path.
Returns
The resulting path that contains the new key/value pair.
static Coalesys\WebObjectTree\WebObjectTree::extractKeys (   $sourcePath)
static

Extracts the key portion(s) of a string that contains key/value pair(s).

Parameters
$sourcePathThe source path that contains some key/value pair(s).
Returns
The resulting path that contains key(s) only.
static Coalesys\WebObjectTree\WebObjectTree::extractValues (   $sourcePath)
static

Extracts the value portion(s) of a string that contains key/value pair(s).

Parameters
$sourcePathThe source path that contains some key/value pair(s).
Returns
The resulting path that contains value(s) only.
Coalesys\WebObjectTree\WebObjectTree::getClosedIconImageUrl ( )

Gets the image to display for closed parent items.

Coalesys\WebObjectTree\WebObjectTree::getCollapsedImageUrl ( )

Gets the image used when an item has been collapsed.

Coalesys\WebObjectTree\WebObjectTree::getCustomData ( )

Gets the custom tree data that is persisted during postbacks.

Coalesys\WebObjectTree\WebObjectTree::getExpandedImageUrl ( )

Gets the image used when an item has been expanded.

Coalesys\WebObjectTree\WebObjectTree::getFullPath ( )

Gets the current full path selected in the webobjecttree control.

Coalesys\WebObjectTree\WebObjectTree::getInnerIndentImageUrl ( )

Gets the image to display before a set of indented items.

Coalesys\WebObjectTree\WebObjectTree::getItemIndentImageUrl ( )

Gets the image to display before an indented item.

Coalesys\WebObjectTree\WebObjectTree::getItems ( )

Gets the items collection.

Coalesys\WebObjectTree\WebObjectTree::getLastIndentImageUrl ( )

Gets the image to display before the last indented item.

Coalesys\WebObjectTree\WebObjectTree::getLeafIconImageUrl ( )

Gets the image to display for leaf children items.

Coalesys\WebObjectTree\WebObjectTree::getLoadingImageUrl ( )

Gets the image to display when retrieving the children items.

Coalesys\WebObjectTree\WebObjectTree::getLoadingText ( )

Gets the text to display when retrieving the children items.

Coalesys\WebObjectTree\WebObjectTree::getOpenedIconImageUrl ( )

Gets the image to display for opened parent items.

Coalesys\WebObjectTree\WebObjectTree::getSelectedBackColor ( )

Gets the color of the background of the selected item.

Coalesys\WebObjectTree\WebObjectTree::getSelectedForeColor ( )

Gets the color of the text within the selected item.

Coalesys\WebObjectTree\WebObjectTree::getSelectInitialItem ( )

Gets whether to select the first item when the control initially loads.

Coalesys\WebObjectTree\WebObjectTree::getShowIndentImages ( )

Gets whether to show the item indent images.

Coalesys\WebObjectTree\WebObjectTree::getShowItemExpanders ( )

Gets whether to show the item expander elements.

Coalesys\WebObjectTree\WebObjectTree::getShowItemIcons ( )

Gets whether to show the item icon elements.

Coalesys\WebObjectTree\WebObjectTree::getSpacerImageUrl ( )

Gets the spacer image used for items that have no children.

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

Sets the border width of the control.

Coalesys\WebObjectTree\WebObjectTree::setClosedIconImageUrl (   $value)

Sets the image to display for closed parent items.

Coalesys\WebObjectTree\WebObjectTree::setCollapsedImageUrl (   $value)

Sets the image used when an item has been collapsed.

Coalesys\WebObjectTree\WebObjectTree::setCustomData (   $value)

Sets the custom tree data that is persisted during postbacks.

Coalesys\WebObjectTree\WebObjectTree::setExpandedImageUrl (   $value)

Sets the image used when an item has been expanded.

Coalesys\WebObjectTree\WebObjectTree::setFullPath (   $value)

Sets the current full path selected in the webobjecttree control.

Coalesys\WebObjectTree\WebObjectTree::setInnerIndentImageUrl (   $value)

Sets the image to display before a set of indented items.

Coalesys\WebObjectTree\WebObjectTree::setItemIndentImageUrl (   $value)

Sets the image to display before an indented item.

Coalesys\WebObjectTree\WebObjectTree::setLastIndentImageUrl (   $value)

Sets the image to display before the last indented item.

Coalesys\WebObjectTree\WebObjectTree::setLeafIconImageUrl (   $value)

Sets the image to display for leaf children items.

Coalesys\WebObjectTree\WebObjectTree::setLoadingImageUrl (   $value)

Sets the image to display when retrieving the children items.

Coalesys\WebObjectTree\WebObjectTree::setLoadingText (   $value)

Sets the text to display when retrieving the children items.

Coalesys\WebObjectTree\WebObjectTree::setOpenedIconImageUrl (   $value)

Sets the image to display for opened parent items.

Coalesys\WebObjectTree\WebObjectTree::setSelectedBackColor (   $value)

Sets the color of the background of the selected item.

Coalesys\WebObjectTree\WebObjectTree::setSelectedForeColor (   $value)

Sets the color of the text within the selected item.

Coalesys\WebObjectTree\WebObjectTree::setSelectInitialItem (   $value)

Sets whether to select the first item when the control initially loads.

Coalesys\WebObjectTree\WebObjectTree::setShowIndentImages (   $value)

Sets whether to show the item indent images.

Coalesys\WebObjectTree\WebObjectTree::setShowItemExpanders (   $value)

Sets whether to show the item expander elements.

Coalesys\WebObjectTree\WebObjectTree::setShowItemIcons (   $value)

Sets whether to show the item icon elements.

Coalesys\WebObjectTree\WebObjectTree::setSpacerImageUrl (   $value)

Sets the spacer image used for items that have no children.


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