WebObjectTree for JSP
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

Item addItem ()
 Adds a new item to the items collection. More...
 
Item addItem (String text)
 Adds a new item to the items collection. More...
 
Item addItem (String text, String hint)
 Adds a new item to the items collection. More...
 
String getClosedIconImageUrl ()
 Gets the image to display for closed parent items. More...
 
String getCollapsedImageUrl ()
 Gets the image used when an item has been collapsed. More...
 
String getCustomData ()
 Gets the custom tree data that is persisted during postbacks. More...
 
String getExpandedImageUrl ()
 Gets the image used when an item has been expanded. More...
 
String getFullPath ()
 Gets the current full path selected in the webobjecttree control. More...
 
String getInnerIndentImageUrl ()
 Gets the image to display before a set of indented items. More...
 
String getItemIndentImageUrl ()
 Gets the image to display before an indented item. More...
 
ArrayList< ItemgetItems ()
 Gets the items collection. More...
 
String getLastIndentImageUrl ()
 Gets the image to display before the last indented item. More...
 
String getLeafIconImageUrl ()
 Gets the image to display for leaf children items. More...
 
String getLoadingImageUrl ()
 Gets the image to display when retrieving the children items. More...
 
String getLoadingText ()
 Gets the text to display when retrieving the children items. More...
 
String getOpenedIconImageUrl ()
 Gets the image to display for opened parent items. More...
 
String getSelectedBackColor ()
 Gets the color of the background of the selected item. More...
 
String getSelectedForeColor ()
 Gets the color of the text within the selected item. More...
 
boolean getSelectInitialItem ()
 Gets whether to select the first item when the control initially loads. More...
 
boolean getShowIndentImages ()
 Gets whether to show the item indent images. More...
 
boolean getShowItemExpanders ()
 Gets whether to show the item expander elements. More...
 
boolean getShowItemIcons ()
 Gets whether to show the item icon elements. More...
 
String getSpacerImageUrl ()
 Gets the spacer image used for items that have no children. More...
 
void setBorderWidth (String value)
 Sets the border width of the control. More...
 
void setClosedIconImageUrl (String value)
 Sets the image to display for closed parent items. More...
 
void setCollapsedImageUrl (String value)
 Sets the image used when an item has been collapsed. More...
 
void setCustomData (String value)
 Sets the custom tree data that is persisted during postbacks. More...
 
void setExpandedImageUrl (String value)
 Sets the image used when an item has been expanded. More...
 
void setFullPath (String value)
 Sets the current full path selected in the webobjecttree control. More...
 
void setInnerIndentImageUrl (String value)
 Sets the image to display before a set of indented items. More...
 
void setItemIndentImageUrl (String value)
 Sets the image to display before an indented item. More...
 
void setLastIndentImageUrl (String value)
 Sets the image to display before the last indented item. More...
 
void setLeafIconImageUrl (String value)
 Sets the image to display for leaf children items. More...
 
void setLoadingImageUrl (String value)
 Sets the image to display when retrieving the children items. More...
 
void setLoadingText (String value)
 Sets the text to display when retrieving the children items. More...
 
void setOpenedIconImageUrl (String value)
 Sets the image to display for opened parent items. More...
 
void setSelectedBackColor (String value)
 Sets the color of the background of the selected item. More...
 
void setSelectedForeColor (String value)
 Sets the color of the text within the selected item. More...
 
void setSelectInitialItem (boolean value)
 Sets whether to select the first item when the control initially loads. More...
 
void setShowIndentImages (boolean value)
 Sets whether to show the item indent images. More...
 
void setShowItemExpanders (boolean value)
 Sets whether to show the item expander elements. More...
 
void setShowItemIcons (boolean value)
 Sets whether to show the item icon elements. More...
 
void setSpacerImageUrl (String value)
 Sets the spacer image used for items that have no children. More...
 
 WebObjectTree ()
 WebObjectTree constructor. More...
 
 WebObjectTree (String id)
 WebObjectTree constructor. More...
 
 WebObjectTree (String id, Map< String, String[]> parameterMap)
 WebObjectTree constructor. More...
 
- Public Member Functions inherited from Coalesys.WebObjectTree.WebControl
String getAbout ()
 Returns about information for the control. More...
 
String getAccessKey ()
 Gets the access key that allows you to quickly navigate to the control. More...
 
String getBackColor ()
 Gets the background color of the control. More...
 
String getBorderColor ()
 Gets the border color of the control. More...
 
BorderStyle getBorderStyle ()
 Gets the border color of the control. More...
 
String getBorderWidth ()
 Gets the border width of the control. More...
 
String getControlData ()
 Gets the item data to display in the control. More...
 
String getCustomClassPrefix ()
 Gets the prefix string to use for custom css class names. More...
 
String getDataRetrievalUrl ()
 Gets the location to retrieve item data. More...
 
boolean getEnabled ()
 Gets a value indicating whether the control is enabled. More...
 
