|
| Node( Object attributes )
+ | Node |
| 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 ] )
- :
+Usage:this.addEvents('storeloaded', 'storecleared'); Returns: | 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:
@@ -109,141 +109,144 @@ Or a shorthand syntax:
'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 arguments to the function
-wil... 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. | Node |
| cascade( Function fn , [Object scope ], [Array args ] )
- :
- voidCascades down the tree from this node, calling the specified function with each node. The arguments to the function
-... 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. | Node |
| 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 |
| destroy()
- :
- void | Node |
| eachChild( Function fn , [Object scope ], [Array args ] )
- :
- voidInterates 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:fn : FunctionThe function to call scope : Object(optional) The scope (this reference) in which the function is executed. Defaults to the current Node in the iteration. args : Array(optional) The args to call the function with (default to passing the current Node) Returns: | Node |
| enableBubble( String/Array 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 |
| 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 . | Node |
| fireEvent( String eventName , Object... args )
- :
- BooleanFires the specified event with the passed parameters (minus the event name).
+}); 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 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. | Node |
| cascade( Function fn , [Object scope ], [Array args ] )
+ :
+ voidCascades 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. | Node |
| 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 |
| destroy()
+ :
+ void | Node |
| eachChild( Function fn , [Object scope ], [Array args ] )
+ :
+ voidInterates 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:fn : FunctionThe function to call scope : Object(optional) The scope (this reference) in which the function is executed. Defaults to the current Node in the iteration. args : Array(optional) The args to call the function with (default to passing the current Node) Returns: | Node |
| enableBubble( String/Array 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 |
| findChild( String attribute , Mixed value , [Boolean deep ] )
+ :
+ NodeFinds the first child that has the attribute with the specified value. Finds the first child that has the attribute with the specified value. | Node |
| findChildBy( Function fn , [Object scope ], [Boolean deep ] )
+ :
+ 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 : FunctionA function which must return true if the passed Node is the required Node. scope : Object(optional) The scope (this reference) in which the function is executed. Defaults to the Node being tested. deep : Boolean(Optional) True to search through nodes deeper than the immediate children 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 |
| 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 |
| 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 |
| 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 ] )
- :
+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 |
| 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 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. | Node |
| 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 |
| 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( Boolean destroy )
- :
- NodeRemoves this node from its parent Removes this node from its parent | Node |
| removeChild( Node node , Boolean destroy )
- :
- NodeRemoves a child node from this node. Removes a child node from this node. | 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( Boolean destroy )
+ :
+ NodeRemoves this node from its parent Removes this node from its parent | Node |
| removeAll( Boolean destroy )
+ :
+ NodeRemoves all child nodes from this node. Removes all child nodes from this node. | Node |
| removeChild( Node node , Boolean destroy )
+ :
+ NodeRemoves a child node from this node. Removes a child node from this node. | 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 |
| 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 |
| 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 : FunctionA function which, when passed two Nodes, returns -1, 0 or 1 depending upon required sort order. scope : Object(optional)The scope (this reference) in which the function is executed. Defaults to the browser window. Returns: | Node |
| suspendEvents( Boolean queueSuspended )
- :
+events fired during event suspension will be sent to any listeners now. | Observable |
| 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 |
| 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 : FunctionA function which, when passed two Nodes, returns -1, 0 or 1 depending upon required sort order. scope : Object(optional)The scope (this reference) in which the function is executed. Defaults to the browser window. 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 |
| un( String eventName , Function handler , [Object scope ] )
- :
- voidRemoves an event handler (shorthand for removeListener.) | Observable |