WebObjectTree for JSP
Client-Side Methods

Client-side JavaScript functions implemented by WebObjectTree.

See also Client-Side Events.

JavaScript Functions

function cwotAppendKeyValue (sourcePath, keyString, valueString)
 Appends a new key/value pair to the end of the path string. More...
 
function cwotClearChildren (controlId, clearPath)
 Removes the children from an item in the WebObjectTree control. More...
 
function cwotExpandItem (controlId, expandPath, expandState)
 Sets the expanded state of an item in the WebObjectTree control. More...
 
function cwotExtractKeys (sourcePath)
 Extracts the key portion(s) of a path that contains key/value pair(s). More...
 
function cwotExtractValues (sourcePath)
 Extracts the value portion(s) of a path that contains key/value pair(s). More...
 
function cwotGetCustomData (controlId)
 Gets the custom tree data that is persisted during postbacks. More...
 
function cwotGetFullPath (controlId)
 Gets the current full path selected in the WebObjectTree control. More...
 
function cwotInitializeControl (controlId, controlSettings, controlData)
 Initializes a new WebObjectTree instance with the specified control settings and data. More...
 
function cwotProcessResponse (controlId, responseData)
 Processes the response from a request to retrieve information for an expanded item object. More...
 
function cwotRenameItem (controlId, renamePath, newValue)
 Renames an item in the WebObjectTree control. More...
 
function cwotSetCustomData (controlId, customData)
 Sets the custom tree data that is persisted during postbacks. More...
 
function cwotSetFocus (controlId, beginEdit)
 Sets the keyboard focus to the WebObjectTree control. More...
 
function cwotSetFullPath (controlId, fullPath)
 Sets the current full path selected in the WebObjectTree control. More...
 
function cwotSetHeight (controlId, height)
 Sets the height of the WebObjectTree control. More...
 
function cwotSetWidth (controlId, width)
 Sets the width of the WebObjectTree control. More...
 
function cwotUninitializeControl (controlId)
 Uninitializes the specified WebObjectTree control instance. More...
 

Function Documentation

function cwotAppendKeyValue ( sourcePath, keyString, valueString )
inline

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.
function cwotClearChildren ( controlId, clearPath )
inline

Removes the children from an item in the WebObjectTree control.

Parameters
controlIdThe control identifier of the WebObjectTree instance.
clearPathThe full path of the target item in the WebObjectTree control.
Returns
None.
function cwotExpandItem ( controlId, expandPath, expandState )
inline

Sets the expanded state of an item in the WebObjectTree control.

Parameters
controlIdThe control identifier of the WebObjectTree instance.
expandPathThe full path of the target item in the WebObjectTree control.
expandStateA boolean value that indicates the expanded (true) or collapsed (false) state.
Returns
None.
function cwotExtractKeys ( sourcePath )
inline

Extracts the key portion(s) of a path 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.
function cwotExtractValues ( sourcePath )
inline

Extracts the value portion(s) of a path 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.
function cwotGetCustomData ( controlId )
inline

Gets the custom tree data that is persisted during postbacks.

Parameters
controlIdThe control identifier of the WebObjectTree instance.
Returns
The custom data that can be used to dynamically populate the children items.
function cwotGetFullPath ( controlId )
inline

Gets the current full path selected in the WebObjectTree control.

Parameters
controlIdThe control identifier of the WebObjectTree instance.
Returns
The current full path selected in the WebObjectTree control.
function cwotInitializeControl ( controlId, controlSettings, controlData )
inline

Initializes a new WebObjectTree instance with the specified control settings and data.

Parameters
controlIdThe control identifier of the WebObjectTree instance.
controlSettingsThe control settings as a JSON string or JavaScript object.
controlDataThe control data as a JSON string or JavaScript object, or null to load on demand.
Returns
None.
function cwotProcessResponse ( controlId, responseData )
inline

Processes the response from a request to retrieve information for an expanded item object.

Parameters
controlIdThe control identifier of the WebObjectTree instance.
responseDataThe children item information as a JSON string or JavaScript object, or null to indicate the information could not be retrieved.
Returns
None.
function cwotRenameItem ( controlId, renamePath, newValue )
inline

Renames an item in the WebObjectTree control.

Parameters
controlIdThe control identifier of the WebObjectTree instance.
renamePathThe full path of the target item in the WebObjectTree control.
newValueThe new text string value for the item object.
Returns
None.
function cwotSetCustomData ( controlId, customData )
inline

Sets the custom tree data that is persisted during postbacks.

Parameters
controlIdThe control identifier of the WebObjectTree instance.
customDataThe custom data that can be used to dynamically populate the children items.
Returns
None.
function cwotSetFocus ( controlId, beginEdit )
inline

Sets the keyboard focus to the WebObjectTree control.

Parameters
controlIdThe control identifier of the WebObjectTree instance.
beginEditA boolean value whether to begin an item edit operation.
Returns
None.
function cwotSetFullPath ( controlId, fullPath )
inline

Sets the current full path selected in the WebObjectTree control.

Parameters
controlIdThe control identifier of the WebObjectTree instance.
fullPathThe current full path selected in the WebObjectTree control.
Returns
None.
function cwotSetHeight ( controlId, height )
inline

Sets the height of the WebObjectTree control.

Parameters
controlIdThe control identifier of the WebObjectTree instance.
heightThe height of the control in pixels (without the "px" suffix).
Returns
None.
function cwotSetWidth ( controlId, width )
inline

Sets the width of the WebObjectTree control.

Parameters
controlIdThe control identifier of the WebObjectTree instance.
widthThe width of the control in pixels (without the "px" suffix).
Returns
None.
function cwotUninitializeControl ( controlId )
inline

Uninitializes the specified WebObjectTree control instance.

Parameters
controlIdThe control identifier of the WebObjectTree instance.
Returns
None.

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