Observable Node TreeNode
Package: | Ext.tree |
Defined In: | TreeNode.js |
Class: | TreeNode |
Subclasses: | AsyncTreeNode |
Extends: | Node |
Config Options | Defined By | |
---|---|---|
allowChildren : Boolean
False to not allow this node to have child nodes (defaults to true)
|
TreeNode | |
allowDrag : Boolean
False to make this node undraggable if draggable = true (defaults to true)
|
TreeNode | |
allowDrop : Boolean
False if this node cannot have child nodes dropped on it (defaults to true)
|
TreeNode | |
checked : Boolean True to render a checked checkbox for this node, false to render an unchecked checkbox (defaults to undefined with no...
True to render a checked checkbox for this node, false to render an unchecked checkbox (defaults to undefined with no checkbox rendered)
|
TreeNode | |
cls : String
A css class to be added to the node
|
TreeNode | |
disabled : Boolean
true to start the node disabled
|
TreeNode | |
draggable : Boolean
True to make this node draggable (defaults to false)
|
TreeNode | |
expandable : Boolean
If set to true, the node will always show a plus/minus icon, even when empty
|
TreeNode | |
expanded : Boolean
true to start the node expanded
|
TreeNode | |
href : String
URL of the link used for the node (defaults to #)
|
TreeNode | |
hrefTarget : String
target frame for the link
|
TreeNode | |
icon : String The path to an icon for the node. The preferred way to do this is to use the cls or iconCls attributes and add the ic...
The path to an icon for the node. The preferred way to do this is to use the cls or iconCls attributes and add the icon via a CSS background image.
|
TreeNode | |
iconCls : String
A css class to be added to the nodes icon element for applying css background images
|
TreeNode | |
id : String
The id for this node. If one is not specified, one is generated.
|
Node | |
isTarget : Boolean
False to not allow this node to act as a drop target (defaults to true)
|
TreeNode | |
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 | |
qtip : String
An Ext QuickTip for the node
|
TreeNode | |
qtipCfg : String
An Ext QuickTip config for the node (used instead of qtip)
|
TreeNode | |
singleClickExpand : Boolean
True for single click expand on this node
|
TreeNode | |
text : String
The text for this node
|
TreeNode | |
uiProvider : Function
A UI class to use for this node (defaults to Ext.tree.TreeNodeUI)
|
TreeNode |
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 | |
disabled : Boolean
True if this node is disabled.
|
TreeNode | |
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 | |
text : String
Read-only. The text for this node. To change it use setText().
|
TreeNode | |
ui : TreeNodeUI
Read-only. The UI for this node
|
TreeNode |
Method | Defined By | |
---|---|---|
TreeNode( Object/String attributes )
Parameters:
|
TreeNode | |
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 | |
collapse( [Boolean deep ], [Boolean anim ] ) : void Collapse this node.
Collapse this node.
Parameters:
|
TreeNode | |
collapseChildNodes( [Boolean deep ] ) : void Collapse all child nodes
Collapse all child nodes
Parameters:
|
TreeNode | |
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 | |
disable() : void Disables this node
Disables this node
Parameters:
|
TreeNode | |
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 | |
enable() : void Enables this node
Enables this node
Parameters:
|
TreeNode | |
ensureVisible( [Function callback ] ) : void Ensures all parent nodes are expanded, and if necessary, scrolls
the node into view.
Ensures all parent nodes are expanded, and if necessary, scrolls
the node into view.
Parameters:
|
TreeNode | |
expand( [Boolean deep ], [Boolean anim ], [Function callback ] ) : void Expand this node.
Expand this node.
Parameters:
|
TreeNode | |
expandChildNodes( [Boolean deep ] ) : void Expand all child nodes
Expand all child nodes
Parameters:
|
TreeNode | |
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 | |
getUI() : TreeNodeUI Returns the UI object for this node.
Returns the UI object for this node.
Parameters:
|
TreeNode | |
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 | |
isExpanded() : Boolean Returns true if this node is expanded
Returns true if this node is expanded
Parameters:
|
TreeNode | |
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 | |
isSelected() : Boolean Returns true if this node is selected
Returns true if this node is selected
Parameters:
|
TreeNode | |
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 | |
select() : void Triggers selection of this node
Triggers selection of this node
Parameters:
|
TreeNode | |
setText( String text ) : void Sets the text for this node
Sets the text for this node
Parameters:
|
TreeNode | |
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 | |
toggle() : void Toggles expanded/collapsed state of the node
Toggles expanded/collapsed state of the node
Parameters:
|
TreeNode | |
un( String eventName , Function handler , [Object scope ] ) : void Removes a listener (shorthand for removeListener)
Removes a listener (shorthand for removeListener)
Parameters:
|
Observable | |
unselect() : void Triggers deselection of this node
Triggers deselection of this node
Parameters:
|
TreeNode |
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 | |
beforechildrenrendered : ( Node this ) Fires right before the child nodes for this node are rendered
Fires right before the child nodes for this node are rendered
Listeners will be called with the following arguments:
|
TreeNode | |
beforeclick : ( Node this , Ext.EventObject e ) Fires before click processing. Return false to cancel the default action.
Fires before click processing. Return false to cancel the default action.
Listeners will be called with the following arguments:
|
TreeNode | |
beforecollapse : ( Node this , Boolean deep , Boolean anim ) Fires before this node is collapsed, return false to cancel.
Fires before this node is collapsed, return false to cancel.
Listeners will be called with the following arguments:
|
TreeNode | |
beforeexpand : ( Node this , Boolean deep , Boolean anim ) Fires before this node is expanded, return false to cancel.
Fires before this node is expanded, return false to cancel.
Listeners will be called with the following arguments:
|
TreeNode | |
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 | |
checkchange : ( Node this , Boolean checked ) Fires when a node with a checkbox's checked property changes
Fires when a node with a checkbox's checked property changes
Listeners will be called with the following arguments:
|
TreeNode | |
click : ( Node this , Ext.EventObject e ) Fires when this node is clicked
Fires when this node is clicked
Listeners will be called with the following arguments:
|
TreeNode | |
collapse : ( Node this ) Fires when this node is collapsed
Fires when this node is collapsed
Listeners will be called with the following arguments:
|
TreeNode | |
contextmenu : ( Node this , Ext.EventObject e ) Fires when this node is right clicked
Fires when this node is right clicked
Listeners will be called with the following arguments:
|
TreeNode | |
dblclick : ( Node this , Ext.EventObject e ) Fires when this node is double clicked
Fires when this node is double clicked
Listeners will be called with the following arguments:
|
TreeNode | |
disabledchange : ( Node this , Boolean disabled ) Fires when the disabled status of this node changes
Fires when the disabled status of this node changes
Listeners will be called with the following arguments:
|
TreeNode | |
expand : ( Node this ) Fires when this node is expanded
Fires when this node is expanded
Listeners will be called with the following arguments:
|
TreeNode | |
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 | |
textchange : ( Node this , String text , String oldText ) Fires when the text for this node is changed
Fires when the text for this node is changed
Listeners will be called with the following arguments:
|
TreeNode |