|
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 |
|
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 |
|
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) |
attributes
public Object attributes
The attributes supplied for the node. You can use this property to access any custom attributes you supplied.
This property is defined by
Node.
childNodes
public Array childNodes
All child nodes of this node.
This property is defined by
Node.
disabled
public Boolean disabled
True if this node is disabled.
This property is defined by TreeNode.
firstChild
public Node firstChild
The first direct child node of this node, or null if this node has no child nodes.
This property is defined by
Node.
id
public String id
The node id.
This property is defined by
Node.
lastChild
public Node lastChild
The last direct child node of this node, or null if this node has no child nodes.
This property is defined by
Node.
nextSibling
public Node nextSibling
The node immediately following this node in the tree, or null if there is no sibling node.
This property is defined by
Node.
parentNode
public Node parentNode
The parent node for this node.
This property is defined by
Node.
previousSibling
public Node previousSibling
The node immediately preceding this node in the tree, or null if there is no sibling node.
This property is defined by
Node.
text
public String text
Read-only. The text for this node. To change it use setText().
This property is defined by TreeNode.
ui
public TreeNodeUI ui
Read-only. The UI for this node
This property is defined by TreeNode.
addEvents
public function addEvents( Object object
)
Used to define events on this Observable
addListener
public function addListener( String eventName
, Function handler
, [Object scope
], [Object options
] )
Appends an event handler to this component
Parameters:
eventName
: StringThe type of event to listen for
handler
: FunctionThe method the event invokes
scope
: Object(optional) The scope in which to execute the handler
function. The handler function's "this" context.
options
: Object(optional) An object containing handler configuration
properties. This may contain any of the following properties:
- scope {Object} The scope in which to execute the handler function. The handler function's "this" context.
- delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
- single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
- buffer {Number} Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed
by the specified number of milliseconds. If the event fires again within that time, the original
handler is not invoked, but the new handler is scheduled in its place.
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
});
Returns:
appendChild
public function appendChild( Node/Array node
)
Insert node(s) as the last child node of this node.
This method is defined by
Node.
bubble
public function bubble( Function fn
, [Object scope
], [Array args
] )
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.
This method is defined by
Node.
cascade
public function cascade( Function fn
, [Object scope
], [Array args
] )
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.
This method is defined by
Node.
collapse
public function collapse( [Boolean deep
], [Boolean anim
] )
This method is defined by TreeNode.
collapseChildNodes
public function collapseChildNodes( [Boolean deep
] )
This method is defined by TreeNode.
contains
public function contains( Node node
)
Returns true if this node is an ancestor (at any point) of the passed node.
This method is defined by
Node.
disable
public function disable()
This method is defined by TreeNode.
eachChild
public function eachChild( Function fn
, [Object scope
], [Array args
] )
Interates 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.
This method is defined by
Node.
enable
public function enable()
This method is defined by TreeNode.
ensureVisible
public function ensureVisible()
Ensures all parent nodes are expanded
This method is defined by TreeNode.
expand
public function expand( [Boolean deep
], [Boolean anim
], [Function callback
] )
Expand this node.
Parameters:
deep
: Boolean(optional) True to expand all children as well
anim
: Boolean(optional) false to cancel the default animation
callback
: Function(optional) A callback to be called when
expanding this node completes (does not wait for deep expand to complete).
Called with 1 parameter, this node.
Returns:
This method is defined by TreeNode.
expandChildNodes
public function expandChildNodes( [Boolean deep
] )
This method is defined by TreeNode.
findChild
public function findChild( String attribute
, Mixed value
)
Finds the first child that has the attribute with the specified value.
Parameters:
attribute
: StringThe attribute name
value
: MixedThe value to search for
Returns:
This method is defined by
Node.
findChildBy
public function findChildBy( Function fn
, [Object scope
] )
Finds the first child by a custom function. The child matches if the function passed
returns true.
Parameters:
fn
: Functionscope
: Object(optional)
Returns:
This method is defined by
Node.
fireEvent
public function fireEvent( String eventName
, Object... args
)
Fires the specified event with the passed parameters (minus the event name).
getDepth
public function getDepth()
Returns depth of this node (the root node has a depth of 0)
This method is defined by
Node.
getOwnerTree
public function getOwnerTree()
Returns the tree this node is in.
This method is defined by
Node.
getPath
public function getPath( [String attr
] )
Returns the path for this node. The path can be used to expand or select this node programmatically.
This method is defined by
Node.
getUI
public function getUI()
Returns the UI object for this node
This method is defined by TreeNode.
hasListener
public function hasListener( String eventName
)
Checks to see if this object has any listeners for a specified event
indexOf
public function indexOf( Node node
)
Returns the index of a child node
This method is defined by
Node.
insertBefore
public function insertBefore( Node node
, Node refNode
)
Inserts the first node before the second node in this nodes childNodes collection.
This method is defined by
Node.
isAncestor
public function isAncestor( Node node
)
Returns true if the passed node is an ancestor (at any point) of this node.
This method is defined by
Node.
isExpanded
public function isExpanded()
Returns true if this node is expanded
This method is defined by TreeNode.
isFirst
public function isFirst()
Returns true if this node is the first child of its parent
This method is defined by
Node.
isLast
public function isLast()
Returns true if this node is the last child of its parent
This method is defined by
Node.
isLeaf
public function isLeaf()
Returns true if this node is a leaf
This method is defined by
Node.
isSelected
public function isSelected()
Returns true if this node is selected
This method is defined by TreeNode.
item
public function item( Number index
)
Returns the child node at the specified index.
This method is defined by
Node.
on
public function on( String eventName
, Function handler
, [Object scope
], [Object options
] )
Appends an event handler to this element (shorthand for addListener)
Parameters:
eventName
: StringThe type of event to listen for
handler
: FunctionThe method the event invokes
scope
: Object(optional) The scope in which to execute the handler
function. The handler function's "this" context.
options
: Object(optional)
Returns:
purgeListeners
public function purgeListeners()
Removes all listeners for this object
removeChild
public function removeChild( Node node
)
Removes a child node from this node.
Parameters:
node
: NodeThe node to remove
Returns:
This method is defined by
Node.
removeListener
public function removeListener( String eventName
, Function handler
, [Object scope
] )
replaceChild
public function replaceChild( Node newChild
, Node oldChild
)
Replaces one child node in this node with another.
Parameters:
newChild
: NodeThe replacement node
oldChild
: NodeThe node to replace
Returns:
This method is defined by
Node.
select
public function select()
Triggers selection of this node
This method is defined by TreeNode.
setText
public function setText( String text
)
Sets the text for this node
This method is defined by TreeNode.
sort
public function sort( Function fn
, [Object scope
] )
Sorts this nodes children using the supplied sort function
Parameters:
fn
: Functionscope
: Object(optional)
Returns:
This method is defined by
Node.
toggle
public function toggle()
Toggles expanded/collapsed state of the node
This method is defined by TreeNode.
un
public function un( String eventName
, Function handler
, [Object scope
] )
Removes a listener (shorthand for removeListener)
unselect
public function unselect()
Triggers deselection of this node
This method is defined by TreeNode.
append
public event append
Fires when a new child node is appended
Subscribers will be called with the following parameters:
This event is defined by
Node.
beforeappend
public event beforeappend
Fires before a new child is appended, return false to cancel the append.
Subscribers will be called with the following parameters:
This event is defined by
Node.
beforechildrenrendered
public event beforechildrenrendered
Fires right before the child nodes for this node are rendered
Subscribers will be called with the following parameters:
This event is defined by TreeNode.
beforeclick
public event beforeclick
Fires before click processing. Return false to cancel the default action.
Subscribers will be called with the following parameters:
this
: NodeThis node
e
: Ext.EventObjectThe event object
This event is defined by TreeNode.
beforecollapse
public event beforecollapse
Fires before this node is collapsed, return false to cancel.
Subscribers will be called with the following parameters:
this
: NodeThis node
deep
: Booleananim
: Boolean
This event is defined by TreeNode.
beforeexpand
public event beforeexpand
Fires before this node is expanded, return false to cancel.
Subscribers will be called with the following parameters:
this
: NodeThis node
deep
: Booleananim
: Boolean
This event is defined by TreeNode.
beforeinsert
public event beforeinsert
Fires before a new child is inserted, return false to cancel the insert.
Subscribers will be called with the following parameters:
This event is defined by
Node.
beforemove
public event beforemove
Fires before this node is moved to a new location in the tree. Return false to cancel the move.
Subscribers will be called with the following parameters:
This event is defined by
Node.
beforeremove
public event beforeremove
Fires before a child is removed, return false to cancel the remove.
Subscribers will be called with the following parameters:
This event is defined by
Node.
checkchange
public event checkchange
Fires when a node with a checkbox's checked property changes
Subscribers will be called with the following parameters:
this
: NodeThis node
checked
: Boolean
This event is defined by TreeNode.
click
public event click
Fires when this node is clicked
Subscribers will be called with the following parameters:
this
: NodeThis node
e
: Ext.EventObjectThe event object
This event is defined by TreeNode.
collapse
public event collapse
Fires when this node is collapsed
Subscribers will be called with the following parameters:
This event is defined by TreeNode.
contextmenu
public event contextmenu
Fires when this node is right clicked
Subscribers will be called with the following parameters:
this
: NodeThis node
e
: Ext.EventObjectThe event object
This event is defined by TreeNode.
dblclick
public event dblclick
Fires when this node is double clicked
Subscribers will be called with the following parameters:
this
: NodeThis node
e
: Ext.EventObjectThe event object
This event is defined by TreeNode.
disabledchange
public event disabledchange
Fires when the disabled status of this node changes
Subscribers will be called with the following parameters:
this
: NodeThis node
disabled
: Boolean
This event is defined by TreeNode.
expand
public event expand
Fires when this node is expanded
Subscribers will be called with the following parameters:
This event is defined by TreeNode.
insert
public event insert
Fires when a new child node is inserted.
Subscribers will be called with the following parameters:
This event is defined by
Node.
move
public event move
Fires when this node is moved to a new location in the tree
Subscribers will be called with the following parameters:
tree
: TreeThe owner tree
this
: NodeThis node
oldParent
: NodeThe old parent of this node
newParent
: NodeThe new parent of this node
index
: NumberThe index it was moved to
This event is defined by
Node.
remove
public event remove
Fires when a child node is removed
Subscribers will be called with the following parameters:
tree
: TreeThe owner tree
this
: NodeThis node
node
: NodeThe removed node
This event is defined by
Node.
textchange
public event textchange
Fires when the text for this node is changed
Subscribers will be called with the following parameters:
this
: NodeThis node
text
: StringThe new text
oldText
: StringThe old text
This event is defined by TreeNode.
allowDrag
allowDrag : Boolean
false to make this node undraggable if DD is on (defaults to true)
This config option is defined by TreeNode.
allowDrop
allowDrop : Boolean
false if this node cannot be drop on
This config option is defined by TreeNode.
checked
checked : Boolean
True to render a checked checkbox for this node, false to render an unchecked checkbox (defaults to undefined with no checkbox rendered)
This config option is defined by TreeNode.
cls
cls : String
A css class to be added to the node
This config option is defined by TreeNode.
disabled
disabled : Boolean
true to start the node disabled
This config option is defined by TreeNode.
expanded
expanded : Boolean
true to start the node expanded
This config option is defined by TreeNode.
href
href : String
URL of the link used for the node (defaults to #)
This config option is defined by TreeNode.
hrefTarget
hrefTarget : String
target frame for the link
This config option is defined by TreeNode.
icon
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 icon via a CSS background image.
This config option is defined by TreeNode.
iconCls
iconCls : String
A css class to be added to the nodes icon element for applying css background images
This config option is defined by TreeNode.
id
id : String
The id for this node. If one is not specified, one is generated.
This config option is defined by
Node.
leaf
leaf : Boolean
true if this node is a leaf and does not have children
This config option is defined by
Node.
qtip
qtip : String
An Ext QuickTip for the node
This config option is defined by TreeNode.
qtipCfg
qtipCfg : String
An Ext QuickTip config for the node (used instead of qtip)
This config option is defined by TreeNode.
singleClickExpand
singleClickExpand : Boolean
True for single click expand on this node
This config option is defined by TreeNode.
text
text : String
The text for this node
This config option is defined by TreeNode.
uiProvider
uiProvider : Function
A UI class to use for this node (defaults to Ext.tree.TreeNodeUI)
This config option is defined by TreeNode.