Upgrade to ExtJS 3.3.0 - Released 10/06/2010
[extjs.git] / docs / output / Ext.tree.TreeNode.html
index fa33008..6256b3c 100644 (file)
@@ -1,4 +1,4 @@
-<div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.tree.TreeNode-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.tree.TreeNode-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.tree.TreeNode-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="inner-link" href="#Ext.tree.TreeNode-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>&#13;<a class="bookmark" href="../docs/?class=Ext.tree.TreeNode"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><div class="inheritance res-block"><pre class="res-block-inner"><a href="output/Ext.util.Observable.html" ext:member="" ext:cls="Ext.util.Observable">Observable</a>&#13;&nbsp;&nbsp;<img src="resources/elbow-end.gif"><a href="output/Ext.data.Node.html" ext:member="" ext:cls="Ext.data.Node">Node</a>&#13;&nbsp;&nbsp;&nbsp;&nbsp;<img src="resources/elbow-end.gif">TreeNode</pre></div><h1>Class <a href="source/TreeNode.html#cls-Ext.tree.TreeNode">Ext.tree.TreeNode</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.tree</td></tr><tr><td class="label">Defined In:</td><td class="hd-info"><a href="source/TreeNode.html#cls-Ext.tree.TreeNode">TreeNode.js</a></td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/TreeNode.html#cls-Ext.tree.TreeNode">TreeNode</a></td></tr><tr><td class="label">Subclasses:</td><td class="hd-info"><a href="output/Ext.tree.AsyncTreeNode.html" ext:cls="Ext.tree.AsyncTreeNode">AsyncTreeNode</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.data.Node.html" ext:cls="Ext.data.Node" ext:member="">Node</a></td></tr></table><div class="description"></div><div class="hr"></div><a id="Ext.tree.TreeNode-configs"></a><h2>Config Options</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Config Options</th><th class="msource-header">Defined By</th></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.tree.TreeNode-allowChildren"></a><b><a href="source/TreeNode.html#cfg-Ext.tree.TreeNode-allowChildren">allowChildren</a></b> : Boolean<div class="mdesc">False to not allow this node to have child nodes (defaults to true)</div></td><td class="msource">TreeNode</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.tree.TreeNode-allowDrag"></a><b><a href="source/TreeNode.html#cfg-Ext.tree.TreeNode-allowDrag">allowDrag</a></b> : Boolean<div class="mdesc">False to make this node undraggable if <a href="output/Ext.tree.TreeNode.html#Ext.tree.TreeNode-draggable" ext:member="draggable" ext:cls="Ext.tree.TreeNode">draggable</a> = true (defaults to true)</div></td><td class="msource">TreeNode</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.tree.TreeNode-allowDrop"></a><b><a href="source/TreeNode.html#cfg-Ext.tree.TreeNode-allowDrop">allowDrop</a></b> : Boolean<div class="mdesc">False if this node cannot have child nodes dropped on it (defaults to true)</div></td><td class="msource">TreeNode</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.tree.TreeNode-checked"></a><b><a href="source/TreeNode.html#cfg-Ext.tree.TreeNode-checked">checked</a></b> : Boolean<div class="mdesc"><div class="short">True to render a checked checkbox for this node, false to render an unchecked checkbox
+<div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.tree.TreeNode-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.tree.TreeNode-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.tree.TreeNode-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="inner-link" href="#Ext.tree.TreeNode-configs"><img src="resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>&#13;<a class="bookmark" href="../docs/?class=Ext.tree.TreeNode"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><div class="inheritance res-block"><pre class="res-block-inner"><a href="output/Ext.util.Observable.html" ext:member="" ext:cls="Ext.util.Observable">Observable</a>&#13;&nbsp;&nbsp;<img src="resources/elbow-end.gif"><a href="output/Ext.data.Node.html" ext:member="" ext:cls="Ext.data.Node">Node</a>&#13;&nbsp;&nbsp;&nbsp;&nbsp;<img src="resources/elbow-end.gif">TreeNode</pre></div><h1>Class <a href="source/TreeNode.html#cls-Ext.tree.TreeNode">Ext.tree.TreeNode</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.tree</td></tr><tr><td class="label">Defined In:</td><td class="hd-info"><a href="source/TreeNode.html#cls-Ext.tree.TreeNode">TreeNode.js</a></td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/TreeNode.html#cls-Ext.tree.TreeNode">TreeNode</a></td></tr><tr><td class="label">Subclasses:</td><td class="hd-info"><a href="output/Ext.tree.AsyncTreeNode.html" ext:cls="Ext.tree.AsyncTreeNode">AsyncTreeNode</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.data.Node.html" ext:cls="Ext.data.Node" ext:member="">Node</a></td></tr></table><div class="description"></div><div class="hr"></div><a id="Ext.tree.TreeNode-configs"></a><h2>Config Options</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Config Options</th><th class="msource-header">Defined By</th></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.tree.TreeNode-allowChildren"></a><b><a href="source/TreeNode.html#cfg-Ext.tree.TreeNode-allowChildren">allowChildren</a></b> : Boolean<div class="mdesc">False to not allow this node to have child nodes (defaults to true)</div></td><td class="msource">TreeNode</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.tree.TreeNode-allowDrag"></a><b><a href="source/TreeNode.html#cfg-Ext.tree.TreeNode-allowDrag">allowDrag</a></b> : Boolean<div class="mdesc">False to make this node undraggable if <a href="output/Ext.tree.TreeNode.html#Ext.tree.TreeNode-draggable" ext:member="draggable" ext:cls="Ext.tree.TreeNode">draggable</a> = true (defaults to true)</div></td><td class="msource">TreeNode</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.tree.TreeNode-allowDrop"></a><b><a href="source/TreeNode.html#cfg-Ext.tree.TreeNode-allowDrop">allowDrop</a></b> : Boolean<div class="mdesc">False if this node cannot have child nodes dropped on it (defaults to true)</div></td><td class="msource">TreeNode</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.tree.TreeNode-checked"></a><b><a href="source/TreeNode.html#cfg-Ext.tree.TreeNode-checked">checked</a></b> : Boolean<div class="mdesc"><div class="short">True to render a checked checkbox for this node, false to render an unchecked checkbox
 (defaults to undefined with no...</div><div class="long">True to render a checked checkbox for this node, false to render an unchecked checkbox
 (defaults to undefined with no checkbox rendered)</div></div></td><td class="msource">TreeNode</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.tree.TreeNode-cls"></a><b><a href="source/TreeNode.html#cfg-Ext.tree.TreeNode-cls">cls</a></b> : String<div class="mdesc">A css class to be added to the node</div></td><td class="msource">TreeNode</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.tree.TreeNode-disabled"></a><b><a href="source/TreeNode.html#cfg-Ext.tree.TreeNode-disabled">disabled</a></b> : Boolean<div class="mdesc">true to start the node disabled</div></td><td class="msource">TreeNode</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.tree.TreeNode-draggable"></a><b><a href="source/TreeNode.html#cfg-Ext.tree.TreeNode-draggable">draggable</a></b> : Boolean<div class="mdesc">True to make this node draggable (defaults to false)</div></td><td class="msource">TreeNode</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.tree.TreeNode-editable"></a><b><a href="source/TreeNode.html#cfg-Ext.tree.TreeNode-editable">editable</a></b> : Boolean<div class="mdesc">False to not allow this node to be edited by an <a href="output/Ext.tree.TreeEditor.html" ext:cls="Ext.tree.TreeEditor">Ext.tree.TreeEditor</a> (defaults to true)</div></td><td class="msource">TreeNode</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.tree.TreeNode-expandable"></a><b><a href="source/TreeNode.html#cfg-Ext.tree.TreeNode-expandable">expandable</a></b> : Boolean<div class="mdesc">If set to true, the node will always show a plus/minus icon, even when empty</div></td><td class="msource">TreeNode</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.tree.TreeNode-expanded"></a><b><a href="source/TreeNode.html#cfg-Ext.tree.TreeNode-expanded">expanded</a></b> : Boolean<div class="mdesc">true to start the node expanded</div></td><td class="msource">TreeNode</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.tree.TreeNode-hidden"></a><b><a href="source/TreeNode.html#cfg-Ext.tree.TreeNode-hidden">hidden</a></b> : Boolean<div class="mdesc">True to render hidden. (Defaults to false).</div></td><td class="msource">TreeNode</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.tree.TreeNode-href"></a><b><a href="source/TreeNode.html#cfg-Ext.tree.TreeNode-href">href</a></b> : String<div class="mdesc">URL of the link used for the node (defaults to #)</div></td><td class="msource">TreeNode</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.tree.TreeNode-hrefTarget"></a><b><a href="source/TreeNode.html#cfg-Ext.tree.TreeNode-hrefTarget">hrefTarget</a></b> : String<div class="mdesc">target frame for the link</div></td><td class="msource">TreeNode</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.tree.TreeNode-icon"></a><b><a href="source/TreeNode.html#cfg-Ext.tree.TreeNode-icon">icon</a></b> : String<div class="mdesc"><div class="short">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 ic...</div><div class="long">The path to an icon for the node. The preferred way to do this
@@ -258,11 +258,21 @@ event...</div><div class="long">Resume firing events. (see <a href="output/Ext.u
 If events were suspended using the <tt><b>queueSuspended</b></tt> parameter, then all
 events fired during event suspension will be sent to any listeners now.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#resumeEvents" ext:member="#resumeEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.tree.TreeNode-select"></a><b><a href="source/TreeNode.html#method-Ext.tree.TreeNode-select">select</a></b>()
     :
-                                        void<div class="mdesc"><div class="short">Triggers selection of this node</div><div class="long">Triggers selection of this node<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">TreeNode</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Node-setId"></a><b><a href="source/Tree.html#method-Ext.data.Node-setId">setId</a></b>(&nbsp;<code>String&nbsp;id</code>&nbsp;)
+                                        void<div class="mdesc"><div class="short">Triggers selection of this node</div><div class="long">Triggers selection of this node<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">TreeNode</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.tree.TreeNode-setCls"></a><b><a href="source/TreeNode.html#method-Ext.tree.TreeNode-setCls">setCls</a></b>(&nbsp;<code>String&nbsp;cls</code>&nbsp;)
+    :
+                                        void<div class="mdesc"><div class="short">Sets the class on this node.</div><div class="long">Sets the class on this node.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>cls</code> : String<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">TreeNode</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.tree.TreeNode-setHref"></a><b><a href="source/TreeNode.html#method-Ext.tree.TreeNode-setHref">setHref</a></b>(&nbsp;<code>String&nbsp;href</code>,&nbsp;<code>String&nbsp;(Optional)</code>&nbsp;)
+    :
+                                        void<div class="mdesc"><div class="short">Sets the href for the node.</div><div class="long">Sets the href for the node.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>href</code> : String<div class="sub-desc">The href to set</div></li><li><code>(Optional)</code> : String<div class="sub-desc">target The target of the href</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">TreeNode</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.tree.TreeNode-setIcon"></a><b><a href="source/TreeNode.html#method-Ext.tree.TreeNode-setIcon">setIcon</a></b>(&nbsp;<code>String&nbsp;icon</code>&nbsp;)
+    :
+                                        void<div class="mdesc"><div class="short">Sets the icon for this node.</div><div class="long">Sets the icon for this node.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>icon</code> : String<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">TreeNode</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.tree.TreeNode-setIconCls"></a><b><a href="source/TreeNode.html#method-Ext.tree.TreeNode-setIconCls">setIconCls</a></b>(&nbsp;<code>String&nbsp;cls</code>&nbsp;)
+    :
+                                        void<div class="mdesc"><div class="short">Sets the icon class for this node.</div><div class="long">Sets the icon class for this node.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>cls</code> : String<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">TreeNode</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Node-setId"></a><b><a href="source/Tree.html#method-Ext.data.Node-setId">setId</a></b>(&nbsp;<code>String&nbsp;id</code>&nbsp;)
     :
                                         void<div class="mdesc"><div class="short">Changes the id of this node.</div><div class="long">Changes the id of this node.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>id</code> : String<div class="sub-desc">The new id for the node.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Node.html#setId" ext:member="#setId" ext:cls="Ext.data.Node">Node</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.tree.TreeNode-setText"></a><b><a href="source/TreeNode.html#method-Ext.tree.TreeNode-setText">setText</a></b>(&nbsp;<code>String&nbsp;text</code>&nbsp;)
     :
-                                        void<div class="mdesc"><div class="short">Sets the text for this node</div><div class="long">Sets the text for this node<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>text</code> : String<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">TreeNode</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Node-sort"></a><b><a href="source/Tree.html#method-Ext.data.Node-sort">sort</a></b>(&nbsp;<code>Function&nbsp;fn</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>&nbsp;)
+                                        void<div class="mdesc"><div class="short">Sets the text for this node</div><div class="long">Sets the text for this node<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>text</code> : String<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">TreeNode</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.tree.TreeNode-setTooltip"></a><b><a href="source/TreeNode.html#method-Ext.tree.TreeNode-setTooltip">setTooltip</a></b>(&nbsp;<code>String&nbsp;tip</code>,&nbsp;<span title="Optional" class="optional">[<code>String&nbsp;title</code>]</span>&nbsp;)
+    :
+                                        void<div class="mdesc"><div class="short">Sets the tooltip for this node.</div><div class="long">Sets the tooltip for this node.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>tip</code> : String<div class="sub-desc">The text for the tip</div></li><li><code>title</code> : String<div class="sub-desc">(Optional) The title for the tip</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">TreeNode</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Node-sort"></a><b><a href="source/Tree.html#method-Ext.data.Node-sort">sort</a></b>(&nbsp;<code>Function&nbsp;fn</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>&nbsp;)
     :
                                         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">A function which, when passed two Nodes, returns -1, 0 or 1 depending upon required sort order.</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional)The scope (<code>this</code> reference) in which the function is executed. Defaults to the browser window.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Node.html#sort" ext:member="#sort" ext:cls="Ext.data.Node">Node</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-suspendEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-suspendEvents">suspendEvents</a></b>(&nbsp;<code>Boolean&nbsp;queueSuspended</code>&nbsp;)
     :