Package: | Ext.tree |
Class: | TreeNode |
Extends: | Node |
Subclasses: | AsyncTreeNode |
Defined In: | TreeNode.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. | ||
disabled : Boolean | TreeNode | |
True if this node is disabled. | ||
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. | ||
text : String | TreeNode | |
Read-only. The text for this node. To change it use setText(). | ||
ui : TreeNodeUI | TreeNode | |
Read-only. The UI for this node |
Method | Defined By | |
---|---|---|
TreeNode( Object/String attributes ) |
TreeNode | |
addEvents( Object object ) : void |
Observable | |
Used to define events on this Observable | ||
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 ca... | ||
collapse( [Boolean deep ], [Boolean anim ] ) : void |
TreeNode | |
Collapse this node. | ||
collapseChildNodes( [Boolean deep ] ) : void |
TreeNode | |
Collapse all child nodes | ||
contains( Node node ) : Boolean |
Node | |
Returns true if this node is an ancestor (at any point) of the passed node. | ||
disable() : void | TreeNode | |
Disables this 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 c... | ||
enable() : void | TreeNode | |
Enables this node | ||
ensureVisible() : void | TreeNode | |
Ensures all parent nodes are expanded | ||
expand( [Boolean deep ], [Boolean anim ], [Function callback ] ) : void |
TreeNode | |
Expand this node. | ||
expandChildNodes( [Boolean deep ] ) : void |
TreeNode | |
Expand all child nodes | ||
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. | ||
getUI() : TreeNodeUI | TreeNode | |
Returns the UI object for this node | ||
hasListener( String eventName ) : Boolean |
Observable | |
Checks to see if this object has any listeners 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. | ||
isExpanded() : Boolean | TreeNode | |
Returns true if this node is expanded | ||
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 | ||
isSelected() : Boolean | TreeNode | |
Returns true if this node is selected | ||
item( Number index ) : Node |
Node | |
Returns the child node at the specified index. | ||
on( String eventName , Function handler , [Object scope ], [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. | ||
select() : void | TreeNode | |
Triggers selection of this node | ||
setText( String text ) : void |
TreeNode | |
Sets the text for this node | ||
sort( Function fn , [Object scope ] ) : void |
Node | |
Sorts this nodes children using the supplied sort function | ||
toggle() : void | TreeNode | |
Toggles expanded/collapsed state of the node | ||
un( String eventName , Function handler , [Object scope ] ) : void |
Observable | |
Removes a listener (shorthand for removeListener) | ||
unselect() : void | TreeNode | |
Triggers deselection of this node |
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. | ||
beforechildrenrendered : ( Node this ) |
TreeNode | |
Fires right before the child nodes for this node are rendered | ||
beforeclick : ( Node this , Ext.EventObject e ) |
TreeNode | |
Fires before click processing. Return false to cancel the default action. | ||
beforecollapse : ( Node this , Boolean deep , Boolean anim ) |
TreeNode | |
Fires before this node is collapsed, return false to cancel. | ||
beforeexpand : ( Node this , Boolean deep , Boolean anim ) |
TreeNode | |
Fires before this node is expanded, return false to cancel. | ||
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. | ||
checkchange : ( Node this , Boolean checked ) |
TreeNode | |
Fires when a node with a checkbox's checked property changes | ||
click : ( Node this , Ext.EventObject e ) |
TreeNode | |
Fires when this node is clicked | ||
collapse : ( Node this ) |
TreeNode | |
Fires when this node is collapsed | ||
contextmenu : ( Node this , Ext.EventObject e ) |
TreeNode | |
Fires when this node is right clicked | ||
dblclick : ( Node this , Ext.EventObject e ) |
TreeNode | |
Fires when this node is double clicked | ||
disabledchange : ( Node this , Boolean disabled ) |
TreeNode | |
Fires when the disabled status of this node changes | ||
expand : ( Node this ) |
TreeNode | |
Fires when this node is expanded | ||
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 | ||
textchange : ( Node this , String text , String oldText ) |
TreeNode | |
Fires when the text for this node is changed |
Config Options | Defined By | |
---|---|---|
allowDrag : Boolean | TreeNode | |
false to make this node undraggable if DD is on (defaults to true) | ||
allowDrop : Boolean | TreeNode | |
false if this node cannot be drop on | ||
checked : Boolean | TreeNode | |
True to render a checked checkbox for this node, false to render an unchecked checkbox (defaults to undefined with no... | ||
cls : String | TreeNode | |
A css class to be added to the node | ||
disabled : Boolean | TreeNode | |
true to start the node disabled | ||
expanded : Boolean | TreeNode | |
true to start the node expanded | ||
href : String | TreeNode | |
URL of the link used for the node (defaults to #) | ||
hrefTarget : String | TreeNode | |
target frame for the link | ||
icon : String | TreeNode | |
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... | ||
iconCls : String | TreeNode | |
A css class to be added to the nodes icon element for applying css background images | ||
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 | ||
qtip : String | TreeNode | |
An Ext QuickTip for the node | ||
qtipCfg : String | TreeNode | |
An Ext QuickTip config for the node (used instead of qtip) | ||
singleClickExpand : Boolean | TreeNode | |
True for single click expand on this node | ||
text : String | TreeNode | |
The text for this node | ||
uiProvider : Function | TreeNode | |
A UI class to use for this node (defaults to Ext.tree.TreeNodeUI) |
public Object attributes
public Boolean disabled
public Node firstChild
public Node lastChild
public Node nextSibling
public Node previousSibling
public String text
public TreeNodeUI ui
public function TreeNode( Object/String attributes
)
attributes
: Object/Stringpublic 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,
forumId: 4
});
Attaching multiple handlers in 1 call
The method also allows for a single argument to be passed which is a config object containing properties
which specify multiple handlers.
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 which passes the same scope object to all handlers:
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 collapse( [Boolean deep
], [Boolean anim
] )
deep
: Booleananim
: Booleanvoid
public function collapseChildNodes( [Boolean deep
] )
deep
: Booleanvoid
public function contains( Node node
)
node
: NodeBoolean
public function disable()
void
public function eachChild( Function fn
, [Object scope
], [Array args
] )
fn
: Functionscope
: Objectargs
: Arrayvoid
public function enable()
void
public function ensureVisible()
void
public function expand( [Boolean deep
], [Boolean anim
], [Function callback
] )
deep
: Booleananim
: Booleancallback
: Functionvoid
public function expandChildNodes( [Boolean deep
] )
deep
: Booleanvoid
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 getUI()
TreeNodeUI
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 isExpanded()
Boolean
public function isFirst()
Boolean
public function isLast()
Boolean
public function isLeaf()
Boolean
public function isSelected()
Boolean
public function item( Number index
)
index
: NumberNode
public function on( String eventName
, Function handler
, [Object scope
], [Object options
] )
eventName
: Stringhandler
: Functionscope
: Objectoptions
: 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 select()
void
public function setText( String text
)
text
: Stringvoid
public function sort( Function fn
, [Object scope
] )
fn
: Functionscope
: Objectvoid
public function toggle()
void
public function un( String eventName
, Function handler
, [Object scope
] )
eventName
: Stringhandler
: Functionscope
: Objectvoid
public function unselect()
void
public event append
tree
: Treethis
: Nodenode
: Nodeindex
: Numberpublic event beforeappend
tree
: Treethis
: Nodenode
: Nodepublic event beforechildrenrendered
this
: Nodepublic event beforeclick
this
: Nodee
: Ext.EventObjectpublic event beforecollapse
this
: Nodedeep
: Booleananim
: Booleanpublic event beforeexpand
this
: Nodedeep
: Booleananim
: Booleanpublic event beforeinsert
tree
: Treethis
: Nodenode
: NoderefNode
: Nodepublic event beforemove
tree
: Treethis
: NodeoldParent
: NodenewParent
: Nodeindex
: Numberpublic event beforeremove
tree
: Treethis
: Nodenode
: Nodepublic event checkchange
this
: Nodechecked
: Booleanpublic event click
this
: Nodee
: Ext.EventObjectpublic event collapse
this
: Nodepublic event contextmenu
this
: Nodee
: Ext.EventObjectpublic event dblclick
this
: Nodee
: Ext.EventObjectpublic event disabledchange
this
: Nodedisabled
: Booleanpublic event expand
this
: Nodepublic event insert
tree
: Treethis
: Nodenode
: NoderefNode
: Nodepublic event move
tree
: Treethis
: NodeoldParent
: NodenewParent
: Nodeindex
: Numberpublic event remove
tree
: Treethis
: Nodenode
: Nodepublic event textchange
this
: Nodetext
: StringoldText
: StringallowDrag : Boolean
allowDrop : Boolean
checked : Boolean
cls : String
disabled : Boolean
expanded : Boolean
href : String
hrefTarget : String
icon : String
iconCls : String
id : String
leaf : Boolean
qtip : String
qtipCfg : String
singleClickExpand : Boolean
text : String
uiProvider : Function