2 |
aperonnet |
1 |
<div class="body-wrap">
|
|
|
2 |
<div class="top-tools">
|
|
|
3 |
<a class="inner-link" href="#Ext.data.Node-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
|
|
|
4 |
<a class="inner-link" href="#Ext.data.Node-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
|
|
|
5 |
<a class="inner-link" href="#Ext.data.Node-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
|
|
|
6 |
<a class="inner-link" href="#Ext.data.Node-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.Node"><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"/>Node</pre></div>
|
|
|
12 |
<h1>Class Ext.data.Node</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">Node</td></tr>
|
|
|
17 |
<tr><td class="label">Subclasses:</td><td class="hd-info"><a ext:cls="Ext.tree.TreeNode" href="output/Ext.tree.TreeNode.html">TreeNode</a></td></tr>
|
|
|
18 |
<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>
|
|
|
19 |
</table>
|
|
|
20 |
<div class="description">
|
|
|
21 |
</div>
|
|
|
22 |
|
|
|
23 |
<div class="hr"></div>
|
|
|
24 |
<a id="Ext.data.Node-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">
|
|
|
32 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
33 |
<td class="sig">
|
|
|
34 |
<a id="Ext.data.Node-id"></a>
|
|
|
35 |
<b>id</b> : String <div class="mdesc">
|
|
|
36 |
The id for this node. If one is not specified, one is generated. </div>
|
|
|
37 |
</td>
|
|
|
38 |
<td class="msource">Node</td>
|
|
|
39 |
</tr>
|
|
|
40 |
<tr class="config-row alt">
|
|
|
41 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
42 |
<td class="sig">
|
|
|
43 |
<a id="Ext.data.Node-leaf"></a>
|
|
|
44 |
<b>leaf</b> : Boolean <div class="mdesc">
|
|
|
45 |
true if this node is a leaf and does not have children </div>
|
|
|
46 |
</td>
|
|
|
47 |
<td class="msource">Node</td>
|
|
|
48 |
</tr>
|
|
|
49 |
<tr class="config-row inherited expandable">
|
|
|
50 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
51 |
<td class="sig">
|
|
|
52 |
<a id="Ext.data.Node-listeners"></a>
|
|
|
53 |
<b>listeners</b> : Object <div class="mdesc">
|
|
|
54 |
<div class="short">A config object containing one or more event handlers to be added to this object during initialization. This should b...</div>
|
|
|
55 |
<div class="long">
|
|
|
56 |
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>
|
|
|
57 |
</div>
|
|
|
58 |
</td>
|
|
|
59 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td>
|
|
|
60 |
</tr>
|
|
|
61 |
</table>
|
|
|
62 |
<a id="Ext.data.Node-props"></a>
|
|
|
63 |
<h2>Public Properties</h2>
|
|
|
64 |
<table cellspacing="0" class="member-table">
|
|
|
65 |
<tr>
|
|
|
66 |
<th class="sig-header" colspan="2">Property</th>
|
|
|
67 |
<th class="msource-header">Defined By</th>
|
|
|
68 |
</tr>
|
|
|
69 |
<tr class="property-row">
|
|
|
70 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
71 |
<td class="sig">
|
|
|
72 |
<a id="Ext.data.Node-attributes"></a>
|
|
|
73 |
<b>attributes</b> : Object <div class="mdesc">
|
|
|
74 |
The attributes supplied for the node. You can use this property to access any custom attributes you supplied. </div>
|
|
|
75 |
</td>
|
|
|
76 |
<td class="msource">Node</td>
|
|
|
77 |
</tr>
|
|
|
78 |
<tr class="property-row alt">
|
|
|
79 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
80 |
<td class="sig">
|
|
|
81 |
<a id="Ext.data.Node-childNodes"></a>
|
|
|
82 |
<b>childNodes</b> : Array <div class="mdesc">
|
|
|
83 |
All child nodes of this node. </div>
|
|
|
84 |
</td>
|
|
|
85 |
<td class="msource">Node</td>
|
|
|
86 |
</tr>
|
|
|
87 |
<tr class="property-row">
|
|
|
88 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
89 |
<td class="sig">
|
|
|
90 |
<a id="Ext.data.Node-firstChild"></a>
|
|
|
91 |
<b>firstChild</b> : Node <div class="mdesc">
|
|
|
92 |
The first direct child node of this node, or null if this node has no child nodes. </div>
|
|
|
93 |
</td>
|
|
|
94 |
<td class="msource">Node</td>
|
|
|
95 |
</tr>
|
|
|
96 |
<tr class="property-row alt">
|
|
|
97 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
98 |
<td class="sig">
|
|
|
99 |
<a id="Ext.data.Node-id"></a>
|
|
|
100 |
<b>id</b> : String <div class="mdesc">
|
|
|
101 |
The node id. </div>
|
|
|
102 |
</td>
|
|
|
103 |
<td class="msource">Node</td>
|
|
|
104 |
</tr>
|
|
|
105 |
<tr class="property-row">
|
|
|
106 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
107 |
<td class="sig">
|
|
|
108 |
<a id="Ext.data.Node-lastChild"></a>
|
|
|
109 |
<b>lastChild</b> : Node <div class="mdesc">
|
|
|
110 |
The last direct child node of this node, or null if this node has no child nodes. </div>
|
|
|
111 |
</td>
|
|
|
112 |
<td class="msource">Node</td>
|
|
|
113 |
</tr>
|
|
|
114 |
<tr class="property-row alt">
|
|
|
115 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
116 |
<td class="sig">
|
|
|
117 |
<a id="Ext.data.Node-nextSibling"></a>
|
|
|
118 |
<b>nextSibling</b> : Node <div class="mdesc">
|
|
|
119 |
The node immediately following this node in the tree, or null if there is no sibling node. </div>
|
|
|
120 |
</td>
|
|
|
121 |
<td class="msource">Node</td>
|
|
|
122 |
</tr>
|
|
|
123 |
<tr class="property-row">
|
|
|
124 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
125 |
<td class="sig">
|
|
|
126 |
<a id="Ext.data.Node-parentNode"></a>
|
|
|
127 |
<b>parentNode</b> : Node <div class="mdesc">
|
|
|
128 |
The parent node for this node. </div>
|
|
|
129 |
</td>
|
|
|
130 |
<td class="msource">Node</td>
|
|
|
131 |
</tr>
|
|
|
132 |
<tr class="property-row alt">
|
|
|
133 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
134 |
<td class="sig">
|
|
|
135 |
<a id="Ext.data.Node-previousSibling"></a>
|
|
|
136 |
<b>previousSibling</b> : Node <div class="mdesc">
|
|
|
137 |
The node immediately preceding this node in the tree, or null if there is no sibling node. </div>
|
|
|
138 |
</td>
|
|
|
139 |
<td class="msource">Node</td>
|
|
|
140 |
</tr>
|
|
|
141 |
</table>
|
|
|
142 |
<a id="Ext.data.Node-methods"></a>
|
|
|
143 |
<h2>Public Methods</h2>
|
|
|
144 |
<table cellspacing="0" class="member-table">
|
|
|
145 |
<tr>
|
|
|
146 |
<th class="sig-header" colspan="2">Method</th>
|
|
|
147 |
<th class="msource-header">Defined By</th>
|
|
|
148 |
</tr>
|
|
|
149 |
<tr class="method-row expandable">
|
|
|
150 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
151 |
<td class="sig">
|
|
|
152 |
<a id="Ext.data.Node-Node"></a>
|
|
|
153 |
<b>Node</b>( <code>Object attributes</code> ) <div class="mdesc">
|
|
|
154 |
<div class="short"></div>
|
|
|
155 |
<div class="long">
|
|
|
156 |
<div class="mdetail-params">
|
|
|
157 |
<strong>Parameters:</strong>
|
|
|
158 |
<ul><li><code>attributes</code> : Object<div class="sub-desc">The attributes/config for the node</div></li> </ul>
|
|
|
159 |
<strong>Returns:</strong>
|
|
|
160 |
<ul>
|
|
|
161 |
<li><code></code></li>
|
|
|
162 |
</ul>
|
|
|
163 |
</div>
|
|
|
164 |
</div>
|
|
|
165 |
</div>
|
|
|
166 |
</td>
|
|
|
167 |
<td class="msource">Node</td>
|
|
|
168 |
</tr>
|
|
|
169 |
<tr class="method-row inherited alt expandable">
|
|
|
170 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
171 |
<td class="sig">
|
|
|
172 |
<a id="Ext.data.Node-addEvents"></a>
|
|
|
173 |
<b>addEvents</b>( <code>Object object</code> ) : void <div class="mdesc">
|
|
|
174 |
<div class="short">Used to define events on this Observable</div>
|
|
|
175 |
<div class="long">
|
|
|
176 |
Used to define events on this Observable <div class="mdetail-params">
|
|
|
177 |
<strong>Parameters:</strong>
|
|
|
178 |
<ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li> </ul>
|
|
|
179 |
<strong>Returns:</strong>
|
|
|
180 |
<ul>
|
|
|
181 |
<li><code>void</code></li>
|
|
|
182 |
</ul>
|
|
|
183 |
</div>
|
|
|
184 |
</div>
|
|
|
185 |
</div>
|
|
|
186 |
</td>
|
|
|
187 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td>
|
|
|
188 |
</tr>
|
|
|
189 |
<tr class="method-row inherited expandable">
|
|
|
190 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
191 |
<td class="sig">
|
|
|
192 |
<a id="Ext.data.Node-addListener"></a>
|
|
|
193 |
<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">
|
|
|
194 |
<div class="short">Appends an event handler to this component</div>
|
|
|
195 |
<div class="long">
|
|
|
196 |
Appends an event handler to this component <div class="mdetail-params">
|
|
|
197 |
<strong>Parameters:</strong>
|
|
|
198 |
<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
|
|
|
199 |
function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration
|
|
|
200 |
properties. This may contain any of the following properties:<ul>
|
|
|
201 |
<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>
|
|
|
202 |
<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>
|
|
|
203 |
<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>
|
|
|
204 |
<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
|
|
|
205 |
by the specified number of milliseconds. If the event fires again within that time, the original
|
|
|
206 |
handler is <em>not</em> invoked, but the new handler is scheduled in its place.</p></li>
|
|
|
207 |
</ul><br>
|
|
|
208 |
<p>
|
|
|
209 |
<b>Combining Options</b><br>
|
|
|
210 |
Using the options argument, it is possible to combine different types of listeners:<br>
|
|
|
211 |
<br>
|
|
|
212 |
A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
|
|
|
213 |
<pre><code>el.on(<em>'click'</em>, <b>this</b>.onClick, <b>this</b>, {
|
|
|
214 |
single: true,
|
|
|
215 |
delay: 100,
|
|
|
216 |
forumId: 4
|
|
|
217 |
});</code></pre>
|
|
|
218 |
<p>
|
|
|
219 |
<b>Attaching multiple handlers in 1 call</b><br>
|
|
|
220 |
The method also allows for a single argument to be passed which is a config object containing properties
|
|
|
221 |
which specify multiple handlers.
|
|
|
222 |
<p>
|
|
|
223 |
<pre><code>foo.on({
|
|
|
224 |
<em>'click'</em> : {
|
|
|
225 |
fn: <b>this</b>.onClick,
|
|
|
226 |
scope: <b>this</b>,
|
|
|
227 |
delay: 100
|
|
|
228 |
},
|
|
|
229 |
<em>'mouseover'</em> : {
|
|
|
230 |
fn: <b>this</b>.onMouseOver,
|
|
|
231 |
scope: <b>this</b>
|
|
|
232 |
},
|
|
|
233 |
<em>'mouseout'</em> : {
|
|
|
234 |
fn: <b>this</b>.onMouseOut,
|
|
|
235 |
scope: <b>this</b>
|
|
|
236 |
}
|
|
|
237 |
});</code></pre>
|
|
|
238 |
<p>
|
|
|
239 |
Or a shorthand syntax:<br>
|
|
|
240 |
<pre><code>foo.on({
|
|
|
241 |
<em>'click'</em> : <b>this</b>.onClick,
|
|
|
242 |
<em>'mouseover'</em> : <b>this</b>.onMouseOver,
|
|
|
243 |
<em>'mouseout'</em> : <b>this</b>.onMouseOut,
|
|
|
244 |
scope: <b>this</b>
|
|
|
245 |
});</code></pre></div></li> </ul>
|
|
|
246 |
<strong>Returns:</strong>
|
|
|
247 |
<ul>
|
|
|
248 |
<li><code>void</code></li>
|
|
|
249 |
</ul>
|
|
|
250 |
</div>
|
|
|
251 |
</div>
|
|
|
252 |
</div>
|
|
|
253 |
</td>
|
|
|
254 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td>
|
|
|
255 |
</tr>
|
|
|
256 |
<tr class="method-row alt expandable">
|
|
|
257 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
258 |
<td class="sig">
|
|
|
259 |
<a id="Ext.data.Node-appendChild"></a>
|
|
|
260 |
<b>appendChild</b>( <code>Node/Array node</code> ) : Node <div class="mdesc">
|
|
|
261 |
<div class="short">Insert node(s) as the last child node of this node.</div>
|
|
|
262 |
<div class="long">
|
|
|
263 |
Insert node(s) as the last child node of this node. <div class="mdetail-params">
|
|
|
264 |
<strong>Parameters:</strong>
|
|
|
265 |
<ul><li><code>node</code> : Node/Array<div class="sub-desc">The node or Array of nodes to append</div></li> </ul>
|
|
|
266 |
<strong>Returns:</strong>
|
|
|
267 |
<ul>
|
|
|
268 |
<li><code>Node</code><div class="sub-desc">The appended node if single append, or null if an array was passed</div></li>
|
|
|
269 |
</ul>
|
|
|
270 |
</div>
|
|
|
271 |
</div>
|
|
|
272 |
</div>
|
|
|
273 |
</td>
|
|
|
274 |
<td class="msource">Node</td>
|
|
|
275 |
</tr>
|
|
|
276 |
<tr class="method-row expandable">
|
|
|
277 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
278 |
<td class="sig">
|
|
|
279 |
<a id="Ext.data.Node-bubble"></a>
|
|
|
280 |
<b>bubble</b>( <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Array args</code>]</span> ) : void <div class="mdesc">
|
|
|
281 |
<div class="short">Bubbles up the tree from this node, calling the specified function with each node. The scope (this) of
|
|
|
282 |
function call ...</div>
|
|
|
283 |
<div class="long">
|
|
|
284 |
Bubbles up the tree from this node, calling the specified function with each node. The scope (<i>this</i>) of
|
|
|
285 |
function call will be the scope provided or the current node. The arguments to the function
|
|
|
286 |
will be the args provided or the current node. If the function returns false at any point,
|
|
|
287 |
the bubble is stopped. <div class="mdetail-params">
|
|
|
288 |
<strong>Parameters:</strong>
|
|
|
289 |
<ul><li><code>fn</code> : Function<div class="sub-desc">The function to call</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope of the function (defaults to current node)</div></li><li><code>args</code> : Array<div class="sub-desc">(optional) The args to call the function with (default to passing the current node)</div></li> </ul>
|
|
|
290 |
<strong>Returns:</strong>
|
|
|
291 |
<ul>
|
|
|
292 |
<li><code>void</code></li>
|
|
|
293 |
</ul>
|
|
|
294 |
</div>
|
|
|
295 |
</div>
|
|
|
296 |
</div>
|
|
|
297 |
</td>
|
|
|
298 |
<td class="msource">Node</td>
|
|
|
299 |
</tr>
|
|
|
300 |
<tr class="method-row alt expandable">
|
|
|
301 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
302 |
<td class="sig">
|
|
|
303 |
<a id="Ext.data.Node-cascade"></a>
|
|
|
304 |
<b>cascade</b>( <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Array args</code>]</span> ) : void <div class="mdesc">
|
|
|
305 |
<div class="short">Cascades down the tree from this node, calling the specified function with each node. The scope (this) of
|
|
|
306 |
function ca...</div>
|
|
|
307 |
<div class="long">
|
|
|
308 |
Cascades down the tree from this node, calling the specified function with each node. The scope (<i>this</i>) of
|
|
|
309 |
function call will be the scope provided or the current node. The arguments to the function
|
|
|
310 |
will be the args provided or the current node. If the function returns false at any point,
|
|
|
311 |
the cascade is stopped on that branch. <div class="mdetail-params">
|
|
|
312 |
<strong>Parameters:</strong>
|
|
|
313 |
<ul><li><code>fn</code> : Function<div class="sub-desc">The function to call</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope of the function (defaults to current node)</div></li><li><code>args</code> : Array<div class="sub-desc">(optional) The args to call the function with (default to passing the current node)</div></li> </ul>
|
|
|
314 |
<strong>Returns:</strong>
|
|
|
315 |
<ul>
|
|
|
316 |
<li><code>void</code></li>
|
|
|
317 |
</ul>
|
|
|
318 |
</div>
|
|
|
319 |
</div>
|
|
|
320 |
</div>
|
|
|
321 |
</td>
|
|
|
322 |
<td class="msource">Node</td>
|
|
|
323 |
</tr>
|
|
|
324 |
<tr class="method-row expandable">
|
|
|
325 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
326 |
<td class="sig">
|
|
|
327 |
<a id="Ext.data.Node-contains"></a>
|
|
|
328 |
<b>contains</b>( <code>Node node</code> ) : Boolean <div class="mdesc">
|
|
|
329 |
<div class="short">Returns true if this node is an ancestor (at any point) of the passed node.</div>
|
|
|
330 |
<div class="long">
|
|
|
331 |
Returns true if this node is an ancestor (at any point) of the passed node. <div class="mdetail-params">
|
|
|
332 |
<strong>Parameters:</strong>
|
|
|
333 |
<ul><li><code>node</code> : Node<div class="sub-desc"></div></li> </ul>
|
|
|
334 |
<strong>Returns:</strong>
|
|
|
335 |
<ul>
|
|
|
336 |
<li><code>Boolean</code></li>
|
|
|
337 |
</ul>
|
|
|
338 |
</div>
|
|
|
339 |
</div>
|
|
|
340 |
</div>
|
|
|
341 |
</td>
|
|
|
342 |
<td class="msource">Node</td>
|
|
|
343 |
</tr>
|
|
|
344 |
<tr class="method-row alt expandable">
|
|
|
345 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
346 |
<td class="sig">
|
|
|
347 |
<a id="Ext.data.Node-eachChild"></a>
|
|
|
348 |
<b>eachChild</b>( <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Array args</code>]</span> ) : void <div class="mdesc">
|
|
|
349 |
<div class="short">Interates the child nodes of this node, calling the specified function with each node. The scope (this) of
|
|
|
350 |
function c...</div>
|
|
|
351 |
<div class="long">
|
|
|
352 |
Interates the child nodes of this node, calling the specified function with each node. The scope (<i>this</i>) of
|
|
|
353 |
function call will be the scope provided or the current node. The arguments to the function
|
|
|
354 |
will be the args provided or the current node. If the function returns false at any point,
|
|
|
355 |
the iteration stops. <div class="mdetail-params">
|
|
|
356 |
<strong>Parameters:</strong>
|
|
|
357 |
<ul><li><code>fn</code> : Function<div class="sub-desc">The function to call</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope of the function (defaults to current node)</div></li><li><code>args</code> : Array<div class="sub-desc">(optional) The args to call the function with (default to passing the current node)</div></li> </ul>
|
|
|
358 |
<strong>Returns:</strong>
|
|
|
359 |
<ul>
|
|
|
360 |
<li><code>void</code></li>
|
|
|
361 |
</ul>
|
|
|
362 |
</div>
|
|
|
363 |
</div>
|
|
|
364 |
</div>
|
|
|
365 |
</td>
|
|
|
366 |
<td class="msource">Node</td>
|
|
|
367 |
</tr>
|
|
|
368 |
<tr class="method-row expandable">
|
|
|
369 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
370 |
<td class="sig">
|
|
|
371 |
<a id="Ext.data.Node-findChild"></a>
|
|
|
372 |
<b>findChild</b>( <code>String attribute</code>, <code>Mixed value</code> ) : Node <div class="mdesc">
|
|
|
373 |
<div class="short">Finds the first child that has the attribute with the specified value.</div>
|
|
|
374 |
<div class="long">
|
|
|
375 |
Finds the first child that has the attribute with the specified value. <div class="mdetail-params">
|
|
|
376 |
<strong>Parameters:</strong>
|
|
|
377 |
<ul><li><code>attribute</code> : String<div class="sub-desc">The attribute name</div></li><li><code>value</code> : Mixed<div class="sub-desc">The value to search for</div></li> </ul>
|
|
|
378 |
<strong>Returns:</strong>
|
|
|
379 |
<ul>
|
|
|
380 |
<li><code>Node</code><div class="sub-desc">The found child or null if none was found</div></li>
|
|
|
381 |
</ul>
|
|
|
382 |
</div>
|
|
|
383 |
</div>
|
|
|
384 |
</div>
|
|
|
385 |
</td>
|
|
|
386 |
<td class="msource">Node</td>
|
|
|
387 |
</tr>
|
|
|
388 |
<tr class="method-row alt expandable">
|
|
|
389 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
390 |
<td class="sig">
|
|
|
391 |
<a id="Ext.data.Node-findChildBy"></a>
|
|
|
392 |
<b>findChildBy</b>( <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : Node <div class="mdesc">
|
|
|
393 |
<div class="short">Finds the first child by a custom function. The child matches if the function passed
|
|
|
394 |
returns true.</div>
|
|
|
395 |
<div class="long">
|
|
|
396 |
Finds the first child by a custom function. The child matches if the function passed
|
|
|
397 |
returns true. <div class="mdetail-params">
|
|
|
398 |
<strong>Parameters:</strong>
|
|
|
399 |
<ul><li><code>fn</code> : Function<div class="sub-desc"></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional)</div></li> </ul>
|
|
|
400 |
<strong>Returns:</strong>
|
|
|
401 |
<ul>
|
|
|
402 |
<li><code>Node</code><div class="sub-desc">The found child or null if none was found</div></li>
|
|
|
403 |
</ul>
|
|
|
404 |
</div>
|
|
|
405 |
</div>
|
|
|
406 |
</div>
|
|
|
407 |
</td>
|
|
|
408 |
<td class="msource">Node</td>
|
|
|
409 |
</tr>
|
|
|
410 |
<tr class="method-row inherited expandable">
|
|
|
411 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
412 |
<td class="sig">
|
|
|
413 |
<a id="Ext.data.Node-fireEvent"></a>
|
|
|
414 |
<b>fireEvent</b>( <code>String eventName</code>, <code>Object... args</code> ) : Boolean <div class="mdesc">
|
|
|
415 |
<div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
|
|
|
416 |
<div class="long">
|
|
|
417 |
Fires the specified event with the passed parameters (minus the event name). <div class="mdetail-params">
|
|
|
418 |
<strong>Parameters:</strong>
|
|
|
419 |
<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>
|
|
|
420 |
<strong>Returns:</strong>
|
|
|
421 |
<ul>
|
|
|
422 |
<li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li>
|
|
|
423 |
</ul>
|
|
|
424 |
</div>
|
|
|
425 |
</div>
|
|
|
426 |
</div>
|
|
|
427 |
</td>
|
|
|
428 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td>
|
|
|
429 |
</tr>
|
|
|
430 |
<tr class="method-row alt expandable">
|
|
|
431 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
432 |
<td class="sig">
|
|
|
433 |
<a id="Ext.data.Node-getDepth"></a>
|
|
|
434 |
<b>getDepth</b>() : Number <div class="mdesc">
|
|
|
435 |
<div class="short">Returns depth of this node (the root node has a depth of 0)</div>
|
|
|
436 |
<div class="long">
|
|
|
437 |
Returns depth of this node (the root node has a depth of 0) <div class="mdetail-params">
|
|
|
438 |
<strong>Parameters:</strong>
|
|
|
439 |
<ul><li>None.</li> </ul>
|
|
|
440 |
<strong>Returns:</strong>
|
|
|
441 |
<ul>
|
|
|
442 |
<li><code>Number</code></li>
|
|
|
443 |
</ul>
|
|
|
444 |
</div>
|
|
|
445 |
</div>
|
|
|
446 |
</div>
|
|
|
447 |
</td>
|
|
|
448 |
<td class="msource">Node</td>
|
|
|
449 |
</tr>
|
|
|
450 |
<tr class="method-row expandable">
|
|
|
451 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
452 |
<td class="sig">
|
|
|
453 |
<a id="Ext.data.Node-getOwnerTree"></a>
|
|
|
454 |
<b>getOwnerTree</b>() : Tree <div class="mdesc">
|
|
|
455 |
<div class="short">Returns the tree this node is in.</div>
|
|
|
456 |
<div class="long">
|
|
|
457 |
Returns the tree this node is in. <div class="mdetail-params">
|
|
|
458 |
<strong>Parameters:</strong>
|
|
|
459 |
<ul><li>None.</li> </ul>
|
|
|
460 |
<strong>Returns:</strong>
|
|
|
461 |
<ul>
|
|
|
462 |
<li><code>Tree</code></li>
|
|
|
463 |
</ul>
|
|
|
464 |
</div>
|
|
|
465 |
</div>
|
|
|
466 |
</div>
|
|
|
467 |
</td>
|
|
|
468 |
<td class="msource">Node</td>
|
|
|
469 |
</tr>
|
|
|
470 |
<tr class="method-row alt expandable">
|
|
|
471 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
472 |
<td class="sig">
|
|
|
473 |
<a id="Ext.data.Node-getPath"></a>
|
|
|
474 |
<b>getPath</b>( <span class="optional" title="Optional">[<code>String attr</code>]</span> ) : String <div class="mdesc">
|
|
|
475 |
<div class="short">Returns the path for this node. The path can be used to expand or select this node programmatically.</div>
|
|
|
476 |
<div class="long">
|
|
|
477 |
Returns the path for this node. The path can be used to expand or select this node programmatically. <div class="mdetail-params">
|
|
|
478 |
<strong>Parameters:</strong>
|
|
|
479 |
<ul><li><code>attr</code> : String<div class="sub-desc">(optional) The attr to use for the path (defaults to the node's id)</div></li> </ul>
|
|
|
480 |
<strong>Returns:</strong>
|
|
|
481 |
<ul>
|
|
|
482 |
<li><code>String</code><div class="sub-desc">The path</div></li>
|
|
|
483 |
</ul>
|
|
|
484 |
</div>
|
|
|
485 |
</div>
|
|
|
486 |
</div>
|
|
|
487 |
</td>
|
|
|
488 |
<td class="msource">Node</td>
|
|
|
489 |
</tr>
|
|
|
490 |
<tr class="method-row inherited expandable">
|
|
|
491 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
492 |
<td class="sig">
|
|
|
493 |
<a id="Ext.data.Node-hasListener"></a>
|
|
|
494 |
<b>hasListener</b>( <code>String eventName</code> ) : Boolean <div class="mdesc">
|
|
|
495 |
<div class="short">Checks to see if this object has any listeners for a specified event</div>
|
|
|
496 |
<div class="long">
|
|
|
497 |
Checks to see if this object has any listeners for a specified event <div class="mdetail-params">
|
|
|
498 |
<strong>Parameters:</strong>
|
|
|
499 |
<ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li> </ul>
|
|
|
500 |
<strong>Returns:</strong>
|
|
|
501 |
<ul>
|
|
|
502 |
<li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li>
|
|
|
503 |
</ul>
|
|
|
504 |
</div>
|
|
|
505 |
</div>
|
|
|
506 |
</div>
|
|
|
507 |
</td>
|
|
|
508 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td>
|
|
|
509 |
</tr>
|
|
|
510 |
<tr class="method-row alt expandable">
|
|
|
511 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
512 |
<td class="sig">
|
|
|
513 |
<a id="Ext.data.Node-indexOf"></a>
|
|
|
514 |
<b>indexOf</b>( <code>Node node</code> ) : Number <div class="mdesc">
|
|
|
515 |
<div class="short">Returns the index of a child node</div>
|
|
|
516 |
<div class="long">
|
|
|
517 |
Returns the index of a child node <div class="mdetail-params">
|
|
|
518 |
<strong>Parameters:</strong>
|
|
|
519 |
<ul><li><code>node</code> : Node<div class="sub-desc"></div></li> </ul>
|
|
|
520 |
<strong>Returns:</strong>
|
|
|
521 |
<ul>
|
|
|
522 |
<li><code>Number</code><div class="sub-desc">The index of the node or -1 if it was not found</div></li>
|
|
|
523 |
</ul>
|
|
|
524 |
</div>
|
|
|
525 |
</div>
|
|
|
526 |
</div>
|
|
|
527 |
</td>
|
|
|
528 |
<td class="msource">Node</td>
|
|
|
529 |
</tr>
|
|
|
530 |
<tr class="method-row expandable">
|
|
|
531 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
532 |
<td class="sig">
|
|
|
533 |
<a id="Ext.data.Node-insertBefore"></a>
|
|
|
534 |
<b>insertBefore</b>( <code>Node node</code>, <code>Node refNode</code> ) : Node <div class="mdesc">
|
|
|
535 |
<div class="short">Inserts the first node before the second node in this nodes childNodes collection.</div>
|
|
|
536 |
<div class="long">
|
|
|
537 |
Inserts the first node before the second node in this nodes childNodes collection. <div class="mdetail-params">
|
|
|
538 |
<strong>Parameters:</strong>
|
|
|
539 |
<ul><li><code>node</code> : Node<div class="sub-desc">The node to insert</div></li><li><code>refNode</code> : Node<div class="sub-desc">The node to insert before (if null the node is appended)</div></li> </ul>
|
|
|
540 |
<strong>Returns:</strong>
|
|
|
541 |
<ul>
|
|
|
542 |
<li><code>Node</code><div class="sub-desc">The inserted node</div></li>
|
|
|
543 |
</ul>
|
|
|
544 |
</div>
|
|
|
545 |
</div>
|
|
|
546 |
</div>
|
|
|
547 |
</td>
|
|
|
548 |
<td class="msource">Node</td>
|
|
|
549 |
</tr>
|
|
|
550 |
<tr class="method-row alt expandable">
|
|
|
551 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
552 |
<td class="sig">
|
|
|
553 |
<a id="Ext.data.Node-isAncestor"></a>
|
|
|
554 |
<b>isAncestor</b>( <code>Node node</code> ) : Boolean <div class="mdesc">
|
|
|
555 |
<div class="short">Returns true if the passed node is an ancestor (at any point) of this node.</div>
|
|
|
556 |
<div class="long">
|
|
|
557 |
Returns true if the passed node is an ancestor (at any point) of this node. <div class="mdetail-params">
|
|
|
558 |
<strong>Parameters:</strong>
|
|
|
559 |
<ul><li><code>node</code> : Node<div class="sub-desc"></div></li> </ul>
|
|
|
560 |
<strong>Returns:</strong>
|
|
|
561 |
<ul>
|
|
|
562 |
<li><code>Boolean</code></li>
|
|
|
563 |
</ul>
|
|
|
564 |
</div>
|
|
|
565 |
</div>
|
|
|
566 |
</div>
|
|
|
567 |
</td>
|
|
|
568 |
<td class="msource">Node</td>
|
|
|
569 |
</tr>
|
|
|
570 |
<tr class="method-row expandable">
|
|
|
571 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
572 |
<td class="sig">
|
|
|
573 |
<a id="Ext.data.Node-isFirst"></a>
|
|
|
574 |
<b>isFirst</b>() : Boolean <div class="mdesc">
|
|
|
575 |
<div class="short">Returns true if this node is the first child of its parent</div>
|
|
|
576 |
<div class="long">
|
|
|
577 |
Returns true if this node is the first child of its parent <div class="mdetail-params">
|
|
|
578 |
<strong>Parameters:</strong>
|
|
|
579 |
<ul><li>None.</li> </ul>
|
|
|
580 |
<strong>Returns:</strong>
|
|
|
581 |
<ul>
|
|
|
582 |
<li><code>Boolean</code></li>
|
|
|
583 |
</ul>
|
|
|
584 |
</div>
|
|
|
585 |
</div>
|
|
|
586 |
</div>
|
|
|
587 |
</td>
|
|
|
588 |
<td class="msource">Node</td>
|
|
|
589 |
</tr>
|
|
|
590 |
<tr class="method-row alt expandable">
|
|
|
591 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
592 |
<td class="sig">
|
|
|
593 |
<a id="Ext.data.Node-isLast"></a>
|
|
|
594 |
<b>isLast</b>() : Boolean <div class="mdesc">
|
|
|
595 |
<div class="short">Returns true if this node is the last child of its parent</div>
|
|
|
596 |
<div class="long">
|
|
|
597 |
Returns true if this node is the last child of its parent <div class="mdetail-params">
|
|
|
598 |
<strong>Parameters:</strong>
|
|
|
599 |
<ul><li>None.</li> </ul>
|
|
|
600 |
<strong>Returns:</strong>
|
|
|
601 |
<ul>
|
|
|
602 |
<li><code>Boolean</code></li>
|
|
|
603 |
</ul>
|
|
|
604 |
</div>
|
|
|
605 |
</div>
|
|
|
606 |
</div>
|
|
|
607 |
</td>
|
|
|
608 |
<td class="msource">Node</td>
|
|
|
609 |
</tr>
|
|
|
610 |
<tr class="method-row expandable">
|
|
|
611 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
612 |
<td class="sig">
|
|
|
613 |
<a id="Ext.data.Node-isLeaf"></a>
|
|
|
614 |
<b>isLeaf</b>() : Boolean <div class="mdesc">
|
|
|
615 |
<div class="short">Returns true if this node is a leaf</div>
|
|
|
616 |
<div class="long">
|
|
|
617 |
Returns true if this node is a leaf <div class="mdetail-params">
|
|
|
618 |
<strong>Parameters:</strong>
|
|
|
619 |
<ul><li>None.</li> </ul>
|
|
|
620 |
<strong>Returns:</strong>
|
|
|
621 |
<ul>
|
|
|
622 |
<li><code>Boolean</code></li>
|
|
|
623 |
</ul>
|
|
|
624 |
</div>
|
|
|
625 |
</div>
|
|
|
626 |
</div>
|
|
|
627 |
</td>
|
|
|
628 |
<td class="msource">Node</td>
|
|
|
629 |
</tr>
|
|
|
630 |
<tr class="method-row alt expandable">
|
|
|
631 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
632 |
<td class="sig">
|
|
|
633 |
<a id="Ext.data.Node-item"></a>
|
|
|
634 |
<b>item</b>( <code>Number index</code> ) : Node <div class="mdesc">
|
|
|
635 |
<div class="short">Returns the child node at the specified index.</div>
|
|
|
636 |
<div class="long">
|
|
|
637 |
Returns the child node at the specified index. <div class="mdetail-params">
|
|
|
638 |
<strong>Parameters:</strong>
|
|
|
639 |
<ul><li><code>index</code> : Number<div class="sub-desc"></div></li> </ul>
|
|
|
640 |
<strong>Returns:</strong>
|
|
|
641 |
<ul>
|
|
|
642 |
<li><code>Node</code></li>
|
|
|
643 |
</ul>
|
|
|
644 |
</div>
|
|
|
645 |
</div>
|
|
|
646 |
</div>
|
|
|
647 |
</td>
|
|
|
648 |
<td class="msource">Node</td>
|
|
|
649 |
</tr>
|
|
|
650 |
<tr class="method-row inherited expandable">
|
|
|
651 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
652 |
<td class="sig">
|
|
|
653 |
<a id="Ext.data.Node-on"></a>
|
|
|
654 |
<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">
|
|
|
655 |
<div class="short">Appends an event handler to this element (shorthand for addListener)</div>
|
|
|
656 |
<div class="long">
|
|
|
657 |
Appends an event handler to this element (shorthand for addListener) <div class="mdetail-params">
|
|
|
658 |
<strong>Parameters:</strong>
|
|
|
659 |
<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
|
|
|
660 |
function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li> </ul>
|
|
|
661 |
<strong>Returns:</strong>
|
|
|
662 |
<ul>
|
|
|
663 |
<li><code>void</code></li>
|
|
|
664 |
</ul>
|
|
|
665 |
</div>
|
|
|
666 |
</div>
|
|
|
667 |
</div>
|
|
|
668 |
</td>
|
|
|
669 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td>
|
|
|
670 |
</tr>
|
|
|
671 |
<tr class="method-row inherited alt expandable">
|
|
|
672 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
673 |
<td class="sig">
|
|
|
674 |
<a id="Ext.data.Node-purgeListeners"></a>
|
|
|
675 |
<b>purgeListeners</b>() : void <div class="mdesc">
|
|
|
676 |
<div class="short">Removes all listeners for this object</div>
|
|
|
677 |
<div class="long">
|
|
|
678 |
Removes all listeners for this object <div class="mdetail-params">
|
|
|
679 |
<strong>Parameters:</strong>
|
|
|
680 |
<ul><li>None.</li> </ul>
|
|
|
681 |
<strong>Returns:</strong>
|
|
|
682 |
<ul>
|
|
|
683 |
<li><code>void</code></li>
|
|
|
684 |
</ul>
|
|
|
685 |
</div>
|
|
|
686 |
</div>
|
|
|
687 |
</div>
|
|
|
688 |
</td>
|
|
|
689 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td>
|
|
|
690 |
</tr>
|
|
|
691 |
<tr class="method-row expandable">
|
|
|
692 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
693 |
<td class="sig">
|
|
|
694 |
<a id="Ext.data.Node-remove"></a>
|
|
|
695 |
<b>remove</b>() : Node <div class="mdesc">
|
|
|
696 |
<div class="short">Removes this node from it's parent</div>
|
|
|
697 |
<div class="long">
|
|
|
698 |
Removes this node from it's parent <div class="mdetail-params">
|
|
|
699 |
<strong>Parameters:</strong>
|
|
|
700 |
<ul><li>None.</li> </ul>
|
|
|
701 |
<strong>Returns:</strong>
|
|
|
702 |
<ul>
|
|
|
703 |
<li><code>Node</code><div class="sub-desc">this</div></li>
|
|
|
704 |
</ul>
|
|
|
705 |
</div>
|
|
|
706 |
</div>
|
|
|
707 |
</div>
|
|
|
708 |
</td>
|
|
|
709 |
<td class="msource">Node</td>
|
|
|
710 |
</tr>
|
|
|
711 |
<tr class="method-row alt expandable">
|
|
|
712 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
713 |
<td class="sig">
|
|
|
714 |
<a id="Ext.data.Node-removeChild"></a>
|
|
|
715 |
<b>removeChild</b>( <code>Node node</code> ) : Node <div class="mdesc">
|
|
|
716 |
<div class="short">Removes a child node from this node.</div>
|
|
|
717 |
<div class="long">
|
|
|
718 |
Removes a child node from this node. <div class="mdetail-params">
|
|
|
719 |
<strong>Parameters:</strong>
|
|
|
720 |
<ul><li><code>node</code> : Node<div class="sub-desc">The node to remove</div></li> </ul>
|
|
|
721 |
<strong>Returns:</strong>
|
|
|
722 |
<ul>
|
|
|
723 |
<li><code>Node</code><div class="sub-desc">The removed node</div></li>
|
|
|
724 |
</ul>
|
|
|
725 |
</div>
|
|
|
726 |
</div>
|
|
|
727 |
</div>
|
|
|
728 |
</td>
|
|
|
729 |
<td class="msource">Node</td>
|
|
|
730 |
</tr>
|
|
|
731 |
<tr class="method-row inherited expandable">
|
|
|
732 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
733 |
<td class="sig">
|
|
|
734 |
<a id="Ext.data.Node-removeListener"></a>
|
|
|
735 |
<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">
|
|
|
736 |
<div class="short">Removes a listener</div>
|
|
|
737 |
<div class="long">
|
|
|
738 |
Removes a listener <div class="mdetail-params">
|
|
|
739 |
<strong>Parameters:</strong>
|
|
|
740 |
<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>
|
|
|
741 |
<strong>Returns:</strong>
|
|
|
742 |
<ul>
|
|
|
743 |
<li><code>void</code></li>
|
|
|
744 |
</ul>
|
|
|
745 |
</div>
|
|
|
746 |
</div>
|
|
|
747 |
</div>
|
|
|
748 |
</td>
|
|
|
749 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td>
|
|
|
750 |
</tr>
|
|
|
751 |
<tr class="method-row alt expandable">
|
|
|
752 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
753 |
<td class="sig">
|
|
|
754 |
<a id="Ext.data.Node-replaceChild"></a>
|
|
|
755 |
<b>replaceChild</b>( <code>Node newChild</code>, <code>Node oldChild</code> ) : Node <div class="mdesc">
|
|
|
756 |
<div class="short">Replaces one child node in this node with another.</div>
|
|
|
757 |
<div class="long">
|
|
|
758 |
Replaces one child node in this node with another. <div class="mdetail-params">
|
|
|
759 |
<strong>Parameters:</strong>
|
|
|
760 |
<ul><li><code>newChild</code> : Node<div class="sub-desc">The replacement node</div></li><li><code>oldChild</code> : Node<div class="sub-desc">The node to replace</div></li> </ul>
|
|
|
761 |
<strong>Returns:</strong>
|
|
|
762 |
<ul>
|
|
|
763 |
<li><code>Node</code><div class="sub-desc">The replaced node</div></li>
|
|
|
764 |
</ul>
|
|
|
765 |
</div>
|
|
|
766 |
</div>
|
|
|
767 |
</div>
|
|
|
768 |
</td>
|
|
|
769 |
<td class="msource">Node</td>
|
|
|
770 |
</tr>
|
|
|
771 |
<tr class="method-row inherited expandable">
|
|
|
772 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
773 |
<td class="sig">
|
|
|
774 |
<a id="Ext.data.Node-resumeEvents"></a>
|
|
|
775 |
<b>resumeEvents</b>() : void <div class="mdesc">
|
|
|
776 |
<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>
|
|
|
777 |
<div class="long">
|
|
|
778 |
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">
|
|
|
779 |
<strong>Parameters:</strong>
|
|
|
780 |
<ul><li>None.</li> </ul>
|
|
|
781 |
<strong>Returns:</strong>
|
|
|
782 |
<ul>
|
|
|
783 |
<li><code>void</code></li>
|
|
|
784 |
</ul>
|
|
|
785 |
</div>
|
|
|
786 |
</div>
|
|
|
787 |
</div>
|
|
|
788 |
</td>
|
|
|
789 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td>
|
|
|
790 |
</tr>
|
|
|
791 |
<tr class="method-row alt expandable">
|
|
|
792 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
793 |
<td class="sig">
|
|
|
794 |
<a id="Ext.data.Node-sort"></a>
|
|
|
795 |
<b>sort</b>( <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc">
|
|
|
796 |
<div class="short">Sorts this nodes children using the supplied sort function</div>
|
|
|
797 |
<div class="long">
|
|
|
798 |
Sorts this nodes children using the supplied sort function <div class="mdetail-params">
|
|
|
799 |
<strong>Parameters:</strong>
|
|
|
800 |
<ul><li><code>fn</code> : Function<div class="sub-desc"></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional)</div></li> </ul>
|
|
|
801 |
<strong>Returns:</strong>
|
|
|
802 |
<ul>
|
|
|
803 |
<li><code>void</code></li>
|
|
|
804 |
</ul>
|
|
|
805 |
</div>
|
|
|
806 |
</div>
|
|
|
807 |
</div>
|
|
|
808 |
</td>
|
|
|
809 |
<td class="msource">Node</td>
|
|
|
810 |
</tr>
|
|
|
811 |
<tr class="method-row inherited expandable">
|
|
|
812 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
813 |
<td class="sig">
|
|
|
814 |
<a id="Ext.data.Node-suspendEvents"></a>
|
|
|
815 |
<b>suspendEvents</b>() : void <div class="mdesc">
|
|
|
816 |
<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>
|
|
|
817 |
<div class="long">
|
|
|
818 |
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">
|
|
|
819 |
<strong>Parameters:</strong>
|
|
|
820 |
<ul><li>None.</li> </ul>
|
|
|
821 |
<strong>Returns:</strong>
|
|
|
822 |
<ul>
|
|
|
823 |
<li><code>void</code></li>
|
|
|
824 |
</ul>
|
|
|
825 |
</div>
|
|
|
826 |
</div>
|
|
|
827 |
</div>
|
|
|
828 |
</td>
|
|
|
829 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td>
|
|
|
830 |
</tr>
|
|
|
831 |
<tr class="method-row inherited alt expandable">
|
|
|
832 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
833 |
<td class="sig">
|
|
|
834 |
<a id="Ext.data.Node-un"></a>
|
|
|
835 |
<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">
|
|
|
836 |
<div class="short">Removes a listener (shorthand for removeListener)</div>
|
|
|
837 |
<div class="long">
|
|
|
838 |
Removes a listener (shorthand for removeListener) <div class="mdetail-params">
|
|
|
839 |
<strong>Parameters:</strong>
|
|
|
840 |
<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>
|
|
|
841 |
<strong>Returns:</strong>
|
|
|
842 |
<ul>
|
|
|
843 |
<li><code>void</code></li>
|
|
|
844 |
</ul>
|
|
|
845 |
</div>
|
|
|
846 |
</div>
|
|
|
847 |
</div>
|
|
|
848 |
</td>
|
|
|
849 |
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td>
|
|
|
850 |
</tr>
|
|
|
851 |
</table>
|
|
|
852 |
<a id="Ext.data.Node-events"></a>
|
|
|
853 |
<h2>Public Events</h2>
|
|
|
854 |
<table cellspacing="0" class="member-table">
|
|
|
855 |
<tr>
|
|
|
856 |
<th class="sig-header" colspan="2">Event</th>
|
|
|
857 |
<th class="msource-header">Defined By</th>
|
|
|
858 |
</tr>
|
|
|
859 |
<tr class="event-row expandable">
|
|
|
860 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
861 |
<td class="sig">
|
|
|
862 |
<a id="Ext.data.Node-append"></a>
|
|
|
863 |
<b>append</b> : ( <code>Tree tree</code>, <code>Node this</code>, <code>Node node</code>, <code>Number index</code> ) <div class="mdesc">
|
|
|
864 |
<div class="short">Fires when a new child node is appended</div>
|
|
|
865 |
<div class="long">
|
|
|
866 |
Fires when a new child node is appended <div class="mdetail-params">
|
|
|
867 |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
|
|
|
868 |
<ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>this</code> : Node<div class="sub-desc">This 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>
|
|
|
869 |
</div>
|
|
|
870 |
</div>
|
|
|
871 |
</div>
|
|
|
872 |
</td>
|
|
|
873 |
<td class="msource">Node</td>
|
|
|
874 |
</tr>
|
|
|
875 |
<tr class="event-row alt expandable">
|
|
|
876 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
877 |
<td class="sig">
|
|
|
878 |
<a id="Ext.data.Node-beforeappend"></a>
|
|
|
879 |
<b>beforeappend</b> : ( <code>Tree tree</code>, <code>Node this</code>, <code>Node node</code> ) <div class="mdesc">
|
|
|
880 |
<div class="short">Fires before a new child is appended, return false to cancel the append.</div>
|
|
|
881 |
<div class="long">
|
|
|
882 |
Fires before a new child is appended, return false to cancel the append. <div class="mdetail-params">
|
|
|
883 |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
|
|
|
884 |
<ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>this</code> : Node<div class="sub-desc">This node</div></li><li><code>node</code> : Node<div class="sub-desc">The child node to be appended</div></li> </ul>
|
|
|
885 |
</div>
|
|
|
886 |
</div>
|
|
|
887 |
</div>
|
|
|
888 |
</td>
|
|
|
889 |
<td class="msource">Node</td>
|
|
|
890 |
</tr>
|
|
|
891 |
<tr class="event-row expandable">
|
|
|
892 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
893 |
<td class="sig">
|
|
|
894 |
<a id="Ext.data.Node-beforeinsert"></a>
|
|
|
895 |
<b>beforeinsert</b> : ( <code>Tree tree</code>, <code>Node this</code>, <code>Node node</code>, <code>Node refNode</code> ) <div class="mdesc">
|
|
|
896 |
<div class="short">Fires before a new child is inserted, return false to cancel the insert.</div>
|
|
|
897 |
<div class="long">
|
|
|
898 |
Fires before a new child is inserted, return false to cancel the insert. <div class="mdetail-params">
|
|
|
899 |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
|
|
|
900 |
<ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>this</code> : Node<div class="sub-desc">This 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>
|
|
|
901 |
</div>
|
|
|
902 |
</div>
|
|
|
903 |
</div>
|
|
|
904 |
</td>
|
|
|
905 |
<td class="msource">Node</td>
|
|
|
906 |
</tr>
|
|
|
907 |
<tr class="event-row alt expandable">
|
|
|
908 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
909 |
<td class="sig">
|
|
|
910 |
<a id="Ext.data.Node-beforemove"></a>
|
|
|
911 |
<b>beforemove</b> : ( <code>Tree tree</code>, <code>Node this</code>, <code>Node oldParent</code>, <code>Node newParent</code>, <code>Number index</code> ) <div class="mdesc">
|
|
|
912 |
<div class="short">Fires before this node is moved to a new location in the tree. Return false to cancel the move.</div>
|
|
|
913 |
<div class="long">
|
|
|
914 |
Fires before this node is moved to a new location in the tree. Return false to cancel the move. <div class="mdetail-params">
|
|
|
915 |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
|
|
|
916 |
<ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>this</code> : Node<div class="sub-desc">This node</div></li><li><code>oldParent</code> : Node<div class="sub-desc">The parent of this node</div></li><li><code>newParent</code> : Node<div class="sub-desc">The new parent this 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>
|
|
|
917 |
</div>
|
|
|
918 |
</div>
|
|
|
919 |
</div>
|
|
|
920 |
</td>
|
|
|
921 |
<td class="msource">Node</td>
|
|
|
922 |
</tr>
|
|
|
923 |
<tr class="event-row expandable">
|
|
|
924 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
925 |
<td class="sig">
|
|
|
926 |
<a id="Ext.data.Node-beforeremove"></a>
|
|
|
927 |
<b>beforeremove</b> : ( <code>Tree tree</code>, <code>Node this</code>, <code>Node node</code> ) <div class="mdesc">
|
|
|
928 |
<div class="short">Fires before a child is removed, return false to cancel the remove.</div>
|
|
|
929 |
<div class="long">
|
|
|
930 |
Fires before a child is removed, return false to cancel the remove. <div class="mdetail-params">
|
|
|
931 |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
|
|
|
932 |
<ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>this</code> : Node<div class="sub-desc">This node</div></li><li><code>node</code> : Node<div class="sub-desc">The child node to be removed</div></li> </ul>
|
|
|
933 |
</div>
|
|
|
934 |
</div>
|
|
|
935 |
</div>
|
|
|
936 |
</td>
|
|
|
937 |
<td class="msource">Node</td>
|
|
|
938 |
</tr>
|
|
|
939 |
<tr class="event-row alt expandable">
|
|
|
940 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
941 |
<td class="sig">
|
|
|
942 |
<a id="Ext.data.Node-insert"></a>
|
|
|
943 |
<b>insert</b> : ( <code>Tree tree</code>, <code>Node this</code>, <code>Node node</code>, <code>Node refNode</code> ) <div class="mdesc">
|
|
|
944 |
<div class="short">Fires when a new child node is inserted.</div>
|
|
|
945 |
<div class="long">
|
|
|
946 |
Fires when a new child node is inserted. <div class="mdetail-params">
|
|
|
947 |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
|
|
|
948 |
<ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>this</code> : Node<div class="sub-desc">This 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>
|
|
|
949 |
</div>
|
|
|
950 |
</div>
|
|
|
951 |
</div>
|
|
|
952 |
</td>
|
|
|
953 |
<td class="msource">Node</td>
|
|
|
954 |
</tr>
|
|
|
955 |
<tr class="event-row expandable">
|
|
|
956 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
957 |
<td class="sig">
|
|
|
958 |
<a id="Ext.data.Node-move"></a>
|
|
|
959 |
<b>move</b> : ( <code>Tree tree</code>, <code>Node this</code>, <code>Node oldParent</code>, <code>Node newParent</code>, <code>Number index</code> ) <div class="mdesc">
|
|
|
960 |
<div class="short">Fires when this node is moved to a new location in the tree</div>
|
|
|
961 |
<div class="long">
|
|
|
962 |
Fires when this node is moved to a new location in the tree <div class="mdetail-params">
|
|
|
963 |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
|
|
|
964 |
<ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>this</code> : Node<div class="sub-desc">This node</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>
|
|
|
965 |
</div>
|
|
|
966 |
</div>
|
|
|
967 |
</div>
|
|
|
968 |
</td>
|
|
|
969 |
<td class="msource">Node</td>
|
|
|
970 |
</tr>
|
|
|
971 |
<tr class="event-row alt expandable">
|
|
|
972 |
<td class="micon"><a class="exi" href="#expand"> </a></td>
|
|
|
973 |
<td class="sig">
|
|
|
974 |
<a id="Ext.data.Node-remove"></a>
|
|
|
975 |
<b>remove</b> : ( <code>Tree tree</code>, <code>Node this</code>, <code>Node node</code> ) <div class="mdesc">
|
|
|
976 |
<div class="short">Fires when a child node is removed</div>
|
|
|
977 |
<div class="long">
|
|
|
978 |
Fires when a child node is removed <div class="mdetail-params">
|
|
|
979 |
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
|
|
|
980 |
<ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>this</code> : Node<div class="sub-desc">This node</div></li><li><code>node</code> : Node<div class="sub-desc">The removed node</div></li> </ul>
|
|
|
981 |
</div>
|
|
|
982 |
</div>
|
|
|
983 |
</div>
|
|
|
984 |
</td>
|
|
|
985 |
<td class="msource">Node</td>
|
|
|
986 |
</tr>
|
|
|
987 |
</table>
|
|
|
988 |
|
|
|
989 |
</div>
|