ObservableNode
| Package: | CQ.Ext.data |
| Class: | Node |
| Subclasses: | TreeNode |
| Extends: | CQ.Ext.util.Observable |
| Clientlib: | cq.widgets |
| 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 | |
| Method | Defined By | |
|---|---|---|
Node( Object attributes )
Parameters:
|
Node | |
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 arguments to the function
will...
Bubbles up the tree from this node, calling the specified function with each 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 arguments to the function
w...
Cascades down the tree from this node, calling the specified function with each 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 | |
|
destroy() : void Destroys the node.
Destroys the node.
Parameters:
|
Node | |
eachChild( Function fn, [Object scope], [Array args] ) : void Interates the child nodes of this node, calling the specified function with each node. The arguments to the function
...
Interates the child nodes of this node, calling the specified function with each 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( 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 CQ.Ext.Components to bubble events to owner Containers. See CQ.Ext.Component.getBubbleTarget. The default implementation in CQ.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 | |
findChild( String attribute, Mixed value, [Boolean deep] ) : 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], [Boolean deep] ) : 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 | |
|
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 | |
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 | |
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( Boolean destroy ) : Node Removes this node from its parent
Removes this node from its parent
Parameters:
|
Node | |
removeAll( Boolean destroy ) : Node Removes all child nodes from this node.
Removes all child nodes from this node.
Parameters:
|
Node | |
removeChild( Node node, Boolean destroy ) : Node Removes a child node from this node.
Removes a child node from this node.
Parameters:
|
Node | |
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 | |
setId( String id ) : void Changes the id of this node.
Changes the id of this node.
Parameters:
|
Node | |
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 | |