Observable Tree
Package: | Ext.data |
Defined In: | Tree.js |
Class: | Tree |
Extends: | Observable |
Config Options | Defined By | |
---|---|---|
listeners : Object A config object containing one or more event handlers to be added to this
object during initialization. This should ... A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the addListener example for attaching multiple handlers at once. DOM events from ExtJs Components While some ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
is usually only done when extra value can be added. For example the DataView's
| Observable | |
pathSeparator : String The token used to separate paths in node ids (defaults to '/'). | Tree |
Property | Defined By | |
---|---|---|
root : Node The root node for this tree | Tree |
Method | Defined By | |
---|---|---|
Tree( [Node root] ) Parameters:
| Tree | |
addEvents( Object|String o, string Optional. ) : void Adds the specified events to the list of events which this Observable may fire. Adds the specified events to the list of events which this Observable may fire. Parameters:
| Observable | |
addListener( String eventName, Function handler, [Object scope], [Object options] ) : void Appends an event handler to this object. Appends an event handler to this object. Parameters:
| Observable | |
enableBubble( String/Array events ) : void Enables events fired by this Observable to bubble up an owner hierarchy by calling
this.getBubbleTarget() if present.... Enables events fired by this Observable to bubble up an owner hierarchy by calling
This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to access the required target more quickly. Example:
Parameters:
| Observable | |
fireEvent( String eventName, Object... args ) : Boolean Fires the specified event with the passed parameters (minus the event name).
An event may be set to bubble up an Obse... Fires the specified event with the passed parameters (minus the event name). An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by calling enableBubble. Parameters:
| Observable | |
getNodeById( String id ) : Node Gets a node in this tree by its id. Gets a node in this tree by its id. Parameters:
| Tree | |
getRootNode() : Node Returns the root node for this tree. Returns the root node for this tree. Parameters:
| Tree | |
hasListener( String eventName ) : Boolean Checks to see if this object has any listeners for a specified event Checks to see if this object has any listeners for a specified event Parameters:
| Observable | |
on( String eventName, Function handler, [Object scope], [Object options] ) : void Appends an event handler to this object (shorthand for addListener.) Appends an event handler to this object (shorthand for addListener.) Parameters:
| Observable | |
purgeListeners() : void Removes all listeners for this object Removes all listeners for this object Parameters:
| Observable | |
relayEvents( Object o, Array events ) : void Relays selected events from the specified Observable as if the events were fired by this. Relays selected events from the specified Observable as if the events were fired by this. Parameters:
| Observable | |
removeListener( String eventName, Function handler, [Object scope] ) : void Removes an event handler. Removes an event handler. Parameters:
| Observable | |
resumeEvents() : void Resume firing events. (see suspendEvents)
If events were suspended using the queueSuspended parameter, then all
event... Resume firing events. (see suspendEvents)
If events were suspended using the queueSuspended parameter, then all
events fired during event suspension will be sent to any listeners now. Parameters:
| Observable | |
setRootNode( Node node ) : Node Sets the root node for this tree. Sets the root node for this tree. Parameters:
| Tree | |
suspendEvents( Boolean queueSuspended ) : void Suspend the firing of all events. (see resumeEvents) Suspend the firing of all events. (see resumeEvents) Parameters:
| Observable | |
un( String eventName, Function handler, [Object scope] ) : void Removes an event handler (shorthand for removeListener.) Removes an event handler (shorthand for removeListener.) Parameters:
| Observable |
Event | Defined By | |
---|---|---|
append : ( Tree tree, Node parent, Node node, Number index ) Fires when a new child node is appended to a node in this tree. Fires when a new child node is appended to a node in this tree. Listeners will be called with the following arguments:
| Tree | |
beforeappend : ( Tree tree, Node parent, Node node ) Fires before a new child is appended to a node in this tree, return false to cancel the append. Fires before a new child is appended to a node in this tree, return false to cancel the append. Listeners will be called with the following arguments:
| Tree | |
beforeinsert : ( Tree tree, Node parent, Node node, Node refNode ) Fires before a new child is inserted in a node in this tree, return false to cancel the insert. Fires before a new child is inserted in a node in this tree, return false to cancel the insert. Listeners will be called with the following arguments:
| Tree | |
beforemove : ( Tree tree, Node node, Node oldParent, Node newParent, Number index ) Fires before a node is moved to a new location in the tree. Return false to cancel the move. Fires before a node is moved to a new location in the tree. Return false to cancel the move. Listeners will be called with the following arguments:
| Tree | |
beforeremove : ( Tree tree, Node parent, Node node ) Fires before a child is removed from a node in this tree, return false to cancel the remove. Fires before a child is removed from a node in this tree, return false to cancel the remove. Listeners will be called with the following arguments:
| Tree | |
insert : ( Tree tree, Node parent, Node node, Node refNode ) Fires when a new child node is inserted in a node in this tree. Fires when a new child node is inserted in a node in this tree. Listeners will be called with the following arguments:
| Tree | |
move : ( Tree tree, Node node, Node oldParent, Node newParent, Number index ) Fires when a node is moved to a new location in the tree Fires when a node is moved to a new location in the tree Listeners will be called with the following arguments:
| Tree | |
remove : ( Tree tree, Node parent, Node node ) Fires when a child node is removed from a node in this tree. Fires when a child node is removed from a node in this tree. Listeners will be called with the following arguments:
| Tree |