jsx3.gui.TreeAPI
| Adopt | Fires before a record from this tree is adopted by another object. |
| Before Drop | Fires continuously as the user drags the mouse over a record in this tree during a drag-and-drop operation. |
| Cancel Drop | Fires after the user drags the mouse off this tree during a drag-and-drop operation. |
| Change | Fires when the user changes the selection of this tree. |
| Ctrl Drop | Fires after the user drops a record on this tree while pressing the Ctrl key. |
| Data | Fires after the user expands a node with attribute @jsxlazy equal to '1'. |
| Destroy | Fires after this tree is removed from the DOM. |
| Drag | Fires when the user drags a record(s) of this tree. |
| Drop | Fires after the user drops a record on this tree. |
| Execute | Fires after the user double-clicks a record in this tree or presses the Enter key with focus in a record of this tree. |
| Menu | Fires after the user right-clicks this tree and before the bound context menu displays. |
| Select | Deprecated. Use the Change event instead. |
| Spyglass | Fires after the user hovers the mouse over this tree and before the spyglass displays. |
| Toggle | Fires when the user expands or collapses a record with nested records in this tree. |
Fires after the user double-clicks a record in this tree or presses the Enter key with focus in a record of this tree.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
strRECORDID {
String} - the CDF jsxid of the selected record.
strRECORDIDS {
Array<String>} - the list of CDF jsxids of the selected records.
objRECORD {
jsx3.xml.Entity} -
Deprecated. Use strRECORDID instead. the object handle to the CDF record.
Deprecated. Use the Change event instead.
Fires after one or more records has changed from unselected to selected.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
strRECORDID {
String} - the CDF jsxid of the selected object.
strRECORDIDS {
Array<String>} - the list of CDF jsxids of the selected records.
Fires when the user changes the selection of this tree.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
Fires when the user expands or collapses a record with nested records in this tree.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
strRECORDID {
String} - the CDF jsxid of the toggled node.
bOPEN {
boolean} - the new open value for object.
Fires when the user drags a record(s) of this tree. Canceling this event prevents the drag from occurring.
Cancelable: Evaluate to false to cancel event.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
strDRAGTYPE {
String} - the type of drag (JSXDragType).
strDRAGID {
String} - the CDF jsxid of the record to be dragged.
strDRAGIDS {
Array<String>} - an array containing the CDF jsxids of the dragged records.
Fires continuously as the user drags the mouse over a record in this tree during a drag-and-drop operation. Canceling this event prevents the drop indicator from displaying.
Cancelable: Evaluate to false to cancel event.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
strDRAGTYPE {
String} - the type of drag (JSXDragType).
strDRAGID {
String} - the CDF jsxid of the dragged record.
strDRAGIDS {
Array<String>} - an array containing the CDF jsxids of the dragged records.
strRECORDID {
String} - the CDF jsxid corresponding to the node hovered over in the view.
Fires after the user drags the mouse off this tree during a drag-and-drop operation.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
strDRAGTYPE {
String} - the type of drag (JSXDragType).
strDRAGID {
String} - the CDF jsxid of the dragged record.
strDRAGIDS {
Array<String>} - an array containing the CDF jsxids of the dragged records.
strRECORDID {
String} - the CDF jsxid corresponding to the node hovered over in the view.
Fires after the user drops a record on this tree. Canceling this event prevents the CDF adoption from occurring.
Cancelable: Evaluate to false to cancel event.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
strDRAGTYPE {
String} - the type of drag (JSXDragType).
strDRAGID {
String} - the CDF jsxid of the dragged record.
strDRAGIDS {
Array<String>} - an array containing the CDF jsxids of the dragged records.
strRECORDID {
String} - the CDF jsxid corresponding to the node hovered over in the view.
bINSERTBEFORE {
boolean} - whether the dropped record should be inserted before
strRECORDID. Otherwise, it is appended as a child of
strRECORDID.
bALLOWADOPT {
boolean} - whether the source of the dragged CDF record allows the adoption.
Fires after the user drops a record on this tree while pressing the Ctrl key. Canceling this event prevents the CDF adoption from occurring.
Cancelable: Evaluate to false to cancel event.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
strDRAGTYPE {
String} - the type of drag (JSXDragType).
strDRAGID {
String} - the CDF jsxid of the dragged record.
strDRAGIDS {
Array<String>} - an array containing the CDF jsxids of the dragged records.
strRECORDID {
String} - the CDF jsxid corresponding to the node hovered over in the view.
bINSERTBEFORE {
boolean} - whether the dropped record should be inserted before
strRECORDID. Otherwise, it is appended as a child of
strRECORDID.
bALLOWADOPT {
boolean} - whether the source of the dragged CDF record allows the adoption.
Fires before a record from this tree is adopted by another object. Canceling this event prevents the CDF adoption from occurring.
Cancelable: Evaluate to false to cancel event.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
strRECORDID {
String} - the CDF jsxid of the record to adopt.
strRECORDIDS {
Array<String>} - an array containing the jsxids of the records to adopt.
objTARGET {
jsx3.gui.Tree} - the object that will adopt the record(s).
bCONTROL {
boolean} -
true if Ctrl Drop,
false otherwise.
Fires after the user hovers the mouse over this tree and before the spyglass displays. The event script must evaluate to the HTML content to display in the spyglass. Canceling this event prevents the spyglass from displaying.
Cancelable: Evaluate to false to cancel event.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
strRECORDID {
String} - the CDF jsxid of the spied record.
Fires after the user right-clicks this tree and before the bound context menu displays. Canceling this event prevents the menu from displaying.
Cancelable: Evaluate to false to cancel event.
Context Variables
objEVENT {
jsx3.gui.Event} - the browser event that triggers this event.
strRECORDID {
String} - the CDF jsxid of the selected record.
Return Fields
objMENU {
jsx3.gui.Menu} - use this field to override the default menu with an instance of
jsx3.gui.Menu.
Fires after the user expands a node with attribute @jsxlazy equal to '1'.
Return Fields
bCLEAR {
boolean} - if
true, the jsxlazy attribute of objNODE is cleared.
arrNODES {
Array<jsx3.xml.Entity>} - if not
null, all child nodes of objNODE are removed and replaced with the contents of this array.
Fires after this tree is removed from the DOM.
Context Variables
objPARENT {
jsx3.app.Model} - the parent of this tree before it is removed from the DOM.
Copyright © 2001-2007, TIBCO Software Inc.