Observable Node
Package: | Ext.data |
Defined In: | Tree.js |
Class: | Node |
Subclasses: | TreeNode |
Extends: | Observable |
Config Options | Defined By | |
---|---|---|
id : String The id for this node. If one is not specified, one is generated. | Node | |
leaf : Boolean true if this node is a leaf and does not have children | Node | |
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 |
Property | Defined By | |
---|---|---|
attributes : Object The attributes supplied for the node. You can use this property to access any custom attributes you supplied. | Node | |
childNodes : Array All child nodes of this node. | Node | |
firstChild : Node The first direct child node of this node, or null if this node has no child nodes. | Node | |
id : String The node id. | Node | |
lastChild : Node The last direct child node of this node, or null if this node has no child nodes. | Node | |
nextSibling : Node The node immediately following this node in the tree, or null if there is no sibling node. | Node | |
parentNode : Node The parent node for this node. | Node | |
previousSibling : Node The node immediately preceding this node in the tree, or null if there is no sibling node. | Node |
Method | Defined By | |
---|---|---|
Node( Object attributes )
Parameters:
| Node | |
addEvents( Object object )
:
voidUsed to define events on this Observable Used to define events on this Observable Parameters:
| Observable | |
addListener( String eventName , Function handler , [Object scope ], [Object options ] )
:
voidAppends an event handler to this object. Appends an event handler to this object. Parameters:
| Observable | |
appendChild( Node/Array node )
:
NodeInsert node(s) as the last child node of this node. Insert node(s) as the last child node of this node. Parameters:
| Node | |
bubble( Function fn , [Object scope ], [Array args ] )
:
voidBubbles up the tree from this node, calling the specified function with each node. The scope (this) of
function call... Bubbles up the tree from this node, calling the specified function with each node. The scope (this) of
function call will be the scope provided or the current node. The arguments to the function
will be the args provided or the current node. If the function returns false at any point,
the bubble is stopped. Parameters:
| Node | |
cascade( Function fn , [Object scope ], [Array args ] )
:
voidCascades down the tree from this node, calling the specified function with each node. The scope (this) of
function c... Cascades down the tree from this node, calling the specified function with each node. The scope (this) of
function call will be the scope provided or the current node. The arguments to the function
will be the args provided or the current node. If the function returns false at any point,
the cascade is stopped on that branch. Parameters:
| Node | |
contains( Node node )
:
BooleanReturns true if this node is an ancestor (at any point) of the passed node. Returns true if this node is an ancestor (at any point) of the passed node. Parameters:
| Node | |
eachChild( Function fn , [Object scope ], [Array args ] )
:
voidInterates the child nodes of this node, calling the specified function with each node. The scope (this) of
function ... Interates the child nodes of this node, calling the specified function with each node. The scope (this) of
function call will be the scope provided or the current node. The arguments to the function
will be the args provided or the current node. If the function returns false at any point,
the iteration stops. Parameters:
| Node | |
enableBubble( Object events )
:
voidUsed to enable bubbling of events Used to enable bubbling of events Parameters:
| Observable | |
findChild( String attribute , Mixed value )
:
NodeFinds the first child that has the attribute with the specified value. Finds the first child that has the attribute with the specified value. Parameters:
| Node | |
findChildBy( Function fn , [Object scope ] )
:
NodeFinds the first child by a custom function. The child matches if the function passed
returns true. Finds the first child by a custom function. The child matches if the function passed
returns true. Parameters:
| Node | |
fireEvent( String eventName , Object... args )
:
BooleanFires 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 | |
getDepth()
:
Number Returns depth of this node (the root node has a depth of 0) Returns depth of this node (the root node has a depth of 0) Parameters:
| Node | |
getOwnerTree()
:
Tree Returns the tree this node is in. Returns the tree this node is in. Parameters:
| Node | |
getPath( [String attr ] )
:
StringReturns the path for this node. The path can be used to expand or select this node programmatically. Returns the path for this node. The path can be used to expand or select this node programmatically. Parameters:
| Node | |
hasChildNodes()
:
Boolean Returns true if this node has one or more child nodes, else false. Returns true if this node has one or more child nodes, else false. Parameters:
| Node | |
hasListener( String eventName )
:
BooleanChecks 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 | |
indexOf( Node node )
:
NumberReturns the index of a child node Returns the index of a child node Parameters:
| Node | |
insertBefore( Node node , Node refNode )
:
NodeInserts the first node before the second node in this nodes childNodes collection. Inserts the first node before the second node in this nodes childNodes collection. Parameters:
| Node | |
isAncestor( Node node )
:
BooleanReturns true if the passed node is an ancestor (at any point) of this node. Returns true if the passed node is an ancestor (at any point) of this node. Parameters:
| Node | |
isExpandable()
:
Boolean Returns true if this node has one or more child nodes, or if the expandable
node attribute is explicitly specified a... Returns true if this node has one or more child nodes, or if the expandable
node attribute is explicitly specified as true (see attributes), otherwise returns false. Parameters:
| Node | |
isFirst()
:
Boolean Returns true if this node is the first child of its parent Returns true if this node is the first child of its parent Parameters:
| Node | |
isLast()
:
Boolean Returns true if this node is the last child of its parent Returns true if this node is the last child of its parent Parameters:
| Node | |
isLeaf()
:
Boolean Returns true if this node is a leaf Returns true if this node is a leaf Parameters:
| Node | |
item( Number index )
:
NodeReturns the child node at the specified index. Returns the child node at the specified index. Parameters:
| Node | |
on( String eventName , Function handler , [Object scope ], [Object options ] )
:
voidAppends 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 )
:
voidRelays 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 | |
remove()
:
Node Removes this node from its parent Removes this node from its parent Parameters:
| Node | |
removeChild( Node node )
:
NodeRemoves a child node from this node. Removes a child node from this node. Parameters:
| Node | |
removeListener( String eventName , Function handler , [Object scope ] )
:
voidRemoves an event handler. Removes an event handler. Parameters:
| Observable | |
replaceChild( Node newChild , Node oldChild )
:
NodeReplaces one child node in this node with another. Replaces one child node in this node with another. Parameters:
| Node | |
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 | |
setId( String id )
:
voidChanges the id of this node. Changes the id of this node. Parameters:
| Node | |
sort( Function fn , [Object scope ] )
:
voidSorts this nodes children using the supplied sort function Sorts this nodes children using the supplied sort function Parameters:
| Node | |
suspendEvents( Boolean queueSuspended )
:
voidSuspend the firing of all events. (see resumeEvents) Suspend the firing of all events. (see resumeEvents) Parameters:
| Observable | |
un( String eventName , Function handler , [Object scope ] )
:
voidRemoves an event handler (shorthand for removeListener.) Removes an event handler (shorthand for removeListener.) Parameters:
| Observable |
Event | Defined By | |
---|---|---|
append :
( Tree tree , Node this , Node node , Number index )
Fires when a new child node is appended Fires when a new child node is appended Listeners will be called with the following arguments:
| Node | |
beforeappend :
( Tree tree , Node this , Node node )
Fires before a new child is appended, return false to cancel the append. Fires before a new child is appended, return false to cancel the append. Listeners will be called with the following arguments:
| Node | |
beforeinsert :
( Tree tree , Node this , Node node , Node refNode )
Fires before a new child is inserted, return false to cancel the insert. Fires before a new child is inserted, return false to cancel the insert. Listeners will be called with the following arguments:
| Node | |
beforemove :
( Tree tree , Node this , Node oldParent , Node newParent , Number index )
Fires before this node is moved to a new location in the tree. Return false to cancel the move. Fires before this node is moved to a new location in the tree. Return false to cancel the move. Listeners will be called with the following arguments:
| Node | |
beforeremove :
( Tree tree , Node this , Node node )
Fires before a child is removed, return false to cancel the remove. Fires before a child is removed, return false to cancel the remove. Listeners will be called with the following arguments:
| Node | |
insert :
( Tree tree , Node this , Node node , Node refNode )
Fires when a new child node is inserted. Fires when a new child node is inserted. Listeners will be called with the following arguments:
| Node | |
move :
( Tree tree , Node this , Node oldParent , Node newParent , Number index )
Fires when this node is moved to a new location in the tree Fires when this node is moved to a new location in the tree Listeners will be called with the following arguments:
| Node | |
remove :
( Tree tree , Node this , Node node )
Fires when a child node is removed Fires when a child node is removed Listeners will be called with the following arguments:
| Node |