boolean getEnableOutline ()
 Gets whether to enable outline for keyboard focus. More...
 
FontInfo getFont ()
 Gets the font properties associated with the control. More...
 
String getForeColor ()
 Gets the text color for the control. More...
 
String getHeight ()
 Gets the height of the control. More...
 
String getID ()
 Gets the programmatic identifier assigned to the control. More...
 
String getName ()
 Gets the name of the control. More...
 
int getRetentionPeriod ()
 Gets the number of seconds before the item data is discarded (zero or less for infinite). More...
 
int getTabIndex ()
 Gets the tab order of the control. More...
 
String getToolTip ()
 Gets the tooltip displayed when the mouse is over the control. More...
 
String getUserData ()
 Gets the user data for the control. More...
 
String getWidth ()
 Gets the width of the control. More...
 
void loadState (String file) throws Exception
 Loads the control state from the specified file. More...
 
void loadState (InputStream stream) throws Exception
 Loads the control state from the specified stream. More...
 
String renderControl ()
 Renders the required code for this control instance. More...
 
void saveState (String file) throws Exception
 Saves the control state to the specified file. More...
 
void saveState (OutputStream stream) throws Exception
 Saves the control state to the specified stream. More...
 
void setAccessKey (String value)
 Sets the access key that allows you to quickly navigate to the control. More...
 
void setBackColor (String value)
 Sets the background color of the control. More...
 
void setBorderColor (String value)
 Sets the border color of the control. More...
 
void setBorderStyle (BorderStyle value)
 Sets the border color of the control. More...
 
void setBorderWidth (String value)
 Sets the border width of the control. More...
 
void setControlData (String value)
 Sets the item data to display in the control. More...
 
void setCustomClassPrefix (String value)
 Sets the prefix string to use for custom css class names. More...
 
void setDataRetrievalUrl (String value)
 Sets the location to retrieve item data. More...
 
void setEnabled (boolean value)
 Sets a value indicating whether the control is enabled. More...
 
void setEnableOutline (boolean value)
 Sets whether to enable outline for keyboard focus. More...
 
void setForeColor (String value)
 Sets the text color for the control. More...
 
void setHeight (String value)
 Sets the height of the control. More...
 
void setID (String value)
 Sets the programmatic identifier assigned to the control. More...
 
void setName (String value)
 Sets the name of the control. More...
 
void setRetentionPeriod (int value)
 Sets the number of seconds before the item data is discarded (zero or less for infinite). More...
 
void setTabIndex (int value)
 Sets the tab order of the control. More...
 
void setToolTip (String value)
 Sets the tooltip displayed when the mouse is over the control. More...
 
void setUserData (String value)
 Sets the user data for the control. More...
 
void setWidth (String value)
 Sets the width of the control. More...
 

Static Public Member Functions

static String appendKeyValue (String sourcePath, String keyString, String valueString)
 Appends a new key/value pair to the end of the path string. More...
 
static String extractKeys (String sourcePath)
 Extracts the key portion(s) of a string that contains key/value pair(s). More...
 
