Version

TreeClientEvents Class Members

The following tables list the members exposed by TreeClientEvents.

Public Fields
 NameDescription
Public FieldDataBindingEvent fired prior to databinding. Function takes arguments evt and ui. Use ui.owner to get a reference to the tree performing databinding.  
Public FieldDataBoundEvent fired after databinding is complete but rendering has not yet started. Function takes arguments evt and ui. Use ui.owner to get a reference to the tree performing databinding. Use ui.dataView to get a reference to the data the tree has been databound to.  
Public FieldDragFired on node drag Use ui.owner to get a reference to the tree. Use ui.binding to gets a reference to the binding. Use ui.data to get a reference to the data. Use ui.element to get a reference to the element. Use ui.helper to get a reference to the helper. Use ui.offset to get a reference to the offset. Use ui.orginalPosition to get a reference to the original position of the draggable element (the node). Use ui.path to get a reference to the node path. Use ui.position to get a reference to the current position of the draggable element.  
Public FieldDragStartFired on node drag start Use ui.owner to get a reference to the tree. Use ui.binding to gets a reference to the binding. Use ui.data to get a reference to the data. Use ui.element to get a reference to the element. Use ui.helper to get a reference to the helper. Use ui.offset to get a reference to the offset. Use ui.orginalPosition to get a reference to the original position of the draggable element (the node). Use ui.path to get a reference to the node path. Use ui.position to get a reference to the current position of the draggable element.  
Public FieldDragStopFired after a drag operation has completed Use ui.owner to get a reference to the tree. Use ui.helper to get a reference to the helper. Use ui.offset to get a reference to the offset. Use ui.orginalPosition to get a reference to the original position of the draggable element (the node). Use ui.position to get a reference to the current position of the draggable element.  
Public FieldNodeCheckstateChangedFired after the checkbox state of a node has changed Use ui.owner to get a reference to the tree. Use ui.node to get a reference to the node object the checkbox of which is being interacted with. Use ui.newState to get the new current state of the checkbox. Use ui.newCheckedNodes to get the collection of all checked nodes. Use ui.newPartiallyCheckedNodes to get the collection of all partially checked nodes.  
Public FieldNodeCheckstateChangingFired prior to changing the checkbox state of a node Function takes arguments evt and ui. Use ui.owner to get a reference to the tree. Use ui.node to get a reference to the node object the checkbox of which is being interacted with. Use ui.currentState to get the current state of the checkbox. Use ui.newState to get the new future state of the checkbox. Use ui.currentCheckedNodes to get the collection of all checked nodes before the new state is applied.  
Public FieldNodeClickFired on node click. Use ui.owner to get a reference to the tree. Use ui.node to get a reference to the node object being clicked.  
Public FieldNodeCollapsedFired after a node is collapsed Use ui.owner to get a reference to the tree. Use ui.node to get a reference to the collapsed node object.  
Public FieldNodeCollapsingFired prior to a node being collapsed Use ui.owner to get a reference to the tree. Use ui.node to get a reference to the node object about to collapse.  
Public FieldNodeDoubleClickFired on node double click Use ui.path to get a reference to the path of the double clicked node. Use ui.element to get a reference to the jQuery element of the double clicked node. Use ui.data to get the node data. Use ui.binding to get a reference to the bindings object for the level at which the double clicked node is located.  
Public FieldNodeDroppedFired after a node drop Use ui.owner to get a reference to the tree. Use ui.binding to gets a reference to the binding. Use ui.data to get a reference to the data. Use ui.draggable to get a reference to the draggable element (the node). Use ui.element to get a reference to the element. Use ui.helper to get a reference to the helper. Use ui.offset to get a reference to the offset. Use ui.path to get a reference to the node path. Use ui.position to get a reference to the current position of the draggable element. Use ui.sourceNode to get a reference to the dropped source node object.  
Public FieldNodeDroppingFired before a node drop Use ui.owner to get a reference to the tree. Use ui.binding to gets a reference to the binding. Use ui.data to get a reference to the data. Use ui.draggable to get a reference to the draggable element (the node). Use ui.element to get a reference to the element. Use ui.helper to get a reference to the helper. Use ui.offset to get a reference to the offset. Use ui.path to get a reference to the node path. Use ui.position to get a reference to the current position of the draggable element. Use ui.sourceNode to get a reference to the source node object about to be dropped.  
Public FieldNodeExpandedFired after a node is expanded Use ui.owner to get a reference to the tree. Use ui.node to get a reference to the expanded node object.  
Public FieldNodeExpandingFired prior to a node being expanded Use ui.owner to get a reference to the tree. Use ui.node to get a reference to the node object about to expand.  
Public FieldNodePopulatedFired after the children of a node are populated in the case of load on demand Use ui.path to get a reference to the path of the populated node. Use ui.element to get a reference to the jQuery element of the populated node. Use ui.data to get the node data. Use ui.binding to get a reference to the bindings object for the level at which the populated node is located.  
Public FieldNodePopulatingFired prior to the children of a node being populated in the case of load on demand Use ui.path to get a reference to the path of the node being populated. Use ui.element to get a reference to the jQuery element of the node being populated. Use ui.data to get the node data. Use ui.binding to get a reference to the bindings object for the level at which the populating node is located.  
Public FieldRenderedEvent fired after the widget has built and attach all the DOM it is rendering. Function takes arguments evt and ui. Use ui.owner to get a reference to the tree.  
Public FieldRenderingEvent fired prior to starting the rendering of the widget, item descriptions should be present at this point if they are not provided by the user but are generated internally. Function takes arguments evt and ui. Use ui.owner to get a reference to the tree performing rendering. Use ui.dataView to get a reference to the data the tree is going to render.  
Public FieldSelectionChangedEvent fired after changing the selected node in the tree has finished. Function takes arguments evt and ui. Use ui.owner to get a reference to the tree. Use ui.selectedNodes to get a reference to the selected nodes. Use ui.newNodes to get a reference to the newly added nodes to the selection.  
Public FieldSelectionChangingEvent fired prior to changing the selected node in the tree. Function takes arguments evt and ui. Use ui.owner to get a reference to the tree. Use ui.selectedNodes to get a reference to currently selected nodes. Use ui.newNodes to get a reference to the new nodes getting selected.  
See Also

View on GitHub