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 (optional) A config object containing one or more event handlers to be added to this object during initialization. Th...
(optional) 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.
|
Observable |
Method | Defined By | |
---|---|---|
Node( Object attributes )
Parameters:
|
Node | |
addEvents( Object object ) : void Used to define events on this Observable
Used to define events on this Observable
Parameters:
|
Observable | |
addListener( String eventName , Function handler , [Object scope ], [Object options ] ) : void Appends an event handler to this component
Appends an event handler to this component
Parameters:
|
Observable | |
appendChild( Node/Array node ) : Node Insert 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 ] ) : void Bubbles 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 ] ) : void Cascades down the tree from this node, calling the specified function with each node. The scope (this) of
function ca...
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 ) : Boolean Returns 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 ] ) : void Iterates the child nodes of this node, calling the specified function with each node. The scope (this) of
function ca...
Iterates 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 | |
findChild( String attribute , Mixed value ) : Node Finds 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 ] ) : Node Finds 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 ) : Boolean Fires the specified event with the passed parameters (minus the event name).
Fires the specified event with the passed parameters (minus the event name).
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 ] ) : String Returns 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 ) : 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 | |
indexOf( Node node ) : Number Returns the index of a child node
Returns the index of a child node
Parameters:
|
Node | |
insertBefore( Node node , Node refNode ) : Node Inserts 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 ) : Boolean Returns 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 as...
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 ) : Node Returns 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 ] ) : void Appends an event handler to this element (shorthand for addListener)
Appends an event handler to this element (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 | |
remove() : Node Removes this node from it's parent
Removes this node from it's parent
Parameters:
|
Node | |
removeChild( Node node ) : Node Removes a child node from this node.
Removes a child node from this node.
Parameters:
|
Node | |
removeListener( String eventName , Function handler , [Object scope ] ) : void Removes a listener
Removes a listener
Parameters:
|
Observable | |
replaceChild( Node newChild , Node oldChild ) : Node Replaces 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)
Resume firing events. (see suspendEvents)
Parameters:
|
Observable | |
sort( Function fn , [Object scope ] ) : void Sorts this nodes children using the supplied sort function
Sorts this nodes children using the supplied sort function
Parameters:
|
Node | |
suspendEvents() : 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 a listener (shorthand for removeListener)
Removes a listener (shorthand for removeListener)
Parameters:
|
Observable |