static String extractValues (String 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.WebObjectTree ( )
inline

WebObjectTree constructor.

Coalesys.WebObjectTree.WebObjectTree.WebObjectTree ( String  id)
inline

WebObjectTree constructor.

Parameters
idThe control identifier.
Coalesys.WebObjectTree.WebObjectTree.WebObjectTree ( String  id,
Map< String, String[]>  parameterMap 
)
inline

WebObjectTree constructor.

Parameters
idThe control identifier.
parameterMapThe request parameter map.

Member Function Documentation

Item Coalesys.WebObjectTree.WebObjectTree.addItem ( )
inline

Adds a new item to the items collection.

Returns
The item object.
Item Coalesys.WebObjectTree.WebObjectTree.addItem ( String  text)
inline

Adds a new item to the items collection.

Parameters
textThe text string displayed for the item.
Returns
The item object.
Item Coalesys.WebObjectTree.WebObjectTree.addItem ( String  text,
String  hint 
)
inline

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 String Coalesys.WebObjectTree.WebObjectTree.appendKeyValue ( String  sourcePath,
String  keyString,
String  valueString 
)
inlinestatic

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 String Coalesys.WebObjectTree.WebObjectTree.extractKeys ( String  sourcePath)
inlinestatic

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 String Coalesys.WebObjectTree.WebObjectTree.extractValues ( String  sourcePath)
inlinestatic

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.
String Coalesys.WebObjectTree.WebObjectTree.getClosedIconImageUrl ( )
inline

Gets the image to display for closed parent items.

String Coalesys.WebObjectTree.WebObjectTree.getCollapsedImageUrl ( )
inline

Gets the image used when an item has been collapsed.

String Coalesys.WebObjectTree.WebObjectTree.getCustomData ( )
inline

Gets the custom tree data that is persisted during postbacks.

String Coalesys.WebObjectTree.WebObjectTree.getExpandedImageUrl ( )
inline

Gets the image used when an item has been expanded.

String Coalesys.WebObjectTree.WebObjectTree.getFullPath ( )
inline

Gets the current full path selected in the webobjecttree control.

String Coalesys.WebObjectTree.WebObjectTree.getInnerIndentImageUrl ( )
inline

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

String Coalesys.WebObjectTree.WebObjectTree.getItemIndentImageUrl ( )
inline

Gets the image to display before an indented item.

ArrayList<Item> Coalesys.WebObjectTree.WebObjectTree.getItems ( )
inline

Gets the items collection.

String Coalesys.WebObjectTree.WebObjectTree.getLastIndentImageUrl ( )
inline

Gets the image to display before the last indented item.

String Coalesys.WebObjectTree.WebObjectTree.getLeafIconImageUrl ( )
inline

Gets the image to display for leaf children items.

String Coalesys.WebObjectTree.WebObjectTree.getLoadingImageUrl ( )
inline

Gets the image to display when retrieving the children items.

String Coalesys.WebObjectTree.WebObjectTree.getLoadingText ( )
inline

Gets the text to display when retrieving the children items.

String Coalesys.WebObjectTree.WebObjectTree.getOpenedIconImageUrl ( )
inline

Gets the image to display for opened parent items.

String Coalesys.WebObjectTree.WebObjectTree.getSelectedBackColor ( )
inline

Gets the color of the background of the selected item.

String Coalesys.WebObjectTree.WebObjectTree.getSelectedForeColor ( )
inline

Gets the color of the text within the selected item.

boolean Coalesys.WebObjectTree.WebObjectTree.getSelectInitialItem ( )
inline

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

boolean Coalesys.WebObjectTree.WebObjectTree.getShowIndentImages ( )
inline

Gets whether to show the item indent images.

boolean Coalesys.WebObjectTree.WebObjectTree.getShowItemExpanders ( )
inline

Gets whether to show the item expander elements.

boolean Coalesys.WebObjectTree.WebObjectTree.getShowItemIcons ( )
inline

Gets whether to show the item icon elements.

String Coalesys.WebObjectTree.WebObjectTree.getSpacerImageUrl ( )
inline

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

void Coalesys.WebObjectTree.WebObjectTree.setBorderWidth ( String  value)
inline

Sets the border width of the control.

void Coalesys.WebObjectTree.WebObjectTree.setClosedIconImageUrl ( String  value)
inline

Sets the image to display for closed parent items.

void Coalesys.WebObjectTree.WebObjectTree.setCollapsedImageUrl ( String  value)
inline

Sets the image used when an item has been collapsed.

void Coalesys.WebObjectTree.WebObjectTree.setCustomData ( String  value)
inline

Sets the custom tree data that is persisted during postbacks.

void Coalesys.WebObjectTree.WebObjectTree.setExpandedImageUrl ( String  value)
inline

Sets the image used when an item has been expanded.

void Coalesys.WebObjectTree.WebObjectTree.setFullPath ( String  value)
inline

Sets the current full path selected in the webobjecttree control.

void Coalesys.WebObjectTree.WebObjectTree.setInnerIndentImageUrl ( String  value)
inline

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

void Coalesys.WebObjectTree.WebObjectTree.setItemIndentImageUrl ( String  value)
inline

Sets the image to display before an indented item.

void Coalesys.WebObjectTree.WebObjectTree.setLastIndentImageUrl ( String  value)
inline

Sets the image to display before the last indented item.

void Coalesys.WebObjectTree.WebObjectTree.setLeafIconImageUrl ( String  value)
inline

Sets the image to display for leaf children items.

void Coalesys.WebObjectTree.WebObjectTree.setLoadingImageUrl ( String  value)
inline

Sets the image to display when retrieving the children items.

void Coalesys.WebObjectTree.WebObjectTree.setLoadingText ( String  value)
inline

Sets the text to display when retrieving the children items.

void Coalesys.WebObjectTree.WebObjectTree.setOpenedIconImageUrl ( String  value)
inline

Sets the image to display for opened parent items.

void Coalesys.WebObjectTree.WebObjectTree.setSelectedBackColor ( String  value)
inline

Sets the color of the background of the selected item.

void Coalesys.WebObjectTree.WebObjectTree.setSelectedForeColor ( String  value)
inline

Sets the color of the text within the selected item.

void Coalesys.WebObjectTree.WebObjectTree.setSelectInitialItem ( boolean  value)
inline

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

void Coalesys.WebObjectTree.WebObjectTree.setShowIndentImages ( boolean  value)
inline

Sets whether to show the item indent images.

void Coalesys.WebObjectTree.WebObjectTree.setShowItemExpanders ( boolean  value)
inline

Sets whether to show the item expander elements.

void Coalesys.WebObjectTree.WebObjectTree.setShowItemIcons ( boolean  value)
inline

Sets whether to show the item icon elements.

void Coalesys.WebObjectTree.WebObjectTree.setSpacerImageUrl ( String  value)
inline

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


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