Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / docs / api / Ext.data.Tree.html
1 <!DOCTYPE html><html><head><title>Ext.data.Tree | Ext JS 4.0 Documentation</title><script type="text/javascript" src="../ext-all.js"></script><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../scrollbars.css" type="text/css"><link rel="stylesheet" href="../docs.css" type="text/css"><link id="styleCss" rel="stylesheet" href="../style.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script><link rel="stylesheet" href="../prettify.css" type="text/css"><!-- link(rel: 'stylesheet', href: req.baseURL + '/css/ext4.css', type: 'text/css')--><link rel="shortcut icon" type="image/ico" href="../favicon.ico"><!--[if IE]>
2 <style type="text/css">.head-band { display: none; }
3 .header { border: 0; top: 0; left: 0px; background: url(../header.gif) repeat-x; }
4 .doc-tab .members .member a.more { background-color: #efefef; }
5 </style><link rel="stylesheet" href="/new/css/ie.css" type="text/css"><![endif]-->
6 </head><body id="ext-body" class="iScroll"><div id="notice" class="notice">For up to date documentation and features, visit 
7 <a href="http://docs.sencha.com/ext-js/4-0">http://docs.sencha.com/ext-js/4-0</a></div><div class="wrapper"><div class="head-band"></div><div class="header"><h2><a href="../index.html">Sencha Documentation</a></h2></div><div id="search"><form><input type="text" placeholder="Search" id="search-field" autocomplete="off" name="q"></form><div id="search-box"></div></div><div id="treePanel"></div><div id="container"><script type="text/javascript">
8
9     req = {
10         liveURL: '.',
11         standAloneMode: true,
12         origDocClass: 'Ext.data.Tree',
13         docClass: 'Ext.data.Tree',
14         docReq: 'Ext.data.Tree',
15         version: '4.0',
16         baseURL: '.',
17         baseDocURL: '.',
18         baseProdURL: '.'
19     };
20
21     clsInfo = {};
22
23
24
25 </script>
26
27 <script type="text/javascript" src="../search.js"></script>
28 <!--script type="text/javascript" src="/new/javascripts/app/examples.js"></script-->
29 <script type="text/javascript" src="../class_tree.js"></script>
30 <script type="text/javascript" src="../class_doc.js"></script>
31 <script type="text/javascript">
32     req.source = 'Tree.html#Ext-data.Tree';
33     clsInfo = {"methods":["Tree","addEvents","addListener","addManagedListener","capture","clearListeners","clearManagedListeners","enableBubble","fireEvent","getNodeById","getRootNode","hasListener","observe","on","relayEvents","releaseCapture","removeListener","removeManagedListener","resumeEvents","setRootNode","suspendEvents","un"],"cfgs":["listeners"],"properties":["root"],"events":["append","beforeappend","beforecollapse","beforeexpand","beforeinsert","beforemove","beforeremove","collapse","expand","insert","move","remove","rootchange"],"subclasses":[]};
34     Ext.onReady(function() {
35         Ext.create('Docs.classPanel');
36     });
37 </script><div id="top-block" class="top-block"><h1 id="clsTitle" class="cls"><a href="../source/Tree.html#Ext-data.Tree" target="_blank">Ext.data.Tree</a></h1></div><div id="docContent"><div id="doc-overview-content"><div class="lft"><pre class="subclasses"><h4>Mixins</h4><div class="mixin"><a href="Ext.util.Observable.html" rel="Ext.util.Observable" class="cls docClass">Ext.util.Observable</a></div></pre><p>This class is used as a container for a series of nodes. The nodes themselves maintain
38 the relationship between parent/child. The tree itself acts as a manager. It gives functionality
39 to retrieve a node by its identifier: <a href="Ext.data.Tree.html#getNodeById" rel="Ext.data.Tree#getNodeById" class="docClass">getNodeById</a>.</p>
40
41 <p>The tree also relays events from any of it's child nodes, allowing them to be handled in a
42 centralized fashion. In general this class is not used directly, rather used internally
43 by other parts of the framework.</p>
44 <div class="members"><div class="m-cfgs"><div class="definedBy">Defined By</div><a name="configs"></a><h3 class="cfg p">Config Options</h3><h4 class="cfgGroup">Other Configs</h4><div id="config-listeners" class="member f inherited"><a href="Ext.data.Tree.html#config-listeners" rel="config-listeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-cfg-listeners" class="viewSource">view source</a></div><a name="listeners"></a><a name="config-listeners"></a><a href="Ext.data.Tree.html#" rel="config-listeners" class="cls expand">listeners</a><span> : Object</span></div><div class="description"><div class="short">(optional) A config object containing one or more event handlers to be added to this
45 object during initialization.  T...</div><div class="long"><p>(optional) <p>A config object containing one or more event handlers to be added to this
46 object during initialization.  This should be a valid listeners config object as specified in the
47 <a href="Ext.data.Tree.html#addListener" rel="Ext.data.Tree#addListener" class="docClass">addListener</a> example for attaching multiple handlers at once.</p></p>
48
49 <br><p><b><u>DOM events from ExtJs <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a></u></b></p>
50
51
52 <br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
53
54
55 <p>is usually only done when extra value can be added. For example the <a href="Ext.view.View.html" rel="Ext.view.View" class="docClass">DataView</a>'s
56 <b><code><a href="Ext.view.View.html#click" rel="Ext.view.View#click" class="docClass">click</a></code></b> event passing the node clicked on. To access DOM
57 events directly from a child element of a Component, we need to specify the <code>element</code> option to
58 identify the Component property to add a DOM listener to:</p>
59
60 <pre><code>new Ext.panel.Panel({
61     width: 400,
62     height: 200,
63     dockedItems: [{
64         xtype: 'toolbar'
65     }],
66     listeners: {
67         click: {
68             element: 'el', //bind to the underlying el property on the panel
69             fn: function(){ console.log('click el'); }
70         },
71         dblclick: {
72             element: 'body', //bind to the underlying body property on the panel
73             fn: function(){ console.log('dblclick body'); }
74         }
75     }
76 });
77 </code></pre>
78
79
80 <p></p></p>
81 </div></div></div></div><div class="m-properties"><a name="properties"></a><div class="definedBy">Defined By</div><h3 class="prp p">Properties</h3><div id="property-root" class="member f ni"><a href="Ext.data.Tree.html#property-root" rel="property-root" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Tree.html" class="definedIn docClass">Ext.data.Tree</a><br/><a href="../source/Tree.html#Ext-data.Tree-property-root" class="viewSource">view source</a></div><a name="root"></a><a name="property-root"></a><a href="Ext.data.Tree.html#" rel="property-root" class="cls expand">root</a><span> : Node</span></div><div class="description"><div class="short"><p>The root node for this tree</p>
82 </div><div class="long"><p>The root node for this tree</p>
83 </div></div></div></div><div class="m-methods"><a name="methods"></a><div class="definedBy">Defined By</div><h3 class="mth p">Methods</h3><div id="method-Tree" class="member f ni"><a href="Ext.data.Tree.html#method-Tree" rel="method-Tree" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Tree.html" class="definedIn docClass">Ext.data.Tree</a><br/><a href="../source/Tree.html#Ext-data.Tree-method-constructor" class="viewSource">view source</a></div><a name="Tree"></a><a name="method-Tree"></a><a href="Ext.data.Tree.html#" rel="method-Tree" class="cls expand">Tree</a>(
84 <span class="pre">[Node root]</span>)
85  : void</div><div class="description"><div class="short"><p>&nbsp;</p></div><div class="long">
86 <h3 class="pa">Parameters</h3><ul><li><span class="pre">root</span> : Node<div class="sub-desc"><p>(optional) The root node</p>
87 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
88 </li></ul></div></div></div><div id="method-addEvents" class="member inherited"><a href="Ext.data.Tree.html#method-addEvents" rel="method-addEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addEvents" class="viewSource">view source</a></div><a name="addEvents"></a><a name="method-addEvents"></a><a href="Ext.data.Tree.html#" rel="method-addEvents" class="cls expand">addEvents</a>(
89 <span class="pre">Object/String o, String </span>)
90  : void</div><div class="description"><div class="short"><p>Adds the specified events to the list of events which this Observable may fire.</p>
91 </div><div class="long"><p>Adds the specified events to the list of events which this Observable may fire.</p>
92 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Object/String<div class="sub-desc"><p>Either an object with event names as properties with a value of <code>true</code>
93 or the first event name string if multiple event names are being passed as separate parameters.</p>
94 </div></li><li><span class="pre"></span> : String<div class="sub-desc"><p>[additional] Optional additional event names if multiple event names are being passed as separate parameters.
95 Usage:</p>
96
97 <pre><code>this.addEvents('storeloaded', 'storecleared');
98 </code></pre>
99
100 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
101 </li></ul></div></div></div><div id="method-addListener" class="member inherited"><a href="Ext.data.Tree.html#method-addListener" rel="method-addListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addListener" class="viewSource">view source</a></div><a name="addListener"></a><a name="method-addListener"></a><a href="Ext.data.Tree.html#" rel="method-addListener" class="cls expand">addListener</a>(
102 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
103  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object.</p>
104 </div><div class="long"><p>Appends an event handler to this object.</p>
105 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to listen for. May also be an object who's property names are event names. See</p>
106 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes.</p>
107 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
108 <b>If omitted, defaults to the object which fired the event.</b></p>
109 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.
110 properties. This may contain any of the following properties:<ul>
111 <li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
112 <b>If omitted, defaults to the object which fired the event.</b></div></li>
113 <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>
114 <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>
115 <li><b>buffer</b> : Number<div class="sub-desc">Causes the handler to be scheduled to run in an <a href="Ext.util.DelayedTask.html" rel="Ext.util.DelayedTask" class="docClass">Ext.util.DelayedTask</a> delayed
116 by the specified number of milliseconds. If the event fires again within that time, the original
117 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
118 <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>
119 if the event was bubbled up from a child Observable.</div></li>
120 <li><b>element</b> : String<div class="sub-desc"><b>This option is only valid for listeners bound to <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a>.</b>
121 The name of a Component property which references an element to add a listener to.</p>
122
123 <p>This option is useful during Component construction to add DOM event listeners to elements of <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a> which
124 will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:
125 <pre><code>new Ext.panel.Panel({
126     title: 'The title',
127     listeners: {
128         click: this.handlePanelClick,
129         element: 'body'
130     }
131 });
132 </code></pre></p>
133
134
135 <p>When added in this way, the options available are the options applicable to <a href="Ext.core.Element.html#addListener" rel="Ext.core.Element#addListener" class="docClass">Ext.core.Element.addListener</a></p>
136
137
138 <p></div></li>
139 </ul><br></p>
140
141 <p>
142 <b>Combining Options</b><br>
143 Using the options argument, it is possible to combine different types of listeners:<br>
144 <br>
145 A delayed, one-time listener.
146 <pre><code>myPanel.on('hide', this.handleClick, this, {
147 single: true,
148 delay: 100
149 });</code></pre>
150 <p>
151 <b>Attaching multiple handlers in 1 call</b><br>
152 The method also allows for a single argument to be passed which is a config object containing properties
153 which specify multiple events. For example:
154 <pre><code>myGridPanel.on({
155     cellClick: this.onCellClick,
156     mouseover: this.onMouseOver,
157     mouseout: this.onMouseOut,
158     scope: this // Important. Ensure "this" is correct during handler execution
159 });
160 </code></pre>.
161 <p>
162
163 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
164 </li></ul></div></div></div><div id="method-addManagedListener" class="member inherited"><a href="Ext.data.Tree.html#method-addManagedListener" rel="method-addManagedListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addManagedListener" class="viewSource">view source</a></div><a name="addManagedListener"></a><a name="method-addManagedListener"></a><a href="Ext.data.Tree.html#" rel="method-addManagedListener" class="cls expand">addManagedListener</a>(
165 <span class="pre">Observable/Element item, Object/String ename, Function fn, Object scope, Object opt</span>)
166  : void</div><div class="description"><div class="short"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
167 is destroyed.
168
169 </div><div class="long"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
170 is destroyed.
171
172 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Observable/Element<div class="sub-desc"><p>The item to which to add a listener/listeners.</p>
173 </div></li><li><span class="pre">ename</span> : Object/String<div class="sub-desc"><p>The event name, or an object containing event name properties.</p>
174 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
175 is the handler function.</p>
176 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
177 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
178 </div></li><li><span class="pre">opt</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
179 is the <a href="Ext.util.Observable.html#addListener" rel="Ext.util.Observable#addListener" class="docClass">addListener</a> options.</p>
180 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
181 </li></ul></div></div></div><div id="method-capture" class="member inherited"><a href="Ext.data.Tree.html#method-capture" rel="method-capture" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-capture" class="viewSource">view source</a></div><a name="capture"></a><a name="method-capture"></a><a href="Ext.data.Tree.html#" rel="method-capture" class="cls expand">capture</a>(
182 <span class="pre">Observable o, Function fn, [Object scope]</span>)
183  : void</div><div class="description"><div class="short">Starts capture on the specified Observable. All events will be passed
184 to the supplied function with the event name + ...</div><div class="long"><p>Starts capture on the specified Observable. All events will be passed
185 to the supplied function with the event name + standard signature of the event
186 <b>before</b> the event is fired. If the supplied function returns false,
187 the event will not fire.</p>
188 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to capture events from.</p>
189 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The function to call when an event is fired.</p>
190 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>
191 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
192 </li></ul></div></div></div><div id="method-clearListeners" class="member inherited"><a href="Ext.data.Tree.html#method-clearListeners" rel="method-clearListeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-clearListeners" class="viewSource">view source</a></div><a name="clearListeners"></a><a name="method-clearListeners"></a><a href="Ext.data.Tree.html#" rel="method-clearListeners" class="cls expand">clearListeners</a> : void</div><div class="description"><div class="short"><p>Removes all listeners for this object including the managed listeners</p>
193 </div><div class="long"><p>Removes all listeners for this object including the managed listeners</p>
194 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
195 </li></ul></div></div></div><div id="method-clearManagedListeners" class="member inherited"><a href="Ext.data.Tree.html#method-clearManagedListeners" rel="method-clearManagedListeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-clearManagedListeners" class="viewSource">view source</a></div><a name="clearManagedListeners"></a><a name="method-clearManagedListeners"></a><a href="Ext.data.Tree.html#" rel="method-clearManagedListeners" class="cls expand">clearManagedListeners</a> : void</div><div class="description"><div class="short"><p>Removes all managed listeners for this object.</p>
196 </div><div class="long"><p>Removes all managed listeners for this object.</p>
197 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
198 </li></ul></div></div></div><div id="method-enableBubble" class="member inherited"><a href="Ext.data.Tree.html#method-enableBubble" rel="method-enableBubble" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-enableBubble" class="viewSource">view source</a></div><a name="enableBubble"></a><a name="method-enableBubble"></a><a href="Ext.data.Tree.html#" rel="method-enableBubble" class="cls expand">enableBubble</a>(
199 <span class="pre">String/Array events</span>)
200  : void</div><div class="description"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
201 this.getBubbleTarget() if present....</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling
202 <code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>
203
204
205 <p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href="Ext.Component.html#getBubbleTarget" rel="Ext.Component#getBubbleTarget" class="docClass">Ext.Component.getBubbleTarget</a>. The default
206 implementation in <a href="Ext.Component.html" 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
207 access the required target more quickly.</p>
208
209
210 <p>Example:</p>
211
212
213 <pre><code>Ext.override(Ext.form.field.Base, {
214 //  Add functionality to Field&#39;s initComponent to enable the change event to bubble
215 initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
216     this.enableBubble('change');
217 }),
218
219 //  We know that we want Field&#39;s events to bubble directly to the FormPanel.
220 getBubbleTarget : function() {
221     if (!this.formPanel) {
222         this.formPanel = this.findParentByType('form');
223     }
224     return this.formPanel;
225 }
226 });
227
228 var myForm = new Ext.formPanel({
229 title: 'User Details',
230 items: [{
231     ...
232 }],
233 listeners: {
234     change: function() {
235         // Title goes red if form has been modified.
236         myForm.header.setStyle('color', 'red');
237     }
238 }
239 });
240 </code></pre>
241
242 <h3 class="pa">Parameters</h3><ul><li><span class="pre">events</span> : String/Array<div class="sub-desc"><p>The event name to bubble, or an Array of event names.</p>
243 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
244 </li></ul></div></div></div><div id="method-fireEvent" class="member inherited"><a href="Ext.data.Tree.html#method-fireEvent" rel="method-fireEvent" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-fireEvent" class="viewSource">view source</a></div><a name="fireEvent"></a><a name="method-fireEvent"></a><a href="Ext.data.Tree.html#" rel="method-fireEvent" class="cls expand">fireEvent</a>(
245 <span class="pre">String eventName, Object... args</span>)
246  : Boolean</div><div class="description"><div class="short">Fires the specified event with the passed parameters (minus the event name).
247
248
249 An event may be set to bubble up an Ob...</div><div class="long"><p>Fires the specified event with the passed parameters (minus the event name).</p>
250
251
252 <p>An event may be set to bubble up an Observable parent hierarchy (See <a href="Ext.Component.html#getBubbleTarget" rel="Ext.Component#getBubbleTarget" class="docClass">Ext.Component.getBubbleTarget</a>)
253 by calling <a href="Ext.data.Tree.html#enableBubble" rel="Ext.data.Tree#enableBubble" class="docClass">enableBubble</a>.</p>
254
255 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to fire.</p>
256 </div></li><li><span class="pre">args</span> : Object...<div class="sub-desc"><p>Variable number of parameters are passed to handlers.</p>
257 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>returns false if any of the handlers return false otherwise it returns true.</p>
258 </li></ul></div></div></div><div id="method-getNodeById" class="member ni"><a href="Ext.data.Tree.html#method-getNodeById" rel="method-getNodeById" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Tree.html" class="definedIn docClass">Ext.data.Tree</a><br/><a href="../source/Tree.html#Ext-data.Tree-method-getNodeById" class="viewSource">view source</a></div><a name="getNodeById"></a><a name="method-getNodeById"></a><a href="Ext.data.Tree.html#" rel="method-getNodeById" class="cls expand">getNodeById</a>(
259 <span class="pre">String id</span>)
260  : Ext.data.NodeInterface</div><div class="description"><div class="short"><p>Gets a node in this tree by its id.</p>
261 </div><div class="long"><p>Gets a node in this tree by its id.</p>
262 <h3 class="pa">Parameters</h3><ul><li><span class="pre">id</span> : String<div class="sub-desc">
263 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.data.NodeInterface</span>&nbsp; &nbsp;<p>The match node.</p>
264 </li></ul></div></div></div><div id="method-getRootNode" class="member ni"><a href="Ext.data.Tree.html#method-getRootNode" rel="method-getRootNode" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Tree.html" class="definedIn docClass">Ext.data.Tree</a><br/><a href="../source/Tree.html#Ext-data.Tree-method-getRootNode" class="viewSource">view source</a></div><a name="getRootNode"></a><a name="method-getRootNode"></a><a href="Ext.data.Tree.html#" rel="method-getRootNode" class="cls expand">getRootNode</a> : Ext.data.NodeInterface</div><div class="description"><div class="short"><p>Returns the root node for this tree.</p>
265 </div><div class="long"><p>Returns the root node for this tree.</p>
266 <h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.data.NodeInterface</span>&nbsp; &nbsp;
267 </li></ul></div></div></div><div id="method-hasListener" class="member inherited"><a href="Ext.data.Tree.html#method-hasListener" rel="method-hasListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-hasListener" class="viewSource">view source</a></div><a name="hasListener"></a><a name="method-hasListener"></a><a href="Ext.data.Tree.html#" rel="method-hasListener" class="cls expand">hasListener</a>(
268 <span class="pre">String eventName</span>)
269  : Boolean</div><div class="description"><div class="short"><p>Checks to see if this object has any listeners for a specified event</p>
270 </div><div class="long"><p>Checks to see if this object has any listeners for a specified event</p>
271 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to check for</p>
272 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if the event is being listened for, else false</p>
273 </li></ul></div></div></div><div id="method-observe" class="member inherited"><a href="Ext.data.Tree.html#method-observe" rel="method-observe" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-observe" class="viewSource">view source</a></div><a name="observe"></a><a name="method-observe"></a><a href="Ext.data.Tree.html#" rel="method-observe" class="cls expand">observe</a>(
274 <span class="pre">Function c, Object listeners</span>)
275  : void</div><div class="description"><div class="short">Sets observability on the passed class constructor.
276
277 This makes any event fired on any instance of the passed class a...</div><div class="long"><p>Sets observability on the passed class constructor.</p>
278
279 <p>This makes any event fired on any instance of the passed class also fire a single event through
280 the <strong>class</strong> allowing for central handling of events on many instances at once.</p>
281
282 <p>Usage:</p>
283
284 <pre><code>Ext.util.Observable.observe(Ext.data.Connection);
285 Ext.data.Connection.on('beforerequest', function(con, options) {
286     console.log('Ajax request made to ' + options.url);
287 });
288 </code></pre>
289 <h3 class="pa">Parameters</h3><ul><li><span class="pre">c</span> : Function<div class="sub-desc"><p>The class constructor to make observable.</p>
290 </div></li><li><span class="pre">listeners</span> : Object<div class="sub-desc"><p>An object containing a series of listeners to add. See <a href="Ext.data.Tree.html#addListener" rel="Ext.data.Tree#addListener" class="docClass">addListener</a>.</p>
291 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
292 </li></ul></div></div></div><div id="method-on" class="member inherited"><a href="Ext.data.Tree.html#method-on" rel="method-on" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-on" class="viewSource">view source</a></div><a name="on"></a><a name="method-on"></a><a href="Ext.data.Tree.html#" rel="method-on" class="cls expand">on</a>(
293 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
294  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object (shorthand for <a href="Ext.data.Tree.html#addListener" rel="Ext.data.Tree#addListener" class="docClass">addListener</a>.)</p>
295 </div><div class="long"><p>Appends an event handler to this object (shorthand for <a href="Ext.data.Tree.html#addListener" rel="Ext.data.Tree#addListener" class="docClass">addListener</a>.)</p>
296 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event to listen for</p>
297 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes</p>
298 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
299 <b>If omitted, defaults to the object which fired the event.</b></p>
300 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.</p>
301 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
302 </li></ul></div></div></div><div id="method-relayEvents" class="member inherited"><a href="Ext.data.Tree.html#method-relayEvents" rel="method-relayEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-relayEvents" class="viewSource">view source</a></div><a name="relayEvents"></a><a name="method-relayEvents"></a><a href="Ext.data.Tree.html#" rel="method-relayEvents" class="cls expand">relayEvents</a>(
303 <span class="pre">Object origin, Array events, Object prefix</span>)
304  : void</div><div class="description"><div class="short"><p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>
305 </div><div class="long"><p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>
306 <h3 class="pa">Parameters</h3><ul><li><span class="pre">origin</span> : Object<div class="sub-desc"><p>The Observable whose events this object is to relay.</p>
307 </div></li><li><span class="pre">events</span> : Array<div class="sub-desc"><p>Array of event names to relay.</p>
308 </div></li><li><span class="pre">prefix</span> : Object<div class="sub-desc">
309 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
310 </li></ul></div></div></div><div id="method-releaseCapture" class="member inherited"><a href="Ext.data.Tree.html#method-releaseCapture" rel="method-releaseCapture" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-releaseCapture" class="viewSource">view source</a></div><a name="releaseCapture"></a><a name="method-releaseCapture"></a><a href="Ext.data.Tree.html#" rel="method-releaseCapture" class="cls expand">releaseCapture</a>(
311 <span class="pre">Observable o</span>)
312  : void</div><div class="description"><div class="short"><p>Removes <b>all</b> added captures from the Observable.</p>
313 </div><div class="long"><p>Removes <b>all</b> added captures from the Observable.</p>
314 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to release</p>
315 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
316 </li></ul></div></div></div><div id="method-removeListener" class="member inherited"><a href="Ext.data.Tree.html#method-removeListener" rel="method-removeListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-removeListener" class="viewSource">view source</a></div><a name="removeListener"></a><a name="method-removeListener"></a><a href="Ext.data.Tree.html#" rel="method-removeListener" class="cls expand">removeListener</a>(
317 <span class="pre">String eventName, Function handler, [Object scope]</span>)
318  : void</div><div class="description"><div class="short"><p>Removes an event handler.</p>
319 </div><div class="long"><p>Removes an event handler.</p>
320 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event the handler was associated with.</p>
321 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The handler to remove. <b>This must be a reference to the function passed into the <a href="Ext.data.Tree.html#addListener" rel="Ext.data.Tree#addListener" class="docClass">addListener</a> call.</b></p>
322 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
323 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
324 </li></ul></div></div></div><div id="method-removeManagedListener" class="member inherited"><a href="Ext.data.Tree.html#method-removeManagedListener" rel="method-removeManagedListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-removeManagedListener" class="viewSource">view source</a></div><a name="removeManagedListener"></a><a name="method-removeManagedListener"></a><a href="Ext.data.Tree.html#" rel="method-removeManagedListener" class="cls expand">removeManagedListener</a>(
325 <span class="pre">Observable|Element item, Object|String ename, Function fn, Object scope</span>)
326  : void</div><div class="description"><div class="short"><p>Removes listeners that were added by the <a href="Ext.data.Tree.html#mon" rel="Ext.data.Tree#mon" class="docClass">mon</a> method.</p>
327 </div><div class="long"><p>Removes listeners that were added by the <a href="Ext.data.Tree.html#mon" rel="Ext.data.Tree#mon" class="docClass">mon</a> method.</p>
328 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Observable|Element<div class="sub-desc"><p>The item from which to remove a listener/listeners.</p>
329 </div></li><li><span class="pre">ename</span> : Object|String<div class="sub-desc"><p>The event name, or an object containing event name properties.</p>
330 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
331 is the handler function.</p>
332 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
333 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
334 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
335 </li></ul></div></div></div><div id="method-resumeEvents" class="member inherited"><a href="Ext.data.Tree.html#method-resumeEvents" rel="method-resumeEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-resumeEvents" class="viewSource">view source</a></div><a name="resumeEvents"></a><a name="method-resumeEvents"></a><a href="Ext.data.Tree.html#" rel="method-resumeEvents" class="cls expand">resumeEvents</a> : void</div><div class="description"><div class="short">Resume firing events. (see suspendEvents)
336 If events were suspended using the queueSuspended parameter, then all
337 event...</div><div class="long"><p>Resume firing events. (see <a href="Ext.data.Tree.html#suspendEvents" rel="Ext.data.Tree#suspendEvents" class="docClass">suspendEvents</a>)
338 If events were suspended using the <code><b>queueSuspended</b></code> parameter, then all
339 events fired during event suspension will be sent to any listeners now.</p>
340 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
341 </li></ul></div></div></div><div id="method-setRootNode" class="member ni"><a href="Ext.data.Tree.html#method-setRootNode" rel="method-setRootNode" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Tree.html" class="definedIn docClass">Ext.data.Tree</a><br/><a href="../source/Tree.html#Ext-data.Tree-method-setRootNode" class="viewSource">view source</a></div><a name="setRootNode"></a><a name="method-setRootNode"></a><a href="Ext.data.Tree.html#" rel="method-setRootNode" class="cls expand">setRootNode</a>(
342 <span class="pre">Ext.data.NodeInterface node</span>)
343  : Ext.data.NodeInterface</div><div class="description"><div class="short"><p>Sets the root node for this tree.</p>
344 </div><div class="long"><p>Sets the root node for this tree.</p>
345 <h3 class="pa">Parameters</h3><ul><li><span class="pre">node</span> : Ext.data.NodeInterface<div class="sub-desc">
346 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.data.NodeInterface</span>&nbsp; &nbsp;<p>The root node</p>
347 </li></ul></div></div></div><div id="method-suspendEvents" class="member inherited"><a href="Ext.data.Tree.html#method-suspendEvents" rel="method-suspendEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-suspendEvents" class="viewSource">view source</a></div><a name="suspendEvents"></a><a name="method-suspendEvents"></a><a href="Ext.data.Tree.html#" rel="method-suspendEvents" class="cls expand">suspendEvents</a>(
348 <span class="pre">Boolean queueSuspended</span>)
349  : void</div><div class="description"><div class="short"><p>Suspend the firing of all events. (see <a href="Ext.data.Tree.html#resumeEvents" rel="Ext.data.Tree#resumeEvents" class="docClass">resumeEvents</a>)</p>
350 </div><div class="long"><p>Suspend the firing of all events. (see <a href="Ext.data.Tree.html#resumeEvents" rel="Ext.data.Tree#resumeEvents" class="docClass">resumeEvents</a>)</p>
351 <h3 class="pa">Parameters</h3><ul><li><span class="pre">queueSuspended</span> : Boolean<div class="sub-desc"><p>Pass as true to queue up suspended events to be fired
352 after the <a href="Ext.data.Tree.html#resumeEvents" rel="Ext.data.Tree#resumeEvents" class="docClass">resumeEvents</a> call instead of discarding all suspended events;</p>
353 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
354 </li></ul></div></div></div><div id="method-un" class="member inherited"><a href="Ext.data.Tree.html#method-un" rel="method-un" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-un" class="viewSource">view source</a></div><a name="un"></a><a name="method-un"></a><a href="Ext.data.Tree.html#" rel="method-un" class="cls expand">un</a>(
355 <span class="pre">String eventName, Function handler, [Object scope]</span>)
356  : void</div><div class="description"><div class="short"><p>Removes an event handler (shorthand for <a href="Ext.data.Tree.html#removeListener" rel="Ext.data.Tree#removeListener" class="docClass">removeListener</a>.)</p>
357 </div><div class="long"><p>Removes an event handler (shorthand for <a href="Ext.data.Tree.html#removeListener" rel="Ext.data.Tree#removeListener" class="docClass">removeListener</a>.)</p>
358 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event the handler was associated with.</p>
359 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The handler to remove. <b>This must be a reference to the function passed into the <a href="Ext.data.Tree.html#addListener" rel="Ext.data.Tree#addListener" class="docClass">addListener</a> call.</b></p>
360 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
361 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
362 </li></ul></div></div></div></div><div class="m-events"><a name="events"></a><div class="definedBy">Defined By</div><h3 class="evt p">Events</h3><div id="event-append" class="member f ni"><a href="Ext.data.Tree.html#event-append" rel="event-append" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Tree.html" class="definedIn docClass">Ext.data.Tree</a><br/><a href="../source/Tree.html#Ext-data.Tree-event-append" class="viewSource">view source</a></div><a name="append"></a><a name="event-append"></a><a href="Ext.data.Tree.html#" rel="event-append" class="cls expand">append</a>(
363 <span class="pre">Tree tree, Node parent, Node node, Number index</span>)
364 </div><div class="description"><div class="short"><p>Fires when a new child node is appended to a node in this tree.</p>
365 </div><div class="long"><p>Fires when a new child node is appended to a node in this tree.</p>
366 <h3 class="pa">Parameters</h3><ul><li><span class="pre">tree</span> : Tree<div class="sub-desc"><p>The owner tree</p>
367 </div></li><li><span class="pre">parent</span> : Node<div class="sub-desc"><p>The parent node</p>
368 </div></li><li><span class="pre">node</span> : Node<div class="sub-desc"><p>The newly appended node</p>
369 </div></li><li><span class="pre">index</span> : Number<div class="sub-desc"><p>The index of the newly appended node</p>
370 </div></li></ul></div></div></div><div id="event-beforeappend" class="member ni"><a href="Ext.data.Tree.html#event-beforeappend" rel="event-beforeappend" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Tree.html" class="definedIn docClass">Ext.data.Tree</a><br/><a href="../source/Tree.html#Ext-data.Tree-event-beforeappend" class="viewSource">view source</a></div><a name="beforeappend"></a><a name="event-beforeappend"></a><a href="Ext.data.Tree.html#" rel="event-beforeappend" class="cls expand">beforeappend</a>(
371 <span class="pre">Tree tree, Node parent, Node node</span>)
372 </div><div class="description"><div class="short"><p>Fires before a new child is appended to a node in this tree, return false to cancel the append.</p>
373 </div><div class="long"><p>Fires before a new child is appended to a node in this tree, return false to cancel the append.</p>
374 <h3 class="pa">Parameters</h3><ul><li><span class="pre">tree</span> : Tree<div class="sub-desc"><p>The owner tree</p>
375 </div></li><li><span class="pre">parent</span> : Node<div class="sub-desc"><p>The parent node</p>
376 </div></li><li><span class="pre">node</span> : Node<div class="sub-desc"><p>The child node to be appended</p>
377 </div></li></ul></div></div></div><div id="event-beforecollapse" class="member ni"><a href="Ext.data.Tree.html#event-beforecollapse" rel="event-beforecollapse" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Tree.html" class="definedIn docClass">Ext.data.Tree</a><br/><a href="../source/Tree.html#Ext-data.Tree-event-beforecollapse" class="viewSource">view source</a></div><a name="beforecollapse"></a><a name="event-beforecollapse"></a><a href="Ext.data.Tree.html#" rel="event-beforecollapse" class="cls expand">beforecollapse</a>(
378 <span class="pre">Node this</span>)
379 </div><div class="description"><div class="short"><p>Fires before this node is collapsed.</p>
380 </div><div class="long"><p>Fires before this node is collapsed.</p>
381 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Node<div class="sub-desc"><p>The collapsing node</p>
382 </div></li></ul></div></div></div><div id="event-beforeexpand" class="member ni"><a href="Ext.data.Tree.html#event-beforeexpand" rel="event-beforeexpand" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Tree.html" class="definedIn docClass">Ext.data.Tree</a><br/><a href="../source/Tree.html#Ext-data.Tree-event-beforeexpand" class="viewSource">view source</a></div><a name="beforeexpand"></a><a name="event-beforeexpand"></a><a href="Ext.data.Tree.html#" rel="event-beforeexpand" class="cls expand">beforeexpand</a>(
383 <span class="pre">Node this</span>)
384 </div><div class="description"><div class="short"><p>Fires before this node is expanded.</p>
385 </div><div class="long"><p>Fires before this node is expanded.</p>
386 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Node<div class="sub-desc"><p>The expanding node</p>
387 </div></li></ul></div></div></div><div id="event-beforeinsert" class="member ni"><a href="Ext.data.Tree.html#event-beforeinsert" rel="event-beforeinsert" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Tree.html" class="definedIn docClass">Ext.data.Tree</a><br/><a href="../source/Tree.html#Ext-data.Tree-event-beforeinsert" class="viewSource">view source</a></div><a name="beforeinsert"></a><a name="event-beforeinsert"></a><a href="Ext.data.Tree.html#" rel="event-beforeinsert" class="cls expand">beforeinsert</a>(
388 <span class="pre">Tree tree, Node parent, Node node, Node refNode</span>)
389 </div><div class="description"><div class="short"><p>Fires before a new child is inserted in a node in this tree, return false to cancel the insert.</p>
390 </div><div class="long"><p>Fires before a new child is inserted in a node in this tree, return false to cancel the insert.</p>
391 <h3 class="pa">Parameters</h3><ul><li><span class="pre">tree</span> : Tree<div class="sub-desc"><p>The owner tree</p>
392 </div></li><li><span class="pre">parent</span> : Node<div class="sub-desc"><p>The parent node</p>
393 </div></li><li><span class="pre">node</span> : Node<div class="sub-desc"><p>The child node to be inserted</p>
394 </div></li><li><span class="pre">refNode</span> : Node<div class="sub-desc"><p>The child node the node is being inserted before</p>
395 </div></li></ul></div></div></div><div id="event-beforemove" class="member ni"><a href="Ext.data.Tree.html#event-beforemove" rel="event-beforemove" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Tree.html" class="definedIn docClass">Ext.data.Tree</a><br/><a href="../source/Tree.html#Ext-data.Tree-event-beforemove" class="viewSource">view source</a></div><a name="beforemove"></a><a name="event-beforemove"></a><a href="Ext.data.Tree.html#" rel="event-beforemove" class="cls expand">beforemove</a>(
396 <span class="pre">Tree tree, Node node, Node oldParent, Node newParent, Number index</span>)
397 </div><div class="description"><div class="short"><p>Fires before a node is moved to a new location in the tree. Return false to cancel the move.</p>
398 </div><div class="long"><p>Fires before a node is moved to a new location in the tree. Return false to cancel the move.</p>
399 <h3 class="pa">Parameters</h3><ul><li><span class="pre">tree</span> : Tree<div class="sub-desc"><p>The owner tree</p>
400 </div></li><li><span class="pre">node</span> : Node<div class="sub-desc"><p>The node being moved</p>
401 </div></li><li><span class="pre">oldParent</span> : Node<div class="sub-desc"><p>The parent of the node</p>
402 </div></li><li><span class="pre">newParent</span> : Node<div class="sub-desc"><p>The new parent the node is moving to</p>
403 </div></li><li><span class="pre">index</span> : Number<div class="sub-desc"><p>The index it is being moved to</p>
404 </div></li></ul></div></div></div><div id="event-beforeremove" class="member ni"><a href="Ext.data.Tree.html#event-beforeremove" rel="event-beforeremove" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Tree.html" class="definedIn docClass">Ext.data.Tree</a><br/><a href="../source/Tree.html#Ext-data.Tree-event-beforeremove" class="viewSource">view source</a></div><a name="beforeremove"></a><a name="event-beforeremove"></a><a href="Ext.data.Tree.html#" rel="event-beforeremove" class="cls expand">beforeremove</a>(
405 <span class="pre">Tree tree, Node parent, Node node</span>)
406 </div><div class="description"><div class="short"><p>Fires before a child is removed from a node in this tree, return false to cancel the remove.</p>
407 </div><div class="long"><p>Fires before a child is removed from a node in this tree, return false to cancel the remove.</p>
408 <h3 class="pa">Parameters</h3><ul><li><span class="pre">tree</span> : Tree<div class="sub-desc"><p>The owner tree</p>
409 </div></li><li><span class="pre">parent</span> : Node<div class="sub-desc"><p>The parent node</p>
410 </div></li><li><span class="pre">node</span> : Node<div class="sub-desc"><p>The child node to be removed</p>
411 </div></li></ul></div></div></div><div id="event-collapse" class="member ni"><a href="Ext.data.Tree.html#event-collapse" rel="event-collapse" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Tree.html" class="definedIn docClass">Ext.data.Tree</a><br/><a href="../source/Tree.html#Ext-data.Tree-event-collapse" class="viewSource">view source</a></div><a name="collapse"></a><a name="event-collapse"></a><a href="Ext.data.Tree.html#" rel="event-collapse" class="cls expand">collapse</a>(
412 <span class="pre">Node this</span>)
413 </div><div class="description"><div class="short"><p>Fires when this node is collapsed.</p>
414 </div><div class="long"><p>Fires when this node is collapsed.</p>
415 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Node<div class="sub-desc"><p>The collapsing node</p>
416 </div></li></ul></div></div></div><div id="event-expand" class="member ni"><a href="Ext.data.Tree.html#event-expand" rel="event-expand" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Tree.html" class="definedIn docClass">Ext.data.Tree</a><br/><a href="../source/Tree.html#Ext-data.Tree-event-expand" class="viewSource">view source</a></div><a name="expand"></a><a name="event-expand"></a><a href="Ext.data.Tree.html#" rel="event-expand" class="cls expand">expand</a>(
417 <span class="pre">Node this</span>)
418 </div><div class="description"><div class="short"><p>Fires when this node is expanded.</p>
419 </div><div class="long"><p>Fires when this node is expanded.</p>
420 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Node<div class="sub-desc"><p>The expanding node</p>
421 </div></li></ul></div></div></div><div id="event-insert" class="member ni"><a href="Ext.data.Tree.html#event-insert" rel="event-insert" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Tree.html" class="definedIn docClass">Ext.data.Tree</a><br/><a href="../source/Tree.html#Ext-data.Tree-event-insert" class="viewSource">view source</a></div><a name="insert"></a><a name="event-insert"></a><a href="Ext.data.Tree.html#" rel="event-insert" class="cls expand">insert</a>(
422 <span class="pre">Tree tree, Node parent, Node node, Node refNode</span>)
423 </div><div class="description"><div class="short"><p>Fires when a new child node is inserted in a node in this tree.</p>
424 </div><div class="long"><p>Fires when a new child node is inserted in a node in this tree.</p>
425 <h3 class="pa">Parameters</h3><ul><li><span class="pre">tree</span> : Tree<div class="sub-desc"><p>The owner tree</p>
426 </div></li><li><span class="pre">parent</span> : Node<div class="sub-desc"><p>The parent node</p>
427 </div></li><li><span class="pre">node</span> : Node<div class="sub-desc"><p>The child node inserted</p>
428 </div></li><li><span class="pre">refNode</span> : Node<div class="sub-desc"><p>The child node the node was inserted before</p>
429 </div></li></ul></div></div></div><div id="event-move" class="member ni"><a href="Ext.data.Tree.html#event-move" rel="event-move" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Tree.html" class="definedIn docClass">Ext.data.Tree</a><br/><a href="../source/Tree.html#Ext-data.Tree-event-move" class="viewSource">view source</a></div><a name="move"></a><a name="event-move"></a><a href="Ext.data.Tree.html#" rel="event-move" class="cls expand">move</a>(
430 <span class="pre">Tree tree, Node node, Node oldParent, Node newParent, Number index</span>)
431 </div><div class="description"><div class="short"><p>Fires when a node is moved to a new location in the tree</p>
432 </div><div class="long"><p>Fires when a node is moved to a new location in the tree</p>
433 <h3 class="pa">Parameters</h3><ul><li><span class="pre">tree</span> : Tree<div class="sub-desc"><p>The owner tree</p>
434 </div></li><li><span class="pre">node</span> : Node<div class="sub-desc"><p>The node moved</p>
435 </div></li><li><span class="pre">oldParent</span> : Node<div class="sub-desc"><p>The old parent of this node</p>
436 </div></li><li><span class="pre">newParent</span> : Node<div class="sub-desc"><p>The new parent of this node</p>
437 </div></li><li><span class="pre">index</span> : Number<div class="sub-desc"><p>The index it was moved to</p>
438 </div></li></ul></div></div></div><div id="event-remove" class="member ni"><a href="Ext.data.Tree.html#event-remove" rel="event-remove" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Tree.html" class="definedIn docClass">Ext.data.Tree</a><br/><a href="../source/Tree.html#Ext-data.Tree-event-remove" class="viewSource">view source</a></div><a name="remove"></a><a name="event-remove"></a><a href="Ext.data.Tree.html#" rel="event-remove" class="cls expand">remove</a>(
439 <span class="pre">Tree tree, Node parent, Node node</span>)
440 </div><div class="description"><div class="short"><p>Fires when a child node is removed from a node in this tree.</p>
441 </div><div class="long"><p>Fires when a child node is removed from a node in this tree.</p>
442 <h3 class="pa">Parameters</h3><ul><li><span class="pre">tree</span> : Tree<div class="sub-desc"><p>The owner tree</p>
443 </div></li><li><span class="pre">parent</span> : Node<div class="sub-desc"><p>The parent node</p>
444 </div></li><li><span class="pre">node</span> : Node<div class="sub-desc"><p>The child node removed</p>
445 </div></li></ul></div></div></div><div id="event-rootchange" class="member ni"><a href="Ext.data.Tree.html#event-rootchange" rel="event-rootchange" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Tree.html" class="definedIn docClass">Ext.data.Tree</a><br/><a href="../source/Tree.html#Ext-data.Tree-event-rootchange" class="viewSource">view source</a></div><a name="rootchange"></a><a name="event-rootchange"></a><a href="Ext.data.Tree.html#" rel="event-rootchange" class="cls expand">rootchange</a>(
446 <span class="pre">Ext.data.Model root</span>)
447 </div><div class="description"><div class="short"><p>Fires whenever the root node is changed in the tree.</p>
448 </div><div class="long"><p>Fires whenever the root node is changed in the tree.</p>
449 <h3 class="pa">Parameters</h3><ul><li><span class="pre">root</span> : Ext.data.Model<div class="sub-desc"><p>The new root</p>
450 </div></li></ul></div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>