|
| TreeNode( Object/String attributes )
+ | TreeNode |
| addEvents( Object|String o , string Optional. )
+ :
+ voidAdds the specified events to the list of events which this Observable may fire. Adds the specified events to the list of events which this Observable may fire. | Observable |
| addListener( String eventName , Function handler , [Object scope ], [Object options ] )
+ :
voidAppends an event handler to this object. Appends an event handler to this object. Parameters:eventName : StringThe name of the event to listen for. handler : FunctionThe method the event invokes. scope : Object(optional) The scope (this reference) in which the handler function is executed.
If omitted, defaults to the object which fired the event. options : Object(optional) An object containing handler configuration.
properties. This may contain any of the following properties:
@@ -81,8 +83,8 @@ Using the options argument, it is possible to combine different types of listene
A delayed, one-time listener.
myDataView.on('click', this.onClick, this, {
- single: true,
- delay: 100
+single: true,
+delay: 100
});
Attaching multiple handlers in 1 call
@@ -90,194 +92,228 @@ The method also allows for a single argument to be passed which is a config obje
which specify multiple handlers.
myGridPanel.on({
- 'click' : {
- fn: this.onClick,
- scope: this,
- delay: 100
- },
- 'mouseover' : {
- fn: this.onMouseOver,
- scope: this
- },
- 'mouseout' : {
- fn: this.onMouseOut,
- scope: this
- }
+'click' : {
+ fn: this.onClick,
+ scope: this,
+ delay: 100
+},
+'mouseover' : {
+ fn: this.onMouseOver,
+ scope: this
+},
+'mouseout' : {
+ fn: this.onMouseOut,
+ scope: this
+}
});
Or a shorthand syntax:
myGridPanel.on({
- 'click' : this.onClick,
- 'mouseover' : this.onMouseOver,
- 'mouseout' : this.onMouseOut,
- scope: this
-});
Returns: | Observable |
| appendChild( Node/Array node )
- :
- NodeInsert node(s) as the last child node of this node. Insert node(s) as the last child node of this node. | Node |
| bubble( Function fn , [Object scope ], [Array args ] )
- :
- voidBubbles up the tree from this node, calling the specified function with each node. The scope (this) of
+'click' : this.onClick,
+'mouseover' : this.onMouseOver,
+'mouseout' : this.onMouseOut,
+ scope: this
+}); Returns: | Observable |
| appendChild( Node/Array node )
+ :
+ NodeInsert node(s) as the last child node of this node. Insert node(s) as the last child node of this node. | Node |
| bubble( Function fn , [Object scope ], [Array args ] )
+ :
+ voidBubbles 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. | Node |
| cascade( Function fn , [Object scope ], [Array args ] )
- :
- voidCascades down the tree from this node, calling the specified function with each node. The scope (this) of
+the bubble is stopped. | Node |
| cascade( Function fn , [Object scope ], [Array args ] )
+ :
+ voidCascades down the tree from this node, calling the specified function with each node. The scope (this) of
function c... 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. | Node |
| collapse( [Boolean deep ], [Boolean anim ], [Function callback ], [Object scope ] )
- :
+the cascade is stopped on that branch. | Node |
| collapse( [Boolean deep ], [Boolean anim ], [Function callback ], [Object scope ] )
+ :
voidCollapse this node. Collapse this node. Parameters:deep : Boolean(optional) True to collapse 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. scope : Object(optional) The scope in which to execute the callback. Returns: | TreeNode |
| collapseChildNodes( [Boolean deep ] )
- :
- void | TreeNode |
| contains( Node node )
- :
- BooleanReturns 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. | Node |
| disable()
- :
- void | TreeNode |
| eachChild( Function fn , [Object scope ], [Array args ] )
- :
- voidInterates the child nodes of this node, calling the specified function with each node. The scope (this) of
+Called with 1 parameter, this node. scope : Object(optional) The scope in which to execute the callback. Returns: | TreeNode |
| collapseChildNodes( [Boolean deep ] )
+ :
+ void | TreeNode |
| contains( Node node )
+ :
+ BooleanReturns 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. | Node |
| disable()
+ :
+ void | TreeNode |
| eachChild( Function fn , [Object scope ], [Array args ] )
+ :
+ voidInterates the child nodes of this node, calling the specified function with each node. The scope (this) of
function ... 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. | Node |
| enable()
- :
- void | TreeNode |
| enableBubble( Object events )
- :
- voidUsed to enable bubbling of events Used to enable bubbling of events | Observable |
| ensureVisible( [Function callback ], [Object scope ] )
- :
- voidEnsures all parent nodes are expanded, and if necessary, scrolls
+the iteration stops. | Node |
| enable()
+ :
+ void | TreeNode |
| enableBubble( Object events )
+ :
+ voidEnables 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.getBubbleTarget() if present. There is no implementation in the Observable base class.
+ This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default
+implementation in 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: Ext.override(Ext.form.Field, {
+// Add functionality to Field's initComponent to enable the change event to bubble
+ initComponent: Ext.form.Field.prototype.initComponent.createSequence(function() {
+ this.enableBubble('change');
+ }),
+
+// We know that we want Field's events to bubble directly to the FormPanel.
+ getBubbleTarget: function() {
+ if (!this.formPanel) {
+ this.formPanel = this.findParentByType('form');
+ }
+ return this.formPanel;
+ }
+});
+
+var myForm = new Ext.formPanel({
+ title: 'User Details',
+ items: [{
+ ...
+ }],
+ listeners: {
+ change: function() {
+// Title goes red if form has been modified.
+ myForm.header.setStyle("color", "red");
+ }
+ }
+});
| Observable |
| ensureVisible( [Function callback ], [Object scope ] )
+ :
+ voidEnsures 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. | TreeNode |
| expand( [Boolean deep ], [Boolean anim ], [Function callback ], [Object scope ] )
- :
+the node into view. | TreeNode |
| expand( [Boolean deep ], [Boolean anim ], [Function callback ], [Object scope ] )
+ :
voidExpand this node. 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. scope : Object(optional) The scope in which to execute the callback. Returns: | TreeNode |
| expandChildNodes( [Boolean deep ] )
- :
- void | TreeNode |
| findChild( String attribute , Mixed value )
- :
- NodeFinds the first child that has the attribute with the specified 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: | Node |
| findChildBy( Function fn , [Object scope ] )
- :
- NodeFinds the first child by a custom function. The child matches if the function passed
+Called with 1 parameter, this node. scope : Object(optional) The scope in which to execute the callback. Returns: | TreeNode |
| expandChildNodes( [Boolean deep ] )
+ :
+ void | TreeNode |
| findChild( String attribute , Mixed value )
+ :
+ NodeFinds the first child that has the attribute with the specified 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: | Node |
| findChildBy( Function fn , [Object scope ] )
+ :
+ NodeFinds 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:fn : Functionscope : Object(optional) Returns: | Node |
| fireEvent( String eventName , Object... args )
- :
- BooleanFires the specified event with the passed parameters (minus the event name).
+returns true. Parameters:fn : Functionscope : Object(optional) Returns: | Node |
| fireEvent( String eventName , Object... args )
+ :
+ BooleanFires the specified event with the passed parameters (minus the event name).
An event may be set to bubble up an Obse... | Observable |
| getDepth()
- :
- NumberReturns 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) | Node |
| getOwnerTree()
- :
- TreeReturns the tree this node is in. Returns the tree this node is in. | Node |
| getPath( [String attr ] )
- :
- StringReturns 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. | Node |
| getUI()
- :
- TreeNodeUIReturns the UI object for this node. Returns the UI object for this node. | TreeNode |
| hasChildNodes()
- :
- BooleanReturns 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. | Node |
| hasListener( String eventName )
- :
- BooleanChecks 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 | Observable |
| indexOf( Node node )
- :
- NumberReturns the index of a child node Returns the index of a child node | Node |
| insertBefore( Node node , Node refNode )
- :
- NodeInserts 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. | Node |
| isAncestor( Node node )
- :
- BooleanReturns 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. | Node |
| isExpandable()
- :
- BooleanReturns true if this node has one or more child nodes, or if the expandable
+by calling enableBubble. | Observable |
| getDepth()
+ :
+ NumberReturns 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) | Node |
| getOwnerTree()
+ :
+ TreeReturns the tree this node is in. Returns the tree this node is in. | Node |
| getPath( [String attr ] )
+ :
+ StringReturns 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. | Node |
| getUI()
+ :
+ TreeNodeUIReturns the UI object for this node. Returns the UI object for this node. | TreeNode |
| hasChildNodes()
+ :
+ BooleanReturns 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. | Node |
| hasListener( String eventName )
+ :
+ BooleanChecks 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 | Observable |
| indexOf( Node node )
+ :
+ NumberReturns the index of a child node Returns the index of a child node | Node |
| insertBefore( Node node , Node refNode )
+ :
+ NodeInserts 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. | Node |
| isAncestor( Node node )
+ :
+ BooleanReturns 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. | Node |
| isExpandable()
+ :
+ BooleanReturns true if this node has one or more child nodes, or if the expandable
node attribute is explicitly specified a... 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. | Node |
| isExpanded()
- :
- BooleanReturns true if this node is expanded Returns true if this node is expanded | TreeNode |
| isFirst()
- :
- BooleanReturns true if this node is the first child of its parent Returns true if this node is the first child of its parent | Node |
| isLast()
- :
- BooleanReturns true if this node is the last child of its parent Returns true if this node is the last child of its parent | Node |
| isLeaf()
- :
- BooleanReturns true if this node is a leaf Returns true if this node is a leaf | Node |
| isSelected()
- :
- BooleanReturns true if this node is selected Returns true if this node is selected | TreeNode |
| item( Number index )
- :
- NodeReturns the child node at the specified index. Returns the child node at the specified index. | Node |
| on( String eventName , Function handler , [Object scope ], [Object options ] )
- :
+node attribute is explicitly specified as true (see attributes), otherwise returns false. | Node |
| isExpanded()
+ :
+ BooleanReturns true if this node is expanded Returns true if this node is expanded | TreeNode |
| isFirst()
+ :
+ BooleanReturns true if this node is the first child of its parent Returns true if this node is the first child of its parent | Node |
| isLast()
+ :
+ BooleanReturns true if this node is the last child of its parent Returns true if this node is the last child of its parent | Node |
| isLeaf()
+ :
+ BooleanReturns true if this node is a leaf Returns true if this node is a leaf | Node |
| isSelected()
+ :
+ BooleanReturns true if this node is selected Returns true if this node is selected | TreeNode |
| item( Number index )
+ :
+ NodeReturns the child node at the specified index. Returns the child node at the specified index. | Node |
| on( String eventName , Function handler , [Object scope ], [Object options ] )
+ :
voidAppends an event handler to this object (shorthand for addListener.) Appends an event handler to this object (shorthand for addListener.) Parameters:eventName : StringThe type of event to listen for handler : FunctionThe method the event invokes scope : Object(optional) The scope (this reference) in which the handler function is executed.
-If omitted, defaults to the object which fired the event. options : Object(optional) An object containing handler configuration. Returns: | Observable |
| purgeListeners()
- :
- voidRemoves all listeners for this object Removes all listeners for this object | Observable |
| relayEvents( Object o , Array events )
- :
- voidRelays 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. | Observable |
| remove()
- :
- NodeRemoves this node from its parent Removes this node from its parent | Node |
| removeChild( Node node )
- :
- NodeRemoves a child node from this node. Removes a child node from this node. Parameters:node : NodeThe node to remove Returns: | Node |
| removeListener( String eventName , Function handler , [Object scope ] )
- :
- voidRemoves an event handler. Removes an event handler. | Observable |
| replaceChild( Node newChild , Node oldChild )
- :
- NodeReplaces one child node in this node with another. Replaces one child node in this node with another. Parameters:newChild : NodeThe replacement node oldChild : NodeThe node to replace Returns: | Node |
| resumeEvents()
- :
- voidResume firing events. (see suspendEvents)
-If events were suspended using the queueSuspended parameter, then all
+If omitted, defaults to the object which fired the event. options : Object(optional) An object containing handler configuration. Returns: | Observable |
| purgeListeners()
+ :
+ voidRemoves all listeners for this object Removes all listeners for this object | Observable |
| relayEvents( Object o , Array events )
+ :
+ voidRelays 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. | Observable |
| remove()
+ :
+ NodeRemoves this node from its parent Removes this node from its parent | Node |
| removeChild( Node node )
+ :
+ NodeRemoves a child node from this node. Removes a child node from this node. Parameters:node : NodeThe node to remove Returns: | Node |
| removeListener( String eventName , Function handler , [Object scope ] )
+ :
+ voidRemoves an event handler. Removes an event handler. | Observable |
| replaceChild( Node newChild , Node oldChild )
+ :
+ NodeReplaces one child node in this node with another. Replaces one child node in this node with another. Parameters:newChild : NodeThe replacement node oldChild : NodeThe node to replace Returns: | Node |
| resumeEvents()
+ :
+ voidResume firing events. (see suspendEvents)
+If events were suspended using the queueSuspended parameter, then all
event... Resume firing events. (see suspendEvents)
If events were suspended using the queueSuspended parameter, then all
-events fired during event suspension will be sent to any listeners now. | Observable |
| select()
- :
- voidTriggers selection of this node Triggers selection of this node | TreeNode |
| setId( String id )
- :
- voidChanges the id of this node. Changes the id of this node. Parameters:id : StringThe new id for the node. Returns: | Node |
| setText( String text )
- :
- voidSets the text for this node Sets the text for this node | TreeNode |
| sort( Function fn , [Object scope ] )
- :
- voidSorts this nodes children using the supplied sort function Sorts this nodes children using the supplied sort function Parameters:fn : Functionscope : Object(optional) Returns: | Node |
| suspendEvents( Boolean queueSuspended )
- :
+events fired during event suspension will be sent to any listeners now. | Observable |
| select()
+ :
+ voidTriggers selection of this node Triggers selection of this node | TreeNode |
| setId( String id )
+ :
+ voidChanges the id of this node. Changes the id of this node. Parameters:id : StringThe new id for the node. Returns: | Node |
| setText( String text )
+ :
+ voidSets the text for this node Sets the text for this node | TreeNode |
| sort( Function fn , [Object scope ] )
+ :
+ voidSorts this nodes children using the supplied sort function Sorts this nodes children using the supplied sort function Parameters:fn : Functionscope : Object(optional) Returns: | Node |
| suspendEvents( Boolean queueSuspended )
+ :
voidSuspend the firing of all events. (see resumeEvents) Suspend the firing of all events. (see resumeEvents) Parameters:queueSuspended : BooleanPass as true to queue up suspended events to be fired
-after the resumeEvents call instead of discarding all suspended events; Returns: | Observable |
| toggle()
- :
- voidToggles expanded/collapsed state of the node Toggles expanded/collapsed state of the node | TreeNode |
| un( String eventName , Function handler , [Object scope ] )
- :
- voidRemoves an event handler (shorthand for removeListener.) | Observable |
| unselect()
- :
- voidTriggers deselection of this node Triggers deselection of this node | TreeNode |