|
| allowChildren : Boolean False to not allow this node to have child nodes (defaults to true) | TreeNode |
| allowDrag : BooleanFalse 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 : BooleanTrue to render a checked checkbox for this node, false to render an unchecked checkbox
(defaults to undefined with n... 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 |
| editable : Boolean False to not allow this node to be edited by an (@link Ext.tree.TreeEditor} (defaults to true) | 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 |
| hidden : Boolean True to render hidden. (Defaults to false). | TreeNode |
| href : String URL of the link used for the node (defaults to #) | TreeNode |
| hrefTarget : String target frame for the link | TreeNode |
| icon : StringThe path to an icon for the node. The preferred way to do this
+(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 |
| editable : Boolean | 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 |
| hidden : Boolean True to render hidden. (Defaults to false). | TreeNode |
| href : String URL of the link used for the node (defaults to #) | TreeNode |
| hrefTarget : String target frame for the link | TreeNode |
| icon : StringThe path to an icon for the node. The preferred way to do this
is to use the cls or iconCls attributes and add the i... 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 : ObjectA config object containing one or more event handlers to be added to this
object during initialization. This should ... A config object containing one or more event handlers to be added to this
@@ -117,35 +117,33 @@ Or a shorthand syntax:
:
Node Insert 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
+ void Bubbles 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 ] )
+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
+ void Cascades 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 |
| 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 ] )
+Called with 1 parameter, this node.scope : Object(optional) The scope (this reference) in which the callback is executed. Defaults to this TreeNode. 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()
+ 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 |
| 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
+ void Interates 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. | Node |
| enable()
+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 |
| enable()
:
- void | TreeNode |
| enableBubble( Object events )
+ void | TreeNode |
| 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
@@ -154,13 +152,13 @@ this.getBubbleTarget() if present... Enables events fi
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');
+ // 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() {
+ // We know that we want Field's events to bubble directly to the FormPanel.
+ getBubbleTarget : function() {
if (!this.formPanel) {
this.formPanel = this.findParentByType('form');
}
@@ -175,27 +173,25 @@ access the required target more quickly.
}],
listeners: {
change: function() {
-// Title goes red if form has been modified.
- myForm.header.setStyle("color", "red");
+ // Title goes red if form has been modified.
+ myForm.header.setStyle('color', 'red');
}
}
-});
| Observable |
| ensureVisible( [Function callback ], [Object scope ] )
+}); | 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 ] )
+Called with 1 parameter, this node.scope : Object(optional) The scope (this reference) in which the callback is executed. Defaults to this TreeNode. 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 )
+ 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).
An event may be set to bubble up an Obse... | 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()
+ 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 )
+ 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. Parameters:node : NodeThe node to remove Returns: | Node |
| removeListener( String eventName , Function handler , [Object scope ] )
+ 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 )
:
@@ -265,16 +261,16 @@ events fired during event suspension will be sent to any listeners now.Sets 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 )
+ 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 |
| 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()
+ voidRemoves an event handler (shorthand for removeListener.) | Observable |
| unselect( [Boolean silent ] )
:
- voidTriggers deselection of this node Triggers deselection of this node | TreeNode |