WebObjectTree for PHP
Client-Side Events

Client-side JavaScript functions called by WebObjectTree.

See also Client-Side Methods.

JavaScript Functions

function cwotOnAllowRename (controlId, renamePath)
 Occurs when the user attempts to rename an item object. More...
 
function cwotOnApplyStyle (controlId, classNames, itemHint)
 Occurs when applying Cascading Style Sheets (CSS) class names to an element within the control. More...
 
function cwotOnBeginRequest (controlId, requestPath)
 Occurs when the WebObjectTree control requires information for an expanded item object. More...
 
function cwotOnDataRetrievalBegin (controlId)
 Occurs when the WebObjectTree control starts retrieving children item information. More...
 
function cwotOnDataRetrievalEnd (controlId)
 Occurs when the WebObjectTree control stops retrieving children item information. More...
 
function cwotOnDataRetrievalError (controlId, statusCode, statusText)
 Occurs when the WebObjectTree control encounters an error retrieving children item information. More...
 
function cwotOnKeyDown (controlId, eventObject)
 Occurs when the WebObjectTree control has keyboard focus and the user presses a key down. More...
 
function cwotOnRenameComplete (controlId)
 Occurs when the actual item renaming process completes. More...
 
function cwotOnRenameItem (controlId, renamePath, newValue)
 Occurs when the user completes the renaming of an item object. More...
 
function cwotOnSelectionChange (controlId, selectedValue)
 Occurs when the user changes the current item selected. More...
 

Function Documentation

function cwotOnAllowRename ( controlId, renamePath )
inline

Occurs when the user attempts to rename an item object.

Parameters
controlIdThe control identifier of the WebObjectTree instance.
renamePathThe full path of the target item in the WebObjectTree control.
Returns
A boolean value that indicates if the rename should be allowed (true) or disallowed (false).
function cwotOnApplyStyle ( controlId, classNames, itemHint )
inline

Occurs when applying Cascading Style Sheets (CSS) class names to an element within the control.

Parameters
controlIdThe control identifier of the WebObjectTree instance.
classNamesThe current array of CSS class names being applied to the element.
itemHintThe user-defined style hint for this item, or null if not applicable or available.
Returns
None.
function cwotOnBeginRequest ( controlId, requestPath )
inline

Occurs when the WebObjectTree control requires information for an expanded item object.

Parameters
controlIdThe control identifier of the WebObjectTree instance.
requestPathThe path to the data required for the expanded item object.
Returns
The children item information as a JSON string or JavaScript object, or null to asynchronously return the data through the cwotProcessResponse method.
function cwotOnDataRetrievalBegin ( controlId )
inline

Occurs when the WebObjectTree control starts retrieving children item information.

Parameters
controlIdThe control identifier of the WebObjectTree instance.
Returns
None.
function cwotOnDataRetrievalEnd ( controlId )
inline

Occurs when the WebObjectTree control stops retrieving children item information.

Parameters
controlIdThe control identifier of the WebObjectTree instance.
Returns
None.
function cwotOnDataRetrievalError ( controlId, statusCode, statusText )
inline

Occurs when the WebObjectTree control encounters an error retrieving children item information.

Parameters
controlIdThe control identifier of the WebObjectTree instance.
statusCodeThe status code returned when retrieving children item information.
statusTextThe status description returned when retrieving children item information.
Returns
None.
function cwotOnKeyDown ( controlId, eventObject )
inline

Occurs when the WebObjectTree control has keyboard focus and the user presses a key down.

Parameters
controlIdThe control identifier of the WebObjectTree instance.
eventObjectThe event object associated with the keyboard event.
Returns
A boolean value that indicates if the keyboard processing should continue (true) or be halted (false).
function cwotOnRenameComplete ( controlId )
inline

Occurs when the actual item renaming process completes.

Parameters
controlIdThe control identifier of the WebObjectTree instance.
Returns
None.
function cwotOnRenameItem ( controlId, renamePath, newValue )
inline

Occurs when the user completes the renaming of an item object.

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
A boolean value that indicates if the rename was successful (true) or unsuccessful (false).
function cwotOnSelectionChange ( controlId, selectedValue )
inline

Occurs when the user changes the current item selected.

Parameters
controlIdThe control identifier of the WebObjectTree instance.
selectedValueThe current value for the item being selected.
Returns
None.

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