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"> |
---|
33 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
34 | <td class="sig"> |
---|
35 | <a id="Ext.data.Tree-listeners"></a> |
---|
36 | <b>listeners</b> : Object <div class="mdesc"> |
---|
37 | <div class="short">(optional) A config object containing one or more event handlers to be added to this object during initialization. Th...</div> |
---|
38 | <div class="long"> |
---|
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> |
---|
40 | </div> |
---|
41 | </td> |
---|
42 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td> |
---|
43 | </tr> |
---|
44 | <tr class="config-row alt"> |
---|
45 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
46 | <td class="sig"> |
---|
47 | <a id="Ext.data.Tree-pathSeparator"></a> |
---|
48 | <b>pathSeparator</b> : String <div class="mdesc"> |
---|
49 | The token used to separate paths in node ids (defaults to '/'). </div> |
---|
50 | </td> |
---|
51 | <td class="msource">Tree</td> |
---|
52 | </tr> |
---|
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"> |
---|
62 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
63 | <td class="sig"> |
---|
64 | <a id="Ext.data.Tree-root"></a> |
---|
65 | <b>root</b> : Node <div class="mdesc"> |
---|
66 | The root node for this tree </div> |
---|
67 | </td> |
---|
68 | <td class="msource">Tree</td> |
---|
69 | </tr> |
---|
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"> |
---|
79 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
80 | <td class="sig"> |
---|
81 | <a id="Ext.data.Tree-Tree"></a> |
---|
82 | <b>Tree</b>( <span class="optional" title="Optional">[<code>Node root</code>]</span> ) <div class="mdesc"> |
---|
83 | <div class="short"></div> |
---|
84 | <div class="long"> |
---|
85 | <div class="mdetail-params"> |
---|
86 | <strong>Parameters:</strong> |
---|
87 | <ul><li><code>root</code> : Node<div class="sub-desc">(optional) The root node</div></li> </ul> |
---|
88 | <strong>Returns:</strong> |
---|
89 | <ul> |
---|
90 | <li><code></code></li> |
---|
91 | </ul> |
---|
92 | </div> |
---|
93 | </div> |
---|
94 | </div> |
---|
95 | </td> |
---|
96 | <td class="msource">Tree</td> |
---|
97 | </tr> |
---|
98 | <tr class="method-row inherited alt expandable"> |
---|
99 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
100 | <td class="sig"> |
---|
101 | <a id="Ext.data.Tree-addEvents"></a> |
---|
102 | <b>addEvents</b>( <code>Object object</code> ) : void <div class="mdesc"> |
---|
103 | <div class="short">Used to define events on this Observable</div> |
---|
104 | <div class="long"> |
---|
105 | Used to define events on this Observable <div class="mdetail-params"> |
---|
106 | <strong>Parameters:</strong> |
---|
107 | <ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li> </ul> |
---|
108 | <strong>Returns:</strong> |
---|
109 | <ul> |
---|
110 | <li><code>void</code></li> |
---|
111 | </ul> |
---|
112 | </div> |
---|
113 | </div> |
---|
114 | </div> |
---|
115 | </td> |
---|
116 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td> |
---|
117 | </tr> |
---|
118 | <tr class="method-row inherited expandable"> |
---|
119 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
120 | <td class="sig"> |
---|
121 | <a id="Ext.data.Tree-addListener"></a> |
---|
122 | <b>addListener</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span> ) : void <div class="mdesc"> |
---|
123 | <div class="short">Appends an event handler to this component</div> |
---|
124 | <div class="long"> |
---|
125 | Appends an event handler to this component <div class="mdetail-params"> |
---|
126 | <strong>Parameters:</strong> |
---|
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> |
---|
175 | <strong>Returns:</strong> |
---|
176 | <ul> |
---|
177 | <li><code>void</code></li> |
---|
178 | </ul> |
---|
179 | </div> |
---|
180 | </div> |
---|
181 | </div> |
---|
182 | </td> |
---|
183 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td> |
---|
184 | </tr> |
---|
185 | <tr class="method-row inherited alt expandable"> |
---|
186 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
187 | <td class="sig"> |
---|
188 | <a id="Ext.data.Tree-fireEvent"></a> |
---|
189 | <b>fireEvent</b>( <code>String eventName</code>, <code>Object... args</code> ) : Boolean <div class="mdesc"> |
---|
190 | <div class="short">Fires the specified event with the passed parameters (minus the event name).</div> |
---|
191 | <div class="long"> |
---|
192 | Fires the specified event with the passed parameters (minus the event name). <div class="mdetail-params"> |
---|
193 | <strong>Parameters:</strong> |
---|
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> |
---|
195 | <strong>Returns:</strong> |
---|
196 | <ul> |
---|
197 | <li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li> |
---|
198 | </ul> |
---|
199 | </div> |
---|
200 | </div> |
---|
201 | </div> |
---|
202 | </td> |
---|
203 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td> |
---|
204 | </tr> |
---|
205 | <tr class="method-row expandable"> |
---|
206 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
207 | <td class="sig"> |
---|
208 | <a id="Ext.data.Tree-getNodeById"></a> |
---|
209 | <b>getNodeById</b>( <code>String id</code> ) : Node <div class="mdesc"> |
---|
210 | <div class="short">Gets a node in this tree by its id.</div> |
---|
211 | <div class="long"> |
---|
212 | Gets a node in this tree by its id. <div class="mdetail-params"> |
---|
213 | <strong>Parameters:</strong> |
---|
214 | <ul><li><code>id</code> : String<div class="sub-desc"></div></li> </ul> |
---|
215 | <strong>Returns:</strong> |
---|
216 | <ul> |
---|
217 | <li><code>Node</code></li> |
---|
218 | </ul> |
---|
219 | </div> |
---|
220 | </div> |
---|
221 | </div> |
---|
222 | </td> |
---|
223 | <td class="msource">Tree</td> |
---|
224 | </tr> |
---|
225 | <tr class="method-row alt expandable"> |
---|
226 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
227 | <td class="sig"> |
---|
228 | <a id="Ext.data.Tree-getRootNode"></a> |
---|
229 | <b>getRootNode</b>() : Node <div class="mdesc"> |
---|
230 | <div class="short">Returns the root node for this tree.</div> |
---|
231 | <div class="long"> |
---|
232 | Returns the root node for this tree. <div class="mdetail-params"> |
---|
233 | <strong>Parameters:</strong> |
---|
234 | <ul><li>None.</li> </ul> |
---|
235 | <strong>Returns:</strong> |
---|
236 | <ul> |
---|
237 | <li><code>Node</code></li> |
---|
238 | </ul> |
---|
239 | </div> |
---|
240 | </div> |
---|
241 | </div> |
---|
242 | </td> |
---|
243 | <td class="msource">Tree</td> |
---|
244 | </tr> |
---|
245 | <tr class="method-row inherited expandable"> |
---|
246 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
247 | <td class="sig"> |
---|
248 | <a id="Ext.data.Tree-hasListener"></a> |
---|
249 | <b>hasListener</b>( <code>String eventName</code> ) : Boolean <div class="mdesc"> |
---|
250 | <div class="short">Checks to see if this object has any listeners for a specified event</div> |
---|
251 | <div class="long"> |
---|
252 | Checks to see if this object has any listeners for a specified event <div class="mdetail-params"> |
---|
253 | <strong>Parameters:</strong> |
---|
254 | <ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li> </ul> |
---|
255 | <strong>Returns:</strong> |
---|
256 | <ul> |
---|
257 | <li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li> |
---|
258 | </ul> |
---|
259 | </div> |
---|
260 | </div> |
---|
261 | </div> |
---|
262 | </td> |
---|
263 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td> |
---|
264 | </tr> |
---|
265 | <tr class="method-row inherited alt expandable"> |
---|
266 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
267 | <td class="sig"> |
---|
268 | <a id="Ext.data.Tree-on"></a> |
---|
269 | <b>on</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span> ) : void <div class="mdesc"> |
---|
270 | <div class="short">Appends an event handler to this element (shorthand for addListener)</div> |
---|
271 | <div class="long"> |
---|
272 | Appends an event handler to this element (shorthand for addListener) <div class="mdetail-params"> |
---|
273 | <strong>Parameters:</strong> |
---|
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> |
---|
276 | <strong>Returns:</strong> |
---|
277 | <ul> |
---|
278 | <li><code>void</code></li> |
---|
279 | </ul> |
---|
280 | </div> |
---|
281 | </div> |
---|
282 | </div> |
---|
283 | </td> |
---|
284 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td> |
---|
285 | </tr> |
---|
286 | <tr class="method-row inherited expandable"> |
---|
287 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
288 | <td class="sig"> |
---|
289 | <a id="Ext.data.Tree-purgeListeners"></a> |
---|
290 | <b>purgeListeners</b>() : void <div class="mdesc"> |
---|
291 | <div class="short">Removes all listeners for this object</div> |
---|
292 | <div class="long"> |
---|
293 | Removes all listeners for this object <div class="mdetail-params"> |
---|
294 | <strong>Parameters:</strong> |
---|
295 | <ul><li>None.</li> </ul> |
---|
296 | <strong>Returns:</strong> |
---|
297 | <ul> |
---|
298 | <li><code>void</code></li> |
---|
299 | </ul> |
---|
300 | </div> |
---|
301 | </div> |
---|
302 | </div> |
---|
303 | </td> |
---|
304 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td> |
---|
305 | </tr> |
---|
306 | <tr class="method-row inherited alt expandable"> |
---|
307 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
308 | <td class="sig"> |
---|
309 | <a id="Ext.data.Tree-relayEvents"></a> |
---|
310 | <b>relayEvents</b>( <code>Object o</code>, <code>Array events</code> ) : void <div class="mdesc"> |
---|
311 | <div class="short">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.</div> |
---|
312 | <div class="long"> |
---|
313 | Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>. <div class="mdetail-params"> |
---|
314 | <strong>Parameters:</strong> |
---|
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> |
---|
316 | <strong>Returns:</strong> |
---|
317 | <ul> |
---|
318 | <li><code>void</code></li> |
---|
319 | </ul> |
---|
320 | </div> |
---|
321 | </div> |
---|
322 | </div> |
---|
323 | </td> |
---|
324 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#relayEvents" href="output/Ext.util.Observable.html#relayEvents">Observable</a></td> |
---|
325 | </tr> |
---|
326 | <tr class="method-row inherited expandable"> |
---|
327 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
328 | <td class="sig"> |
---|
329 | <a id="Ext.data.Tree-removeListener"></a> |
---|
330 | <b>removeListener</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc"> |
---|
331 | <div class="short">Removes a listener</div> |
---|
332 | <div class="long"> |
---|
333 | Removes a listener <div class="mdetail-params"> |
---|
334 | <strong>Parameters:</strong> |
---|
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> |
---|
336 | <strong>Returns:</strong> |
---|
337 | <ul> |
---|
338 | <li><code>void</code></li> |
---|
339 | </ul> |
---|
340 | </div> |
---|
341 | </div> |
---|
342 | </div> |
---|
343 | </td> |
---|
344 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td> |
---|
345 | </tr> |
---|
346 | <tr class="method-row inherited alt expandable"> |
---|
347 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
348 | <td class="sig"> |
---|
349 | <a id="Ext.data.Tree-resumeEvents"></a> |
---|
350 | <b>resumeEvents</b>() : void <div class="mdesc"> |
---|
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> |
---|
352 | <div class="long"> |
---|
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"> |
---|
354 | <strong>Parameters:</strong> |
---|
355 | <ul><li>None.</li> </ul> |
---|
356 | <strong>Returns:</strong> |
---|
357 | <ul> |
---|
358 | <li><code>void</code></li> |
---|
359 | </ul> |
---|
360 | </div> |
---|
361 | </div> |
---|
362 | </div> |
---|
363 | </td> |
---|
364 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td> |
---|
365 | </tr> |
---|
366 | <tr class="method-row expandable"> |
---|
367 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
368 | <td class="sig"> |
---|
369 | <a id="Ext.data.Tree-setRootNode"></a> |
---|
370 | <b>setRootNode</b>( <code>Node node</code> ) : Node <div class="mdesc"> |
---|
371 | <div class="short">Sets the root node for this tree.</div> |
---|
372 | <div class="long"> |
---|
373 | Sets the root node for this tree. <div class="mdetail-params"> |
---|
374 | <strong>Parameters:</strong> |
---|
375 | <ul><li><code>node</code> : Node<div class="sub-desc"></div></li> </ul> |
---|
376 | <strong>Returns:</strong> |
---|
377 | <ul> |
---|
378 | <li><code>Node</code></li> |
---|
379 | </ul> |
---|
380 | </div> |
---|
381 | </div> |
---|
382 | </div> |
---|
383 | </td> |
---|
384 | <td class="msource">Tree</td> |
---|
385 | </tr> |
---|
386 | <tr class="method-row inherited alt expandable"> |
---|
387 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
388 | <td class="sig"> |
---|
389 | <a id="Ext.data.Tree-suspendEvents"></a> |
---|
390 | <b>suspendEvents</b>() : void <div class="mdesc"> |
---|
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> |
---|
392 | <div class="long"> |
---|
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"> |
---|
394 | <strong>Parameters:</strong> |
---|
395 | <ul><li>None.</li> </ul> |
---|
396 | <strong>Returns:</strong> |
---|
397 | <ul> |
---|
398 | <li><code>void</code></li> |
---|
399 | </ul> |
---|
400 | </div> |
---|
401 | </div> |
---|
402 | </div> |
---|
403 | </td> |
---|
404 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td> |
---|
405 | </tr> |
---|
406 | <tr class="method-row inherited expandable"> |
---|
407 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
408 | <td class="sig"> |
---|
409 | <a id="Ext.data.Tree-un"></a> |
---|
410 | <b>un</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc"> |
---|
411 | <div class="short">Removes a listener (shorthand for removeListener)</div> |
---|
412 | <div class="long"> |
---|
413 | Removes a listener (shorthand for removeListener) <div class="mdetail-params"> |
---|
414 | <strong>Parameters:</strong> |
---|
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> |
---|
416 | <strong>Returns:</strong> |
---|
417 | <ul> |
---|
418 | <li><code>void</code></li> |
---|
419 | </ul> |
---|
420 | </div> |
---|
421 | </div> |
---|
422 | </div> |
---|
423 | </td> |
---|
424 | <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td> |
---|
425 | </tr> |
---|
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"> |
---|
435 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
436 | <td class="sig"> |
---|
437 | <a id="Ext.data.Tree-append"></a> |
---|
438 | <b>append</b> : ( <code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code>, <code>Number index</code> ) <div class="mdesc"> |
---|
439 | <div class="short">Fires when a new child node is appended to a node in this tree.</div> |
---|
440 | <div class="long"> |
---|
441 | Fires when a new child node is appended to a node in this tree. <div class="mdetail-params"> |
---|
442 | <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong> |
---|
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> |
---|
444 | </div> |
---|
445 | </div> |
---|
446 | </div> |
---|
447 | </td> |
---|
448 | <td class="msource">Tree</td> |
---|
449 | </tr> |
---|
450 | <tr class="event-row alt expandable"> |
---|
451 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
452 | <td class="sig"> |
---|
453 | <a id="Ext.data.Tree-beforeappend"></a> |
---|
454 | <b>beforeappend</b> : ( <code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code> ) <div class="mdesc"> |
---|
455 | <div class="short">Fires before a new child is appended to a node in this tree, return false to cancel the append.</div> |
---|
456 | <div class="long"> |
---|
457 | Fires before a new child is appended to a node in this tree, return false to cancel the append. <div class="mdetail-params"> |
---|
458 | <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong> |
---|
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> |
---|
460 | </div> |
---|
461 | </div> |
---|
462 | </div> |
---|
463 | </td> |
---|
464 | <td class="msource">Tree</td> |
---|
465 | </tr> |
---|
466 | <tr class="event-row expandable"> |
---|
467 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
468 | <td class="sig"> |
---|
469 | <a id="Ext.data.Tree-beforeinsert"></a> |
---|
470 | <b>beforeinsert</b> : ( <code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code>, <code>Node refNode</code> ) <div class="mdesc"> |
---|
471 | <div class="short">Fires before a new child is inserted in a node in this tree, return false to cancel the insert.</div> |
---|
472 | <div class="long"> |
---|
473 | Fires before a new child is inserted in a node in this tree, return false to cancel the insert. <div class="mdetail-params"> |
---|
474 | <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong> |
---|
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> |
---|
476 | </div> |
---|
477 | </div> |
---|
478 | </div> |
---|
479 | </td> |
---|
480 | <td class="msource">Tree</td> |
---|
481 | </tr> |
---|
482 | <tr class="event-row alt expandable"> |
---|
483 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
484 | <td class="sig"> |
---|
485 | <a id="Ext.data.Tree-beforemove"></a> |
---|
486 | <b>beforemove</b> : ( <code>Tree tree</code>, <code>Node node</code>, <code>Node oldParent</code>, <code>Node newParent</code>, <code>Number index</code> ) <div class="mdesc"> |
---|
487 | <div class="short">Fires before a node is moved to a new location in the tree. Return false to cancel the move.</div> |
---|
488 | <div class="long"> |
---|
489 | Fires before a node is moved to a new location in the tree. Return false to cancel the move. <div class="mdetail-params"> |
---|
490 | <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong> |
---|
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> |
---|
492 | </div> |
---|
493 | </div> |
---|
494 | </div> |
---|
495 | </td> |
---|
496 | <td class="msource">Tree</td> |
---|
497 | </tr> |
---|
498 | <tr class="event-row expandable"> |
---|
499 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
500 | <td class="sig"> |
---|
501 | <a id="Ext.data.Tree-beforeremove"></a> |
---|
502 | <b>beforeremove</b> : ( <code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code> ) <div class="mdesc"> |
---|
503 | <div class="short">Fires before a child is removed from a node in this tree, return false to cancel the remove.</div> |
---|
504 | <div class="long"> |
---|
505 | Fires before a child is removed from a node in this tree, return false to cancel the remove. <div class="mdetail-params"> |
---|
506 | <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong> |
---|
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> |
---|
508 | </div> |
---|
509 | </div> |
---|
510 | </div> |
---|
511 | </td> |
---|
512 | <td class="msource">Tree</td> |
---|
513 | </tr> |
---|
514 | <tr class="event-row alt expandable"> |
---|
515 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
516 | <td class="sig"> |
---|
517 | <a id="Ext.data.Tree-insert"></a> |
---|
518 | <b>insert</b> : ( <code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code>, <code>Node refNode</code> ) <div class="mdesc"> |
---|
519 | <div class="short">Fires when a new child node is inserted in a node in this tree.</div> |
---|
520 | <div class="long"> |
---|
521 | Fires when a new child node is inserted in a node in this tree. <div class="mdetail-params"> |
---|
522 | <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong> |
---|
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> |
---|
524 | </div> |
---|
525 | </div> |
---|
526 | </div> |
---|
527 | </td> |
---|
528 | <td class="msource">Tree</td> |
---|
529 | </tr> |
---|
530 | <tr class="event-row expandable"> |
---|
531 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
532 | <td class="sig"> |
---|
533 | <a id="Ext.data.Tree-move"></a> |
---|
534 | <b>move</b> : ( <code>Tree tree</code>, <code>Node node</code>, <code>Node oldParent</code>, <code>Node newParent</code>, <code>Number index</code> ) <div class="mdesc"> |
---|
535 | <div class="short">Fires when a node is moved to a new location in the tree</div> |
---|
536 | <div class="long"> |
---|
537 | Fires when a node is moved to a new location in the tree <div class="mdetail-params"> |
---|
538 | <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong> |
---|
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> |
---|
540 | </div> |
---|
541 | </div> |
---|
542 | </div> |
---|
543 | </td> |
---|
544 | <td class="msource">Tree</td> |
---|
545 | </tr> |
---|
546 | <tr class="event-row alt expandable"> |
---|
547 | <td class="micon"><a class="exi" href="#expand"> </a></td> |
---|
548 | <td class="sig"> |
---|
549 | <a id="Ext.data.Tree-remove"></a> |
---|
550 | <b>remove</b> : ( <code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code> ) <div class="mdesc"> |
---|
551 | <div class="short">Fires when a child node is removed from a node in this tree.</div> |
---|
552 | <div class="long"> |
---|
553 | Fires when a child node is removed from a node in this tree. <div class="mdetail-params"> |
---|
554 | <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong> |
---|
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> |
---|
556 | </div> |
---|
557 | </div> |
---|
558 | </div> |
---|
559 | </td> |
---|
560 | <td class="msource">Tree</td> |
---|
561 | </tr> |
---|
562 | </table> |
---|
563 | |
---|
564 | </div> |
---|