Upgrade to ExtJS 3.1.0 - Released 12/16/2009
[extjs.git] / docs / output / Ext.data.Tree.html
1 <div xmlns:ext="http://www.extjs.com" class="body-wrap"><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">Tree</pre></div><h1>Class <a href="source/Tree.html#cls-Ext.data.Tree">Ext.data.Tree</a></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">Tree.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/Tree.html#cls-Ext.data.Tree">Tree</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.util.Observable.html" ext:cls="Ext.util.Observable" ext:member="">Observable</a></td></tr></table><div class="description">Represents a tree data structure and bubbles all the events for its nodes. The nodes\r
2 in the tree have most standard DOM functionality.</div><div class="hr"></div><a id="Ext.data.Tree-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 expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-listeners"></a><b><a href="source/Observable.html#cfg-Ext.util.Observable-listeners">listeners</a></b> : Object<div class="mdesc"><div class="short">A config object containing one or more event handlers to be added to this\r
3 object during initialization.  This should ...</div><div class="long"><p>A config object containing one or more event handlers to be added to this
4 object during initialization.  This should be a valid listeners config object as specified in the
5 <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> example for attaching multiple handlers at once.</p>
6 <br><p><b><u>DOM events from ExtJs <a href="output/Ext.Component.html" ext:cls="Ext.Component">Components</a></u></b></p>
7 <br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
8 is usually only done when extra value can be added. For example the <a href="output/Ext.DataView.html" ext:cls="Ext.DataView">DataView</a>'s
9 <b><code><a href="output/Ext.DataView.html#Ext.DataView-click" ext:member="click" ext:cls="Ext.DataView">click</a></code></b> event passing the node clicked on. To access DOM
10 events directly from a Component's HTMLElement, listeners must be added to the <i><a href="output/Ext.Component.html#Ext.Component-getEl" ext:member="getEl" ext:cls="Ext.Component">Element</a></i> after the Component
11 has been rendered. A plugin can simplify this step:<pre><code><i>// Plugin is configured <b>with</b> a listeners config object.</i>
12 <i>// The Component is appended to the argument list of all handler functions.</i>
13 Ext.DomObserver = Ext.extend(Object, {
14     constructor: <b>function</b>(config) {
15         this.listeners = config.listeners ? config.listeners : config;
16     },
17
18     <i>// Component passes itself into plugin&#39;s init method</i>
19     init: <b>function</b>(c) {
20         <b>var</b> p, l = this.listeners;
21         <b>for</b> (p <b>in</b> l) {
22             <b>if</b> (Ext.isFunction(l[p])) {
23                 l[p] = this.createHandler(l[p], c);
24             } <b>else</b> {
25                 l[p].fn = this.createHandler(l[p].fn, c);
26             }
27         }
28
29         <i>// Add the listeners to the Element immediately following the render call</i>
30         c.render = c.render.<a href="output/Function.html#Function-createSequence" ext:member="createSequence" ext:cls="Function">createSequence</a>(<b>function</b>() {
31             <b>var</b> e = c.getEl();
32             <b>if</b> (e) {
33                 e.on(l);
34             }
35         });
36     },
37
38     createHandler: <b>function</b>(fn, c) {
39         <b>return</b> <b>function</b>(e) {
40             fn.call(this, e, c);
41         };
42     }
43 });
44
45 <b>var</b> combo = <b>new</b> Ext.form.ComboBox({
46
47     <i>// Collapse combo when its element is clicked on</i>
48     plugins: [ <b>new</b> Ext.DomObserver({
49         click: <b>function</b>(evt, comp) {
50             comp.collapse();
51         }
52     })],
53     store: myStore,
54     typeAhead: true,
55     mode: <em>'local'</em>,
56     triggerAction: <em>'all'</em>
57 });</code></pre></p></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#listeners" ext:member="#listeners" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Tree-pathSeparator"></a><b><a href="source/Tree.html#cfg-Ext.data.Tree-pathSeparator">pathSeparator</a></b> : String<div class="mdesc">The token used to separate paths in node ids (defaults to '/').</div></td><td class="msource">Tree</td></tr></tbody></table><a id="Ext.data.Tree-props"></a><h2>Public Properties</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Property</th><th class="msource-header">Defined By</th></tr><tr class="property-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Tree-root"></a><b><a href="source/Tree.html#prop-Ext.data.Tree-root">root</a></b> : Node<div class="mdesc">The root node for this tree</div></td><td class="msource">Tree</td></tr></tbody></table><a id="Ext.data.Tree-methods"></a><h2>Public Methods</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Tree-Tree"></a><b><a href="source/Tree.html#cls-Ext.data.Tree">Tree</a></b>(&nbsp;<span title="Optional" class="optional">[<code>Node&nbsp;root</code>]</span>&nbsp;)\r
58     <div class="mdesc"><div class="short"></div><div class="long"><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>root</code> : Node<div class="sub-desc">(optional) The root node</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">Tree</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-addEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-addEvents">addEvents</a></b>(&nbsp;<code>Object|String&nbsp;o</code>,&nbsp;<code>string&nbsp;Optional.</code>&nbsp;)\r
59     :\r
60                                         void<div class="mdesc"><div class="short">Adds the specified events to the list of events which this Observable may fire.</div><div class="long">Adds the specified events to the list of events which this Observable may fire.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>o</code> : Object|String<div class="sub-desc">Either an object with event names as properties with a value of <code>true</code>
61 or the first event name string if multiple event names are being passed as separate parameters.</div></li><li><code>Optional.</code> : string<div class="sub-desc">Event name if multiple event names are being passed as separate parameters.
62 Usage:<pre><code>this.addEvents(<em>'storeloaded'</em>, <em>'storecleared'</em>);</code></pre></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#addEvents" ext:member="#addEvents" ext:cls="Ext.util.Observable">Observable</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-addListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-addListener">addListener</a></b>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Function&nbsp;handler</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;options</code>]</span>&nbsp;)\r
63     :\r
64                                         void<div class="mdesc"><div class="short">Appends an event handler to this object.</div><div class="long">Appends an event handler to this object.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the 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 (<code><b>this</b></code> reference) in which the handler function is executed.
65 <b>If omitted, defaults to the object which fired the event.</b></div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration.
66 properties. This may contain any of the following properties:<ul>
67 <li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
68 <b>If omitted, defaults to the object which fired the event.</b></div></li>
69 <li><b>delay</b> : Number<div class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</div></li>
70 <li><b>single</b> : Boolean<div class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</div></li>
71 <li><b>buffer</b> : Number<div class="sub-desc">Causes the handler to be scheduled to run in an <a href="output/Ext.util.DelayedTask.html" ext:cls="Ext.util.DelayedTask">Ext.util.DelayedTask</a> delayed
72 by the specified number of milliseconds. If the event fires again within that time, the original
73 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
74 <li><b>target</b> : Observable<div class="sub-desc">Only call the handler if the event was fired on the target Observable, <i>not</i>
75 if the event was bubbled up from a child Observable.</div></li>
76 </ul><br>
77 <p>
78 <b>Combining Options</b><br>
79 Using the options argument, it is possible to combine different types of listeners:<br>
80 <br>
81 A delayed, one-time listener.
82 <pre><code>myDataView.on(<em>'click'</em>, this.onClick, this, {
83 single: true,
84 delay: 100
85 });</code></pre>
86 <p>
87 <b>Attaching multiple handlers in 1 call</b><br>
88 The method also allows for a single argument to be passed which is a config object containing properties
89 which specify multiple handlers.
90 <p>
91 <pre><code>myGridPanel.on({
92 <em>'click'</em> : {
93     fn: this.onClick,
94     scope: this,
95     delay: 100
96 },
97 <em>'mouseover'</em> : {
98     fn: this.onMouseOver,
99     scope: this
100 },
101 <em>'mouseout'</em> : {
102     fn: this.onMouseOut,
103     scope: this
104 }
105 });</code></pre>
106 <p>
107 Or a shorthand syntax:<br>
108 <pre><code>myGridPanel.on({
109 <em>'click'</em> : this.onClick,
110 <em>'mouseover'</em> : this.onMouseOver,
111 <em>'mouseout'</em> : this.onMouseOut,
112  scope: this
113 });</code></pre></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#addListener" ext:member="#addListener" ext:cls="Ext.util.Observable">Observable</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-enableBubble"></a><b><a href="source/Observable-more.html#method-Ext.util.Observable-enableBubble">enableBubble</a></b>(&nbsp;<code>String/Array&nbsp;events</code>&nbsp;)\r
114     :\r
115                                         void<div class="mdesc"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling&#13;\r
116 this.getBubbleTarget() if present...</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling\r
117 <code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>\r
118 <p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href="output/Ext.Component.getBubbleTarget.html" ext:cls="Ext.Component.getBubbleTarget">Ext.Component.getBubbleTarget</a>. The default\r
119 implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to\r
120 access the required target more quickly.</p>\r
121 <p>Example:</p><pre><code>Ext.override(Ext.form.Field, {\r
122     <i>//  Add functionality to Field&#39;s initComponent to enable the change event to bubble\r</i>
123     initComponent : Ext.form.Field.prototype.initComponent.createSequence(<b>function</b>() {\r
124         this.enableBubble(<em>'change'</em>);\r
125     }),\r
126 \r
127     <i>//  We know that we want Field&#39;s events to bubble directly to the FormPanel.\r</i>
128     getBubbleTarget : <b>function</b>() {\r
129         <b>if</b> (!this.formPanel) {\r
130             this.formPanel = this.findParentByType(<em>'form'</em>);\r
131         }\r
132         <b>return</b> this.formPanel;\r
133     }\r
134 });\r
135 \r
136 <b>var</b> myForm = <b>new</b> Ext.formPanel({\r
137     title: <em>'User Details'</em>,\r
138     items: [{\r
139         ...\r
140     }],\r
141     listeners: {\r
142         change: <b>function</b>() {\r
143             <i>// Title goes red <b>if</b> form has been modified.\r</i>
144             myForm.header.setStyle(<em>'color'</em>, <em>'red'</em>);\r
145         }\r
146     }\r
147 });</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>events</code> : String/Array<div class="sub-desc">The event name to bubble, or an Array of event names.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#enableBubble" ext:member="#enableBubble" ext:cls="Ext.util.Observable">Observable</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-fireEvent"></a><b><a href="source/Observable.html#method-Ext.util.Observable-fireEvent">fireEvent</a></b>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Object...&nbsp;args</code>&nbsp;)\r
148     :\r
149                                         Boolean<div class="mdesc"><div class="short">Fires the specified event with the passed parameters (minus the event name).\r
150 An event may be set to bubble up an Obse...</div><div class="long"><p>Fires the specified event with the passed parameters (minus the event name).</p>
151 <p>An event may be set to bubble up an Observable parent hierarchy (See <a href="output/Ext.Component.html#Ext.Component-getBubbleTarget" ext:member="getBubbleTarget" ext:cls="Ext.Component">Ext.Component.getBubbleTarget</a>)
152 by calling <a href="output/Ext.util.Observable.html#Ext.util.Observable-enableBubble" ext:member="enableBubble" ext:cls="Ext.util.Observable">enableBubble</a>.</p><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to fire.</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 href="output/Ext.util.Observable.html#fireEvent" ext:member="#fireEvent" 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.data.Tree-getNodeById"></a><b><a href="source/Tree.html#method-Ext.data.Tree-getNodeById">getNodeById</a></b>(&nbsp;<code>String&nbsp;id</code>&nbsp;)\r
153     :\r
154                                         Node<div class="mdesc"><div class="short">Gets a node in this tree by its id.</div><div class="long">Gets a node in this tree by its id.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>id</code> : String<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li><code>Node</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">Tree</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Tree-getRootNode"></a><b><a href="source/Tree.html#method-Ext.data.Tree-getRootNode">getRootNode</a></b>()\r
155     :\r
156                                         Node<div class="mdesc"><div class="short">Returns the root node for this tree.</div><div class="long">Returns the root node for this tree.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Node</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">Tree</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-hasListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-hasListener">hasListener</a></b>(&nbsp;<code>String&nbsp;eventName</code>&nbsp;)\r
157     :\r
158                                         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 href="output/Ext.util.Observable.html#hasListener" ext:member="#hasListener" ext:cls="Ext.util.Observable">Observable</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-on"></a><b><a href="source/Observable.html#method-Ext.util.Observable-on">on</a></b>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Function&nbsp;handler</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;options</code>]</span>&nbsp;)\r
159     :\r
160                                         void<div class="mdesc"><div class="short">Appends an event handler to this object (shorthand for addListener.)</div><div class="long">Appends an event handler to this object (shorthand for <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a>.)<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 (<code><b>this</b></code> reference) in which the handler function is executed.
161 <b>If omitted, defaults to the object which fired the event.</b></div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#on" ext:member="#on" ext:cls="Ext.util.Observable">Observable</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-purgeListeners"></a><b><a href="source/Observable.html#method-Ext.util.Observable-purgeListeners">purgeListeners</a></b>()\r
162     :\r
163                                         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>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#purgeListeners" ext:member="#purgeListeners" ext:cls="Ext.util.Observable">Observable</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-relayEvents"></a><b><a href="source/Observable-more.html#method-Ext.util.Observable-relayEvents">relayEvents</a></b>(&nbsp;<code>Object&nbsp;o</code>,&nbsp;<code>Array&nbsp;events</code>&nbsp;)\r
164     :\r
165                                         void<div class="mdesc"><div class="short">Relays selected events from the specified Observable as if the events were fired by this.</div><div class="long">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>o</code> : Object<div class="sub-desc">The Observable whose events this object is to relay.</div></li><li><code>events</code> : Array<div class="sub-desc">Array of event names to relay.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#relayEvents" ext:member="#relayEvents" ext:cls="Ext.util.Observable">Observable</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-removeListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-removeListener">removeListener</a></b>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Function&nbsp;handler</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>&nbsp;)\r
166     :\r
167                                         void<div class="mdesc"><div class="short">Removes an event handler.</div><div class="long">Removes an event handler.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event the handler was associated with.</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove. <b>This must be a reference to the function passed into the <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> call.</b></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope originally specified for the handler.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#removeListener" ext:member="#removeListener" ext:cls="Ext.util.Observable">Observable</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-resumeEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-resumeEvents">resumeEvents</a></b>()\r
168     :\r
169                                         void<div class="mdesc"><div class="short">Resume firing events. (see suspendEvents)\r
170 If events were suspended using the queueSuspended parameter, then all\r
171 event...</div><div class="long">Resume firing events. (see <a href="output/Ext.util.Observable.html#Ext.util.Observable-suspendEvents" ext:member="suspendEvents" ext:cls="Ext.util.Observable">suspendEvents</a>)
172 If events were suspended using the <tt><b>queueSuspended</b></tt> parameter, then all
173 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.data.Tree-setRootNode"></a><b><a href="source/Tree.html#method-Ext.data.Tree-setRootNode">setRootNode</a></b>(&nbsp;<code>Node&nbsp;node</code>&nbsp;)\r
174     :\r
175                                         Node<div class="mdesc"><div class="short">Sets the root node for this tree.</div><div class="long">Sets the root node for this tree.<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>Node</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">Tree</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;)\r
176     :\r
177                                         void<div class="mdesc"><div class="short">Suspend the firing of all events. (see resumeEvents)</div><div class="long">Suspend the firing of all events. (see <a href="output/Ext.util.Observable.html#Ext.util.Observable-resumeEvents" ext:member="resumeEvents" ext:cls="Ext.util.Observable">resumeEvents</a>)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>queueSuspended</code> : Boolean<div class="sub-desc">Pass as true to queue up suspended events to be fired
178 after the <a href="output/Ext.util.Observable.html#Ext.util.Observable-resumeEvents" ext:member="resumeEvents" ext:cls="Ext.util.Observable">resumeEvents</a> call instead of discarding all suspended events;</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#suspendEvents" ext:member="#suspendEvents" ext:cls="Ext.util.Observable">Observable</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-un"></a><b><a href="source/Observable.html#method-Ext.util.Observable-un">un</a></b>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Function&nbsp;handler</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>&nbsp;)\r
179     :\r
180                                         void<div class="mdesc"><div class="short">Removes an event handler (shorthand for removeListener.)</div><div class="long">Removes an event handler (shorthand for <a href="output/Ext.util.Observable.html#Ext.util.Observable-removeListener" ext:member="removeListener" ext:cls="Ext.util.Observable">removeListener</a>.)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event the handler was associated with.</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove. <b>This must be a reference to the function passed into the <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> call.</b></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope originally specified for the handler.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#un" ext:member="#un" ext:cls="Ext.util.Observable">Observable</a></td></tr></tbody></table><a id="Ext.data.Tree-events"></a><h2>Public Events</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Event</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Tree-append"></a><b><a href="source/Tree.html#event-Ext.data.Tree-append">append</a></b> :\r
181                                       (&nbsp;<code>Tree&nbsp;tree</code>,&nbsp;<code>Node&nbsp;parent</code>,&nbsp;<code>Node&nbsp;node</code>,&nbsp;<code>Number&nbsp;index</code>&nbsp;)\r
182     <div class="mdesc"><div class="short">Fires when a new child node is appended to a node in this tree.</div><div class="long">Fires when a new child node is appended to a node in this 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>parent</code> : Node<div class="sub-desc">The parent 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">Tree</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Tree-beforeappend"></a><b><a href="source/Tree.html#event-Ext.data.Tree-beforeappend">beforeappend</a></b> :\r
183                                       (&nbsp;<code>Tree&nbsp;tree</code>,&nbsp;<code>Node&nbsp;parent</code>,&nbsp;<code>Node&nbsp;node</code>&nbsp;)\r
184     <div class="mdesc"><div class="short">Fires before a new child is appended to a node in this tree, return false to cancel the append.</div><div class="long">Fires before a new child is appended to a node in this tree, 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>parent</code> : Node<div class="sub-desc">The parent 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">Tree</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Tree-beforeinsert"></a><b><a href="source/Tree.html#event-Ext.data.Tree-beforeinsert">beforeinsert</a></b> :\r
185                                       (&nbsp;<code>Tree&nbsp;tree</code>,&nbsp;<code>Node&nbsp;parent</code>,&nbsp;<code>Node&nbsp;node</code>,&nbsp;<code>Node&nbsp;refNode</code>&nbsp;)\r
186     <div class="mdesc"><div class="short">Fires before a new child is inserted in a node in this tree, return false to cancel the insert.</div><div class="long">Fires before a new child is inserted in a node in this tree, 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>parent</code> : Node<div class="sub-desc">The parent 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">Tree</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Tree-beforemove"></a><b><a href="source/Tree.html#event-Ext.data.Tree-beforemove">beforemove</a></b> :\r
187                                       (&nbsp;<code>Tree&nbsp;tree</code>,&nbsp;<code>Node&nbsp;node</code>,&nbsp;<code>Node&nbsp;oldParent</code>,&nbsp;<code>Node&nbsp;newParent</code>,&nbsp;<code>Number&nbsp;index</code>&nbsp;)\r
188     <div class="mdesc"><div class="short">Fires before a node is moved to a new location in the tree. Return false to cancel the move.</div><div class="long">Fires before a 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>node</code> : Node<div class="sub-desc">The node being moved</div></li><li><code>oldParent</code> : Node<div class="sub-desc">The parent of the node</div></li><li><code>newParent</code> : Node<div class="sub-desc">The new parent the 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">Tree</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Tree-beforeremove"></a><b><a href="source/Tree.html#event-Ext.data.Tree-beforeremove">beforeremove</a></b> :\r
189                                       (&nbsp;<code>Tree&nbsp;tree</code>,&nbsp;<code>Node&nbsp;parent</code>,&nbsp;<code>Node&nbsp;node</code>&nbsp;)\r
190     <div class="mdesc"><div class="short">Fires before a child is removed from a node in this tree, return false to cancel the remove.</div><div class="long">Fires before a child is removed from a node in this tree, 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>parent</code> : Node<div class="sub-desc">The parent 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">Tree</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Tree-insert"></a><b><a href="source/Tree.html#event-Ext.data.Tree-insert">insert</a></b> :\r
191                                       (&nbsp;<code>Tree&nbsp;tree</code>,&nbsp;<code>Node&nbsp;parent</code>,&nbsp;<code>Node&nbsp;node</code>,&nbsp;<code>Node&nbsp;refNode</code>&nbsp;)\r
192     <div class="mdesc"><div class="short">Fires when a new child node is inserted in a node in this tree.</div><div class="long">Fires when a new child node is inserted in a node in this 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>parent</code> : Node<div class="sub-desc">The parent 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">Tree</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Tree-move"></a><b><a href="source/Tree.html#event-Ext.data.Tree-move">move</a></b> :\r
193                                       (&nbsp;<code>Tree&nbsp;tree</code>,&nbsp;<code>Node&nbsp;node</code>,&nbsp;<code>Node&nbsp;oldParent</code>,&nbsp;<code>Node&nbsp;newParent</code>,&nbsp;<code>Number&nbsp;index</code>&nbsp;)\r
194     <div class="mdesc"><div class="short">Fires when a node is moved to a new location in the tree</div><div class="long">Fires when a 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>node</code> : Node<div class="sub-desc">The node moved</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">Tree</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Tree-remove"></a><b><a href="source/Tree.html#event-Ext.data.Tree-remove">remove</a></b> :\r
195                                       (&nbsp;<code>Tree&nbsp;tree</code>,&nbsp;<code>Node&nbsp;parent</code>,&nbsp;<code>Node&nbsp;node</code>&nbsp;)\r
196     <div class="mdesc"><div class="short">Fires when a child node is removed from a node in this tree.</div><div class="long">Fires when a child node is removed from a node in this 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>parent</code> : Node<div class="sub-desc">The parent node</div></li><li><code>node</code> : Node<div class="sub-desc">The child node removed</div></li></ul></div></div></div></td><td class="msource">Tree</td></tr></tbody></table></div>