source: trunk/web/addons/job_monarch/lib/extjs/docs/output/Ext.tree.TreeLoader.html @ 619

Last change on this file since 619 was 619, checked in by ramonb, 15 years ago

lib/:

  • added new AJAX dependancies: ExtJS, pChart, Lightbox2
File size: 33.6 KB
Line 
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            *
21A 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
22nodes from a specified URL. The response must be a JavaScript Array definition
23whose 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>
38A server request is sent, and child nodes are loaded only when a node is expanded.
39The loading node's id is passed to the server under the parameter name "node" to
40enable the server to produce the correct child nodes.
41<br><br>
42To pass extra parameters, an event handler may be attached to the "beforeload"
43event, 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>
47This would pass an HTTP parameter called "category" to the server containing
48the 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">
59        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
60        <td class="sig">
61        <a id="Ext.tree.TreeLoader-baseAttrs"></a>
62            <b>baseAttrs</b> : Object            <div class="mdesc">
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>
64            <div class="long">
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>
66                        </div>
67        </td>
68        <td class="msource">TreeLoader</td>
69    </tr>
70        <tr class="config-row alt">
71        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
72        <td class="sig">
73        <a id="Ext.tree.TreeLoader-baseParams"></a>
74            <b>baseParams</b> : Object            <div class="mdesc">
75                            (optional) An object containing properties which specify HTTP parameters to be passed to each request for child nodes.                        </div>
76        </td>
77        <td class="msource">TreeLoader</td>
78    </tr>
79        <tr class="config-row">
80        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
81        <td class="sig">
82        <a id="Ext.tree.TreeLoader-clearOnLoad"></a>
83            <b>clearOnLoad</b> : Boolean            <div class="mdesc">
84                            (optional) Default to true. Remove previously existing child nodes before loading.                        </div>
85        </td>
86        <td class="msource">TreeLoader</td>
87    </tr>
88        <tr class="config-row alt expandable">
89        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
90        <td class="sig">
91        <a id="Ext.tree.TreeLoader-dataUrl"></a>
92            <b>dataUrl</b> : String            <div class="mdesc">
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>
94            <div class="long">
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>
96                        </div>
97        </td>
98        <td class="msource">TreeLoader</td>
99    </tr>
100        <tr class="config-row inherited expandable">
101        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
102        <td class="sig">
103        <a id="Ext.tree.TreeLoader-listeners"></a>
104            <b>listeners</b> : Object            <div class="mdesc">
105                        <div class="short">(optional) A config object containing one or more event handlers to be added to this object during initialization. Th...</div>
106            <div class="long">
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>
108                        </div>
109        </td>
110        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td>
111    </tr>
112        <tr class="config-row alt">
113        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
114        <td class="sig">
115        <a id="Ext.tree.TreeLoader-preloadChildren"></a>
116            <b>preloadChildren</b> : Boolean            <div class="mdesc">
117                            If set to true, the loader recursively loads "children" attributes when doing the first load on nodes.                        </div>
118        </td>
119        <td class="msource">TreeLoader</td>
120    </tr>
121        <tr class="config-row">
122        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
123        <td class="sig">
124        <a id="Ext.tree.TreeLoader-requestMethod"></a>
125            <b>requestMethod</b> : String            <div class="mdesc">
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>
127        </td>
128        <td class="msource">TreeLoader</td>
129    </tr>
130        <tr class="config-row alt expandable">
131        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
132        <td class="sig">
133        <a id="Ext.tree.TreeLoader-uiProviders"></a>
134            <b>uiProviders</b> : Object            <div class="mdesc">
135                        <div class="short">(optional) An object containing properties which specify custom Ext.tree.TreeNodeUI implementations. If the optional ...</div>
136            <div class="long">
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>
138                        </div>
139        </td>
140        <td class="msource">TreeLoader</td>
141    </tr>
142        <tr class="config-row">
143        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
144        <td class="sig">
145        <a id="Ext.tree.TreeLoader-url"></a>
146            <b>url</b> : String            <div class="mdesc">
147                            Equivalent to <a ext:cls="Ext.tree.TreeLoader" ext:member="dataUrl" href="output/Ext.tree.TreeLoader.html#dataUrl">dataUrl</a>.                        </div>
148        </td>
149        <td class="msource">TreeLoader</td>
150    </tr>
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">
162        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
163        <td class="sig">
164        <a id="Ext.tree.TreeLoader-TreeLoader"></a>
165            <b>TreeLoader</b>(&nbsp;<code>Object config</code>&nbsp;)            <div class="mdesc">
166                        <div class="short">Creates a new Treeloader.</div>
167            <div class="long">
168                Creates a new Treeloader.    <div class="mdetail-params">
169        <strong>Parameters:</strong>
170        <ul><li><code>config</code> : Object<div class="sub-desc">A config object containing config properties.</div></li>        </ul>
171        <strong>Returns:</strong>
172        <ul>
173            <li><code></code></li>
174        </ul>
175    </div>
176                </div>
177                        </div>
178        </td>
179        <td class="msource">TreeLoader</td>
180    </tr>
181        <tr class="method-row inherited alt expandable">
182        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
183        <td class="sig">
184        <a id="Ext.tree.TreeLoader-addEvents"></a>
185            <b>addEvents</b>(&nbsp;<code>Object object</code>&nbsp;) : void            <div class="mdesc">
186                        <div class="short">Used to define events on this Observable</div>
187            <div class="long">
188                Used to define events on this Observable    <div class="mdetail-params">
189        <strong>Parameters:</strong>
190        <ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li>        </ul>
191        <strong>Returns:</strong>
192        <ul>
193            <li><code>void</code></li>
194        </ul>
195    </div>
196                </div>
197                        </div>
198        </td>
199        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td>
200    </tr>
201        <tr class="method-row inherited expandable">
202        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
203        <td class="sig">
204        <a id="Ext.tree.TreeLoader-addListener"></a>
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">
206                        <div class="short">Appends an event handler to this component</div>
207            <div class="long">
208                Appends an event handler to this component    <div class="mdetail-params">
209        <strong>Parameters:</strong>
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
211function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration
212properties. 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
217by the specified number of milliseconds. If the event fires again within that time, the original
218handler 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>
222Using the options argument, it is possible to combine different types of listeners:<br>
223<br>
224A 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>
232The method also allows for a single argument to be passed which is a config object containing properties
233which 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>
251Or 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>
258        <strong>Returns:</strong>
259        <ul>
260            <li><code>void</code></li>
261        </ul>
262    </div>
263                </div>
264                        </div>
265        </td>
266        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td>
267    </tr>
268        <tr class="method-row alt expandable">
269        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
270        <td class="sig">
271        <a id="Ext.tree.TreeLoader-createNode"></a>
272            <b>createNode</b>(&nbsp;<code>attr {Object}</code>&nbsp;) : void            <div class="mdesc">
273                        <div class="short">Override this function for custom TreeNode node implementation, or to
274modify the attributes at creation time.
275Example...</div>
276            <div class="long">
277                <p>Override this function for custom TreeNode node implementation, or to
278modify the attributes at creation time.</p>
279Example:<code><pre>new Ext.tree.TreePanel({
280    ...
281    new Ext.tree.TreeLoader({
282        url: 'dataUrl',
283        createNode: function(attr) {
284//          Allow consolidation consignments to have
285//          consignments dropped into them.
286            if (attr.isConsolidation) {
287                attr.iconCls = 'x-consol',
288                attr.allowDrop = true;
289            }
290            return Ext.tree.TreeLoader.prototype.call(this, attr);
291        }
292    }),
293    ...
294});</pre></code>    <div class="mdetail-params">
295        <strong>Parameters:</strong>
296        <ul><li><code>{Object}</code> : attr<div class="sub-desc">The attributes from which to create the new node.</div></li>        </ul>
297        <strong>Returns:</strong>
298        <ul>
299            <li><code>void</code></li>
300        </ul>
301    </div>
302                </div>
303                        </div>
304        </td>
305        <td class="msource">TreeLoader</td>
306    </tr>
307        <tr class="method-row inherited expandable">
308        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
309        <td class="sig">
310        <a id="Ext.tree.TreeLoader-fireEvent"></a>
311            <b>fireEvent</b>(&nbsp;<code>String eventName</code>, <code>Object... args</code>&nbsp;) : Boolean            <div class="mdesc">
312                        <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
313            <div class="long">
314                Fires the specified event with the passed parameters (minus the event name).    <div class="mdetail-params">
315        <strong>Parameters:</strong>
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>
317        <strong>Returns:</strong>
318        <ul>
319            <li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li>
320        </ul>
321    </div>
322                </div>
323                        </div>
324        </td>
325        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td>
326    </tr>
327        <tr class="method-row inherited alt expandable">
328        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
329        <td class="sig">
330        <a id="Ext.tree.TreeLoader-hasListener"></a>
331            <b>hasListener</b>(&nbsp;<code>String eventName</code>&nbsp;) : Boolean            <div class="mdesc">
332                        <div class="short">Checks to see if this object has any listeners for a specified event</div>
333            <div class="long">
334                Checks to see if this object has any listeners for a specified event    <div class="mdetail-params">
335        <strong>Parameters:</strong>
336        <ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li>        </ul>
337        <strong>Returns:</strong>
338        <ul>
339            <li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li>
340        </ul>
341    </div>
342                </div>
343                        </div>
344        </td>
345        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td>
346    </tr>
347        <tr class="method-row expandable">
348        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
349        <td class="sig">
350        <a id="Ext.tree.TreeLoader-load"></a>
351            <b>load</b>(&nbsp;<code>Ext.tree.TreeNode node</code>, <code>Function callback</code>&nbsp;) : void            <div class="mdesc">
352                        <div class="short">Load an Ext.tree.TreeNode from the URL specified in the constructor.
353This is called automatically when a node is expa...</div>
354            <div class="long">
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.
356This is called automatically when a node is expanded, but may be used to reload
357a 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">
358        <strong>Parameters:</strong>
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>
360        <strong>Returns:</strong>
361        <ul>
362            <li><code>void</code></li>
363        </ul>
364    </div>
365                </div>
366                        </div>
367        </td>
368        <td class="msource">TreeLoader</td>
369    </tr>
370        <tr class="method-row inherited alt expandable">
371        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
372        <td class="sig">
373        <a id="Ext.tree.TreeLoader-on"></a>
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">
375                        <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
376            <div class="long">
377                Appends an event handler to this element (shorthand for addListener)    <div class="mdetail-params">
378        <strong>Parameters:</strong>
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
380function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li>        </ul>
381        <strong>Returns:</strong>
382        <ul>
383            <li><code>void</code></li>
384        </ul>
385    </div>
386                </div>
387                        </div>
388        </td>
389        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td>
390    </tr>
391        <tr class="method-row inherited expandable">
392        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
393        <td class="sig">
394        <a id="Ext.tree.TreeLoader-purgeListeners"></a>
395            <b>purgeListeners</b>() : void            <div class="mdesc">
396                        <div class="short">Removes all listeners for this object</div>
397            <div class="long">
398                Removes all listeners for this object    <div class="mdetail-params">
399        <strong>Parameters:</strong>
400        <ul><li>None.</li>        </ul>
401        <strong>Returns:</strong>
402        <ul>
403            <li><code>void</code></li>
404        </ul>
405    </div>
406                </div>
407                        </div>
408        </td>
409        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td>
410    </tr>
411        <tr class="method-row inherited alt expandable">
412        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
413        <td class="sig">
414        <a id="Ext.tree.TreeLoader-relayEvents"></a>
415            <b>relayEvents</b>(&nbsp;<code>Object o</code>, <code>Array events</code>&nbsp;) : void            <div class="mdesc">
416                        <div class="short">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.</div>
417            <div class="long">
418                Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.    <div class="mdetail-params">
419        <strong>Parameters:</strong>
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>
421        <strong>Returns:</strong>
422        <ul>
423            <li><code>void</code></li>
424        </ul>
425    </div>
426                </div>
427                        </div>
428        </td>
429        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#relayEvents" href="output/Ext.util.Observable.html#relayEvents">Observable</a></td>
430    </tr>
431        <tr class="method-row inherited expandable">
432        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
433        <td class="sig">
434        <a id="Ext.tree.TreeLoader-removeListener"></a>
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">
436                        <div class="short">Removes a listener</div>
437            <div class="long">
438                Removes a listener    <div class="mdetail-params">
439        <strong>Parameters:</strong>
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>
441        <strong>Returns:</strong>
442        <ul>
443            <li><code>void</code></li>
444        </ul>
445    </div>
446                </div>
447                        </div>
448        </td>
449        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td>
450    </tr>
451        <tr class="method-row inherited alt expandable">
452        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
453        <td class="sig">
454        <a id="Ext.tree.TreeLoader-resumeEvents"></a>
455            <b>resumeEvents</b>() : void            <div class="mdesc">
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>
457            <div class="long">
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">
459        <strong>Parameters:</strong>
460        <ul><li>None.</li>        </ul>
461        <strong>Returns:</strong>
462        <ul>
463            <li><code>void</code></li>
464        </ul>
465    </div>
466                </div>
467                        </div>
468        </td>
469        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td>
470    </tr>
471        <tr class="method-row inherited expandable">
472        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
473        <td class="sig">
474        <a id="Ext.tree.TreeLoader-suspendEvents"></a>
475            <b>suspendEvents</b>() : void            <div class="mdesc">
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>
477            <div class="long">
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">
479        <strong>Parameters:</strong>
480        <ul><li>None.</li>        </ul>
481        <strong>Returns:</strong>
482        <ul>
483            <li><code>void</code></li>
484        </ul>
485    </div>
486                </div>
487                        </div>
488        </td>
489        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td>
490    </tr>
491        <tr class="method-row inherited alt expandable">
492        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
493        <td class="sig">
494        <a id="Ext.tree.TreeLoader-un"></a>
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">
496                        <div class="short">Removes a listener (shorthand for removeListener)</div>
497            <div class="long">
498                Removes a listener (shorthand for removeListener)    <div class="mdetail-params">
499        <strong>Parameters:</strong>
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>
501        <strong>Returns:</strong>
502        <ul>
503            <li><code>void</code></li>
504        </ul>
505    </div>
506                </div>
507                        </div>
508        </td>
509        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td>
510    </tr>
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">
520        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
521        <td class="sig">
522        <a id="Ext.tree.TreeLoader-beforeload"></a>
523            <b>beforeload</b> : (&nbsp;<code>Object This</code>, <code>Object node</code>, <code>Object callback</code>&nbsp;)            <div class="mdesc">
524                        <div class="short">Fires before a network request is made to retrieve the Json text which specifies a node's children.</div>
525            <div class="long">
526                Fires before a network request is made to retrieve the Json text which specifies a node's children.    <div class="mdetail-params">
527        <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
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>
529    </div>
530                </div>
531                        </div>
532        </td>
533        <td class="msource">TreeLoader</td>
534    </tr>
535        <tr class="event-row alt expandable">
536        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
537        <td class="sig">
538        <a id="Ext.tree.TreeLoader-load"></a>
539            <b>load</b> : (&nbsp;<code>Object This</code>, <code>Object node</code>, <code>Object response</code>&nbsp;)            <div class="mdesc">
540                        <div class="short">Fires when the node has been successfuly loaded.</div>
541            <div class="long">
542                Fires when the node has been successfuly loaded.    <div class="mdetail-params">
543        <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
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>
545    </div>
546                </div>
547                        </div>
548        </td>
549        <td class="msource">TreeLoader</td>
550    </tr>
551        <tr class="event-row expandable">
552        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
553        <td class="sig">
554        <a id="Ext.tree.TreeLoader-loadexception"></a>
555            <b>loadexception</b> : (&nbsp;<code>Object This</code>, <code>Object node</code>, <code>Object response</code>&nbsp;)            <div class="mdesc">
556                        <div class="short">Fires if the network request failed.</div>
557            <div class="long">
558                Fires if the network request failed.    <div class="mdetail-params">
559        <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
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>
561    </div>
562                </div>
563                        </div>
564        </td>
565        <td class="msource">TreeLoader</td>
566    </tr>
567            </table>
568       
569        </div>
Note: See TracBrowser for help on using the repository browser.