|
| 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 no... 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 | 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 ic... The path to an icon for the node. The preferred way to do this
@@ -117,14 +120,14 @@ 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 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,
+ void Bubbles 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
-... 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,
+ void Cascades 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 |
| 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
@@ -139,44 +142,45 @@ Called with 1 parameter, this node. scope : ObjectDisables this node
| TreeNode |
| 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,
+ 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. 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( 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');
- }
- }
+ 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
@@ -187,11 +191,11 @@ the node into view. Parameters:<
expanding this node completes (does not wait for deep expand to complete).
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 )
+ void | TreeNode |
| 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. Parameters:attribute : StringThe attribute name value : MixedThe value to search for Returns: | Node |
| findChildBy( Function fn , [Object scope ] )
+ 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 . | 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 . 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... Fires the specified event with the passed parameters (minus the event name).
@@ -218,8 +222,8 @@ of {@link Ext.tree.TreeNodeUI} | Returns 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
+ Boolean Returns 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 |
| isExpanded()
:
BooleanReturns true if this node is expanded Returns true if this node is expanded | TreeNode |
| isFirst()
@@ -263,11 +267,21 @@ event... | Observable |
| select()
:
- voidTriggers selection of this node Triggers selection of this node | TreeNode |
| setId( String id )
+ voidTriggers selection of this node Triggers selection of this node | TreeNode |
| setCls( String cls )
+ :
+ voidSets the class on this node. Sets the class on this node. | TreeNode |
| setHref( String href , String (Optional) )
+ :
+ voidSets the href for the node. Sets the href for the node. | TreeNode |
| setIcon( String icon )
+ :
+ voidSets the icon for this node. Sets the icon for this node. | TreeNode |
| setIconCls( String cls )
+ :
+ voidSets the icon class for this node. Sets the icon class for 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 ] )
+ voidSets the text for this node Sets the text for this node | TreeNode |
| setTooltip( String tip , [String title ] )
+ :
+ voidSets the tooltip for this node. Sets the tooltip 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 : 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 )
:
|