New file |
0,0 → 1,989 |
<div class="body-wrap"> |
<div class="top-tools"> |
<a class="inner-link" href="#Ext.data.Node-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a> |
<a class="inner-link" href="#Ext.data.Node-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a> |
<a class="inner-link" href="#Ext.data.Node-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a> |
<a class="inner-link" href="#Ext.data.Node-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a> |
<a class="bookmark" href="../docs/?class=Ext.data.Node"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a> |
</div> |
<div class="inheritance res-block"> |
<pre class="res-block-inner"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a> |
<img src="resources/elbow-end.gif"/>Node</pre></div> |
<h1>Class Ext.data.Node</h1> |
<table cellspacing="0"> |
<tr><td class="label">Package:</td><td class="hd-info">Ext.data</td></tr> |
<tr><td class="label">Defined In:</td><td class="hd-info"><a href="../source/data/Tree.js" target="_blank">Tree.js</a></td></tr> |
<tr><td class="label">Class:</td><td class="hd-info">Node</td></tr> |
<tr><td class="label">Subclasses:</td><td class="hd-info"><a ext:cls="Ext.tree.TreeNode" href="output/Ext.tree.TreeNode.html">TreeNode</a></td></tr> |
<tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a></td></tr> |
</table> |
<div class="description"> |
</div> |
|
<div class="hr"></div> |
<a id="Ext.data.Node-configs"></a> |
<h2>Config Options</h2> |
<table cellspacing="0" class="member-table"> |
<tr> |
<th class="sig-header" colspan="2">Config Options</th> |
<th class="msource-header">Defined By</th> |
</tr> |
<tr class="config-row"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-id"></a> |
<b>id</b> : String <div class="mdesc"> |
The id for this node. If one is not specified, one is generated. </div> |
</td> |
<td class="msource">Node</td> |
</tr> |
<tr class="config-row alt"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-leaf"></a> |
<b>leaf</b> : Boolean <div class="mdesc"> |
true if this node is a leaf and does not have children </div> |
</td> |
<td class="msource">Node</td> |
</tr> |
<tr class="config-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-listeners"></a> |
<b>listeners</b> : Object <div class="mdesc"> |
<div class="short">A config object containing one or more event handlers to be added to this object during initialization. This should b...</div> |
<div class="long"> |
A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the <a ext:cls="Ext.util.Observable" ext:member="addListener" href="output/Ext.util.Observable.html#addListener">addListener</a> example for attaching multiple handlers at once. </div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td> |
</tr> |
</table> |
<a id="Ext.data.Node-props"></a> |
<h2>Public Properties</h2> |
<table cellspacing="0" class="member-table"> |
<tr> |
<th class="sig-header" colspan="2">Property</th> |
<th class="msource-header">Defined By</th> |
</tr> |
<tr class="property-row"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-attributes"></a> |
<b>attributes</b> : Object <div class="mdesc"> |
The attributes supplied for the node. You can use this property to access any custom attributes you supplied. </div> |
</td> |
<td class="msource">Node</td> |
</tr> |
<tr class="property-row alt"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-childNodes"></a> |
<b>childNodes</b> : Array <div class="mdesc"> |
All child nodes of this node. </div> |
</td> |
<td class="msource">Node</td> |
</tr> |
<tr class="property-row"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-firstChild"></a> |
<b>firstChild</b> : Node <div class="mdesc"> |
The first direct child node of this node, or null if this node has no child nodes. </div> |
</td> |
<td class="msource">Node</td> |
</tr> |
<tr class="property-row alt"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-id"></a> |
<b>id</b> : String <div class="mdesc"> |
The node id. </div> |
</td> |
<td class="msource">Node</td> |
</tr> |
<tr class="property-row"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-lastChild"></a> |
<b>lastChild</b> : Node <div class="mdesc"> |
The last direct child node of this node, or null if this node has no child nodes. </div> |
</td> |
<td class="msource">Node</td> |
</tr> |
<tr class="property-row alt"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-nextSibling"></a> |
<b>nextSibling</b> : Node <div class="mdesc"> |
The node immediately following this node in the tree, or null if there is no sibling node. </div> |
</td> |
<td class="msource">Node</td> |
</tr> |
<tr class="property-row"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-parentNode"></a> |
<b>parentNode</b> : Node <div class="mdesc"> |
The parent node for this node. </div> |
</td> |
<td class="msource">Node</td> |
</tr> |
<tr class="property-row alt"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-previousSibling"></a> |
<b>previousSibling</b> : Node <div class="mdesc"> |
The node immediately preceding this node in the tree, or null if there is no sibling node. </div> |
</td> |
<td class="msource">Node</td> |
</tr> |
</table> |
<a id="Ext.data.Node-methods"></a> |
<h2>Public Methods</h2> |
<table cellspacing="0" class="member-table"> |
<tr> |
<th class="sig-header" colspan="2">Method</th> |
<th class="msource-header">Defined By</th> |
</tr> |
<tr class="method-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-Node"></a> |
<b>Node</b>( <code>Object attributes</code> ) <div class="mdesc"> |
<div class="short"></div> |
<div class="long"> |
<div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>attributes</code> : Object<div class="sub-desc">The attributes/config for the node</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code></code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource">Node</td> |
</tr> |
<tr class="method-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-addEvents"></a> |
<b>addEvents</b>( <code>Object object</code> ) : void <div class="mdesc"> |
<div class="short">Used to define events on this Observable</div> |
<div class="long"> |
Used to define events on this Observable <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td> |
</tr> |
<tr class="method-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-addListener"></a> |
<b>addListener</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span> ) : void <div class="mdesc"> |
<div class="short">Appends an event handler to this component</div> |
<div class="long"> |
Appends an event handler to this component <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler |
function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration |
properties. This may contain any of the following properties:<ul> |
<li><b>scope</b> : Object<p class="sub-desc">The scope in which to execute the handler function. The handler function's "this" context.</p></li> |
<li><b>delay</b> : Number<p class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</p></li> |
<li><b>single</b> : Boolean<p class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</p></li> |
<li><b>buffer</b> : Number<p class="sub-desc">Causes the handler to be scheduled to run in an <a ext:cls="Ext.util.DelayedTask" href="output/Ext.util.DelayedTask.html">Ext.util.DelayedTask</a> delayed |
by the specified number of milliseconds. If the event fires again within that time, the original |
handler is <em>not</em> invoked, but the new handler is scheduled in its place.</p></li> |
</ul><br> |
<p> |
<b>Combining Options</b><br> |
Using the options argument, it is possible to combine different types of listeners:<br> |
<br> |
A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId) |
<pre><code>el.on(<em>'click'</em>, <b>this</b>.onClick, <b>this</b>, { |
single: true, |
delay: 100, |
forumId: 4 |
});</code></pre> |
<p> |
<b>Attaching multiple handlers in 1 call</b><br> |
The method also allows for a single argument to be passed which is a config object containing properties |
which specify multiple handlers. |
<p> |
<pre><code>foo.on({ |
<em>'click'</em> : { |
fn: <b>this</b>.onClick, |
scope: <b>this</b>, |
delay: 100 |
}, |
<em>'mouseover'</em> : { |
fn: <b>this</b>.onMouseOver, |
scope: <b>this</b> |
}, |
<em>'mouseout'</em> : { |
fn: <b>this</b>.onMouseOut, |
scope: <b>this</b> |
} |
});</code></pre> |
<p> |
Or a shorthand syntax:<br> |
<pre><code>foo.on({ |
<em>'click'</em> : <b>this</b>.onClick, |
<em>'mouseover'</em> : <b>this</b>.onMouseOver, |
<em>'mouseout'</em> : <b>this</b>.onMouseOut, |
scope: <b>this</b> |
});</code></pre></div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td> |
</tr> |
<tr class="method-row alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-appendChild"></a> |
<b>appendChild</b>( <code>Node/Array node</code> ) : Node <div class="mdesc"> |
<div class="short">Insert node(s) as the last child node of this node.</div> |
<div class="long"> |
Insert node(s) as the last child node of this node. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>node</code> : Node/Array<div class="sub-desc">The node or Array of nodes to append</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>Node</code><div class="sub-desc">The appended node if single append, or null if an array was passed</div></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource">Node</td> |
</tr> |
<tr class="method-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-bubble"></a> |
<b>bubble</b>( <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Array args</code>]</span> ) : void <div class="mdesc"> |
<div class="short">Bubbles up the tree from this node, calling the specified function with each node. The scope (this) of |
function call ...</div> |
<div class="long"> |
Bubbles up the tree from this node, calling the specified function with each node. The scope (<i>this</i>) 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. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>fn</code> : Function<div class="sub-desc">The function to call</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope of the function (defaults to current node)</div></li><li><code>args</code> : Array<div class="sub-desc">(optional) The args to call the function with (default to passing the current node)</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource">Node</td> |
</tr> |
<tr class="method-row alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-cascade"></a> |
<b>cascade</b>( <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Array args</code>]</span> ) : void <div class="mdesc"> |
<div class="short">Cascades down the tree from this node, calling the specified function with each node. The scope (this) of |
function ca...</div> |
<div class="long"> |
Cascades down the tree from this node, calling the specified function with each node. The scope (<i>this</i>) 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. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>fn</code> : Function<div class="sub-desc">The function to call</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope of the function (defaults to current node)</div></li><li><code>args</code> : Array<div class="sub-desc">(optional) The args to call the function with (default to passing the current node)</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource">Node</td> |
</tr> |
<tr class="method-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-contains"></a> |
<b>contains</b>( <code>Node node</code> ) : Boolean <div class="mdesc"> |
<div class="short">Returns true if this node is an ancestor (at any point) of the passed node.</div> |
<div class="long"> |
Returns true if this node is an ancestor (at any point) of the passed node. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>node</code> : Node<div class="sub-desc"></div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>Boolean</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource">Node</td> |
</tr> |
<tr class="method-row alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-eachChild"></a> |
<b>eachChild</b>( <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Array args</code>]</span> ) : void <div class="mdesc"> |
<div class="short">Interates the child nodes of this node, calling the specified function with each node. The scope (this) of |
function c...</div> |
<div class="long"> |
Interates the child nodes of this node, calling the specified function with each node. The scope (<i>this</i>) 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. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>fn</code> : Function<div class="sub-desc">The function to call</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope of the function (defaults to current node)</div></li><li><code>args</code> : Array<div class="sub-desc">(optional) The args to call the function with (default to passing the current node)</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource">Node</td> |
</tr> |
<tr class="method-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-findChild"></a> |
<b>findChild</b>( <code>String attribute</code>, <code>Mixed value</code> ) : Node <div class="mdesc"> |
<div class="short">Finds the first child that has the attribute with the specified value.</div> |
<div class="long"> |
Finds the first child that has the attribute with the specified value. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>attribute</code> : String<div class="sub-desc">The attribute name</div></li><li><code>value</code> : Mixed<div class="sub-desc">The value to search for</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>Node</code><div class="sub-desc">The found child or null if none was found</div></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource">Node</td> |
</tr> |
<tr class="method-row alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-findChildBy"></a> |
<b>findChildBy</b>( <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : Node <div class="mdesc"> |
<div class="short">Finds the first child by a custom function. The child matches if the function passed |
returns true.</div> |
<div class="long"> |
Finds the first child by a custom function. The child matches if the function passed |
returns true. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>fn</code> : Function<div class="sub-desc"></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional)</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>Node</code><div class="sub-desc">The found child or null if none was found</div></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource">Node</td> |
</tr> |
<tr class="method-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-fireEvent"></a> |
<b>fireEvent</b>( <code>String eventName</code>, <code>Object... args</code> ) : Boolean <div class="mdesc"> |
<div class="short">Fires the specified event with the passed parameters (minus the event name).</div> |
<div class="long"> |
Fires the specified event with the passed parameters (minus the event name). <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>eventName</code> : String<div class="sub-desc"></div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td> |
</tr> |
<tr class="method-row alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-getDepth"></a> |
<b>getDepth</b>() : Number <div class="mdesc"> |
<div class="short">Returns depth of this node (the root node has a depth of 0)</div> |
<div class="long"> |
Returns depth of this node (the root node has a depth of 0) <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li>None.</li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>Number</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource">Node</td> |
</tr> |
<tr class="method-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-getOwnerTree"></a> |
<b>getOwnerTree</b>() : Tree <div class="mdesc"> |
<div class="short">Returns the tree this node is in.</div> |
<div class="long"> |
Returns the tree this node is in. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li>None.</li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>Tree</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource">Node</td> |
</tr> |
<tr class="method-row alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-getPath"></a> |
<b>getPath</b>( <span class="optional" title="Optional">[<code>String attr</code>]</span> ) : String <div class="mdesc"> |
<div class="short">Returns the path for this node. The path can be used to expand or select this node programmatically.</div> |
<div class="long"> |
Returns the path for this node. The path can be used to expand or select this node programmatically. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>attr</code> : String<div class="sub-desc">(optional) The attr to use for the path (defaults to the node's id)</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>String</code><div class="sub-desc">The path</div></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource">Node</td> |
</tr> |
<tr class="method-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-hasListener"></a> |
<b>hasListener</b>( <code>String eventName</code> ) : Boolean <div class="mdesc"> |
<div class="short">Checks to see if this object has any listeners for a specified event</div> |
<div class="long"> |
Checks to see if this object has any listeners for a specified event <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td> |
</tr> |
<tr class="method-row alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-indexOf"></a> |
<b>indexOf</b>( <code>Node node</code> ) : Number <div class="mdesc"> |
<div class="short">Returns the index of a child node</div> |
<div class="long"> |
Returns the index of a child node <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>node</code> : Node<div class="sub-desc"></div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>Number</code><div class="sub-desc">The index of the node or -1 if it was not found</div></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource">Node</td> |
</tr> |
<tr class="method-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-insertBefore"></a> |
<b>insertBefore</b>( <code>Node node</code>, <code>Node refNode</code> ) : Node <div class="mdesc"> |
<div class="short">Inserts the first node before the second node in this nodes childNodes collection.</div> |
<div class="long"> |
Inserts the first node before the second node in this nodes childNodes collection. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>node</code> : Node<div class="sub-desc">The node to insert</div></li><li><code>refNode</code> : Node<div class="sub-desc">The node to insert before (if null the node is appended)</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>Node</code><div class="sub-desc">The inserted node</div></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource">Node</td> |
</tr> |
<tr class="method-row alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-isAncestor"></a> |
<b>isAncestor</b>( <code>Node node</code> ) : Boolean <div class="mdesc"> |
<div class="short">Returns true if the passed node is an ancestor (at any point) of this node.</div> |
<div class="long"> |
Returns true if the passed node is an ancestor (at any point) of this node. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>node</code> : Node<div class="sub-desc"></div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>Boolean</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource">Node</td> |
</tr> |
<tr class="method-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-isFirst"></a> |
<b>isFirst</b>() : Boolean <div class="mdesc"> |
<div class="short">Returns true if this node is the first child of its parent</div> |
<div class="long"> |
Returns true if this node is the first child of its parent <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li>None.</li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>Boolean</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource">Node</td> |
</tr> |
<tr class="method-row alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-isLast"></a> |
<b>isLast</b>() : Boolean <div class="mdesc"> |
<div class="short">Returns true if this node is the last child of its parent</div> |
<div class="long"> |
Returns true if this node is the last child of its parent <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li>None.</li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>Boolean</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource">Node</td> |
</tr> |
<tr class="method-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-isLeaf"></a> |
<b>isLeaf</b>() : Boolean <div class="mdesc"> |
<div class="short">Returns true if this node is a leaf</div> |
<div class="long"> |
Returns true if this node is a leaf <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li>None.</li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>Boolean</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource">Node</td> |
</tr> |
<tr class="method-row alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-item"></a> |
<b>item</b>( <code>Number index</code> ) : Node <div class="mdesc"> |
<div class="short">Returns the child node at the specified index.</div> |
<div class="long"> |
Returns the child node at the specified index. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>index</code> : Number<div class="sub-desc"></div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>Node</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource">Node</td> |
</tr> |
<tr class="method-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-on"></a> |
<b>on</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span> ) : void <div class="mdesc"> |
<div class="short">Appends an event handler to this element (shorthand for addListener)</div> |
<div class="long"> |
Appends an event handler to this element (shorthand for addListener) <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler |
function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td> |
</tr> |
<tr class="method-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-purgeListeners"></a> |
<b>purgeListeners</b>() : void <div class="mdesc"> |
<div class="short">Removes all listeners for this object</div> |
<div class="long"> |
Removes all listeners for this object <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li>None.</li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td> |
</tr> |
<tr class="method-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-remove"></a> |
<b>remove</b>() : Node <div class="mdesc"> |
<div class="short">Removes this node from it's parent</div> |
<div class="long"> |
Removes this node from it's parent <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li>None.</li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>Node</code><div class="sub-desc">this</div></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource">Node</td> |
</tr> |
<tr class="method-row alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-removeChild"></a> |
<b>removeChild</b>( <code>Node node</code> ) : Node <div class="mdesc"> |
<div class="short">Removes a child node from this node.</div> |
<div class="long"> |
Removes a child node from this node. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>node</code> : Node<div class="sub-desc">The node to remove</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>Node</code><div class="sub-desc">The removed node</div></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource">Node</td> |
</tr> |
<tr class="method-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-removeListener"></a> |
<b>removeListener</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc"> |
<div class="short">Removes a listener</div> |
<div class="long"> |
Removes a listener <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td> |
</tr> |
<tr class="method-row alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-replaceChild"></a> |
<b>replaceChild</b>( <code>Node newChild</code>, <code>Node oldChild</code> ) : Node <div class="mdesc"> |
<div class="short">Replaces one child node in this node with another.</div> |
<div class="long"> |
Replaces one child node in this node with another. <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>newChild</code> : Node<div class="sub-desc">The replacement node</div></li><li><code>oldChild</code> : Node<div class="sub-desc">The node to replace</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>Node</code><div class="sub-desc">The replaced node</div></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource">Node</td> |
</tr> |
<tr class="method-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-resumeEvents"></a> |
<b>resumeEvents</b>() : void <div class="mdesc"> |
<div class="short">Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>)</div> |
<div class="long"> |
Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>) <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li>None.</li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td> |
</tr> |
<tr class="method-row alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-sort"></a> |
<b>sort</b>( <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc"> |
<div class="short">Sorts this nodes children using the supplied sort function</div> |
<div class="long"> |
Sorts this nodes children using the supplied sort function <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>fn</code> : Function<div class="sub-desc"></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional)</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource">Node</td> |
</tr> |
<tr class="method-row inherited expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-suspendEvents"></a> |
<b>suspendEvents</b>() : void <div class="mdesc"> |
<div class="short">Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>)</div> |
<div class="long"> |
Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>) <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li>None.</li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td> |
</tr> |
<tr class="method-row inherited alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-un"></a> |
<b>un</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc"> |
<div class="short">Removes a listener (shorthand for removeListener)</div> |
<div class="long"> |
Removes a listener (shorthand for removeListener) <div class="mdetail-params"> |
<strong>Parameters:</strong> |
<ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li> </ul> |
<strong>Returns:</strong> |
<ul> |
<li><code>void</code></li> |
</ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td> |
</tr> |
</table> |
<a id="Ext.data.Node-events"></a> |
<h2>Public Events</h2> |
<table cellspacing="0" class="member-table"> |
<tr> |
<th class="sig-header" colspan="2">Event</th> |
<th class="msource-header">Defined By</th> |
</tr> |
<tr class="event-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-append"></a> |
<b>append</b> : ( <code>Tree tree</code>, <code>Node this</code>, <code>Node node</code>, <code>Number index</code> ) <div class="mdesc"> |
<div class="short">Fires when a new child node is appended</div> |
<div class="long"> |
Fires when a new child node is appended <div class="mdetail-params"> |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong> |
<ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>this</code> : Node<div class="sub-desc">This node</div></li><li><code>node</code> : Node<div class="sub-desc">The newly appended node</div></li><li><code>index</code> : Number<div class="sub-desc">The index of the newly appended node</div></li> </ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource">Node</td> |
</tr> |
<tr class="event-row alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-beforeappend"></a> |
<b>beforeappend</b> : ( <code>Tree tree</code>, <code>Node this</code>, <code>Node node</code> ) <div class="mdesc"> |
<div class="short">Fires before a new child is appended, return false to cancel the append.</div> |
<div class="long"> |
Fires before a new child is appended, return false to cancel the append. <div class="mdetail-params"> |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong> |
<ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>this</code> : Node<div class="sub-desc">This node</div></li><li><code>node</code> : Node<div class="sub-desc">The child node to be appended</div></li> </ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource">Node</td> |
</tr> |
<tr class="event-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-beforeinsert"></a> |
<b>beforeinsert</b> : ( <code>Tree tree</code>, <code>Node this</code>, <code>Node node</code>, <code>Node refNode</code> ) <div class="mdesc"> |
<div class="short">Fires before a new child is inserted, return false to cancel the insert.</div> |
<div class="long"> |
Fires before a new child is inserted, return false to cancel the insert. <div class="mdetail-params"> |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong> |
<ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>this</code> : Node<div class="sub-desc">This node</div></li><li><code>node</code> : Node<div class="sub-desc">The child node to be inserted</div></li><li><code>refNode</code> : Node<div class="sub-desc">The child node the node is being inserted before</div></li> </ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource">Node</td> |
</tr> |
<tr class="event-row alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-beforemove"></a> |
<b>beforemove</b> : ( <code>Tree tree</code>, <code>Node this</code>, <code>Node oldParent</code>, <code>Node newParent</code>, <code>Number index</code> ) <div class="mdesc"> |
<div class="short">Fires before this node is moved to a new location in the tree. Return false to cancel the move.</div> |
<div class="long"> |
Fires before this node is moved to a new location in the tree. Return false to cancel the move. <div class="mdetail-params"> |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong> |
<ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>this</code> : Node<div class="sub-desc">This node</div></li><li><code>oldParent</code> : Node<div class="sub-desc">The parent of this node</div></li><li><code>newParent</code> : Node<div class="sub-desc">The new parent this node is moving to</div></li><li><code>index</code> : Number<div class="sub-desc">The index it is being moved to</div></li> </ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource">Node</td> |
</tr> |
<tr class="event-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-beforeremove"></a> |
<b>beforeremove</b> : ( <code>Tree tree</code>, <code>Node this</code>, <code>Node node</code> ) <div class="mdesc"> |
<div class="short">Fires before a child is removed, return false to cancel the remove.</div> |
<div class="long"> |
Fires before a child is removed, return false to cancel the remove. <div class="mdetail-params"> |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong> |
<ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>this</code> : Node<div class="sub-desc">This node</div></li><li><code>node</code> : Node<div class="sub-desc">The child node to be removed</div></li> </ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource">Node</td> |
</tr> |
<tr class="event-row alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-insert"></a> |
<b>insert</b> : ( <code>Tree tree</code>, <code>Node this</code>, <code>Node node</code>, <code>Node refNode</code> ) <div class="mdesc"> |
<div class="short">Fires when a new child node is inserted.</div> |
<div class="long"> |
Fires when a new child node is inserted. <div class="mdetail-params"> |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong> |
<ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>this</code> : Node<div class="sub-desc">This node</div></li><li><code>node</code> : Node<div class="sub-desc">The child node inserted</div></li><li><code>refNode</code> : Node<div class="sub-desc">The child node the node was inserted before</div></li> </ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource">Node</td> |
</tr> |
<tr class="event-row expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-move"></a> |
<b>move</b> : ( <code>Tree tree</code>, <code>Node this</code>, <code>Node oldParent</code>, <code>Node newParent</code>, <code>Number index</code> ) <div class="mdesc"> |
<div class="short">Fires when this node is moved to a new location in the tree</div> |
<div class="long"> |
Fires when this node is moved to a new location in the tree <div class="mdetail-params"> |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong> |
<ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>this</code> : Node<div class="sub-desc">This node</div></li><li><code>oldParent</code> : Node<div class="sub-desc">The old parent of this node</div></li><li><code>newParent</code> : Node<div class="sub-desc">The new parent of this node</div></li><li><code>index</code> : Number<div class="sub-desc">The index it was moved to</div></li> </ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource">Node</td> |
</tr> |
<tr class="event-row alt expandable"> |
<td class="micon"><a class="exi" href="#expand"> </a></td> |
<td class="sig"> |
<a id="Ext.data.Node-remove"></a> |
<b>remove</b> : ( <code>Tree tree</code>, <code>Node this</code>, <code>Node node</code> ) <div class="mdesc"> |
<div class="short">Fires when a child node is removed</div> |
<div class="long"> |
Fires when a child node is removed <div class="mdetail-params"> |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong> |
<ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>this</code> : Node<div class="sub-desc">This node</div></li><li><code>node</code> : Node<div class="sub-desc">The removed node</div></li> </ul> |
</div> |
</div> |
</div> |
</td> |
<td class="msource">Node</td> |
</tr> |
</table> |
|
</div> |