![]() |
WebTabSet for PHP
|
Public Member Functions | |
__construct ($id, $request) | |
WebTabSet constructor. More... | |
addItem ($text=null, $hint=null) | |
Adds a new item to the items collection. More... | |
getExpandedBackColor () | |
Gets the color of the background for an item that has been expanded. More... | |
getExpandedChildrenImageUrl () | |
Gets the image used to indicate the expanded item has children items. More... | |
getExpandedForeColor () | |
Gets the color of the text within an item that has been expanded. More... | |
getExpandedItemImageUrl () | |
Gets the image to display for an item that has been expanded. More... | |
getFullPath () | |
Gets the current full path selected in the webtabset control. More... | |
getItems () | |
Gets the items collection. More... | |
getLoadingBackColor () | |
Gets the color of the background when retrieving the children items. More... | |
getLoadingForeColor () | |
Gets the color of the text when retrieving the 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... | |
getOverlapSize () | |
Gets the number of pixels that the selected item overlaps the content pane. More... | |
getSelectedBackColor () | |
Gets the color of the background of the selected item. More... | |
getSelectedChildrenImageUrl () | |
Gets the image used to indicate the selected item has children items. More... | |
getSelectedForeColor () | |
Gets the color of the text within the selected item. More... | |
getSelectedItemImageUrl () | |
Gets the image to display for the selected items. More... | |
getSelectInitialItem () | |
Gets whether to select the first item when the control initially loads. More... | |
getUnselectedBackColor () | |
Gets the color of the background of the unselected item. More... | |
getUnselectedChildrenImageUrl () | |
Gets the image used to indicate the unselected item has children items. More... | |
getUnselectedForeColor () | |
Gets the color of the text within the unselected item. More... | |
getUnselectedItemImageUrl () | |
Gets the image to display for the unselected items. More... | |
setExpandedBackColor ($value) | |
Sets the color of the background for an item that has been expanded. More... | |
setExpandedChildrenImageUrl ($value) | |
Sets the image used to indicate the expanded item has children items. More... | |
setExpandedForeColor ($value) | |
Sets the color of the text within an item that has been expanded. More... | |
setExpandedItemImageUrl ($value) | |
Sets the image to display for an item that has been expanded. More... | |
setFullPath ($value) | |
Sets the current full path selected in the webtabset control. More... | |
setLoadingBackColor ($value) | |
Sets the color of the background when retrieving the children items. More... | |
setLoadingForeColor ($value) | |
Sets the color of the text when retrieving the 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... | |
setOverlapSize ($value) | |
Sets the number of pixels that the selected item overlaps the content pane. More... | |
setSelectedBackColor ($value) | |
Sets the color of the background of the selected item. More... | |
setSelectedChildrenImageUrl ($value) | |
Sets the image used to indicate the selected item has children items. More... | |
setSelectedForeColor ($value) | |
Sets the color of the text within the selected item. More... | |
setSelectedItemImageUrl ($value) | |
Sets the image to display for the selected items. More... | |
setSelectInitialItem ($value) | |
Sets whether to select the first item when the control initially loads. More... | |
setUnselectedBackColor ($value) | |
Sets the color of the background of the unselected item. More... | |
setUnselectedChildrenImageUrl ($value) | |
Sets the image used to indicate the unselected item has children items. More... | |
setUnselectedForeColor ($value) | |
Sets the color of the text within the unselected item. More... | |
setUnselectedItemImageUrl ($value) | |
Sets the image to display for the unselected items. More... | |
![]() | |
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... | |
WebTabSet class.
Coalesys\WebTabSet\WebTabSet::__construct | ( | $id, | |
$request | |||
) |
WebTabSet constructor.
$id | The control identifier. |
$request | The request parameters. |
Coalesys\WebTabSet\WebTabSet::addItem | ( | $text = null , |
|
$hint = null |
|||
) |
Adds a new item to the items collection.
$text | The text string displayed for the item. |
$hint | The user-defined hint for applying custom styles. |
|
static |
Appends a new key/value pair to the end of the path string.
$sourcePath | The source path to append the new key/value pair. |
$keyString | The new key string to append to the end of the path. |
$valueString | The new value string to append to the end of the path. |
|
static |
Extracts the key portion(s) of a string that contains key/value pair(s).
$sourcePath | The source path that contains some key/value pair(s). |
|
static |
Extracts the value portion(s) of a string that contains key/value pair(s).
$sourcePath | The source path that contains some key/value pair(s). |
Coalesys\WebTabSet\WebTabSet::getExpandedBackColor | ( | ) |
Gets the color of the background for an item that has been expanded.
Coalesys\WebTabSet\WebTabSet::getExpandedChildrenImageUrl | ( | ) |
Gets the image used to indicate the expanded item has children items.
Coalesys\WebTabSet\WebTabSet::getExpandedForeColor | ( | ) |
Gets the color of the text within an item that has been expanded.
Coalesys\WebTabSet\WebTabSet::getExpandedItemImageUrl | ( | ) |
Gets the image to display for an item that has been expanded.
Coalesys\WebTabSet\WebTabSet::getFullPath | ( | ) |
Gets the current full path selected in the webtabset control.
Coalesys\WebTabSet\WebTabSet::getItems | ( | ) |
Gets the items collection.
Coalesys\WebTabSet\WebTabSet::getLoadingBackColor | ( | ) |
Gets the color of the background when retrieving the children items.
Coalesys\WebTabSet\WebTabSet::getLoadingForeColor | ( | ) |
Gets the color of the text when retrieving the children items.
Coalesys\WebTabSet\WebTabSet::getLoadingImageUrl | ( | ) |
Gets the image to display when retrieving the children items.
Coalesys\WebTabSet\WebTabSet::getLoadingText | ( | ) |
Gets the text to display when retrieving the children items.
Coalesys\WebTabSet\WebTabSet::getOverlapSize | ( | ) |
Gets the number of pixels that the selected item overlaps the content pane.
Coalesys\WebTabSet\WebTabSet::getSelectedBackColor | ( | ) |
Gets the color of the background of the selected item.
Coalesys\WebTabSet\WebTabSet::getSelectedChildrenImageUrl | ( | ) |
Gets the image used to indicate the selected item has children items.
Coalesys\WebTabSet\WebTabSet::getSelectedForeColor | ( | ) |
Gets the color of the text within the selected item.
Coalesys\WebTabSet\WebTabSet::getSelectedItemImageUrl | ( | ) |
Gets the image to display for the selected items.
Coalesys\WebTabSet\WebTabSet::getSelectInitialItem | ( | ) |
Gets whether to select the first item when the control initially loads.
Coalesys\WebTabSet\WebTabSet::getUnselectedBackColor | ( | ) |
Gets the color of the background of the unselected item.
Coalesys\WebTabSet\WebTabSet::getUnselectedChildrenImageUrl | ( | ) |
Gets the image used to indicate the unselected item has children items.
Coalesys\WebTabSet\WebTabSet::getUnselectedForeColor | ( | ) |
Gets the color of the text within the unselected item.
Coalesys\WebTabSet\WebTabSet::getUnselectedItemImageUrl | ( | ) |
Gets the image to display for the unselected items.
Coalesys\WebTabSet\WebTabSet::setExpandedBackColor | ( | $value | ) |
Sets the color of the background for an item that has been expanded.
Coalesys\WebTabSet\WebTabSet::setExpandedChildrenImageUrl | ( | $value | ) |
Sets the image used to indicate the expanded item has children items.
Coalesys\WebTabSet\WebTabSet::setExpandedForeColor | ( | $value | ) |
Sets the color of the text within an item that has been expanded.
Coalesys\WebTabSet\WebTabSet::setExpandedItemImageUrl | ( | $value | ) |
Sets the image to display for an item that has been expanded.
Coalesys\WebTabSet\WebTabSet::setFullPath | ( | $value | ) |
Sets the current full path selected in the webtabset control.
Coalesys\WebTabSet\WebTabSet::setLoadingBackColor | ( | $value | ) |
Sets the color of the background when retrieving the children items.
Coalesys\WebTabSet\WebTabSet::setLoadingForeColor | ( | $value | ) |
Sets the color of the text when retrieving the children items.
Coalesys\WebTabSet\WebTabSet::setLoadingImageUrl | ( | $value | ) |
Sets the image to display when retrieving the children items.
Coalesys\WebTabSet\WebTabSet::setLoadingText | ( | $value | ) |
Sets the text to display when retrieving the children items.
Coalesys\WebTabSet\WebTabSet::setOverlapSize | ( | $value | ) |
Sets the number of pixels that the selected item overlaps the content pane.
Coalesys\WebTabSet\WebTabSet::setSelectedBackColor | ( | $value | ) |
Sets the color of the background of the selected item.
Coalesys\WebTabSet\WebTabSet::setSelectedChildrenImageUrl | ( | $value | ) |
Sets the image used to indicate the selected item has children items.
Coalesys\WebTabSet\WebTabSet::setSelectedForeColor | ( | $value | ) |
Sets the color of the text within the selected item.
Coalesys\WebTabSet\WebTabSet::setSelectedItemImageUrl | ( | $value | ) |
Sets the image to display for the selected items.
Coalesys\WebTabSet\WebTabSet::setSelectInitialItem | ( | $value | ) |
Sets whether to select the first item when the control initially loads.
Coalesys\WebTabSet\WebTabSet::setUnselectedBackColor | ( | $value | ) |
Sets the color of the background of the unselected item.
Coalesys\WebTabSet\WebTabSet::setUnselectedChildrenImageUrl | ( | $value | ) |
Sets the image used to indicate the unselected item has children items.
Coalesys\WebTabSet\WebTabSet::setUnselectedForeColor | ( | $value | ) |
Sets the color of the text within the unselected item.
Coalesys\WebTabSet\WebTabSet::setUnselectedItemImageUrl | ( | $value | ) |
Sets the image to display for the unselected items.