commit extjs-2.2.1
[extjs.git] / docs / output / Ext.data.Tree.html
1         <div class="body-wrap">
2         <div class="top-tools">
3             <a class="inner-link" href="#Ext.data.Tree-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
4             <a class="inner-link" href="#Ext.data.Tree-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
5             <a class="inner-link" href="#Ext.data.Tree-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
6                             <a class="inner-link" href="#Ext.data.Tree-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
7                         <a class="bookmark" href="../docs/?class=Ext.data.Tree"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
8         </div>
9                 <div class="inheritance res-block">
10 <pre class="res-block-inner"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a>
11   <img src="resources/elbow-end.gif"/>Tree</pre></div>
12                 <h1>Class Ext.data.Tree</h1>
13         <table cellspacing="0">
14             <tr><td class="label">Package:</td><td class="hd-info">Ext.data</td></tr>
15             <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/Tree.js" target="_blank">Tree.js</a></td></tr>
16             <tr><td class="label">Class:</td><td class="hd-info">Tree</td></tr>
17                                     <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>
18                     </table>
19         <div class="description">
20             *
21 Represents a tree data structure and bubbles all the events for its nodes. The nodes
22 in the tree have most standard DOM functionality.        </div>
23         
24         <div class="hr"></div>
25                 <a id="Ext.data.Tree-configs"></a>
26         <h2>Config Options</h2>
27         <table cellspacing="0" class="member-table">
28             <tr>
29                 <th class="sig-header" colspan="2">Config Options</th>
30                 <th class="msource-header">Defined By</th>
31             </tr>
32                 <tr class="config-row inherited expandable">\r
33         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
34         <td class="sig">\r
35         <a id="Ext.data.Tree-listeners"></a>\r
36             <b>listeners</b> : Object            <div class="mdesc">\r
37                         <div class="short">(optional) A config object containing one or more event handlers to be added to this object during initialization. Th...</div>\r
38             <div class="long">\r
39                 (optional) 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>\r
40                         </div>\r
41         </td>\r
42         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td>\r
43     </tr>\r
44         <tr class="config-row alt">\r
45         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
46         <td class="sig">\r
47         <a id="Ext.data.Tree-pathSeparator"></a>\r
48             <b>pathSeparator</b> : String            <div class="mdesc">\r
49                             The token used to separate paths in node ids (defaults to '/').                        </div>\r
50         </td>\r
51         <td class="msource">Tree</td>\r
52     </tr>\r
53             </table>
54                 <a id="Ext.data.Tree-props"></a>
55         <h2>Public Properties</h2>
56                 <table cellspacing="0" class="member-table">
57             <tr>
58                 <th class="sig-header" colspan="2">Property</th>
59                 <th class="msource-header">Defined By</th>
60             </tr>
61                 <tr class="property-row">\r
62         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
63         <td class="sig">\r
64         <a id="Ext.data.Tree-root"></a>\r
65             <b>root</b> : Node            <div class="mdesc">\r
66                             The root node for this tree                        </div>\r
67         </td>\r
68         <td class="msource">Tree</td>\r
69     </tr>\r
70             </table>
71                 <a id="Ext.data.Tree-methods"></a>
72         <h2>Public Methods</h2>
73                 <table cellspacing="0" class="member-table">
74             <tr>
75                 <th class="sig-header" colspan="2">Method</th>
76                 <th class="msource-header">Defined By</th>
77             </tr>
78                 <tr class="method-row expandable">\r
79         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
80         <td class="sig">\r
81         <a id="Ext.data.Tree-Tree"></a>\r
82             <b>Tree</b>(&nbsp;<span class="optional" title="Optional">[<code>Node root</code>]</span>&nbsp;)            <div class="mdesc">\r
83                         <div class="short"></div>\r
84             <div class="long">\r
85                     <div class="mdetail-params">\r
86         <strong>Parameters:</strong>\r
87         <ul><li><code>root</code> : Node<div class="sub-desc">(optional) The root node</div></li>        </ul>\r
88         <strong>Returns:</strong>\r
89         <ul>\r
90             <li><code></code></li>\r
91         </ul>\r
92     </div>\r
93                 </div>\r
94                         </div>\r
95         </td>\r
96         <td class="msource">Tree</td>\r
97     </tr>\r
98         <tr class="method-row inherited alt expandable">\r
99         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
100         <td class="sig">\r
101         <a id="Ext.data.Tree-addEvents"></a>\r
102             <b>addEvents</b>(&nbsp;<code>Object object</code>&nbsp;) : void            <div class="mdesc">\r
103                         <div class="short">Used to define events on this Observable</div>\r
104             <div class="long">\r
105                 Used to define events on this Observable    <div class="mdetail-params">\r
106         <strong>Parameters:</strong>\r
107         <ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li>        </ul>\r
108         <strong>Returns:</strong>\r
109         <ul>\r
110             <li><code>void</code></li>\r
111         </ul>\r
112     </div>\r
113                 </div>\r
114                         </div>\r
115         </td>\r
116         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td>\r
117     </tr>\r
118         <tr class="method-row inherited expandable">\r
119         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
120         <td class="sig">\r
121         <a id="Ext.data.Tree-addListener"></a>\r
122             <b>addListener</b>(&nbsp;<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>&nbsp;) : void            <div class="mdesc">\r
123                         <div class="short">Appends an event handler to this component</div>\r
124             <div class="long">\r
125                 Appends an event handler to this component    <div class="mdetail-params">\r
126         <strong>Parameters:</strong>\r
127         <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
128 function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration
129 properties. This may contain any of the following properties:<ul>
130 <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>
131 <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>
132 <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>
133 <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
134 by the specified number of milliseconds. If the event fires again within that time, the original
135 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</p></li>
136 </ul><br>
137 <p>
138 <b>Combining Options</b><br>
139 Using the options argument, it is possible to combine different types of listeners:<br>
140 <br>
141 A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
142 <pre><code>el.on(<em>'click'</em>, <b>this</b>.onClick, <b>this</b>, {
143     single: true,
144     delay: 100,
145     forumId: 4
146 });</code></pre>
147 <p>
148 <b>Attaching multiple handlers in 1 call</b><br>
149 The method also allows for a single argument to be passed which is a config object containing properties
150 which specify multiple handlers.
151 <p>
152 <pre><code>foo.on({
153     <em>'click'</em> : {
154         fn: <b>this</b>.onClick,
155         scope: <b>this</b>,
156         delay: 100
157     },
158     <em>'mouseover'</em> : {
159         fn: <b>this</b>.onMouseOver,
160         scope: <b>this</b>
161     },
162     <em>'mouseout'</em> : {
163         fn: <b>this</b>.onMouseOut,
164         scope: <b>this</b>
165     }
166 });</code></pre>
167 <p>
168 Or a shorthand syntax:<br>
169 <pre><code>foo.on({
170     <em>'click'</em> : <b>this</b>.onClick,
171     <em>'mouseover'</em> : <b>this</b>.onMouseOver,
172     <em>'mouseout'</em> : <b>this</b>.onMouseOut,
173      scope: <b>this</b>
174 });</code></pre></div></li>        </ul>\r
175         <strong>Returns:</strong>\r
176         <ul>\r
177             <li><code>void</code></li>\r
178         </ul>\r
179     </div>\r
180                 </div>\r
181                         </div>\r
182         </td>\r
183         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td>\r
184     </tr>\r
185         <tr class="method-row inherited alt expandable">\r
186         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
187         <td class="sig">\r
188         <a id="Ext.data.Tree-fireEvent"></a>\r
189             <b>fireEvent</b>(&nbsp;<code>String eventName</code>, <code>Object... args</code>&nbsp;) : Boolean            <div class="mdesc">\r
190                         <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>\r
191             <div class="long">\r
192                 Fires the specified event with the passed parameters (minus the event name).    <div class="mdetail-params">\r
193         <strong>Parameters:</strong>\r
194         <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>\r
195         <strong>Returns:</strong>\r
196         <ul>\r
197             <li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li>\r
198         </ul>\r
199     </div>\r
200                 </div>\r
201                         </div>\r
202         </td>\r
203         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td>\r
204     </tr>\r
205         <tr class="method-row expandable">\r
206         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
207         <td class="sig">\r
208         <a id="Ext.data.Tree-getNodeById"></a>\r
209             <b>getNodeById</b>(&nbsp;<code>String id</code>&nbsp;) : Node            <div class="mdesc">\r
210                         <div class="short">Gets a node in this tree by its id.</div>\r
211             <div class="long">\r
212                 Gets a node in this tree by its id.    <div class="mdetail-params">\r
213         <strong>Parameters:</strong>\r
214         <ul><li><code>id</code> : String<div class="sub-desc"></div></li>        </ul>\r
215         <strong>Returns:</strong>\r
216         <ul>\r
217             <li><code>Node</code></li>\r
218         </ul>\r
219     </div>\r
220                 </div>\r
221                         </div>\r
222         </td>\r
223         <td class="msource">Tree</td>\r
224     </tr>\r
225         <tr class="method-row alt expandable">\r
226         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
227         <td class="sig">\r
228         <a id="Ext.data.Tree-getRootNode"></a>\r
229             <b>getRootNode</b>() : Node            <div class="mdesc">\r
230                         <div class="short">Returns the root node for this tree.</div>\r
231             <div class="long">\r
232                 Returns the root node for this tree.    <div class="mdetail-params">\r
233         <strong>Parameters:</strong>\r
234         <ul><li>None.</li>        </ul>\r
235         <strong>Returns:</strong>\r
236         <ul>\r
237             <li><code>Node</code></li>\r
238         </ul>\r
239     </div>\r
240                 </div>\r
241                         </div>\r
242         </td>\r
243         <td class="msource">Tree</td>\r
244     </tr>\r
245         <tr class="method-row inherited expandable">\r
246         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
247         <td class="sig">\r
248         <a id="Ext.data.Tree-hasListener"></a>\r
249             <b>hasListener</b>(&nbsp;<code>String eventName</code>&nbsp;) : Boolean            <div class="mdesc">\r
250                         <div class="short">Checks to see if this object has any listeners for a specified event</div>\r
251             <div class="long">\r
252                 Checks to see if this object has any listeners for a specified event    <div class="mdetail-params">\r
253         <strong>Parameters:</strong>\r
254         <ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li>        </ul>\r
255         <strong>Returns:</strong>\r
256         <ul>\r
257             <li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li>\r
258         </ul>\r
259     </div>\r
260                 </div>\r
261                         </div>\r
262         </td>\r
263         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td>\r
264     </tr>\r
265         <tr class="method-row inherited alt expandable">\r
266         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
267         <td class="sig">\r
268         <a id="Ext.data.Tree-on"></a>\r
269             <b>on</b>(&nbsp;<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>&nbsp;) : void            <div class="mdesc">\r
270                         <div class="short">Appends an event handler to this element (shorthand for addListener)</div>\r
271             <div class="long">\r
272                 Appends an event handler to this element (shorthand for addListener)    <div class="mdetail-params">\r
273         <strong>Parameters:</strong>\r
274         <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
275 function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li>        </ul>\r
276         <strong>Returns:</strong>\r
277         <ul>\r
278             <li><code>void</code></li>\r
279         </ul>\r
280     </div>\r
281                 </div>\r
282                         </div>\r
283         </td>\r
284         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td>\r
285     </tr>\r
286         <tr class="method-row inherited expandable">\r
287         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
288         <td class="sig">\r
289         <a id="Ext.data.Tree-purgeListeners"></a>\r
290             <b>purgeListeners</b>() : void            <div class="mdesc">\r
291                         <div class="short">Removes all listeners for this object</div>\r
292             <div class="long">\r
293                 Removes all listeners for this object    <div class="mdetail-params">\r
294         <strong>Parameters:</strong>\r
295         <ul><li>None.</li>        </ul>\r
296         <strong>Returns:</strong>\r
297         <ul>\r
298             <li><code>void</code></li>\r
299         </ul>\r
300     </div>\r
301                 </div>\r
302                         </div>\r
303         </td>\r
304         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td>\r
305     </tr>\r
306         <tr class="method-row inherited alt expandable">\r
307         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
308         <td class="sig">\r
309         <a id="Ext.data.Tree-relayEvents"></a>\r
310             <b>relayEvents</b>(&nbsp;<code>Object o</code>, <code>Array events</code>&nbsp;) : void            <div class="mdesc">\r
311                         <div class="short">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.</div>\r
312             <div class="long">\r
313                 Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.    <div class="mdetail-params">\r
314         <strong>Parameters:</strong>\r
315         <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>\r
316         <strong>Returns:</strong>\r
317         <ul>\r
318             <li><code>void</code></li>\r
319         </ul>\r
320     </div>\r
321                 </div>\r
322                         </div>\r
323         </td>\r
324         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#relayEvents" href="output/Ext.util.Observable.html#relayEvents">Observable</a></td>\r
325     </tr>\r
326         <tr class="method-row inherited expandable">\r
327         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
328         <td class="sig">\r
329         <a id="Ext.data.Tree-removeListener"></a>\r
330             <b>removeListener</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : void            <div class="mdesc">\r
331                         <div class="short">Removes a listener</div>\r
332             <div class="long">\r
333                 Removes a listener    <div class="mdetail-params">\r
334         <strong>Parameters:</strong>\r
335         <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>\r
336         <strong>Returns:</strong>\r
337         <ul>\r
338             <li><code>void</code></li>\r
339         </ul>\r
340     </div>\r
341                 </div>\r
342                         </div>\r
343         </td>\r
344         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td>\r
345     </tr>\r
346         <tr class="method-row inherited alt expandable">\r
347         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
348         <td class="sig">\r
349         <a id="Ext.data.Tree-resumeEvents"></a>\r
350             <b>resumeEvents</b>() : void            <div class="mdesc">\r
351                         <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>\r
352             <div class="long">\r
353                 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">\r
354         <strong>Parameters:</strong>\r
355         <ul><li>None.</li>        </ul>\r
356         <strong>Returns:</strong>\r
357         <ul>\r
358             <li><code>void</code></li>\r
359         </ul>\r
360     </div>\r
361                 </div>\r
362                         </div>\r
363         </td>\r
364         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td>\r
365     </tr>\r
366         <tr class="method-row expandable">\r
367         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
368         <td class="sig">\r
369         <a id="Ext.data.Tree-setRootNode"></a>\r
370             <b>setRootNode</b>(&nbsp;<code>Node node</code>&nbsp;) : Node            <div class="mdesc">\r
371                         <div class="short">Sets the root node for this tree.</div>\r
372             <div class="long">\r
373                 Sets the root node for this tree.    <div class="mdetail-params">\r
374         <strong>Parameters:</strong>\r
375         <ul><li><code>node</code> : Node<div class="sub-desc"></div></li>        </ul>\r
376         <strong>Returns:</strong>\r
377         <ul>\r
378             <li><code>Node</code></li>\r
379         </ul>\r
380     </div>\r
381                 </div>\r
382                         </div>\r
383         </td>\r
384         <td class="msource">Tree</td>\r
385     </tr>\r
386         <tr class="method-row inherited alt expandable">\r
387         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
388         <td class="sig">\r
389         <a id="Ext.data.Tree-suspendEvents"></a>\r
390             <b>suspendEvents</b>() : void            <div class="mdesc">\r
391                         <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>\r
392             <div class="long">\r
393                 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">\r
394         <strong>Parameters:</strong>\r
395         <ul><li>None.</li>        </ul>\r
396         <strong>Returns:</strong>\r
397         <ul>\r
398             <li><code>void</code></li>\r
399         </ul>\r
400     </div>\r
401                 </div>\r
402                         </div>\r
403         </td>\r
404         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td>\r
405     </tr>\r
406         <tr class="method-row inherited expandable">\r
407         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
408         <td class="sig">\r
409         <a id="Ext.data.Tree-un"></a>\r
410             <b>un</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : void            <div class="mdesc">\r
411                         <div class="short">Removes a listener (shorthand for removeListener)</div>\r
412             <div class="long">\r
413                 Removes a listener (shorthand for removeListener)    <div class="mdetail-params">\r
414         <strong>Parameters:</strong>\r
415         <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>\r
416         <strong>Returns:</strong>\r
417         <ul>\r
418             <li><code>void</code></li>\r
419         </ul>\r
420     </div>\r
421                 </div>\r
422                         </div>\r
423         </td>\r
424         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td>\r
425     </tr>\r
426             </table>
427                 <a id="Ext.data.Tree-events"></a>
428         <h2>Public Events</h2>
429                 <table cellspacing="0" class="member-table">
430             <tr>
431                 <th class="sig-header" colspan="2">Event</th>
432                 <th class="msource-header">Defined By</th>
433             </tr>
434                 <tr class="event-row expandable">\r
435         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
436         <td class="sig">\r
437         <a id="Ext.data.Tree-append"></a>\r
438             <b>append</b> : (&nbsp;<code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code>, <code>Number index</code>&nbsp;)            <div class="mdesc">\r
439                         <div class="short">Fires when a new child node is appended to a node in this tree.</div>\r
440             <div class="long">\r
441                 Fires when a new child node is appended to a node in this tree.    <div class="mdetail-params">\r
442         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
443         <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>\r
444     </div>\r
445                 </div>\r
446                         </div>\r
447         </td>\r
448         <td class="msource">Tree</td>\r
449     </tr>\r
450         <tr class="event-row alt expandable">\r
451         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
452         <td class="sig">\r
453         <a id="Ext.data.Tree-beforeappend"></a>\r
454             <b>beforeappend</b> : (&nbsp;<code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code>&nbsp;)            <div class="mdesc">\r
455                         <div class="short">Fires before a new child is appended to a node in this tree, return false to cancel the append.</div>\r
456             <div class="long">\r
457                 Fires before a new child is appended to a node in this tree, return false to cancel the append.    <div class="mdetail-params">\r
458         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
459         <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>\r
460     </div>\r
461                 </div>\r
462                         </div>\r
463         </td>\r
464         <td class="msource">Tree</td>\r
465     </tr>\r
466         <tr class="event-row expandable">\r
467         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
468         <td class="sig">\r
469         <a id="Ext.data.Tree-beforeinsert"></a>\r
470             <b>beforeinsert</b> : (&nbsp;<code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code>, <code>Node refNode</code>&nbsp;)            <div class="mdesc">\r
471                         <div class="short">Fires before a new child is inserted in a node in this tree, return false to cancel the insert.</div>\r
472             <div class="long">\r
473                 Fires before a new child is inserted in a node in this tree, return false to cancel the insert.    <div class="mdetail-params">\r
474         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
475         <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>\r
476     </div>\r
477                 </div>\r
478                         </div>\r
479         </td>\r
480         <td class="msource">Tree</td>\r
481     </tr>\r
482         <tr class="event-row alt expandable">\r
483         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
484         <td class="sig">\r
485         <a id="Ext.data.Tree-beforemove"></a>\r
486             <b>beforemove</b> : (&nbsp;<code>Tree tree</code>, <code>Node node</code>, <code>Node oldParent</code>, <code>Node newParent</code>, <code>Number index</code>&nbsp;)            <div class="mdesc">\r
487                         <div class="short">Fires before a node is moved to a new location in the tree. Return false to cancel the move.</div>\r
488             <div class="long">\r
489                 Fires before a node is moved to a new location in the tree. Return false to cancel the move.    <div class="mdetail-params">\r
490         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
491         <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>\r
492     </div>\r
493                 </div>\r
494                         </div>\r
495         </td>\r
496         <td class="msource">Tree</td>\r
497     </tr>\r
498         <tr class="event-row expandable">\r
499         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
500         <td class="sig">\r
501         <a id="Ext.data.Tree-beforeremove"></a>\r
502             <b>beforeremove</b> : (&nbsp;<code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code>&nbsp;)            <div class="mdesc">\r
503                         <div class="short">Fires before a child is removed from a node in this tree, return false to cancel the remove.</div>\r
504             <div class="long">\r
505                 Fires before a child is removed from a node in this tree, return false to cancel the remove.    <div class="mdetail-params">\r
506         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
507         <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>\r
508     </div>\r
509                 </div>\r
510                         </div>\r
511         </td>\r
512         <td class="msource">Tree</td>\r
513     </tr>\r
514         <tr class="event-row alt expandable">\r
515         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
516         <td class="sig">\r
517         <a id="Ext.data.Tree-insert"></a>\r
518             <b>insert</b> : (&nbsp;<code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code>, <code>Node refNode</code>&nbsp;)            <div class="mdesc">\r
519                         <div class="short">Fires when a new child node is inserted in a node in this tree.</div>\r
520             <div class="long">\r
521                 Fires when a new child node is inserted in a node in this tree.    <div class="mdetail-params">\r
522         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
523         <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>\r
524     </div>\r
525                 </div>\r
526                         </div>\r
527         </td>\r
528         <td class="msource">Tree</td>\r
529     </tr>\r
530         <tr class="event-row expandable">\r
531         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
532         <td class="sig">\r
533         <a id="Ext.data.Tree-move"></a>\r
534             <b>move</b> : (&nbsp;<code>Tree tree</code>, <code>Node node</code>, <code>Node oldParent</code>, <code>Node newParent</code>, <code>Number index</code>&nbsp;)            <div class="mdesc">\r
535                         <div class="short">Fires when a node is moved to a new location in the tree</div>\r
536             <div class="long">\r
537                 Fires when a node is moved to a new location in the tree    <div class="mdetail-params">\r
538         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
539         <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>\r
540     </div>\r
541                 </div>\r
542                         </div>\r
543         </td>\r
544         <td class="msource">Tree</td>\r
545     </tr>\r
546         <tr class="event-row alt expandable">\r
547         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
548         <td class="sig">\r
549         <a id="Ext.data.Tree-remove"></a>\r
550             <b>remove</b> : (&nbsp;<code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code>&nbsp;)            <div class="mdesc">\r
551                         <div class="short">Fires when a child node is removed from a node in this tree.</div>\r
552             <div class="long">\r
553                 Fires when a child node is removed from a node in this tree.    <div class="mdetail-params">\r
554         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
555         <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>\r
556     </div>\r
557                 </div>\r
558                         </div>\r
559         </td>\r
560         <td class="msource">Tree</td>\r
561     </tr>\r
562             </table>
563         
564         </div>