Upgrade to ExtJS 4.0.1 - Released 05/18/2011
[extjs.git] / docs / output / Ext.data.Tree.js
1 Ext.data.JsonP.Ext_data_Tree({
2   "tagname": "class",
3   "name": "Ext.data.Tree",
4   "doc": "<p>This class is used as a container for a series of nodes. The nodes themselves maintain\nthe relationship between parent/child. The tree itself acts as a manager. It gives functionality\nto retrieve a node by its identifier: <a href=\"#/api/Ext.data.Tree-method-getNodeById\" rel=\"Ext.data.Tree-method-getNodeById\" class=\"docClass\">getNodeById</a>.</p>\n\n<p>The tree also relays events from any of it's child nodes, allowing them to be handled in a\ncentralized fashion. In general this class is not used directly, rather used internally\nby other parts of the framework.</p>\n",
5   "extends": null,
6   "mixins": [
7     "Ext.util.Observable"
8   ],
9   "alternateClassNames": [
10
11   ],
12   "xtype": null,
13   "author": null,
14   "docauthor": null,
15   "singleton": false,
16   "private": false,
17   "cfg": [
18     {
19       "tagname": "cfg",
20       "name": "listeners",
21       "member": "Ext.util.Observable",
22       "type": "Object",
23       "doc": "<p>(optional) <p>A config object containing one or more event handlers to be added to this\nobject during initialization.  This should be a valid listeners config object as specified in the\n<a href=\"#/api/Ext.data.Tree-method-addListener\" rel=\"Ext.data.Tree-method-addListener\" class=\"docClass\">addListener</a> example for attaching multiple handlers at once.</p></p>\n\n<br><p><b><u>DOM events from ExtJs <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a></u></b></p>\n\n\n<br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this\n\n\n<p>is usually only done when extra value can be added. For example the <a href=\"#/api/Ext.view.View\" rel=\"Ext.view.View\" class=\"docClass\">DataView</a>'s\n<b><code><a href=\"#/api/Ext.view.View--click\" rel=\"Ext.view.View--click\" class=\"docClass\">click</a></code></b> event passing the node clicked on. To access DOM\nevents directly from a child element of a Component, we need to specify the <code>element</code> option to\nidentify the Component property to add a DOM listener to:</p>\n\n<pre><code>new Ext.panel.Panel({\n    width: 400,\n    height: 200,\n    dockedItems: [{\n        xtype: 'toolbar'\n    }],\n    listeners: {\n        click: {\n            element: 'el', //bind to the underlying el property on the panel\n            fn: function(){ console.log('click el'); }\n        },\n        dblclick: {\n            element: 'body', //bind to the underlying body property on the panel\n            fn: function(){ console.log('dblclick body'); }\n        }\n    }\n});\n</code></pre>\n\n\n<p></p></p>\n",
24       "private": false,
25       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
26       "linenr": 103,
27       "html_filename": "Observable.html",
28       "href": "Observable.html#Ext-util-Observable-cfg-listeners",
29       "shortDoc": "(optional) A config object containing one or more event handlers to be added to this\nobject during initialization.  T..."
30     }
31   ],
32   "method": [
33     {
34       "tagname": "method",
35       "name": "Tree",
36       "member": "Ext.data.Tree",
37       "doc": "\n",
38       "params": [
39         {
40           "type": "Node",
41           "name": "root",
42           "doc": "<p>(optional) The root node</p>\n",
43           "optional": true
44         }
45       ],
46       "return": {
47         "type": "void",
48         "doc": "\n"
49       },
50       "private": false,
51       "static": false,
52       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Tree.js",
53       "linenr": 1,
54       "html_filename": "Tree.html",
55       "href": "Tree.html#Ext-data-Tree-method-constructor",
56       "shortDoc": "\n"
57     },
58     {
59       "tagname": "method",
60       "name": "addEvents",
61       "member": "Ext.util.Observable",
62       "doc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n",
63       "params": [
64         {
65           "type": "Object/String",
66           "name": "o",
67           "doc": "<p>Either an object with event names as properties with a value of <code>true</code>\nor the first event name string if multiple event names are being passed as separate parameters.</p>\n",
68           "optional": false
69         },
70         {
71           "type": "String",
72           "name": "",
73           "doc": "<p>[additional] Optional additional event names if multiple event names are being passed as separate parameters.\nUsage:</p>\n\n<pre><code>this.addEvents('storeloaded', 'storecleared');\n</code></pre>\n\n",
74           "optional": false
75         }
76       ],
77       "return": {
78         "type": "void",
79         "doc": "\n"
80       },
81       "private": false,
82       "static": false,
83       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
84       "linenr": 452,
85       "html_filename": "Observable.html",
86       "href": "Observable.html#Ext-util-Observable-method-addEvents",
87       "shortDoc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n"
88     },
89     {
90       "tagname": "method",
91       "name": "addListener",
92       "member": "Ext.util.Observable",
93       "doc": "<p>Appends an event handler to this object.</p>\n",
94       "params": [
95         {
96           "type": "String",
97           "name": "eventName",
98           "doc": "<p>The name of the event to listen for. May also be an object who's property names are event names. See</p>\n",
99           "optional": false
100         },
101         {
102           "type": "Function",
103           "name": "handler",
104           "doc": "<p>The method the event invokes.</p>\n",
105           "optional": false
106         },
107         {
108           "type": "Object",
109           "name": "scope",
110           "doc": "<p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.\n<b>If omitted, defaults to the object which fired the event.</b></p>\n",
111           "optional": true
112         },
113         {
114           "type": "Object",
115           "name": "options",
116           "doc": "<p>(optional) An object containing handler configuration.\nproperties. This may contain any of the following properties:<ul>\n<li><b>scope</b> : Object<div class=\"sub-desc\">The scope (<code><b>this</b></code> reference) in which the handler function is executed.\n<b>If omitted, defaults to the object which fired the event.</b></div></li>\n<li><b>delay</b> : Number<div class=\"sub-desc\">The number of milliseconds to delay the invocation of the handler after the event fires.</div></li>\n<li><b>single</b> : Boolean<div class=\"sub-desc\">True to add a handler to handle just the next firing of the event, and then remove itself.</div></li>\n<li><b>buffer</b> : Number<div class=\"sub-desc\">Causes the handler to be scheduled to run in an <a href=\"#/api/Ext.util.DelayedTask\" rel=\"Ext.util.DelayedTask\" class=\"docClass\">Ext.util.DelayedTask</a> delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>\n<li><b>target</b> : Observable<div class=\"sub-desc\">Only call the handler if the event was fired on the target Observable, <i>not</i>\nif the event was bubbled up from a child Observable.</div></li>\n<li><b>element</b> : String<div class=\"sub-desc\"><b>This option is only valid for listeners bound to <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a>.</b>\nThe name of a Component property which references an element to add a listener to.</p>\n\n<p>This option is useful during Component construction to add DOM event listeners to elements of <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a> which\nwill exist only after the Component is rendered. For example, to add a click listener to a Panel's body:\n<pre><code>new Ext.panel.Panel({\n    title: 'The title',\n    listeners: {\n        click: this.handlePanelClick,\n        element: 'body'\n    }\n});\n</code></pre></p>\n\n\n<p>When added in this way, the options available are the options applicable to <a href=\"#/api/Ext.core.Element-method-addListener\" rel=\"Ext.core.Element-method-addListener\" class=\"docClass\">Ext.core.Element.addListener</a></p>\n\n\n<p></div></li>\n</ul><br></p>\n\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA delayed, one-time listener.\n<pre><code>myPanel.on('hide', this.handleClick, this, {\nsingle: true,\ndelay: 100\n});</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple events. For example:\n<pre><code>myGridPanel.on({\n    cellClick: this.onCellClick,\n    mouseover: this.onMouseOver,\n    mouseout: this.onMouseOut,\n    scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n</code></pre>.\n<p>\n\n",
117           "optional": true
118         }
119       ],
120       "return": {
121         "type": "void",
122         "doc": "\n"
123       },
124       "private": false,
125       "static": false,
126       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
127       "linenr": 271,
128       "html_filename": "Observable.html",
129       "href": "Observable.html#Ext-util-Observable-method-addListener",
130       "shortDoc": "<p>Appends an event handler to this object.</p>\n"
131     },
132     {
133       "tagname": "method",
134       "name": "addManagedListener",
135       "member": "Ext.util.Observable",
136       "doc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n",
137       "params": [
138         {
139           "type": "Observable/Element",
140           "name": "item",
141           "doc": "<p>The item to which to add a listener/listeners.</p>\n",
142           "optional": false
143         },
144         {
145           "type": "Object/String",
146           "name": "ename",
147           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
148           "optional": false
149         },
150         {
151           "type": "Function",
152           "name": "fn",
153           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
154           "optional": false
155         },
156         {
157           "type": "Object",
158           "name": "scope",
159           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the scope (<code>this</code> reference) in which the handler function is executed.</p>\n",
160           "optional": false
161         },
162         {
163           "type": "Object",
164           "name": "opt",
165           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">addListener</a> options.</p>\n",
166           "optional": false
167         }
168       ],
169       "return": {
170         "type": "void",
171         "doc": "\n"
172       },
173       "private": false,
174       "static": false,
175       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
176       "linenr": 155,
177       "html_filename": "Observable.html",
178       "href": "Observable.html#Ext-util-Observable-method-addManagedListener",
179       "shortDoc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n"
180     },
181     {
182       "tagname": "method",
183       "name": "capture",
184       "member": "Ext.util.Observable",
185       "doc": "<p>Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.</p>\n",
186       "params": [
187         {
188           "type": "Observable",
189           "name": "o",
190           "doc": "<p>The Observable to capture events from.</p>\n",
191           "optional": false
192         },
193         {
194           "type": "Function",
195           "name": "fn",
196           "doc": "<p>The function to call when an event is fired.</p>\n",
197           "optional": false
198         },
199         {
200           "type": "Object",
201           "name": "scope",
202           "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>\n",
203           "optional": true
204         }
205       ],
206       "return": {
207         "type": "void",
208         "doc": "\n"
209       },
210       "private": false,
211       "static": true,
212       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
213       "linenr": 55,
214       "html_filename": "Observable.html",
215       "href": "Observable.html#Ext-util-Observable-method-capture",
216       "shortDoc": "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + ..."
217     },
218     {
219       "tagname": "method",
220       "name": "clearListeners",
221       "member": "Ext.util.Observable",
222       "doc": "<p>Removes all listeners for this object including the managed listeners</p>\n",
223       "params": [
224
225       ],
226       "return": {
227         "type": "void",
228         "doc": "\n"
229       },
230       "private": false,
231       "static": false,
232       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
233       "linenr": 383,
234       "html_filename": "Observable.html",
235       "href": "Observable.html#Ext-util-Observable-method-clearListeners",
236       "shortDoc": "<p>Removes all listeners for this object including the managed listeners</p>\n"
237     },
238     {
239       "tagname": "method",
240       "name": "clearManagedListeners",
241       "member": "Ext.util.Observable",
242       "doc": "<p>Removes all managed listeners for this object.</p>\n",
243       "params": [
244
245       ],
246       "return": {
247         "type": "void",
248         "doc": "\n"
249       },
250       "private": false,
251       "static": false,
252       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
253       "linenr": 412,
254       "html_filename": "Observable.html",
255       "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners",
256       "shortDoc": "<p>Removes all managed listeners for this object.</p>\n"
257     },
258     {
259       "tagname": "method",
260       "name": "enableBubble",
261       "member": "Ext.util.Observable",
262       "doc": "<p>Enables events fired by this Observable to bubble up an owner hierarchy by calling\n<code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>\n\n\n<p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href=\"#/api/Ext.Component-method-getBubbleTarget\" rel=\"Ext.Component-method-getBubbleTarget\" class=\"docClass\">Ext.Component.getBubbleTarget</a>. The default\nimplementation in <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Ext.Component</a> returns the Component's immediate owner. But if a known target is required, this can be overridden to\naccess the required target more quickly.</p>\n\n\n<p>Example:</p>\n\n\n<pre><code>Ext.override(Ext.form.field.Base, {\n//  Add functionality to Field&#39;s initComponent to enable the change event to bubble\ninitComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {\n    this.enableBubble('change');\n}),\n\n//  We know that we want Field&#39;s events to bubble directly to the FormPanel.\ngetBubbleTarget : function() {\n    if (!this.formPanel) {\n        this.formPanel = this.findParentByType('form');\n    }\n    return this.formPanel;\n}\n});\n\nvar myForm = new Ext.formPanel({\ntitle: 'User Details',\nitems: [{\n    ...\n}],\nlisteners: {\n    change: function() {\n        // Title goes red if form has been modified.\n        myForm.header.setStyle('color', 'red');\n    }\n}\n});\n</code></pre>\n\n",
263       "params": [
264         {
265           "type": "String/Array",
266           "name": "events",
267           "doc": "<p>The event name to bubble, or an Array of event names.</p>\n",
268           "optional": false
269         }
270       ],
271       "return": {
272         "type": "void",
273         "doc": "\n"
274       },
275       "private": false,
276       "static": false,
277       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
278       "linenr": 554,
279       "html_filename": "Observable.html",
280       "href": "Observable.html#Ext-util-Observable-method-enableBubble",
281       "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present...."
282     },
283     {
284       "tagname": "method",
285       "name": "fireEvent",
286       "member": "Ext.util.Observable",
287       "doc": "<p>Fires the specified event with the passed parameters (minus the event name).</p>\n\n\n<p>An event may be set to bubble up an Observable parent hierarchy (See <a href=\"#/api/Ext.Component-method-getBubbleTarget\" rel=\"Ext.Component-method-getBubbleTarget\" class=\"docClass\">Ext.Component.getBubbleTarget</a>)\nby calling <a href=\"#/api/Ext.data.Tree-method-enableBubble\" rel=\"Ext.data.Tree-method-enableBubble\" class=\"docClass\">enableBubble</a>.</p>\n\n",
288       "params": [
289         {
290           "type": "String",
291           "name": "eventName",
292           "doc": "<p>The name of the event to fire.</p>\n",
293           "optional": false
294         },
295         {
296           "type": "Object...",
297           "name": "args",
298           "doc": "<p>Variable number of parameters are passed to handlers.</p>\n",
299           "optional": false
300         }
301       ],
302       "return": {
303         "type": "Boolean",
304         "doc": "<p>returns false if any of the handlers return false otherwise it returns true.</p>\n"
305       },
306       "private": false,
307       "static": false,
308       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
309       "linenr": 232,
310       "html_filename": "Observable.html",
311       "href": "Observable.html#Ext-util-Observable-method-fireEvent",
312       "shortDoc": "Fires the specified event with the passed parameters (minus the event name).\n\n\nAn event may be set to bubble up an Ob..."
313     },
314     {
315       "tagname": "method",
316       "name": "getNodeById",
317       "member": "Ext.data.Tree",
318       "doc": "<p>Gets a node in this tree by its id.</p>\n",
319       "params": [
320         {
321           "type": "String",
322           "name": "id",
323           "doc": "\n",
324           "optional": false
325         }
326       ],
327       "return": {
328         "type": "Ext.data.NodeInterface",
329         "doc": "<p>The match node.</p>\n"
330       },
331       "private": false,
332       "static": false,
333       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Tree.js",
334       "linenr": 242,
335       "html_filename": "Tree.html",
336       "href": "Tree.html#Ext-data-Tree-method-getNodeById",
337       "shortDoc": "<p>Gets a node in this tree by its id.</p>\n"
338     },
339     {
340       "tagname": "method",
341       "name": "getRootNode",
342       "member": "Ext.data.Tree",
343       "doc": "<p>Returns the root node for this tree.</p>\n",
344       "params": [
345
346       ],
347       "return": {
348         "type": "Ext.data.NodeInterface",
349         "doc": "\n"
350       },
351       "private": false,
352       "static": false,
353       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Tree.js",
354       "linenr": 40,
355       "html_filename": "Tree.html",
356       "href": "Tree.html#Ext-data-Tree-method-getRootNode",
357       "shortDoc": "<p>Returns the root node for this tree.</p>\n"
358     },
359     {
360       "tagname": "method",
361       "name": "hasListener",
362       "member": "Ext.util.Observable",
363       "doc": "<p>Checks to see if this object has any listeners for a specified event</p>\n",
364       "params": [
365         {
366           "type": "String",
367           "name": "eventName",
368           "doc": "<p>The name of the event to check for</p>\n",
369           "optional": false
370         }
371       ],
372       "return": {
373         "type": "Boolean",
374         "doc": "<p>True if the event is being listened for, else false</p>\n"
375       },
376       "private": false,
377       "static": false,
378       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
379       "linenr": 480,
380       "html_filename": "Observable.html",
381       "href": "Observable.html#Ext-util-Observable-method-hasListener",
382       "shortDoc": "<p>Checks to see if this object has any listeners for a specified event</p>\n"
383     },
384     {
385       "tagname": "method",
386       "name": "observe",
387       "member": "Ext.util.Observable",
388       "doc": "<p>Sets observability on the passed class constructor.</p>\n\n<p>This makes any event fired on any instance of the passed class also fire a single event through\nthe <strong>class</strong> allowing for central handling of events on many instances at once.</p>\n\n<p>Usage:</p>\n\n<pre><code>Ext.util.Observable.observe(Ext.data.Connection);\nExt.data.Connection.on('beforerequest', function(con, options) {\n    console.log('Ajax request made to ' + options.url);\n});\n</code></pre>\n",
389       "params": [
390         {
391           "type": "Function",
392           "name": "c",
393           "doc": "<p>The class constructor to make observable.</p>\n",
394           "optional": false
395         },
396         {
397           "type": "Object",
398           "name": "listeners",
399           "doc": "<p>An object containing a series of listeners to add. See <a href=\"#/api/Ext.data.Tree-method-addListener\" rel=\"Ext.data.Tree-method-addListener\" class=\"docClass\">addListener</a>.</p>\n",
400           "optional": false
401         }
402       ],
403       "return": {
404         "type": "void",
405         "doc": "\n"
406       },
407       "private": false,
408       "static": true,
409       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
410       "linenr": 69,
411       "html_filename": "Observable.html",
412       "href": "Observable.html#Ext-util-Observable-method-observe",
413       "shortDoc": "Sets observability on the passed class constructor.\n\nThis makes any event fired on any instance of the passed class a..."
414     },
415     {
416       "tagname": "method",
417       "name": "on",
418       "member": "Ext.util.Observable",
419       "doc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.data.Tree-method-addListener\" rel=\"Ext.data.Tree-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n",
420       "params": [
421         {
422           "type": "String",
423           "name": "eventName",
424           "doc": "<p>The type of event to listen for</p>\n",
425           "optional": false
426         },
427         {
428           "type": "Function",
429           "name": "handler",
430           "doc": "<p>The method the event invokes</p>\n",
431           "optional": false
432         },
433         {
434           "type": "Object",
435           "name": "scope",
436           "doc": "<p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.\n<b>If omitted, defaults to the object which fired the event.</b></p>\n",
437           "optional": true
438         },
439         {
440           "type": "Object",
441           "name": "options",
442           "doc": "<p>(optional) An object containing handler configuration.</p>\n",
443           "optional": true
444         }
445       ],
446       "return": {
447         "type": "void",
448         "doc": "\n"
449       },
450       "private": false,
451       "static": false,
452       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
453       "linenr": 616,
454       "html_filename": "Observable.html",
455       "href": "Observable.html#Ext-util-Observable-method-on",
456       "shortDoc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.data.Tree-method-addListener\" rel=\"Ext.data.Tree-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n"
457     },
458     {
459       "tagname": "method",
460       "name": "relayEvents",
461       "member": "Ext.util.Observable",
462       "doc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n",
463       "params": [
464         {
465           "type": "Object",
466           "name": "origin",
467           "doc": "<p>The Observable whose events this object is to relay.</p>\n",
468           "optional": false
469         },
470         {
471           "type": "Array",
472           "name": "events",
473           "doc": "<p>Array of event names to relay.</p>\n",
474           "optional": false
475         },
476         {
477           "type": "Object",
478           "name": "prefix",
479           "doc": "\n",
480           "optional": false
481         }
482       ],
483       "return": {
484         "type": "void",
485         "doc": "\n"
486       },
487       "private": false,
488       "static": false,
489       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
490       "linenr": 520,
491       "html_filename": "Observable.html",
492       "href": "Observable.html#Ext-util-Observable-method-relayEvents",
493       "shortDoc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n"
494     },
495     {
496       "tagname": "method",
497       "name": "releaseCapture",
498       "member": "Ext.util.Observable",
499       "doc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n",
500       "params": [
501         {
502           "type": "Observable",
503           "name": "o",
504           "doc": "<p>The Observable to release</p>\n",
505           "optional": false
506         }
507       ],
508       "return": {
509         "type": "void",
510         "doc": "\n"
511       },
512       "private": false,
513       "static": true,
514       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
515       "linenr": 46,
516       "html_filename": "Observable.html",
517       "href": "Observable.html#Ext-util-Observable-method-releaseCapture",
518       "shortDoc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n"
519     },
520     {
521       "tagname": "method",
522       "name": "removeListener",
523       "member": "Ext.util.Observable",
524       "doc": "<p>Removes an event handler.</p>\n",
525       "params": [
526         {
527           "type": "String",
528           "name": "eventName",
529           "doc": "<p>The type of event the handler was associated with.</p>\n",
530           "optional": false
531         },
532         {
533           "type": "Function",
534           "name": "handler",
535           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.data.Tree-method-addListener\" rel=\"Ext.data.Tree-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
536           "optional": false
537         },
538         {
539           "type": "Object",
540           "name": "scope",
541           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
542           "optional": true
543         }
544       ],
545       "return": {
546         "type": "void",
547         "doc": "\n"
548       },
549       "private": false,
550       "static": false,
551       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
552       "linenr": 352,
553       "html_filename": "Observable.html",
554       "href": "Observable.html#Ext-util-Observable-method-removeListener",
555       "shortDoc": "<p>Removes an event handler.</p>\n"
556     },
557     {
558       "tagname": "method",
559       "name": "removeManagedListener",
560       "member": "Ext.util.Observable",
561       "doc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.data.Tree--mon\" rel=\"Ext.data.Tree--mon\" class=\"docClass\">mon</a> method.</p>\n",
562       "params": [
563         {
564           "type": "Observable|Element",
565           "name": "item",
566           "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
567           "optional": false
568         },
569         {
570           "type": "Object|String",
571           "name": "ename",
572           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
573           "optional": false
574         },
575         {
576           "type": "Function",
577           "name": "fn",
578           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
579           "optional": false
580         },
581         {
582           "type": "Object",
583           "name": "scope",
584           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the scope (<code>this</code> reference) in which the handler function is executed.</p>\n",
585           "optional": false
586         }
587       ],
588       "return": {
589         "type": "void",
590         "doc": "\n"
591       },
592       "private": false,
593       "static": false,
594       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
595       "linenr": 196,
596       "html_filename": "Observable.html",
597       "href": "Observable.html#Ext-util-Observable-method-removeManagedListener",
598       "shortDoc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.data.Tree--mon\" rel=\"Ext.data.Tree--mon\" class=\"docClass\">mon</a> method.</p>\n"
599     },
600     {
601       "tagname": "method",
602       "name": "resumeEvents",
603       "member": "Ext.util.Observable",
604       "doc": "<p>Resume firing events. (see <a href=\"#/api/Ext.data.Tree-method-suspendEvents\" rel=\"Ext.data.Tree-method-suspendEvents\" class=\"docClass\">suspendEvents</a>)\nIf events were suspended using the <code><b>queueSuspended</b></code> parameter, then all\nevents fired during event suspension will be sent to any listeners now.</p>\n",
605       "params": [
606
607       ],
608       "return": {
609         "type": "void",
610         "doc": "\n"
611       },
612       "private": false,
613       "static": false,
614       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
615       "linenr": 502,
616       "html_filename": "Observable.html",
617       "href": "Observable.html#Ext-util-Observable-method-resumeEvents",
618       "shortDoc": "Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevent..."
619     },
620     {
621       "tagname": "method",
622       "name": "setRootNode",
623       "member": "Ext.data.Tree",
624       "doc": "<p>Sets the root node for this tree.</p>\n",
625       "params": [
626         {
627           "type": "Ext.data.NodeInterface",
628           "name": "node",
629           "doc": "\n",
630           "optional": false
631         }
632       ],
633       "return": {
634         "type": "Ext.data.NodeInterface",
635         "doc": "<p>The root node</p>\n"
636       },
637       "private": false,
638       "static": false,
639       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Tree.js",
640       "linenr": 48,
641       "html_filename": "Tree.html",
642       "href": "Tree.html#Ext-data-Tree-method-setRootNode",
643       "shortDoc": "<p>Sets the root node for this tree.</p>\n"
644     },
645     {
646       "tagname": "method",
647       "name": "suspendEvents",
648       "member": "Ext.util.Observable",
649       "doc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.data.Tree-method-resumeEvents\" rel=\"Ext.data.Tree-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n",
650       "params": [
651         {
652           "type": "Boolean",
653           "name": "queueSuspended",
654           "doc": "<p>Pass as true to queue up suspended events to be fired\nafter the <a href=\"#/api/Ext.data.Tree-method-resumeEvents\" rel=\"Ext.data.Tree-method-resumeEvents\" class=\"docClass\">resumeEvents</a> call instead of discarding all suspended events;</p>\n",
655           "optional": false
656         }
657       ],
658       "return": {
659         "type": "void",
660         "doc": "\n"
661       },
662       "private": false,
663       "static": false,
664       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
665       "linenr": 490,
666       "html_filename": "Observable.html",
667       "href": "Observable.html#Ext-util-Observable-method-suspendEvents",
668       "shortDoc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.data.Tree-method-resumeEvents\" rel=\"Ext.data.Tree-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n"
669     },
670     {
671       "tagname": "method",
672       "name": "un",
673       "member": "Ext.util.Observable",
674       "doc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.data.Tree-method-removeListener\" rel=\"Ext.data.Tree-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n",
675       "params": [
676         {
677           "type": "String",
678           "name": "eventName",
679           "doc": "<p>The type of event the handler was associated with.</p>\n",
680           "optional": false
681         },
682         {
683           "type": "Function",
684           "name": "handler",
685           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.data.Tree-method-addListener\" rel=\"Ext.data.Tree-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
686           "optional": false
687         },
688         {
689           "type": "Object",
690           "name": "scope",
691           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
692           "optional": true
693         }
694       ],
695       "return": {
696         "type": "void",
697         "doc": "\n"
698       },
699       "private": false,
700       "static": false,
701       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
702       "linenr": 608,
703       "html_filename": "Observable.html",
704       "href": "Observable.html#Ext-util-Observable-method-un",
705       "shortDoc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.data.Tree-method-removeListener\" rel=\"Ext.data.Tree-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n"
706     }
707   ],
708   "property": [
709     {
710       "tagname": "property",
711       "name": "root",
712       "member": "Ext.data.Tree",
713       "type": "Node",
714       "doc": "<p>The root node for this tree</p>\n",
715       "private": false,
716       "static": false,
717       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Tree.js",
718       "linenr": 22,
719       "html_filename": "Tree.html",
720       "href": "Tree.html#Ext-data-Tree-property-root"
721     }
722   ],
723   "event": [
724     {
725       "tagname": "event",
726       "name": "append",
727       "member": "Ext.data.Tree",
728       "doc": "<p>Fires when a new child node is appended to a node in this tree.</p>\n",
729       "params": [
730         {
731           "type": "Tree",
732           "name": "tree",
733           "doc": "<p>The owner tree</p>\n",
734           "optional": false
735         },
736         {
737           "type": "Node",
738           "name": "parent",
739           "doc": "<p>The parent node</p>\n",
740           "optional": false
741         },
742         {
743           "type": "Node",
744           "name": "node",
745           "doc": "<p>The newly appended node</p>\n",
746           "optional": false
747         },
748         {
749           "type": "Number",
750           "name": "index",
751           "doc": "<p>The index of the newly appended node</p>\n",
752           "optional": false
753         }
754       ],
755       "private": false,
756       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Tree.js",
757       "linenr": 64,
758       "html_filename": "Tree.html",
759       "href": "Tree.html#Ext-data-Tree-event-append",
760       "shortDoc": "<p>Fires when a new child node is appended to a node in this tree.</p>\n"
761     },
762     {
763       "tagname": "event",
764       "name": "beforeappend",
765       "member": "Ext.data.Tree",
766       "doc": "<p>Fires before a new child is appended to a node in this tree, return false to cancel the append.</p>\n",
767       "params": [
768         {
769           "type": "Tree",
770           "name": "tree",
771           "doc": "<p>The owner tree</p>\n",
772           "optional": false
773         },
774         {
775           "type": "Node",
776           "name": "parent",
777           "doc": "<p>The parent node</p>\n",
778           "optional": false
779         },
780         {
781           "type": "Node",
782           "name": "node",
783           "doc": "<p>The child node to be appended</p>\n",
784           "optional": false
785         }
786       ],
787       "private": false,
788       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Tree.js",
789       "linenr": 104,
790       "html_filename": "Tree.html",
791       "href": "Tree.html#Ext-data-Tree-event-beforeappend",
792       "shortDoc": "<p>Fires before a new child is appended to a node in this tree, return false to cancel the append.</p>\n"
793     },
794     {
795       "tagname": "event",
796       "name": "beforecollapse",
797       "member": "Ext.data.Tree",
798       "doc": "<p>Fires before this node is collapsed.</p>\n",
799       "params": [
800         {
801           "type": "Node",
802           "name": "this",
803           "doc": "<p>The collapsing node</p>\n",
804           "optional": false
805         }
806       ],
807       "private": false,
808       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Tree.js",
809       "linenr": 164,
810       "html_filename": "Tree.html",
811       "href": "Tree.html#Ext-data-Tree-event-beforecollapse",
812       "shortDoc": "<p>Fires before this node is collapsed.</p>\n"
813     },
814     {
815       "tagname": "event",
816       "name": "beforeexpand",
817       "member": "Ext.data.Tree",
818       "doc": "<p>Fires before this node is expanded.</p>\n",
819       "params": [
820         {
821           "type": "Node",
822           "name": "this",
823           "doc": "<p>The expanding node</p>\n",
824           "optional": false
825         }
826       ],
827       "private": false,
828       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Tree.js",
829       "linenr": 157,
830       "html_filename": "Tree.html",
831       "href": "Tree.html#Ext-data-Tree-event-beforeexpand",
832       "shortDoc": "<p>Fires before this node is expanded.</p>\n"
833     },
834     {
835       "tagname": "event",
836       "name": "beforeinsert",
837       "member": "Ext.data.Tree",
838       "doc": "<p>Fires before a new child is inserted in a node in this tree, return false to cancel the insert.</p>\n",
839       "params": [
840         {
841           "type": "Tree",
842           "name": "tree",
843           "doc": "<p>The owner tree</p>\n",
844           "optional": false
845         },
846         {
847           "type": "Node",
848           "name": "parent",
849           "doc": "<p>The parent node</p>\n",
850           "optional": false
851         },
852         {
853           "type": "Node",
854           "name": "node",
855           "doc": "<p>The child node to be inserted</p>\n",
856           "optional": false
857         },
858         {
859           "type": "Node",
860           "name": "refNode",
861           "doc": "<p>The child node the node is being inserted before</p>\n",
862           "optional": false
863         }
864       ],
865       "private": false,
866       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Tree.js",
867       "linenr": 133,
868       "html_filename": "Tree.html",
869       "href": "Tree.html#Ext-data-Tree-event-beforeinsert",
870       "shortDoc": "<p>Fires before a new child is inserted in a node in this tree, return false to cancel the insert.</p>\n"
871     },
872     {
873       "tagname": "event",
874       "name": "beforemove",
875       "member": "Ext.data.Tree",
876       "doc": "<p>Fires before a node is moved to a new location in the tree. Return false to cancel the move.</p>\n",
877       "params": [
878         {
879           "type": "Tree",
880           "name": "tree",
881           "doc": "<p>The owner tree</p>\n",
882           "optional": false
883         },
884         {
885           "type": "Node",
886           "name": "node",
887           "doc": "<p>The node being moved</p>\n",
888           "optional": false
889         },
890         {
891           "type": "Node",
892           "name": "oldParent",
893           "doc": "<p>The parent of the node</p>\n",
894           "optional": false
895         },
896         {
897           "type": "Node",
898           "name": "newParent",
899           "doc": "<p>The new parent the node is moving to</p>\n",
900           "optional": false
901         },
902         {
903           "type": "Number",
904           "name": "index",
905           "doc": "<p>The index it is being moved to</p>\n",
906           "optional": false
907         }
908       ],
909       "private": false,
910       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Tree.js",
911       "linenr": 122,
912       "html_filename": "Tree.html",
913       "href": "Tree.html#Ext-data-Tree-event-beforemove",
914       "shortDoc": "<p>Fires before a node is moved to a new location in the tree. Return false to cancel the move.</p>\n"
915     },
916     {
917       "tagname": "event",
918       "name": "beforeremove",
919       "member": "Ext.data.Tree",
920       "doc": "<p>Fires before a child is removed from a node in this tree, return false to cancel the remove.</p>\n",
921       "params": [
922         {
923           "type": "Tree",
924           "name": "tree",
925           "doc": "<p>The owner tree</p>\n",
926           "optional": false
927         },
928         {
929           "type": "Node",
930           "name": "parent",
931           "doc": "<p>The parent node</p>\n",
932           "optional": false
933         },
934         {
935           "type": "Node",
936           "name": "node",
937           "doc": "<p>The child node to be removed</p>\n",
938           "optional": false
939         }
940       ],
941       "private": false,
942       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Tree.js",
943       "linenr": 113,
944       "html_filename": "Tree.html",
945       "href": "Tree.html#Ext-data-Tree-event-beforeremove",
946       "shortDoc": "<p>Fires before a child is removed from a node in this tree, return false to cancel the remove.</p>\n"
947     },
948     {
949       "tagname": "event",
950       "name": "collapse",
951       "member": "Ext.data.Tree",
952       "doc": "<p>Fires when this node is collapsed.</p>\n",
953       "params": [
954         {
955           "type": "Node",
956           "name": "this",
957           "doc": "<p>The collapsing node</p>\n",
958           "optional": false
959         }
960       ],
961       "private": false,
962       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Tree.js",
963       "linenr": 150,
964       "html_filename": "Tree.html",
965       "href": "Tree.html#Ext-data-Tree-event-collapse",
966       "shortDoc": "<p>Fires when this node is collapsed.</p>\n"
967     },
968     {
969       "tagname": "event",
970       "name": "expand",
971       "member": "Ext.data.Tree",
972       "doc": "<p>Fires when this node is expanded.</p>\n",
973       "params": [
974         {
975           "type": "Node",
976           "name": "this",
977           "doc": "<p>The expanding node</p>\n",
978           "optional": false
979         }
980       ],
981       "private": false,
982       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Tree.js",
983       "linenr": 143,
984       "html_filename": "Tree.html",
985       "href": "Tree.html#Ext-data-Tree-event-expand",
986       "shortDoc": "<p>Fires when this node is expanded.</p>\n"
987     },
988     {
989       "tagname": "event",
990       "name": "insert",
991       "member": "Ext.data.Tree",
992       "doc": "<p>Fires when a new child node is inserted in a node in this tree.</p>\n",
993       "params": [
994         {
995           "type": "Tree",
996           "name": "tree",
997           "doc": "<p>The owner tree</p>\n",
998           "optional": false
999         },
1000         {
1001           "type": "Node",
1002           "name": "parent",
1003           "doc": "<p>The parent node</p>\n",
1004           "optional": false
1005         },
1006         {
1007           "type": "Node",
1008           "name": "node",
1009           "doc": "<p>The child node inserted</p>\n",
1010           "optional": false
1011         },
1012         {
1013           "type": "Node",
1014           "name": "refNode",
1015           "doc": "<p>The child node the node was inserted before</p>\n",
1016           "optional": false
1017         }
1018       ],
1019       "private": false,
1020       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Tree.js",
1021       "linenr": 94,
1022       "html_filename": "Tree.html",
1023       "href": "Tree.html#Ext-data-Tree-event-insert",
1024       "shortDoc": "<p>Fires when a new child node is inserted in a node in this tree.</p>\n"
1025     },
1026     {
1027       "tagname": "event",
1028       "name": "move",
1029       "member": "Ext.data.Tree",
1030       "doc": "<p>Fires when a node is moved to a new location in the tree</p>\n",
1031       "params": [
1032         {
1033           "type": "Tree",
1034           "name": "tree",
1035           "doc": "<p>The owner tree</p>\n",
1036           "optional": false
1037         },
1038         {
1039           "type": "Node",
1040           "name": "node",
1041           "doc": "<p>The node moved</p>\n",
1042           "optional": false
1043         },
1044         {
1045           "type": "Node",
1046           "name": "oldParent",
1047           "doc": "<p>The old parent of this node</p>\n",
1048           "optional": false
1049         },
1050         {
1051           "type": "Node",
1052           "name": "newParent",
1053           "doc": "<p>The new parent of this node</p>\n",
1054           "optional": false
1055         },
1056         {
1057           "type": "Number",
1058           "name": "index",
1059           "doc": "<p>The index it was moved to</p>\n",
1060           "optional": false
1061         }
1062       ],
1063       "private": false,
1064       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Tree.js",
1065       "linenr": 83,
1066       "html_filename": "Tree.html",
1067       "href": "Tree.html#Ext-data-Tree-event-move",
1068       "shortDoc": "<p>Fires when a node is moved to a new location in the tree</p>\n"
1069     },
1070     {
1071       "tagname": "event",
1072       "name": "remove",
1073       "member": "Ext.data.Tree",
1074       "doc": "<p>Fires when a child node is removed from a node in this tree.</p>\n",
1075       "params": [
1076         {
1077           "type": "Tree",
1078           "name": "tree",
1079           "doc": "<p>The owner tree</p>\n",
1080           "optional": false
1081         },
1082         {
1083           "type": "Node",
1084           "name": "parent",
1085           "doc": "<p>The parent node</p>\n",
1086           "optional": false
1087         },
1088         {
1089           "type": "Node",
1090           "name": "node",
1091           "doc": "<p>The child node removed</p>\n",
1092           "optional": false
1093         }
1094       ],
1095       "private": false,
1096       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Tree.js",
1097       "linenr": 74,
1098       "html_filename": "Tree.html",
1099       "href": "Tree.html#Ext-data-Tree-event-remove",
1100       "shortDoc": "<p>Fires when a child node is removed from a node in this tree.</p>\n"
1101     },
1102     {
1103       "tagname": "event",
1104       "name": "rootchange",
1105       "member": "Ext.data.Tree",
1106       "doc": "<p>Fires whenever the root node is changed in the tree.</p>\n",
1107       "params": [
1108         {
1109           "type": "Ext.data.Model",
1110           "name": "root",
1111           "doc": "<p>The new root</p>\n",
1112           "optional": false
1113         }
1114       ],
1115       "private": false,
1116       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Tree.js",
1117       "linenr": 171,
1118       "html_filename": "Tree.html",
1119       "href": "Tree.html#Ext-data-Tree-event-rootchange",
1120       "shortDoc": "<p>Fires whenever the root node is changed in the tree.</p>\n"
1121     }
1122   ],
1123   "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Tree.js",
1124   "linenr": 1,
1125   "html_filename": "Tree.html",
1126   "href": "Tree.html#Ext-data-Tree",
1127   "cssVar": [
1128
1129   ],
1130   "cssMixin": [
1131
1132   ],
1133   "component": false,
1134   "superclasses": [
1135
1136   ],
1137   "subclasses": [
1138
1139   ],
1140   "mixedInto": [
1141
1142   ],
1143   "allMixins": [
1144     "Ext.util.Observable"
1145   ]
1146 });