| 2 |
aperonnet |
1 |
<div class="body-wrap">
|
|
|
2 |
<div class="top-tools">
|
|
|
3 |
<a class="inner-link" href="#Ext.data.Tree-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
|
|
|
4 |
<a class="inner-link" href="#Ext.data.Tree-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
|
|
|
5 |
<a class="inner-link" href="#Ext.data.Tree-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
|
|
|
6 |
<a class="inner-link" href="#Ext.data.Tree-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
|
|
|
7 |
<a class="bookmark" href="../docs/?class=Ext.data.Tree"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
|
|
|
8 |
</div>
|
|
|
9 |
<div class="inheritance res-block">
|
|
|
10 |
<pre class="res-block-inner"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a>
|
|
|
11 |
<img src="resources/elbow-end.gif"/>Tree</pre></div>
|
|
|
12 |
<h1>Class Ext.data.Tree</h1>
|
|
|
13 |
<table cellspacing="0">
|
|
|
14 |
<tr><td class="label">Package:</td><td class="hd-info">Ext.data</td></tr>
|
|
|
15 |
<tr><td class="label">Defined In:</td><td class="hd-info"><a href="../source/data/Tree.js" target="_blank">Tree.js</a></td></tr>
|
|
|
16 |
<tr><td class="label">Class:</td><td class="hd-info">Tree</td></tr>
|
|
|
17 |
<tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a></td></tr>
|
|
|
18 |
</table>
|
|
|
19 |
<div class="description">
|
|
|
20 |
Represents a tree data structure and bubbles all the events for its nodes. The nodes
|
|
|
21 |
in the tree have most standard DOM functionality. </div>
|
|
|
22 |
|
|
|
23 |
<div class="hr"></div>
|
|
|
24 |
<a id="Ext.data.Tree-configs"></a>
|
|
|
25 |
<h2>Config Options</h2>
|
|
|
26 |
<table cellspacing="0" class="member-table">
|
|
|
27 |
<tr>
|
|
|
28 |
<th class="sig-header" colspan="2">Config Options</th>
|
|
|
29 |
<th class="msource-header">Defined By</th>
|
|
|
30 |
</tr>
|
|
|
31 |
<tr class="config-row inherited expandable">
|
|
|
32 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
33 |
<td class="sig">
|
|
|
34 |
<a id="Ext.data.Tree-listeners"></a>
|
|
|
35 |
<b>listeners</b> : Object <div class="mdesc">
|
|
|
36 |
<div class="short">A config object containing one or more event handlers to be added to this object during initialization. This should b...</div>
|
|
|
37 |
<div class="long">
|
|
|
38 |
A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the <a ext:cls="Ext.util.Observable" ext:member="addListener" href="output/Ext.util.Observable.html#addListener">addListener</a> example for attaching multiple handlers at once. </div>
|
|
|
39 |
</div>
|
|
|
40 |
</td>
|
|
|
41 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td>
|
|
|
42 |
</tr>
|
|
|
43 |
<tr class="config-row alt">
|
|
|
44 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
45 |
<td class="sig">
|
|
|
46 |
<a id="Ext.data.Tree-pathSeparator"></a>
|
|
|
47 |
<b>pathSeparator</b> : String <div class="mdesc">
|
|
|
48 |
The token used to separate paths in node ids (defaults to '/'). </div>
|
|
|
49 |
</td>
|
|
|
50 |
<td class="msource">Tree</td>
|
|
|
51 |
</tr>
|
|
|
52 |
</table>
|
|
|
53 |
<a id="Ext.data.Tree-props"></a>
|
|
|
54 |
<h2>Public Properties</h2>
|
|
|
55 |
<table cellspacing="0" class="member-table">
|
|
|
56 |
<tr>
|
|
|
57 |
<th class="sig-header" colspan="2">Property</th>
|
|
|
58 |
<th class="msource-header">Defined By</th>
|
|
|
59 |
</tr>
|
|
|
60 |
<tr class="property-row">
|
|
|
61 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
62 |
<td class="sig">
|
|
|
63 |
<a id="Ext.data.Tree-root"></a>
|
|
|
64 |
<b>root</b> : Node <div class="mdesc">
|
|
|
65 |
The root node for this tree </div>
|
|
|
66 |
</td>
|
|
|
67 |
<td class="msource">Tree</td>
|
|
|
68 |
</tr>
|
|
|
69 |
</table>
|
|
|
70 |
<a id="Ext.data.Tree-methods"></a>
|
|
|
71 |
<h2>Public Methods</h2>
|
|
|
72 |
<table cellspacing="0" class="member-table">
|
|
|
73 |
<tr>
|
|
|
74 |
<th class="sig-header" colspan="2">Method</th>
|
|
|
75 |
<th class="msource-header">Defined By</th>
|
|
|
76 |
</tr>
|
|
|
77 |
<tr class="method-row expandable">
|
|
|
78 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
79 |
<td class="sig">
|
|
|
80 |
<a id="Ext.data.Tree-Tree"></a>
|
|
|
81 |
<b>Tree</b>( <span class="optional" title="Optional">[<code>Node root</code>]</span> ) <div class="mdesc">
|
|
|
82 |
<div class="short"></div>
|
|
|
83 |
<div class="long">
|
|
|
84 |
<div class="mdetail-params">
|
|
|
85 |
<strong>Parameters:</strong>
|
|
|
86 |
<ul><li><code>root</code> : Node<div class="sub-desc">(optional) The root node</div></li> </ul>
|
|
|
87 |
<strong>Returns:</strong>
|
|
|
88 |
<ul>
|
|
|
89 |
<li><code></code></li>
|
|
|
90 |
</ul>
|
|
|
91 |
</div>
|
|
|
92 |
</div>
|
|
|
93 |
</div>
|
|
|
94 |
</td>
|
|
|
95 |
<td class="msource">Tree</td>
|
|
|
96 |
</tr>
|
|
|
97 |
<tr class="method-row inherited alt expandable">
|
|
|
98 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
99 |
<td class="sig">
|
|
|
100 |
<a id="Ext.data.Tree-addEvents"></a>
|
|
|
101 |
<b>addEvents</b>( <code>Object object</code> ) : void <div class="mdesc">
|
|
|
102 |
<div class="short">Used to define events on this Observable</div>
|
|
|
103 |
<div class="long">
|
|
|
104 |
Used to define events on this Observable <div class="mdetail-params">
|
|
|
105 |
<strong>Parameters:</strong>
|
|
|
106 |
<ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li> </ul>
|
|
|
107 |
<strong>Returns:</strong>
|
|
|
108 |
<ul>
|
|
|
109 |
<li><code>void</code></li>
|
|
|
110 |
</ul>
|
|
|
111 |
</div>
|
|
|
112 |
</div>
|
|
|
113 |
</div>
|
|
|
114 |
</td>
|
|
|
115 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td>
|
|
|
116 |
</tr>
|
|
|
117 |
<tr class="method-row inherited expandable">
|
|
|
118 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
119 |
<td class="sig">
|
|
|
120 |
<a id="Ext.data.Tree-addListener"></a>
|
|
|
121 |
<b>addListener</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span> ) : void <div class="mdesc">
|
|
|
122 |
<div class="short">Appends an event handler to this component</div>
|
|
|
123 |
<div class="long">
|
|
|
124 |
Appends an event handler to this component <div class="mdetail-params">
|
|
|
125 |
<strong>Parameters:</strong>
|
|
|
126 |
<ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler
|
|
|
127 |
function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration
|
|
|
128 |
properties. This may contain any of the following properties:<ul>
|
|
|
129 |
<li><b>scope</b> : Object<p class="sub-desc">The scope in which to execute the handler function. The handler function's "this" context.</p></li>
|
|
|
130 |
<li><b>delay</b> : Number<p class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</p></li>
|
|
|
131 |
<li><b>single</b> : Boolean<p class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</p></li>
|
|
|
132 |
<li><b>buffer</b> : Number<p class="sub-desc">Causes the handler to be scheduled to run in an <a ext:cls="Ext.util.DelayedTask" href="output/Ext.util.DelayedTask.html">Ext.util.DelayedTask</a> delayed
|
|
|
133 |
by the specified number of milliseconds. If the event fires again within that time, the original
|
|
|
134 |
handler is <em>not</em> invoked, but the new handler is scheduled in its place.</p></li>
|
|
|
135 |
</ul><br>
|
|
|
136 |
<p>
|
|
|
137 |
<b>Combining Options</b><br>
|
|
|
138 |
Using the options argument, it is possible to combine different types of listeners:<br>
|
|
|
139 |
<br>
|
|
|
140 |
A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
|
|
|
141 |
<pre><code>el.on(<em>'click'</em>, <b>this</b>.onClick, <b>this</b>, {
|
|
|
142 |
single: true,
|
|
|
143 |
delay: 100,
|
|
|
144 |
forumId: 4
|
|
|
145 |
});</code></pre>
|
|
|
146 |
<p>
|
|
|
147 |
<b>Attaching multiple handlers in 1 call</b><br>
|
|
|
148 |
The method also allows for a single argument to be passed which is a config object containing properties
|
|
|
149 |
which specify multiple handlers.
|
|
|
150 |
<p>
|
|
|
151 |
<pre><code>foo.on({
|
|
|
152 |
<em>'click'</em> : {
|
|
|
153 |
fn: <b>this</b>.onClick,
|
|
|
154 |
scope: <b>this</b>,
|
|
|
155 |
delay: 100
|
|
|
156 |
},
|
|
|
157 |
<em>'mouseover'</em> : {
|
|
|
158 |
fn: <b>this</b>.onMouseOver,
|
|
|
159 |
scope: <b>this</b>
|
|
|
160 |
},
|
|
|
161 |
<em>'mouseout'</em> : {
|
|
|
162 |
fn: <b>this</b>.onMouseOut,
|
|
|
163 |
scope: <b>this</b>
|
|
|
164 |
}
|
|
|
165 |
});</code></pre>
|
|
|
166 |
<p>
|
|
|
167 |
Or a shorthand syntax:<br>
|
|
|
168 |
<pre><code>foo.on({
|
|
|
169 |
<em>'click'</em> : <b>this</b>.onClick,
|
|
|
170 |
<em>'mouseover'</em> : <b>this</b>.onMouseOver,
|
|
|
171 |
<em>'mouseout'</em> : <b>this</b>.onMouseOut,
|
|
|
172 |
scope: <b>this</b>
|
|
|
173 |
});</code></pre></div></li> </ul>
|
|
|
174 |
<strong>Returns:</strong>
|
|
|
175 |
<ul>
|
|
|
176 |
<li><code>void</code></li>
|
|
|
177 |
</ul>
|
|
|
178 |
</div>
|
|
|
179 |
</div>
|
|
|
180 |
</div>
|
|
|
181 |
</td>
|
|
|
182 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td>
|
|
|
183 |
</tr>
|
|
|
184 |
<tr class="method-row inherited alt expandable">
|
|
|
185 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
186 |
<td class="sig">
|
|
|
187 |
<a id="Ext.data.Tree-fireEvent"></a>
|
|
|
188 |
<b>fireEvent</b>( <code>String eventName</code>, <code>Object... args</code> ) : Boolean <div class="mdesc">
|
|
|
189 |
<div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
|
|
|
190 |
<div class="long">
|
|
|
191 |
Fires the specified event with the passed parameters (minus the event name). <div class="mdetail-params">
|
|
|
192 |
<strong>Parameters:</strong>
|
|
|
193 |
<ul><li><code>eventName</code> : String<div class="sub-desc"></div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers</div></li> </ul>
|
|
|
194 |
<strong>Returns:</strong>
|
|
|
195 |
<ul>
|
|
|
196 |
<li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li>
|
|
|
197 |
</ul>
|
|
|
198 |
</div>
|
|
|
199 |
</div>
|
|
|
200 |
</div>
|
|
|
201 |
</td>
|
|
|
202 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td>
|
|
|
203 |
</tr>
|
|
|
204 |
<tr class="method-row expandable">
|
|
|
205 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
206 |
<td class="sig">
|
|
|
207 |
<a id="Ext.data.Tree-getNodeById"></a>
|
|
|
208 |
<b>getNodeById</b>( <code>String id</code> ) : Node <div class="mdesc">
|
|
|
209 |
<div class="short">Gets a node in this tree by its id.</div>
|
|
|
210 |
<div class="long">
|
|
|
211 |
Gets a node in this tree by its id. <div class="mdetail-params">
|
|
|
212 |
<strong>Parameters:</strong>
|
|
|
213 |
<ul><li><code>id</code> : String<div class="sub-desc"></div></li> </ul>
|
|
|
214 |
<strong>Returns:</strong>
|
|
|
215 |
<ul>
|
|
|
216 |
<li><code>Node</code></li>
|
|
|
217 |
</ul>
|
|
|
218 |
</div>
|
|
|
219 |
</div>
|
|
|
220 |
</div>
|
|
|
221 |
</td>
|
|
|
222 |
<td class="msource">Tree</td>
|
|
|
223 |
</tr>
|
|
|
224 |
<tr class="method-row alt expandable">
|
|
|
225 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
226 |
<td class="sig">
|
|
|
227 |
<a id="Ext.data.Tree-getRootNode"></a>
|
|
|
228 |
<b>getRootNode</b>() : Node <div class="mdesc">
|
|
|
229 |
<div class="short">Returns the root node for this tree.</div>
|
|
|
230 |
<div class="long">
|
|
|
231 |
Returns the root node for this tree. <div class="mdetail-params">
|
|
|
232 |
<strong>Parameters:</strong>
|
|
|
233 |
<ul><li>None.</li> </ul>
|
|
|
234 |
<strong>Returns:</strong>
|
|
|
235 |
<ul>
|
|
|
236 |
<li><code>Node</code></li>
|
|
|
237 |
</ul>
|
|
|
238 |
</div>
|
|
|
239 |
</div>
|
|
|
240 |
</div>
|
|
|
241 |
</td>
|
|
|
242 |
<td class="msource">Tree</td>
|
|
|
243 |
</tr>
|
|
|
244 |
<tr class="method-row inherited expandable">
|
|
|
245 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
246 |
<td class="sig">
|
|
|
247 |
<a id="Ext.data.Tree-hasListener"></a>
|
|
|
248 |
<b>hasListener</b>( <code>String eventName</code> ) : Boolean <div class="mdesc">
|
|
|
249 |
<div class="short">Checks to see if this object has any listeners for a specified event</div>
|
|
|
250 |
<div class="long">
|
|
|
251 |
Checks to see if this object has any listeners for a specified event <div class="mdetail-params">
|
|
|
252 |
<strong>Parameters:</strong>
|
|
|
253 |
<ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li> </ul>
|
|
|
254 |
<strong>Returns:</strong>
|
|
|
255 |
<ul>
|
|
|
256 |
<li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li>
|
|
|
257 |
</ul>
|
|
|
258 |
</div>
|
|
|
259 |
</div>
|
|
|
260 |
</div>
|
|
|
261 |
</td>
|
|
|
262 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td>
|
|
|
263 |
</tr>
|
|
|
264 |
<tr class="method-row inherited alt expandable">
|
|
|
265 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
266 |
<td class="sig">
|
|
|
267 |
<a id="Ext.data.Tree-on"></a>
|
|
|
268 |
<b>on</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span> ) : void <div class="mdesc">
|
|
|
269 |
<div class="short">Appends an event handler to this element (shorthand for addListener)</div>
|
|
|
270 |
<div class="long">
|
|
|
271 |
Appends an event handler to this element (shorthand for addListener) <div class="mdetail-params">
|
|
|
272 |
<strong>Parameters:</strong>
|
|
|
273 |
<ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler
|
|
|
274 |
function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li> </ul>
|
|
|
275 |
<strong>Returns:</strong>
|
|
|
276 |
<ul>
|
|
|
277 |
<li><code>void</code></li>
|
|
|
278 |
</ul>
|
|
|
279 |
</div>
|
|
|
280 |
</div>
|
|
|
281 |
</div>
|
|
|
282 |
</td>
|
|
|
283 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td>
|
|
|
284 |
</tr>
|
|
|
285 |
<tr class="method-row inherited expandable">
|
|
|
286 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
287 |
<td class="sig">
|
|
|
288 |
<a id="Ext.data.Tree-purgeListeners"></a>
|
|
|
289 |
<b>purgeListeners</b>() : void <div class="mdesc">
|
|
|
290 |
<div class="short">Removes all listeners for this object</div>
|
|
|
291 |
<div class="long">
|
|
|
292 |
Removes all listeners for this object <div class="mdetail-params">
|
|
|
293 |
<strong>Parameters:</strong>
|
|
|
294 |
<ul><li>None.</li> </ul>
|
|
|
295 |
<strong>Returns:</strong>
|
|
|
296 |
<ul>
|
|
|
297 |
<li><code>void</code></li>
|
|
|
298 |
</ul>
|
|
|
299 |
</div>
|
|
|
300 |
</div>
|
|
|
301 |
</div>
|
|
|
302 |
</td>
|
|
|
303 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td>
|
|
|
304 |
</tr>
|
|
|
305 |
<tr class="method-row inherited alt expandable">
|
|
|
306 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
307 |
<td class="sig">
|
|
|
308 |
<a id="Ext.data.Tree-removeListener"></a>
|
|
|
309 |
<b>removeListener</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc">
|
|
|
310 |
<div class="short">Removes a listener</div>
|
|
|
311 |
<div class="long">
|
|
|
312 |
Removes a listener <div class="mdetail-params">
|
|
|
313 |
<strong>Parameters:</strong>
|
|
|
314 |
<ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li> </ul>
|
|
|
315 |
<strong>Returns:</strong>
|
|
|
316 |
<ul>
|
|
|
317 |
<li><code>void</code></li>
|
|
|
318 |
</ul>
|
|
|
319 |
</div>
|
|
|
320 |
</div>
|
|
|
321 |
</div>
|
|
|
322 |
</td>
|
|
|
323 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td>
|
|
|
324 |
</tr>
|
|
|
325 |
<tr class="method-row inherited expandable">
|
|
|
326 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
327 |
<td class="sig">
|
|
|
328 |
<a id="Ext.data.Tree-resumeEvents"></a>
|
|
|
329 |
<b>resumeEvents</b>() : void <div class="mdesc">
|
|
|
330 |
<div class="short">Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>)</div>
|
|
|
331 |
<div class="long">
|
|
|
332 |
Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>) <div class="mdetail-params">
|
|
|
333 |
<strong>Parameters:</strong>
|
|
|
334 |
<ul><li>None.</li> </ul>
|
|
|
335 |
<strong>Returns:</strong>
|
|
|
336 |
<ul>
|
|
|
337 |
<li><code>void</code></li>
|
|
|
338 |
</ul>
|
|
|
339 |
</div>
|
|
|
340 |
</div>
|
|
|
341 |
</div>
|
|
|
342 |
</td>
|
|
|
343 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td>
|
|
|
344 |
</tr>
|
|
|
345 |
<tr class="method-row alt expandable">
|
|
|
346 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
347 |
<td class="sig">
|
|
|
348 |
<a id="Ext.data.Tree-setRootNode"></a>
|
|
|
349 |
<b>setRootNode</b>( <code>Node node</code> ) : Node <div class="mdesc">
|
|
|
350 |
<div class="short">Sets the root node for this tree.</div>
|
|
|
351 |
<div class="long">
|
|
|
352 |
Sets the root node for this tree. <div class="mdetail-params">
|
|
|
353 |
<strong>Parameters:</strong>
|
|
|
354 |
<ul><li><code>node</code> : Node<div class="sub-desc"></div></li> </ul>
|
|
|
355 |
<strong>Returns:</strong>
|
|
|
356 |
<ul>
|
|
|
357 |
<li><code>Node</code></li>
|
|
|
358 |
</ul>
|
|
|
359 |
</div>
|
|
|
360 |
</div>
|
|
|
361 |
</div>
|
|
|
362 |
</td>
|
|
|
363 |
<td class="msource">Tree</td>
|
|
|
364 |
</tr>
|
|
|
365 |
<tr class="method-row inherited expandable">
|
|
|
366 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
367 |
<td class="sig">
|
|
|
368 |
<a id="Ext.data.Tree-suspendEvents"></a>
|
|
|
369 |
<b>suspendEvents</b>() : void <div class="mdesc">
|
|
|
370 |
<div class="short">Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>)</div>
|
|
|
371 |
<div class="long">
|
|
|
372 |
Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>) <div class="mdetail-params">
|
|
|
373 |
<strong>Parameters:</strong>
|
|
|
374 |
<ul><li>None.</li> </ul>
|
|
|
375 |
<strong>Returns:</strong>
|
|
|
376 |
<ul>
|
|
|
377 |
<li><code>void</code></li>
|
|
|
378 |
</ul>
|
|
|
379 |
</div>
|
|
|
380 |
</div>
|
|
|
381 |
</div>
|
|
|
382 |
</td>
|
|
|
383 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td>
|
|
|
384 |
</tr>
|
|
|
385 |
<tr class="method-row inherited alt expandable">
|
|
|
386 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
387 |
<td class="sig">
|
|
|
388 |
<a id="Ext.data.Tree-un"></a>
|
|
|
389 |
<b>un</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc">
|
|
|
390 |
<div class="short">Removes a listener (shorthand for removeListener)</div>
|
|
|
391 |
<div class="long">
|
|
|
392 |
Removes a listener (shorthand for removeListener) <div class="mdetail-params">
|
|
|
393 |
<strong>Parameters:</strong>
|
|
|
394 |
<ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li> </ul>
|
|
|
395 |
<strong>Returns:</strong>
|
|
|
396 |
<ul>
|
|
|
397 |
<li><code>void</code></li>
|
|
|
398 |
</ul>
|
|
|
399 |
</div>
|
|
|
400 |
</div>
|
|
|
401 |
</div>
|
|
|
402 |
</td>
|
|
|
403 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td>
|
|
|
404 |
</tr>
|
|
|
405 |
</table>
|
|
|
406 |
<a id="Ext.data.Tree-events"></a>
|
|
|
407 |
<h2>Public Events</h2>
|
|
|
408 |
<table cellspacing="0" class="member-table">
|
|
|
409 |
<tr>
|
|
|
410 |
<th class="sig-header" colspan="2">Event</th>
|
|
|
411 |
<th class="msource-header">Defined By</th>
|
|
|
412 |
</tr>
|
|
|
413 |
<tr class="event-row expandable">
|
|
|
414 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
415 |
<td class="sig">
|
|
|
416 |
<a id="Ext.data.Tree-append"></a>
|
|
|
417 |
<b>append</b> : ( <code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code>, <code>Number index</code> ) <div class="mdesc">
|
|
|
418 |
<div class="short">Fires when a new child node is appended to a node in this tree.</div>
|
|
|
419 |
<div class="long">
|
|
|
420 |
Fires when a new child node is appended to a node in this tree. <div class="mdetail-params">
|
|
|
421 |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
|
|
|
422 |
<ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>parent</code> : Node<div class="sub-desc">The parent node</div></li><li><code>node</code> : Node<div class="sub-desc">The newly appended node</div></li><li><code>index</code> : Number<div class="sub-desc">The index of the newly appended node</div></li> </ul>
|
|
|
423 |
</div>
|
|
|
424 |
</div>
|
|
|
425 |
</div>
|
|
|
426 |
</td>
|
|
|
427 |
<td class="msource">Tree</td>
|
|
|
428 |
</tr>
|
|
|
429 |
<tr class="event-row alt expandable">
|
|
|
430 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
431 |
<td class="sig">
|
|
|
432 |
<a id="Ext.data.Tree-beforeappend"></a>
|
|
|
433 |
<b>beforeappend</b> : ( <code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code> ) <div class="mdesc">
|
|
|
434 |
<div class="short">Fires before a new child is appended to a node in this tree, return false to cancel the append.</div>
|
|
|
435 |
<div class="long">
|
|
|
436 |
Fires before a new child is appended to a node in this tree, return false to cancel the append. <div class="mdetail-params">
|
|
|
437 |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
|
|
|
438 |
<ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>parent</code> : Node<div class="sub-desc">The parent node</div></li><li><code>node</code> : Node<div class="sub-desc">The child node to be appended</div></li> </ul>
|
|
|
439 |
</div>
|
|
|
440 |
</div>
|
|
|
441 |
</div>
|
|
|
442 |
</td>
|
|
|
443 |
<td class="msource">Tree</td>
|
|
|
444 |
</tr>
|
|
|
445 |
<tr class="event-row expandable">
|
|
|
446 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
447 |
<td class="sig">
|
|
|
448 |
<a id="Ext.data.Tree-beforeinsert"></a>
|
|
|
449 |
<b>beforeinsert</b> : ( <code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code>, <code>Node refNode</code> ) <div class="mdesc">
|
|
|
450 |
<div class="short">Fires before a new child is inserted in a node in this tree, return false to cancel the insert.</div>
|
|
|
451 |
<div class="long">
|
|
|
452 |
Fires before a new child is inserted in a node in this tree, return false to cancel the insert. <div class="mdetail-params">
|
|
|
453 |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
|
|
|
454 |
<ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>parent</code> : Node<div class="sub-desc">The parent node</div></li><li><code>node</code> : Node<div class="sub-desc">The child node to be inserted</div></li><li><code>refNode</code> : Node<div class="sub-desc">The child node the node is being inserted before</div></li> </ul>
|
|
|
455 |
</div>
|
|
|
456 |
</div>
|
|
|
457 |
</div>
|
|
|
458 |
</td>
|
|
|
459 |
<td class="msource">Tree</td>
|
|
|
460 |
</tr>
|
|
|
461 |
<tr class="event-row alt expandable">
|
|
|
462 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
463 |
<td class="sig">
|
|
|
464 |
<a id="Ext.data.Tree-beforemove"></a>
|
|
|
465 |
<b>beforemove</b> : ( <code>Tree tree</code>, <code>Node node</code>, <code>Node oldParent</code>, <code>Node newParent</code>, <code>Number index</code> ) <div class="mdesc">
|
|
|
466 |
<div class="short">Fires before a node is moved to a new location in the tree. Return false to cancel the move.</div>
|
|
|
467 |
<div class="long">
|
|
|
468 |
Fires before a node is moved to a new location in the tree. Return false to cancel the move. <div class="mdetail-params">
|
|
|
469 |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
|
|
|
470 |
<ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>node</code> : Node<div class="sub-desc">The node being moved</div></li><li><code>oldParent</code> : Node<div class="sub-desc">The parent of the node</div></li><li><code>newParent</code> : Node<div class="sub-desc">The new parent the node is moving to</div></li><li><code>index</code> : Number<div class="sub-desc">The index it is being moved to</div></li> </ul>
|
|
|
471 |
</div>
|
|
|
472 |
</div>
|
|
|
473 |
</div>
|
|
|
474 |
</td>
|
|
|
475 |
<td class="msource">Tree</td>
|
|
|
476 |
</tr>
|
|
|
477 |
<tr class="event-row expandable">
|
|
|
478 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
479 |
<td class="sig">
|
|
|
480 |
<a id="Ext.data.Tree-beforeremove"></a>
|
|
|
481 |
<b>beforeremove</b> : ( <code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code> ) <div class="mdesc">
|
|
|
482 |
<div class="short">Fires before a child is removed from a node in this tree, return false to cancel the remove.</div>
|
|
|
483 |
<div class="long">
|
|
|
484 |
Fires before a child is removed from a node in this tree, return false to cancel the remove. <div class="mdetail-params">
|
|
|
485 |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
|
|
|
486 |
<ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>parent</code> : Node<div class="sub-desc">The parent node</div></li><li><code>node</code> : Node<div class="sub-desc">The child node to be removed</div></li> </ul>
|
|
|
487 |
</div>
|
|
|
488 |
</div>
|
|
|
489 |
</div>
|
|
|
490 |
</td>
|
|
|
491 |
<td class="msource">Tree</td>
|
|
|
492 |
</tr>
|
|
|
493 |
<tr class="event-row alt expandable">
|
|
|
494 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
495 |
<td class="sig">
|
|
|
496 |
<a id="Ext.data.Tree-insert"></a>
|
|
|
497 |
<b>insert</b> : ( <code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code>, <code>Node refNode</code> ) <div class="mdesc">
|
|
|
498 |
<div class="short">Fires when a new child node is inserted in a node in this tree.</div>
|
|
|
499 |
<div class="long">
|
|
|
500 |
Fires when a new child node is inserted in a node in this tree. <div class="mdetail-params">
|
|
|
501 |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
|
|
|
502 |
<ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>parent</code> : Node<div class="sub-desc">The parent node</div></li><li><code>node</code> : Node<div class="sub-desc">The child node inserted</div></li><li><code>refNode</code> : Node<div class="sub-desc">The child node the node was inserted before</div></li> </ul>
|
|
|
503 |
</div>
|
|
|
504 |
</div>
|
|
|
505 |
</div>
|
|
|
506 |
</td>
|
|
|
507 |
<td class="msource">Tree</td>
|
|
|
508 |
</tr>
|
|
|
509 |
<tr class="event-row expandable">
|
|
|
510 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
511 |
<td class="sig">
|
|
|
512 |
<a id="Ext.data.Tree-move"></a>
|
|
|
513 |
<b>move</b> : ( <code>Tree tree</code>, <code>Node node</code>, <code>Node oldParent</code>, <code>Node newParent</code>, <code>Number index</code> ) <div class="mdesc">
|
|
|
514 |
<div class="short">Fires when a node is moved to a new location in the tree</div>
|
|
|
515 |
<div class="long">
|
|
|
516 |
Fires when a node is moved to a new location in the tree <div class="mdetail-params">
|
|
|
517 |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
|
|
|
518 |
<ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>node</code> : Node<div class="sub-desc">The node moved</div></li><li><code>oldParent</code> : Node<div class="sub-desc">The old parent of this node</div></li><li><code>newParent</code> : Node<div class="sub-desc">The new parent of this node</div></li><li><code>index</code> : Number<div class="sub-desc">The index it was moved to</div></li> </ul>
|
|
|
519 |
</div>
|
|
|
520 |
</div>
|
|
|
521 |
</div>
|
|
|
522 |
</td>
|
|
|
523 |
<td class="msource">Tree</td>
|
|
|
524 |
</tr>
|
|
|
525 |
<tr class="event-row alt expandable">
|
|
|
526 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
527 |
<td class="sig">
|
|
|
528 |
<a id="Ext.data.Tree-remove"></a>
|
|
|
529 |
<b>remove</b> : ( <code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code> ) <div class="mdesc">
|
|
|
530 |
<div class="short">Fires when a child node is removed from a node in this tree.</div>
|
|
|
531 |
<div class="long">
|
|
|
532 |
Fires when a child node is removed from a node in this tree. <div class="mdetail-params">
|
|
|
533 |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
|
|
|
534 |
<ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>parent</code> : Node<div class="sub-desc">The parent node</div></li><li><code>node</code> : Node<div class="sub-desc">The child node removed</div></li> </ul>
|
|
|
535 |
</div>
|
|
|
536 |
</div>
|
|
|
537 |
</div>
|
|
|
538 |
</td>
|
|
|
539 |
<td class="msource">Tree</td>
|
|
|
540 |
</tr>
|
|
|
541 |
</table>
|
|
|
542 |
|
|
|
543 |
</div>
|