WebTabSet for PHP
Client-Side Methods

Client-side JavaScript functions implemented by WebTabSet.

See also Client-Side Events.

JavaScript Functions

function cwtsAppendKeyValue (sourcePath, keyString, valueString)
 Appends a new key/value pair to the end of the path string. More...
 
function cwtsClearChildren (controlId, clearPath)
 Removes the children from an item in the WebTabSet control. More...
 
function cwtsExtractKeys (sourcePath)
 Extracts the key portion(s) of a path that contains key/value pair(s). More...
 
function cwtsExtractValues (sourcePath)
 Extracts the value portion(s) of a path that contains key/value pair(s). More...
 
function cwtsGetFullPath (controlId)
 Gets the current full path selected in the WebTabSet control. More...
 
function cwtsInitializeControl (controlId, controlSettings, controlData)
 Initializes a new WebTabSet instance with the specified control settings and data. More...
 
function cwtsProcessResponse (controlId, responseData)
 Processes the response from a request to retrieve information for an expanded item object. More...
 
function cwtsSetFocus (controlId)
 Sets the keyboard focus to the WebTabSet control. More...
 
function cwtsSetFullPath (controlId, fullPath)
 Sets the current full path selected in the WebTabSet control. More...
 
function cwtsUninitializeControl (controlId)
 Uninitializes the specified WebTabSet control instance. More...
 

Function Documentation

function cwtsAppendKeyValue ( 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 cwtsClearChildren ( controlId, clearPath )
inline

Removes the children from an item in the WebTabSet control.

Parameters
controlIdThe control identifier of the WebTabSet instance.
clearPathThe full path of the target item in the WebTabSet control.
Returns
None.
function cwtsExtractKeys ( 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 cwtsExtractValues ( 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 cwtsGetFullPath ( controlId )
inline

Gets the current full path selected in the WebTabSet control.

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

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

Parameters
controlIdThe control identifier of the WebTabSet 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 cwtsProcessResponse ( controlId, responseData )
inline

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

Parameters
controlIdThe control identifier of the WebTabSet 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 cwtsSetFocus ( controlId )
inline

Sets the keyboard focus to the WebTabSet control.

Parameters
controlIdThe control identifier of the WebTabSet instance.
Returns
None.
function cwtsSetFullPath ( controlId, fullPath )
inline

Sets the current full path selected in the WebTabSet control.

Parameters
controlIdThe control identifier of the WebTabSet instance.
fullPathThe current full path selected in the WebTabSet control.
Returns
None.
function cwtsUninitializeControl ( controlId )
inline

Uninitializes the specified WebTabSet control instance.

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

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