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