Package: | Ext.data |
Class: | Node |
Extends: | Observable |
Subclasses: | TreeNode |
Defined In: | Tree.js |
Property | Defined By | |
---|---|---|
attributes : Object | Node | |
The attributes supplied for the node. You can use this property to access any custom attributes you supplied. | ||
childNodes : Array | Node | |
All child nodes of this node. | ||
firstChild : Node | Node | |
The first direct child node of this node, or null if this node has no child nodes. | ||
id : String | Node | |
The node id. | ||
lastChild : Node | Node | |
The last direct child node of this node, or null if this node has no child nodes. | ||
nextSibling : Node | Node | |
The node immediately following this node in the tree, or null if there is no sibling node. | ||
parentNode : Node | Node | |
The parent node for this node. | ||
previousSibling : Node | Node | |
The node immediately preceding this node in the tree, or null if there is no sibling node. |
Method | Defined By | |
---|---|---|
Node(Object attributes ) |
Node | |
addEvents(Object object ) : void |
Observable | |
Copies any events from the passed object onto this object if they do not already exist. The passed object must also ... | ||
addListener(String eventName , Function handler , [Object scope ], [Object options ]) : void |
Observable | |
Appends an event handler to this component | ||
appendChild(Node/Array node ) : Node |
Node | |
Insert node(s) as the last child node of this node. | ||
bubble(Function fn , [Object scope ], [Array args ]) : void |
Node | |
Bubbles up the tree from this node, calling the specified function with each node. The scope (this) of function call... | ||
cascade(Function fn , [Object scope ], [Array args ]) : void |
Node | |
Cascades down the tree from this node, calling the specified function with each node. The scope (this) of function c... | ||
contains(Node node ) : Boolean |
Node | |
Returns true if this node is an ancestor (at any point) of the passed node. | ||
eachChild(Function fn , [Object scope ], [Array args ]) : void |
Node | |
Interates the child nodes of this node, calling the specified function with each node. The scope (this) of function ... | ||
findChild(String attribute , Mixed value ) : Node |
Node | |
Finds the first child that has the attribute with the specified value. | ||
findChildBy(Function fn , [Object scope ]) : Node |
Node | |
Finds the first child by a custom function. The child matches if the function passed returns true. | ||
fireEvent(String eventName , Object... args ) : Boolean |
Observable | |
Fires the specified event with the passed parameters (minus the event name). | ||
getDepth() : Number | Node | |
Returns depth of this node (the root node has a depth of 0) | ||
getOwnerTree() : Tree | Node | |
Returns the tree this node is in. | ||
getPath([String attr ]) : String |
Node | |
Returns the path for this node. The path can be used to expand or select this node programmatically. | ||
hasListener(String eventName ) : Boolean |
Observable | |
Checks to see if this object is currently listening for a specified event | ||
indexOf(Node node ) : Number |
Node | |
Returns the index of a child node | ||
insertBefore(Node node , Node refNode ) : Node |
Node | |
Inserts the first node before the second node in this nodes childNodes collection. | ||
isAncestor(Node node ) : Boolean |
Node | |
Returns true if the passed node is an ancestor (at any point) of this node. | ||
isFirst() : Boolean | Node | |
Returns true if this node is the first child of its parent | ||
isLast() : Boolean | Node | |
Returns true if this node is the last child of its parent | ||
isLeaf() : Boolean | Node | |
Returns true if this node is a leaf | ||
item(Number index ) : Node |
Node | |
Returns the child node at the specified index. | ||
on(String eventName , Function handler , [Object options ]) : void |
Observable | |
Appends an event handler to this element (shorthand for addListener) | ||
purgeListeners() : void | Observable | |
Removes all listeners for this object | ||
removeChild(Node node ) : Node |
Node | |
Removes a child node from this node. | ||
removeListener(String eventName , Function handler , [Object scope ]) : void |
Observable | |
Removes a listener | ||
replaceChild(Node newChild , Node oldChild ) : Node |
Node | |
Replaces one child node in this node with another. | ||
sort(Function fn , [Object scope ]) : void |
Node | |
Sorts this nodes children using the supplied sort function | ||
un(String eventName , Function handler , [Object scope ]) : void |
Observable | |
Removes a listener (shorthand for removeListener) |
Event | Defined By | |
---|---|---|
append : (Tree tree , Node this , Node node , Number index ) |
Node | |
Fires when a new child node is appended | ||
beforeappend : (Tree tree , Node this , Node node ) |
Node | |
Fires before a new child is appended, return false to cancel the append. | ||
beforeinsert : (Tree tree , Node this , Node node , Node refNode ) |
Node | |
Fires before a new child is inserted, return false to cancel the insert. | ||
beforemove : (Tree tree , Node this , Node oldParent , Node newParent , Number index ) |
Node | |
Fires before this node is moved to a new location in the tree. Return false to cancel the move. | ||
beforeremove : (Tree tree , Node this , Node node ) |
Node | |
Fires before a child is removed, return false to cancel the remove. | ||
insert : (Tree tree , Node this , Node node , Node refNode ) |
Node | |
Fires when a new child node is inserted. | ||
move : (Tree tree , Node this , Node oldParent , Node newParent , Number index ) |
Node | |
Fires when this node is moved to a new location in the tree | ||
remove : (Tree tree , Node this , Node node ) |
Node | |
Fires when a child node is removed |
Config Options | Defined By | |
---|---|---|
id : String | Node | |
The id for this node. If one is not specified, one is generated. | ||
leaf : Boolean | Node | |
true if this node is a leaf and does not have children |
public Object attributes
public Array childNodes
public Node firstChild
public String id
public Node lastChild
public Node nextSibling
public Node parentNode
public Node previousSibling
public function Node(Object attributes
)
attributes
: Objectpublic function addEvents(Object object
)
object
: Objectvoid
public function addListener(String eventName
, Function handler
, [Object scope
], [Object options
])
eventName
: Stringhandler
: Functionscope
: Objectoptions
: Object Combining Options
Using the options argument, it is possible to combine different types of listeners:
A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
el.on('click', this.onClick, this, { single: true, delay: 100, stopEvent : true, forumId: 4 });
The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers.
Attaching multiple handlers in 1 call
Code:
el.on({ 'click' : { fn: this.onClick scope: this, delay: 100 }, 'mouseover' : { fn: this.onMouseOver scope: this }, 'mouseout' : { fn: this.onMouseOut scope: this } });
Or a shorthand syntax:
Code:
el.on({ 'click' : this.onClick, 'mouseover' : this.onMouseOver, 'mouseout' : this.onMouseOut scope: this });
void
public function appendChild(Node/Array node
)
node
: Node/ArrayNode
public function bubble(Function fn
, [Object scope
], [Array args
])
fn
: Functionscope
: Objectargs
: Arrayvoid
public function cascade(Function fn
, [Object scope
], [Array args
])
fn
: Functionscope
: Objectargs
: Arrayvoid
public function contains(Node node
)
node
: NodeBoolean
public function eachChild(Function fn
, [Object scope
], [Array args
])
fn
: Functionscope
: Objectargs
: Arrayvoid
public function findChild(String attribute
, Mixed value
)
attribute
: Stringvalue
: MixedNode
public function findChildBy(Function fn
, [Object scope
])
fn
: Functionscope
: ObjectNode
public function fireEvent(String eventName
, Object... args
)
eventName
: Stringargs
: Object...Boolean
public function getDepth()
Number
public function getOwnerTree()
Tree
public function getPath([String attr
])
attr
: StringString
public function hasListener(String eventName
)
eventName
: StringBoolean
public function indexOf(Node node
)
node
: NodeNumber
public function insertBefore(Node node
, Node refNode
)
node
: NoderefNode
: NodeNode
public function isAncestor(Node node
)
node
: NodeBoolean
public function isFirst()
Boolean
public function isLast()
Boolean
public function isLeaf()
Boolean
public function item(Number index
)
index
: NumberNode
public function on(String eventName
, Function handler
, [Object options
])
eventName
: Stringhandler
: Functionoptions
: Objectvoid
public function purgeListeners()
void
public function removeChild(Node node
)
node
: NodeNode
public function removeListener(String eventName
, Function handler
, [Object scope
])
eventName
: Stringhandler
: Functionscope
: Objectvoid
public function replaceChild(Node newChild
, Node oldChild
)
newChild
: NodeoldChild
: NodeNode
public function sort(Function fn
, [Object scope
])
fn
: Functionscope
: Objectvoid
public function un(String eventName
, Function handler
, [Object scope
])
eventName
: Stringhandler
: Functionscope
: Objectvoid
public event append
tree
: Treethis
: Nodenode
: Nodeindex
: Numberpublic event beforeappend
tree
: Treethis
: Nodenode
: Nodepublic event beforeinsert
tree
: Treethis
: Nodenode
: NoderefNode
: Nodepublic event beforemove
tree
: Treethis
: NodeoldParent
: NodenewParent
: Nodeindex
: Numberpublic event beforeremove
tree
: Treethis
: Nodenode
: Nodepublic event insert
tree
: Treethis
: Nodenode
: NoderefNode
: Nodepublic event move
tree
: Treethis
: NodeoldParent
: NodenewParent
: Nodeindex
: Numberpublic event remove
tree
: Treethis
: Nodenode
: Node