1
<div class="body-wrap">
2
<div class="top-tools">
3
<a class="inner-link" href="#Ext.tree.TreePanel-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
4
<a class="inner-link" href="#Ext.tree.TreePanel-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
5
<a class="inner-link" href="#Ext.tree.TreePanel-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
6
<a class="inner-link" href="#Ext.tree.TreePanel-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
7
<a class="bookmark" href="../docs/?class=Ext.tree.TreePanel"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
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"/><a ext:cls="Ext.Component" ext:member="" href="output/Ext.Component.html">Component</a>
12
<img src="resources/elbow-end.gif"/><a ext:cls="Ext.BoxComponent" ext:member="" href="output/Ext.BoxComponent.html">BoxComponent</a>
13
<img src="resources/elbow-end.gif"/><a ext:cls="Ext.Container" ext:member="" href="output/Ext.Container.html">Container</a>
14
<img src="resources/elbow-end.gif"/><a ext:cls="Ext.Panel" ext:member="" href="output/Ext.Panel.html">Panel</a>
15
<img src="resources/elbow-end.gif"/>TreePanel</pre></div>
16
<h1>Class Ext.tree.TreePanel</h1>
17
<table cellspacing="0">
18
<tr><td class="label">Package:</td><td class="hd-info">Ext.tree</td></tr>
19
<tr><td class="label">Defined In:</td><td class="hd-info">TreePanel.js</td></tr>
20
<tr><td class="label">Class:</td><td class="hd-info">TreePanel</td></tr>
21
<tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.Panel" ext:member="" href="output/Ext.Panel.html">Panel</a></td></tr>
23
<div class="description">
24
<p>The TreePanel provides tree-structured UI representation of tree-structured data.</p>
25
<p><a ext:cls="Ext.tree.TreeNode" href="output/Ext.tree.TreeNode.html">TreeNode</a>s added to the TreePanel may each contain metadata
26
used by your application in their <a ext:cls="Ext.tree.TreeNode" ext:member="attributes" href="output/Ext.tree.TreeNode.html#attributes">attributes</a> property.</p>
27
<p><b>A TreePanel must have a <a ext:cls="Ext.tree.TreePanel" ext:member="root" href="output/Ext.tree.TreePanel.html#root">root</a> node before it is rendered.</b> This may either be
28
specified using the <a ext:cls="Ext.tree.TreePanel" ext:member="root" href="output/Ext.tree.TreePanel.html#root">root</a> config option, or using the <a ext:cls="Ext.tree.TreePanel" ext:member="setRootNode" href="output/Ext.tree.TreePanel.html#setRootNode">setRootNode</a> method. </div>
30
<div class="hr"></div>
31
<a id="Ext.tree.TreePanel-configs"></a>
32
<h2>Config Options</h2>
33
<table cellspacing="0" class="member-table">
35
<th class="sig-header" colspan="2">Config Options</th>
36
<th class="msource-header">Defined By</th>
38
<tr class="config-row inherited expandable">
39
<td class="micon"><a class="exi" href="#expand"> </a></td>
41
<a id="Ext.tree.TreePanel-animCollapse"></a>
42
<b>animCollapse</b> : Boolean <div class="mdesc">
43
<div class="short">True to animate the transition when the panel is collapsed, false to skip the animation (defaults to true if the Ext....</div>
45
True to animate the transition when the panel is collapsed, false to skip the animation (defaults to true if the <a ext:cls="Ext.Fx" href="output/Ext.Fx.html">Ext.Fx</a> class is available, otherwise false). </div>
48
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#animCollapse" href="output/Ext.Panel.html#animCollapse">Panel</a></td>
50
<tr class="config-row alt">
51
<td class="micon"><a class="exi" href="#expand"> </a></td>
53
<a id="Ext.tree.TreePanel-animate"></a>
54
<b>animate</b> : Boolean <div class="mdesc">
55
true to enable animated expand/collapse (defaults to the value of Ext.enableFx) </div>
57
<td class="msource">TreePanel</td>
59
<tr class="config-row inherited expandable">
60
<td class="micon"><a class="exi" href="#expand"> </a></td>
62
<a id="Ext.tree.TreePanel-autoHeight"></a>
63
<b>autoHeight</b> : Boolean <div class="mdesc">
64
<div class="short">True to use height:'auto', false to use fixed height (defaults to false). Note: Although many components inherit this...</div>
66
True to use height:'auto', false to use fixed height (defaults to false). <b>Note</b>: Although many components inherit this config option, not all will function as expected with a height of 'auto'. Setting autoHeight:true means that the browser will manage height based on the element's contents, and that Ext will not manage it at all. </div>
69
<td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#autoHeight" href="output/Ext.BoxComponent.html#autoHeight">BoxComponent</a></td>
71
<tr class="config-row inherited alt expandable">
72
<td class="micon"><a class="exi" href="#expand"> </a></td>
74
<a id="Ext.tree.TreePanel-autoScroll"></a>
75
<b>autoScroll</b> : Boolean <div class="mdesc">
76
<div class="short">True to use overflow:'auto' on the panel's body element and show scroll bars automatically when necessary, false to c...</div>
78
True to use overflow:'auto' on the panel's body element and show scroll bars automatically when necessary, false to clip any overflowing content (defaults to false). </div>
81
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#autoScroll" href="output/Ext.Panel.html#autoScroll">Panel</a></td>
83
<tr class="config-row inherited expandable">
84
<td class="micon"><a class="exi" href="#expand"> </a></td>
86
<a id="Ext.tree.TreePanel-autoShow"></a>
87
<b>autoShow</b> : Boolean <div class="mdesc">
88
<div class="short">True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove them on render...</div>
90
True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove them on render (defaults to false). </div>
93
<td class="msource"><a ext:cls="Ext.Component" ext:member="#autoShow" href="output/Ext.Component.html#autoShow">Component</a></td>
95
<tr class="config-row inherited alt">
96
<td class="micon"><a class="exi" href="#expand"> </a></td>
98
<a id="Ext.tree.TreePanel-baseCls"></a>
99
<b>baseCls</b> : String <div class="mdesc">
100
The base CSS class to apply to this panel's element (defaults to 'x-panel'). </div>
102
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#baseCls" href="output/Ext.Panel.html#baseCls">Panel</a></td>
104
<tr class="config-row inherited expandable">
105
<td class="micon"><a class="exi" href="#expand"> </a></td>
107
<a id="Ext.tree.TreePanel-bbar"></a>
108
<b>bbar</b> : Object/Array <div class="mdesc">
109
<div class="short">The bottom toolbar of the panel. This can be either an Ext.Toolbar object or an array of buttons/button configs to be...</div>
111
<p>The bottom toolbar of the panel. This can be either an <a ext:cls="Ext.Toolbar" href="output/Ext.Toolbar.html">Ext.Toolbar</a> object or an array of buttons/button configs to be added to the toolbar. Note that this is not available as a property after render. To access the bottom toolbar after render, use <a ext:cls="Ext.Panel" ext:member="getBottomToolbar" href="output/Ext.Panel.html#getBottomToolbar">getBottomToolbar</a>.</p> <p><b>Note:</b> Although a Toolbar may contain Field components, these will <b>not<b> be updated by a load of an ancestor FormPanel. A Panel's toolbars are not part of the standard Container->Component hierarchy, and so are not scanned to collect form items. Hoverver, the values <b>will</b> be submitted because form submission parameters are collected from the DOM tree.</p> </div>
114
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#bbar" href="output/Ext.Panel.html#bbar">Panel</a></td>
116
<tr class="config-row inherited alt expandable">
117
<td class="micon"><a class="exi" href="#expand"> </a></td>
119
<a id="Ext.tree.TreePanel-bodyBorder"></a>
120
<b>bodyBorder</b> : Boolean <div class="mdesc">
121
<div class="short">True to display an interior border on the body element of the panel, false to hide it (defaults to true). This only a...</div>
123
True to display an interior border on the body element of the panel, false to hide it (defaults to true). This only applies when <a ext:cls="Ext.Panel" ext:member="border" href="output/Ext.Panel.html#border">border</a> == true. If border == true and bodyBorder == false, the border will display as a 1px wide inset border, giving the entire body element an inset appearance. </div>
126
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#bodyBorder" href="output/Ext.Panel.html#bodyBorder">Panel</a></td>
128
<tr class="config-row inherited expandable">
129
<td class="micon"><a class="exi" href="#expand"> </a></td>
131
<a id="Ext.tree.TreePanel-bodyCfg"></a>
132
<b>bodyCfg</b> : Object <div class="mdesc">
133
<div class="short">A DomHelper configuration object specifying the element structure of this Panel's body Element. This may be used to f...</div>
135
<p>A <a ext:cls="Ext.DomHelper" href="output/Ext.DomHelper.html">DomHelper</a> configuration object specifying the element structure of this Panel's <a ext:cls="Ext.Panel" ext:member="body" href="output/Ext.Panel.html#body">body</a> Element.</p> <p>This may be used to force the body Element to use a different form of markup than is created automatically. An example of this might be to create a child Panel containing custom content, such as a header, or forcing centering of all Panel content by having the body be a <center> element:</p><code><pre>new Ext.Panel({
136
title: 'New Message',
138
renderTo: Ext.getBody(),
147
bodyCfg: {tag: 'h2', html: 'Message'}
163
});</pre></code> </div>
166
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#bodyCfg" href="output/Ext.Panel.html#bodyCfg">Panel</a></td>
168
<tr class="config-row inherited alt expandable">
169
<td class="micon"><a class="exi" href="#expand"> </a></td>
171
<a id="Ext.tree.TreePanel-bodyStyle"></a>
172
<b>bodyStyle</b> : String/Object/Function <div class="mdesc">
173
<div class="short">Custom CSS styles to be applied to the body element in the format expected by Ext.Element.applyStyles (defaults to nu...</div>
175
Custom CSS styles to be applied to the body element in the format expected by <a ext:cls="Ext.Element" ext:member="applyStyles" href="output/Ext.Element.html#applyStyles">Ext.Element.applyStyles</a> (defaults to null). </div>
178
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#bodyStyle" href="output/Ext.Panel.html#bodyStyle">Panel</a></td>
180
<tr class="config-row inherited expandable">
181
<td class="micon"><a class="exi" href="#expand"> </a></td>
183
<a id="Ext.tree.TreePanel-border"></a>
184
<b>border</b> : Boolean <div class="mdesc">
185
<div class="short">True to display the borders of the panel's body element, false to hide them (defaults to true). By default, the borde...</div>
187
True to display the borders of the panel's body element, false to hide them (defaults to true). By default, the border is a 2px wide inset border, but this can be further altered by setting <a ext:cls="Ext.Panel" ext:member="bodyBorder" href="output/Ext.Panel.html#bodyBorder">bodyBorder</a> to false. </div>
190
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#border" href="output/Ext.Panel.html#border">Panel</a></td>
192
<tr class="config-row inherited alt">
193
<td class="micon"><a class="exi" href="#expand"> </a></td>
195
<a id="Ext.tree.TreePanel-buttonAlign"></a>
196
<b>buttonAlign</b> : String <div class="mdesc">
197
The alignment of any buttons added to this panel. Valid values are 'right,' 'left' and 'center' (defaults to 'right'). </div>
199
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#buttonAlign" href="output/Ext.Panel.html#buttonAlign">Panel</a></td>
201
<tr class="config-row inherited">
202
<td class="micon"><a class="exi" href="#expand"> </a></td>
204
<a id="Ext.tree.TreePanel-buttons"></a>
205
<b>buttons</b> : Array <div class="mdesc">
206
An array of <a ext:cls="Ext.Button" href="output/Ext.Button.html">Ext.Button</a>s or <a ext:cls="Ext.Button" href="output/Ext.Button.html">Ext.Button</a> configs used to add buttons to the footer of this panel. </div>
208
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#buttons" href="output/Ext.Panel.html#buttons">Panel</a></td>
210
<tr class="config-row inherited alt expandable">
211
<td class="micon"><a class="exi" href="#expand"> </a></td>
213
<a id="Ext.tree.TreePanel-clearCls"></a>
214
<b>clearCls</b> : String <div class="mdesc">
215
<div class="short">The CSS class used to provide field clearing (defaults to 'x-form-clear-left'). This config is only used when this Co...</div>
217
The CSS class used to provide field clearing (defaults to 'x-form-clear-left'). <p><b>This config is only used when this Component is rendered by a Container which has been configured to use the <a ext:cls="Ext.form.FormLayout" href="output/Ext.form.FormLayout.html">FormLayout</a> layout manager.</b></p> </div>
220
<td class="msource"><a ext:cls="Ext.Component" ext:member="#clearCls" href="output/Ext.Component.html#clearCls">Component</a></td>
222
<tr class="config-row inherited expandable">
223
<td class="micon"><a class="exi" href="#expand"> </a></td>
225
<a id="Ext.tree.TreePanel-cls"></a>
226
<b>cls</b> : String <div class="mdesc">
227
<div class="short">An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be useful for a...</div>
229
An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be useful for adding customized styles to the component or any of its children using standard CSS rules. </div>
232
<td class="msource"><a ext:cls="Ext.Component" ext:member="#cls" href="output/Ext.Component.html#cls">Component</a></td>
234
<tr class="config-row inherited alt expandable">
235
<td class="micon"><a class="exi" href="#expand"> </a></td>
237
<a id="Ext.tree.TreePanel-collapseFirst"></a>
238
<b>collapseFirst</b> : Boolean <div class="mdesc">
239
<div class="short">True to make sure the collapse/expand toggle button always renders first (to the left of) any other tools in the pane...</div>
241
True to make sure the collapse/expand toggle button always renders first (to the left of) any other tools in the panel's title bar, false to render it last (defaults to true). </div>
244
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#collapseFirst" href="output/Ext.Panel.html#collapseFirst">Panel</a></td>
246
<tr class="config-row inherited">
247
<td class="micon"><a class="exi" href="#expand"> </a></td>
249
<a id="Ext.tree.TreePanel-collapsed"></a>
250
<b>collapsed</b> : Boolean <div class="mdesc">
251
True to render the panel collapsed, false to render it expanded (defaults to false). </div>
253
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#collapsed" href="output/Ext.Panel.html#collapsed">Panel</a></td>
255
<tr class="config-row inherited alt">
256
<td class="micon"><a class="exi" href="#expand"> </a></td>
258
<a id="Ext.tree.TreePanel-collapsedCls"></a>
259
<b>collapsedCls</b> : String <div class="mdesc">
260
A CSS class to add to the panel's element after it has been collapsed (defaults to 'x-panel-collapsed'). </div>
262
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#collapsedCls" href="output/Ext.Panel.html#collapsedCls">Panel</a></td>
264
<tr class="config-row inherited expandable">
265
<td class="micon"><a class="exi" href="#expand"> </a></td>
267
<a id="Ext.tree.TreePanel-collapsible"></a>
268
<b>collapsible</b> : Boolean <div class="mdesc">
269
<div class="short">True to make the panel collapsible and have the expand/collapse toggle button automatically rendered into the header ...</div>
271
True to make the panel collapsible and have the expand/collapse toggle button automatically rendered into the header tool button area, false to keep the panel statically sized with no button (defaults to false). </div>
274
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#collapsible" href="output/Ext.Panel.html#collapsible">Panel</a></td>
276
<tr class="config-row alt">
277
<td class="micon"><a class="exi" href="#expand"> </a></td>
279
<a id="Ext.tree.TreePanel-containerScroll"></a>
280
<b>containerScroll</b> : Boolean <div class="mdesc">
281
true to register this container with ScrollManager </div>
283
<td class="msource">TreePanel</td>
285
<tr class="config-row inherited expandable">
286
<td class="micon"><a class="exi" href="#expand"> </a></td>
288
<a id="Ext.tree.TreePanel-ctCls"></a>
289
<b>ctCls</b> : String <div class="mdesc">
290
<div class="short">An optional extra CSS class that will be added to this component's container (defaults to ''). This can be useful for...</div>
292
An optional extra CSS class that will be added to this component's container (defaults to ''). This can be useful for adding customized styles to the container or any of its children using standard CSS rules. </div>
295
<td class="msource"><a ext:cls="Ext.Component" ext:member="#ctCls" href="output/Ext.Component.html#ctCls">Component</a></td>
297
<tr class="config-row alt">
298
<td class="micon"><a class="exi" href="#expand"> </a></td>
300
<a id="Ext.tree.TreePanel-ddAppendOnly"></a>
301
<b>ddAppendOnly</b> : String <div class="mdesc">
302
True if the tree should only allow append drops (use for trees which are sorted) </div>
304
<td class="msource">TreePanel</td>
306
<tr class="config-row">
307
<td class="micon"><a class="exi" href="#expand"> </a></td>
309
<a id="Ext.tree.TreePanel-ddGroup"></a>
310
<b>ddGroup</b> : String <div class="mdesc">
311
The DD group this TreePanel belongs to </div>
313
<td class="msource">TreePanel</td>
315
<tr class="config-row alt">
316
<td class="micon"><a class="exi" href="#expand"> </a></td>
318
<a id="Ext.tree.TreePanel-ddScroll"></a>
319
<b>ddScroll</b> : Boolean <div class="mdesc">
320
true to enable body scrolling </div>
322
<td class="msource">TreePanel</td>
324
<tr class="config-row inherited">
325
<td class="micon"><a class="exi" href="#expand"> </a></td>
327
<a id="Ext.tree.TreePanel-disabled"></a>
328
<b>disabled</b> : Boolean <div class="mdesc">
329
Render this component disabled (default is false). </div>
331
<td class="msource"><a ext:cls="Ext.Component" ext:member="#disabled" href="output/Ext.Component.html#disabled">Component</a></td>
333
<tr class="config-row alt">
334
<td class="micon"><a class="exi" href="#expand"> </a></td>
336
<a id="Ext.tree.TreePanel-dragConfig"></a>
337
<b>dragConfig</b> : Object <div class="mdesc">
338
Custom config to pass to the <a ext:cls="Ext.tree.TreeDragZone" href="output/Ext.tree.TreeDragZone.html">Ext.tree.TreeDragZone</a> instance </div>
340
<td class="msource">TreePanel</td>
342
<tr class="config-row inherited expandable">
343
<td class="micon"><a class="exi" href="#expand"> </a></td>
345
<a id="Ext.tree.TreePanel-draggable"></a>
346
<b>draggable</b> : Boolean <div class="mdesc">
347
<div class="short">True to enable dragging of this Panel (defaults to false). For custom drag/drop implementations, an Ext.Panel.DD conf...</div>
349
<p>True to enable dragging of this Panel (defaults to false).</p> <p>For custom drag/drop implementations, an Ext.Panel.DD config could also be passed in this config instead of true. Ext.Panel.DD is an internal, undocumented class which moves a proxy Element around in place of the Panel's element, but provides no other behaviour during dragging or on drop. It is a subclass of <a ext:cls="Ext.dd.DragSource" href="output/Ext.dd.DragSource.html">Ext.dd.DragSource</a>, so behaviour may be added by implementing the interface methods of <a ext:cls="Ext.dd.DragDrop" href="output/Ext.dd.DragDrop.html">Ext.dd.DragDrop</a> eg: <pre><code>new Ext.Panel({
350
title: <em>'Drag me'</em>,
353
renderTo: Ext.getBody(),
359
<i>// Config option of Ext.Panel.DD class.</i>
360
<i>// It's a floating Panel, so <b>do</b> not show a placeholder proxy <b>in</b> the original position.</i>
363
<i>// Called <b>for</b> each mousemove event <b>while</b> dragging the DD object.</i>
364
onDrag : <b>function</b>(e){
365
<i>// Record the x,y position of the drag proxy so that we can</i>
366
<i>// position the Panel at end of drag.</i>
367
<b>var</b> pel = <b>this</b>.proxy.getEl();
368
<b>this</b>.x = pel.getLeft(true);
369
<b>this</b>.y = pel.getTop(true);
371
<i>// Keep the Shadow aligned <b>if</b> there is one.</i>
372
<b>var</b> s = <b>this</b>.panel.getEl().shadow;
374
s.realign(<b>this</b>.x, <b>this</b>.y, pel.getWidth(), pel.getHeight());
378
<i>// Called on the mouseup event.</i>
379
endDrag : <b>function</b>(e){
380
<b>this</b>.panel.setPosition(<b>this</b>.x, <b>this</b>.y);
383
}).show();</code></pre> </div>
386
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#draggable" href="output/Ext.Panel.html#draggable">Panel</a></td>
388
<tr class="config-row alt">
389
<td class="micon"><a class="exi" href="#expand"> </a></td>
391
<a id="Ext.tree.TreePanel-dropConfig"></a>
392
<b>dropConfig</b> : Object <div class="mdesc">
393
Custom config to pass to the <a ext:cls="Ext.tree.TreeDropZone" href="output/Ext.tree.TreeDropZone.html">Ext.tree.TreeDropZone</a> instance </div>
395
<td class="msource">TreePanel</td>
397
<tr class="config-row">
398
<td class="micon"><a class="exi" href="#expand"> </a></td>
400
<a id="Ext.tree.TreePanel-enableDD"></a>
401
<b>enableDD</b> : Boolean <div class="mdesc">
402
true to enable drag and drop </div>
404
<td class="msource">TreePanel</td>
406
<tr class="config-row alt">
407
<td class="micon"><a class="exi" href="#expand"> </a></td>
409
<a id="Ext.tree.TreePanel-enableDrag"></a>
410
<b>enableDrag</b> : Boolean <div class="mdesc">
411
true to enable just drag </div>
413
<td class="msource">TreePanel</td>
415
<tr class="config-row">
416
<td class="micon"><a class="exi" href="#expand"> </a></td>
418
<a id="Ext.tree.TreePanel-enableDrop"></a>
419
<b>enableDrop</b> : Boolean <div class="mdesc">
420
true to enable just drop </div>
422
<td class="msource">TreePanel</td>
424
<tr class="config-row inherited alt expandable">
425
<td class="micon"><a class="exi" href="#expand"> </a></td>
427
<a id="Ext.tree.TreePanel-fieldLabel"></a>
428
<b>fieldLabel</b> : String <div class="mdesc">
429
<div class="short">The label text to display next to this Component (defaults to '') This config is only used when this Component is ren...</div>
431
The label text to display next to this Component (defaults to '') <p><b>This config is only used when this Component is rendered by a Container which has been configured to use the <a ext:cls="Ext.form.FormLayout" href="output/Ext.form.FormLayout.html">FormLayout</a> layout manager.</b></p> Example use:<pre><code>new Ext.FormPanel({
433
renderTo: Ext.getBody(),
435
xtype: <em>'textfield'</em>,
436
fieldLabel: <em>'Name'</em>
438
});</code></pre> </div>
441
<td class="msource"><a ext:cls="Ext.Component" ext:member="#fieldLabel" href="output/Ext.Component.html#fieldLabel">Component</a></td>
443
<tr class="config-row inherited expandable">
444
<td class="micon"><a class="exi" href="#expand"> </a></td>
446
<a id="Ext.tree.TreePanel-floating"></a>
447
<b>floating</b> : Boolean <div class="mdesc">
448
<div class="short">True to float this Panel (absolute position it with automatic shimming and shadow), false to display it inline where ...</div>
450
<p>True to float this Panel (absolute position it with automatic shimming and shadow), false to display it inline where it is rendered (defaults to false).</p> <p>Setting floating to true will create an <a ext:cls="Ext.Layer" href="output/Ext.Layer.html">Ext.Layer</a> encapsulating this Panel's Element and display the Panel at negative offsets so that it is hidden. The position must be set explicitly after render (e.g., myPanel.setPosition(100,100);).</p> <p>When floating a panel you should always assign a fixed width, otherwise it will be auto width and will expand to fill to the right edge of the viewport.</p> <p>This property may also be specified as an object to be used as the configuration object for the <a ext:cls="Ext.Layer" href="output/Ext.Layer.html">Ext.Layer</a> that will be created. </div>
453
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#floating" href="output/Ext.Panel.html#floating">Panel</a></td>
455
<tr class="config-row inherited alt expandable">
456
<td class="micon"><a class="exi" href="#expand"> </a></td>
458
<a id="Ext.tree.TreePanel-footer"></a>
459
<b>footer</b> : Boolean <div class="mdesc">
460
<div class="short">True to create the footer element explicitly, false to skip creating it. By default, when footer is not specified, if...</div>
462
True to create the footer element explicitly, false to skip creating it. By default, when footer is not specified, if one or more buttons have been added to the panel the footer will be created automatically, otherwise it will not. </div>
465
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#footer" href="output/Ext.Panel.html#footer">Panel</a></td>
467
<tr class="config-row inherited">
468
<td class="micon"><a class="exi" href="#expand"> </a></td>
470
<a id="Ext.tree.TreePanel-footerCfg"></a>
471
<b>footerCfg</b> : Object <div class="mdesc">
472
<p>A <a ext:cls="Ext.DomHelper" href="output/Ext.DomHelper.html">DomHelper</a> configuration object specifying the element structure of this Panel's <a ext:cls="Ext.Panel" ext:member="footer" href="output/Ext.Panel.html#footer">footer</a> Element.</p> </div>
474
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#footerCfg" href="output/Ext.Panel.html#footerCfg">Panel</a></td>
476
<tr class="config-row inherited alt">
477
<td class="micon"><a class="exi" href="#expand"> </a></td>
479
<a id="Ext.tree.TreePanel-frame"></a>
480
<b>frame</b> : Boolean <div class="mdesc">
481
True to render the panel with custom rounded borders, false to render with plain 1px square borders (defaults to false). </div>
483
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#frame" href="output/Ext.Panel.html#frame">Panel</a></td>
485
<tr class="config-row inherited expandable">
486
<td class="micon"><a class="exi" href="#expand"> </a></td>
488
<a id="Ext.tree.TreePanel-header"></a>
489
<b>header</b> : Boolean <div class="mdesc">
490
<div class="short">True to create the Panel's header element explicitly, false to skip creating it. By default, when header is not speci...</div>
492
True to create the Panel's header element explicitly, false to skip creating it. By default, when header is not specified, if a <a ext:cls="Ext.Panel" ext:member="title" href="output/Ext.Panel.html#title">title</a> is set the header will be created automatically, otherwise it will not. If a title is set but header is explicitly set to false, the header will not be rendered. </div>
495
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#header" href="output/Ext.Panel.html#header">Panel</a></td>
497
<tr class="config-row inherited alt">
498
<td class="micon"><a class="exi" href="#expand"> </a></td>
500
<a id="Ext.tree.TreePanel-headerAsText"></a>
501
<b>headerAsText</b> : Boolean <div class="mdesc">
502
True to display the panel title in the header, false to hide it (defaults to true). </div>
504
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#headerAsText" href="output/Ext.Panel.html#headerAsText">Panel</a></td>
506
<tr class="config-row inherited">
507
<td class="micon"><a class="exi" href="#expand"> </a></td>
509
<a id="Ext.tree.TreePanel-headerCfg"></a>
510
<b>headerCfg</b> : Object <div class="mdesc">
511
<p>A <a ext:cls="Ext.DomHelper" href="output/Ext.DomHelper.html">DomHelper</a> configuration object specifying the element structure of this Panel's <a ext:cls="Ext.Panel" ext:member="header" href="output/Ext.Panel.html#header">header</a> Element.</p> </div>
513
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#headerCfg" href="output/Ext.Panel.html#headerCfg">Panel</a></td>
515
<tr class="config-row inherited alt">
516
<td class="micon"><a class="exi" href="#expand"> </a></td>
518
<a id="Ext.tree.TreePanel-height"></a>
519
<b>height</b> : Number <div class="mdesc">
520
The height of this component in pixels (defaults to auto). </div>
522
<td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#height" href="output/Ext.BoxComponent.html#height">BoxComponent</a></td>
524
<tr class="config-row inherited">
525
<td class="micon"><a class="exi" href="#expand"> </a></td>
527
<a id="Ext.tree.TreePanel-hidden"></a>
528
<b>hidden</b> : Boolean <div class="mdesc">
529
Render this component hidden (default is false). </div>
531
<td class="msource"><a ext:cls="Ext.Component" ext:member="#hidden" href="output/Ext.Component.html#hidden">Component</a></td>
533
<tr class="config-row inherited alt">
534
<td class="micon"><a class="exi" href="#expand"> </a></td>
536
<a id="Ext.tree.TreePanel-hideCollapseTool"></a>
537
<b>hideCollapseTool</b> : Boolean <div class="mdesc">
538
True to hide the expand/collapse toggle button when <a ext:cls="Ext.Panel" ext:member="collapsible" href="output/Ext.Panel.html#collapsible">collapsible</a> = true, false to display it (defaults to false). </div>
540
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#hideCollapseTool" href="output/Ext.Panel.html#hideCollapseTool">Panel</a></td>
542
<tr class="config-row inherited expandable">
543
<td class="micon"><a class="exi" href="#expand"> </a></td>
545
<a id="Ext.tree.TreePanel-hideLabel"></a>
546
<b>hideLabel</b> : Boolean <div class="mdesc">
547
<div class="short">True to completely hide the label element (defaults to false). By default, even if you do not specify a fieldLabel th...</div>
549
True to completely hide the label element (defaults to false). By default, even if you do not specify a <a ext:cls="fieldLabel" href="output/fieldLabel.html">fieldLabel</a> the space will still be reserved so that the field will line up with other fields that do have labels. Setting this to true will cause the field to not reserve that space. <p><b>This config is only used when this Component is rendered by a Container which has been configured to use the <a ext:cls="Ext.form.FormLayout" href="output/Ext.form.FormLayout.html">FormLayout</a> layout manager.</b></p> Example use:<pre><code>new Ext.FormPanel({
551
renderTo: Ext.getBody(),
553
xtype: <em>'textfield'</em>
556
});</code></pre> </div>
559
<td class="msource"><a ext:cls="Ext.Component" ext:member="#hideLabel" href="output/Ext.Component.html#hideLabel">Component</a></td>
561
<tr class="config-row inherited alt expandable">
562
<td class="micon"><a class="exi" href="#expand"> </a></td>
564
<a id="Ext.tree.TreePanel-hideMode"></a>
565
<b>hideMode</b> : String <div class="mdesc">
566
<div class="short">How this component should be hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset p...</div>
568
<p>How this component should be hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset position) and "display" (css display) - defaults to "display".</p> <p>For Containers which may be hidden and shown as part of a <a ext:cls="Ext.layout.CardLayout" href="output/Ext.layout.CardLayout.html">card layout</a> Container such as a <a ext:cls="Ext.TabPanel" href="output/Ext.TabPanel.html">TabPanel</a>, it is recommended that hideMode is configured as "offsets". This ensures that hidden Components still have height and width so that layout managers can perform measurements when calculating layouts.</p> </div>
571
<td class="msource"><a ext:cls="Ext.Component" ext:member="#hideMode" href="output/Ext.Component.html#hideMode">Component</a></td>
573
<tr class="config-row inherited expandable">
574
<td class="micon"><a class="exi" href="#expand"> </a></td>
576
<a id="Ext.tree.TreePanel-hideParent"></a>
577
<b>hideParent</b> : Boolean <div class="mdesc">
578
<div class="short">True to hide and show the component's container when hide/show is called on the component, false to hide and show the...</div>
580
True to hide and show the component's container when hide/show is called on the component, false to hide and show the component itself (defaults to false). For example, this can be used as a shortcut for a hide button on a window by setting hide:true on the button when adding it to its parent container. </div>
583
<td class="msource"><a ext:cls="Ext.Component" ext:member="#hideParent" href="output/Ext.Component.html#hideParent">Component</a></td>
585
<tr class="config-row alt">
586
<td class="micon"><a class="exi" href="#expand"> </a></td>
588
<a id="Ext.tree.TreePanel-hlColor"></a>
589
<b>hlColor</b> : String <div class="mdesc">
590
The color of the node highlight (defaults to C3DAF9) </div>
592
<td class="msource">TreePanel</td>
594
<tr class="config-row">
595
<td class="micon"><a class="exi" href="#expand"> </a></td>
597
<a id="Ext.tree.TreePanel-hlDrop"></a>
598
<b>hlDrop</b> : Boolean <div class="mdesc">
599
false to disable node highlight on drop (defaults to the value of Ext.enableFx) </div>
601
<td class="msource">TreePanel</td>
603
<tr class="config-row inherited alt expandable">
604
<td class="micon"><a class="exi" href="#expand"> </a></td>
606
<a id="Ext.tree.TreePanel-iconCls"></a>
607
<b>iconCls</b> : String <div class="mdesc">
608
<div class="short">A CSS class that will provide a background image to be used as the header icon (defaults to ''). An example custom ic...</div>
610
A CSS class that will provide a background image to be used as the header icon (defaults to ''). An example custom icon class would be something like: .my-icon { background: url(../images/my-icon.gif) 0 6px no-repeat !important;} </div>
613
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#iconCls" href="output/Ext.Panel.html#iconCls">Panel</a></td>
615
<tr class="config-row inherited expandable">
616
<td class="micon"><a class="exi" href="#expand"> </a></td>
618
<a id="Ext.tree.TreePanel-id"></a>
619
<b>id</b> : String <div class="mdesc">
620
<div class="short">The unique id of this component (defaults to an auto-assigned id). You should assign an id if you need to be able to ...</div>
622
The unique id of this component (defaults to an auto-assigned id). You should assign an id if you need to be able to access the component later and you do not have an object reference available (e.g., using <a ext:cls="Ext.ComponentMgr" ext:member="getCmp" href="output/Ext.ComponentMgr.html#getCmp">Ext.ComponentMgr.getCmp</a>). Note that this id will also be used as the element id for the containing HTML element that is rendered to the page for this component. This allows you to write id-based CSS rules to style the specific instance of this component uniquely, and also to select sub-elements using this component's id as the parent. </div>
625
<td class="msource"><a ext:cls="Ext.Component" ext:member="#id" href="output/Ext.Component.html#id">Component</a></td>
627
<tr class="config-row inherited alt expandable">
628
<td class="micon"><a class="exi" href="#expand"> </a></td>
630
<a id="Ext.tree.TreePanel-itemCls"></a>
631
<b>itemCls</b> : String <div class="mdesc">
632
<div class="short">An additional CSS class to apply to the wrapper's form item element of this field (defaults to the container's itemCl...</div>
634
An additional CSS class to apply to the wrapper's form item element of this field (defaults to the container's itemCls value if set, or ''). Since it is applied to the item wrapper, it allows you to write standard CSS rules that can apply to the field, the label (if specified) or any other element within the markup for the field. <p><b>This config is only used when this Component is rendered by a Container which has been configured to use the <a ext:cls="Ext.form.FormLayout" href="output/Ext.form.FormLayout.html">FormLayout</a> layout manager.</b></p> Example use:<pre><code><i>// Apply a style to the field's label:</i>
636
.required .x-form-item-label {font-weight:bold;color:red;}
639
<b>new</b> Ext.FormPanel({
641
renderTo: Ext.getBody(),
643
xtype: <em>'textfield'</em>,
644
fieldLabel: <em>'Name'</em>,
645
itemCls: <em>'required'</em> <i>//<b>this</b> label will be styled</i>
647
xtype: <em>'textfield'</em>,
648
fieldLabel: <em>'Favorite Color'</em>
650
});</code></pre> </div>
653
<td class="msource"><a ext:cls="Ext.Component" ext:member="#itemCls" href="output/Ext.Component.html#itemCls">Component</a></td>
655
<tr class="config-row inherited expandable">
656
<td class="micon"><a class="exi" href="#expand"> </a></td>
658
<a id="Ext.tree.TreePanel-keys"></a>
659
<b>keys</b> : Object/Array <div class="mdesc">
660
<div class="short">A KeyMap config object (in the format expected by Ext.KeyMap.addBinding used to assign custom key handling to this pa...</div>
662
A KeyMap config object (in the format expected by <a ext:cls="Ext.KeyMap" ext:member="addBinding" href="output/Ext.KeyMap.html#addBinding">Ext.KeyMap.addBinding</a> used to assign custom key handling to this panel (defaults to null). </div>
665
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#keys" href="output/Ext.Panel.html#keys">Panel</a></td>
667
<tr class="config-row inherited alt expandable">
668
<td class="micon"><a class="exi" href="#expand"> </a></td>
670
<a id="Ext.tree.TreePanel-labelSeparator"></a>
671
<b>labelSeparator</b> : String <div class="mdesc">
672
<div class="short">The standard separator to display after the text of each form label (defaults to the value of Ext.layout.FormLayout.l...</div>
674
The standard separator to display after the text of each form label (defaults to the value of <a ext:cls="Ext.layout.FormLayout" ext:member="labelSeparator" href="output/Ext.layout.FormLayout.html#labelSeparator">Ext.layout.FormLayout.labelSeparator</a>, which is a colon ':' by default). To display no separator for this field's label specify empty string ''. <p><b>This config is only used when this Component is rendered by a Container which has been configured to use the <a ext:cls="Ext.form.FormLayout" href="output/Ext.form.FormLayout.html">FormLayout</a> layout manager.</b></p> Example use:<pre><code>new Ext.FormPanel({
676
renderTo: Ext.getBody(),
678
xtype: <em>'textfield'</em>,
679
fieldLabel: <em>'Name'</em>,
680
labelSeparator: <em>'...'</em>
682
});</code></pre> </div>
685
<td class="msource"><a ext:cls="Ext.Component" ext:member="#labelSeparator" href="output/Ext.Component.html#labelSeparator">Component</a></td>
687
<tr class="config-row inherited expandable">
688
<td class="micon"><a class="exi" href="#expand"> </a></td>
690
<a id="Ext.tree.TreePanel-labelStyle"></a>
691
<b>labelStyle</b> : String <div class="mdesc">
692
<div class="short">A CSS style specification to apply directly to this field's label (defaults to the container's labelStyle value if se...</div>
694
A CSS style specification to apply directly to this field's label (defaults to the container's labelStyle value if set, or '').<code></code>. <p><b>This config is only used when this Component is rendered by a Container which has been configured to use the <a ext:cls="Ext.form.FormLayout" href="output/Ext.form.FormLayout.html">FormLayout</a> layout manager.</b></p> Example use:<pre><code>new Ext.FormPanel({
696
renderTo: Ext.getBody(),
698
xtype: <em>'textfield'</em>,
699
fieldLabel: <em>'Name'</em>,
700
labelStyle: <em>'font-weight:bold;'</em>
702
});</code></pre> </div>
705
<td class="msource"><a ext:cls="Ext.Component" ext:member="#labelStyle" href="output/Ext.Component.html#labelStyle">Component</a></td>
707
<tr class="config-row alt">
708
<td class="micon"><a class="exi" href="#expand"> </a></td>
710
<a id="Ext.tree.TreePanel-lines"></a>
711
<b>lines</b> : Boolean <div class="mdesc">
712
false to disable tree lines (defaults to true) </div>
714
<td class="msource">TreePanel</td>
716
<tr class="config-row inherited expandable">
717
<td class="micon"><a class="exi" href="#expand"> </a></td>
719
<a id="Ext.tree.TreePanel-listeners"></a>
720
<b>listeners</b> : Object <div class="mdesc">
721
<div class="short">(optional) A config object containing one or more event handlers to be added to this object during initialization. Th...</div>
723
(optional) A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the <a ext:cls="Ext.util.Observable" ext:member="addListener" href="output/Ext.util.Observable.html#addListener">addListener</a> example for attaching multiple handlers at once. </div>
726
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td>
728
<tr class="config-row alt">
729
<td class="micon"><a class="exi" href="#expand"> </a></td>
731
<a id="Ext.tree.TreePanel-loader"></a>
732
<b>loader</b> : Ext.tree.TreeLoader <div class="mdesc">
733
A <a ext:cls="Ext.tree.TreeLoader" href="output/Ext.tree.TreeLoader.html">Ext.tree.TreeLoader</a> for use with this TreePanel </div>
735
<td class="msource">TreePanel</td>
737
<tr class="config-row inherited expandable">
738
<td class="micon"><a class="exi" href="#expand"> </a></td>
740
<a id="Ext.tree.TreePanel-maskDisabled"></a>
741
<b>maskDisabled</b> : Boolean <div class="mdesc">
742
<div class="short">True to mask the panel when it is disabled, false to not mask it (defaults to true). Either way, the panel will alway...</div>
744
True to mask the panel when it is disabled, false to not mask it (defaults to true). Either way, the panel will always tell its contained elements to disable themselves when it is disabled, but masking the panel can provide an additional visual cue that the panel is disabled. </div>
747
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#maskDisabled" href="output/Ext.Panel.html#maskDisabled">Panel</a></td>
749
<tr class="config-row inherited alt">
750
<td class="micon"><a class="exi" href="#expand"> </a></td>
752
<a id="Ext.tree.TreePanel-minButtonWidth"></a>
753
<b>minButtonWidth</b> : Number <div class="mdesc">
754
Minimum width in pixels of all buttons in this panel (defaults to 75) </div>
756
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#minButtonWidth" href="output/Ext.Panel.html#minButtonWidth">Panel</a></td>
758
<tr class="config-row inherited expandable">
759
<td class="micon"><a class="exi" href="#expand"> </a></td>
761
<a id="Ext.tree.TreePanel-overCls"></a>
762
<b>overCls</b> : String <div class="mdesc">
763
<div class="short">An optional extra CSS class that will be added to this component's Element when the mouse moves over the Element, and...</div>
765
An optional extra CSS class that will be added to this component's Element when the mouse moves over the Element, and removed when the mouse moves out. (defaults to ''). This can be useful for adding customized "active" or "hover" styles to the component or any of its children using standard CSS rules. </div>
768
<td class="msource"><a ext:cls="Ext.Component" ext:member="#overCls" href="output/Ext.Component.html#overCls">Component</a></td>
770
<tr class="config-row inherited alt">
771
<td class="micon"><a class="exi" href="#expand"> </a></td>
773
<a id="Ext.tree.TreePanel-pageX"></a>
774
<b>pageX</b> : Number <div class="mdesc">
775
The page level x coordinate for this component if contained within a positioning container. </div>
777
<td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#pageX" href="output/Ext.BoxComponent.html#pageX">BoxComponent</a></td>
779
<tr class="config-row inherited">
780
<td class="micon"><a class="exi" href="#expand"> </a></td>
782
<a id="Ext.tree.TreePanel-pageY"></a>
783
<b>pageY</b> : Number <div class="mdesc">
784
The page level y coordinate for this component if contained within a positioning container. </div>
786
<td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#pageY" href="output/Ext.BoxComponent.html#pageY">BoxComponent</a></td>
788
<tr class="config-row alt">
789
<td class="micon"><a class="exi" href="#expand"> </a></td>
791
<a id="Ext.tree.TreePanel-pathSeparator"></a>
792
<b>pathSeparator</b> : String <div class="mdesc">
793
The token used to separate sub-paths in path strings (defaults to '/') </div>
795
<td class="msource">TreePanel</td>
797
<tr class="config-row inherited expandable">
798
<td class="micon"><a class="exi" href="#expand"> </a></td>
800
<a id="Ext.tree.TreePanel-plugins"></a>
801
<b>plugins</b> : Object/Array <div class="mdesc">
802
<div class="short">An object or array of objects that will provide custom functionality for this component. The only requirement for a v...</div>
804
An object or array of objects that will provide custom functionality for this component. The only requirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.Component. When a component is created, if any plugins are available, the component will call the init method on each plugin, passing a reference to itself. Each plugin can then call methods or respond to events on the component as needed to provide its functionality. </div>
807
<td class="msource"><a ext:cls="Ext.Component" ext:member="#plugins" href="output/Ext.Component.html#plugins">Component</a></td>
809
<tr class="config-row inherited alt expandable">
810
<td class="micon"><a class="exi" href="#expand"> </a></td>
812
<a id="Ext.tree.TreePanel-renderTo"></a>
813
<b>renderTo</b> : Mixed <div class="mdesc">
814
<div class="short">The id of the element, a DOM element or an existing Element that this component will be rendered into. When using thi...</div>
816
<p>The id of the element, a DOM element or an existing Element that this component will be rendered into. When using this config, a call to render() is not required.<p> <p>If this Component needs to be managed by a <a ext:cls="Ext.Container" href="output/Ext.Container.html">Container</a>'s <a ext:cls="Ext.Component" ext:member="layout" href="output/Ext.Component.html#layout">layout manager</a>, do not use this option. It is the responsiblity of the Container's layout manager to perform rendering. See <a ext:cls="Ext.Component" ext:member="render" href="output/Ext.Component.html#render">render</a>.</p> </div>
819
<td class="msource"><a ext:cls="Ext.Component" ext:member="#renderTo" href="output/Ext.Component.html#renderTo">Component</a></td>
821
<tr class="config-row">
822
<td class="micon"><a class="exi" href="#expand"> </a></td>
824
<a id="Ext.tree.TreePanel-root"></a>
825
<b>root</b> : Ext.tree.TreeNode <div class="mdesc">
826
The root node for the tree. </div>
828
<td class="msource">TreePanel</td>
830
<tr class="config-row alt">
831
<td class="micon"><a class="exi" href="#expand"> </a></td>
833
<a id="Ext.tree.TreePanel-rootVisible"></a>
834
<b>rootVisible</b> : Boolean <div class="mdesc">
835
false to hide the root node (defaults to true) </div>
837
<td class="msource">TreePanel</td>
839
<tr class="config-row">
840
<td class="micon"><a class="exi" href="#expand"> </a></td>
842
<a id="Ext.tree.TreePanel-selModel"></a>
843
<b>selModel</b> : Object <div class="mdesc">
844
A tree selection model to use with this TreePanel (defaults to a <a ext:cls="Ext.tree.DefaultSelectionModel" href="output/Ext.tree.DefaultSelectionModel.html">Ext.tree.DefaultSelectionModel</a>) </div>
846
<td class="msource">TreePanel</td>
848
<tr class="config-row inherited alt expandable">
849
<td class="micon"><a class="exi" href="#expand"> </a></td>
851
<a id="Ext.tree.TreePanel-shadow"></a>
852
<b>shadow</b> : Boolean/String <div class="mdesc">
853
<div class="short">True (or a valid Ext.Shadow Ext.Shadow.mode value) to display a shadow behind the panel, false to display no shadow (...</div>
855
True (or a valid Ext.Shadow <a ext:cls="Ext.Shadow" ext:member="mode" href="output/Ext.Shadow.html#mode">Ext.Shadow.mode</a> value) to display a shadow behind the panel, false to display no shadow (defaults to 'sides'). Note that this option only applies when floating = true. </div>
858
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#shadow" href="output/Ext.Panel.html#shadow">Panel</a></td>
860
<tr class="config-row inherited expandable">
861
<td class="micon"><a class="exi" href="#expand"> </a></td>
863
<a id="Ext.tree.TreePanel-shadowOffset"></a>
864
<b>shadowOffset</b> : Number <div class="mdesc">
865
<div class="short">The number of pixels to offset the shadow if displayed (defaults to 4). Note that this option only applies when float...</div>
867
The number of pixels to offset the shadow if displayed (defaults to 4). Note that this option only applies when floating = true. </div>
870
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#shadowOffset" href="output/Ext.Panel.html#shadowOffset">Panel</a></td>
872
<tr class="config-row inherited alt expandable">
873
<td class="micon"><a class="exi" href="#expand"> </a></td>
875
<a id="Ext.tree.TreePanel-shim"></a>
876
<b>shim</b> : Boolean <div class="mdesc">
877
<div class="short">False to disable the iframe shim in browsers which need one (defaults to true). Note that this option only applies wh...</div>
879
False to disable the iframe shim in browsers which need one (defaults to true). Note that this option only applies when floating = true. </div>
882
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#shim" href="output/Ext.Panel.html#shim">Panel</a></td>
884
<tr class="config-row">
885
<td class="micon"><a class="exi" href="#expand"> </a></td>
887
<a id="Ext.tree.TreePanel-singleExpand"></a>
888
<b>singleExpand</b> : Boolean <div class="mdesc">
889
true if only 1 node per branch may be expanded </div>
891
<td class="msource">TreePanel</td>
893
<tr class="config-row inherited alt expandable">
894
<td class="micon"><a class="exi" href="#expand"> </a></td>
896
<a id="Ext.tree.TreePanel-stateEvents"></a>
897
<b>stateEvents</b> : Array <div class="mdesc">
898
<div class="short">An array of events that, when fired, should trigger this component to save its state (defaults to none). These can be...</div>
900
An array of events that, when fired, should trigger this component to save its state (defaults to none). These can be any types of events supported by this component, including browser or custom events (e.g., ['click', 'customerchange']). <p>See <a ext:cls="Ext.Component" ext:member="stateful" href="output/Ext.Component.html#stateful">stateful</a> for an explanation of saving and restoring Component state.</p> </div>
903
<td class="msource"><a ext:cls="Ext.Component" ext:member="#stateEvents" href="output/Ext.Component.html#stateEvents">Component</a></td>
905
<tr class="config-row inherited expandable">
906
<td class="micon"><a class="exi" href="#expand"> </a></td>
908
<a id="Ext.tree.TreePanel-stateId"></a>
909
<b>stateId</b> : String <div class="mdesc">
910
<div class="short">The unique id for this component to use for state management purposes (defaults to the component id if one was set, o...</div>
912
The unique id for this component to use for state management purposes (defaults to the component id if one was set, otherwise null if the component is using a generated id). <p>See <a ext:cls="Ext.Component" ext:member="stateful" href="output/Ext.Component.html#stateful">stateful</a> for an explanation of saving and restoring Component state.</p> </div>
915
<td class="msource"><a ext:cls="Ext.Component" ext:member="#stateId" href="output/Ext.Component.html#stateId">Component</a></td>
917
<tr class="config-row inherited alt expandable">
918
<td class="micon"><a class="exi" href="#expand"> </a></td>
920
<a id="Ext.tree.TreePanel-stateful"></a>
921
<b>stateful</b> : Boolean <div class="mdesc">
922
<div class="short">A flag which causes the Component to attempt to restore the state of internal properties from a saved state on startu...</div>
924
<p>A flag which causes the Component to attempt to restore the state of internal properties from a saved state on startup. The component must have either a <a ext:cls="Ext.Component" ext:member="stateId" href="output/Ext.Component.html#stateId">stateId</a> or <a ext:cls="Ext.Component" ext:member="id" href="output/Ext.Component.html#id">id</a> assigned for state to be managed. Auto-generated ids are not guaranteed to be stable across page loads and cannot be relied upon to save and restore the same state for a component.<p> For state saving to work, the state manager's provider must have been set to an implementation of <a ext:cls="Ext.state.Provider" href="output/Ext.state.Provider.html">Ext.state.Provider</a> which overrides the <a ext:cls="Ext.state.Provider" ext:member="set" href="output/Ext.state.Provider.html#set">set</a> and <a ext:cls="Ext.state.Provider" ext:member="get" href="output/Ext.state.Provider.html#get">get</a> methods to save and recall name/value pairs. A built-in implementation, <a ext:cls="Ext.state.CookieProvider" href="output/Ext.state.CookieProvider.html">Ext.state.CookieProvider</a> is available.</p> <p>To set the state provider for the current page:</p> <pre><code>Ext.state.Manager.setProvider(<b>new</b> Ext.state.CookieProvider());</code></pre> <p>Components attempt to save state when one of the events listed in the <a ext:cls="Ext.Component" ext:member="stateEvents" href="output/Ext.Component.html#stateEvents">stateEvents</a> configuration fires.</p> <p>You can perform extra processing on state save and restore by attaching handlers to the <a ext:cls="Ext.Component" ext:member="beforestaterestore" href="output/Ext.Component.html#beforestaterestore">beforestaterestore</a>, <a ext:cls="Ext.Component" ext:member="staterestore" href="output/Ext.Component.html#staterestore">staterestore</a>, <a ext:cls="Ext.Component" ext:member="beforestatesave" href="output/Ext.Component.html#beforestatesave">beforestatesave</a> and <a ext:cls="Ext.Component" ext:member="statesave" href="output/Ext.Component.html#statesave">statesave</a> events</p> </div>
927
<td class="msource"><a ext:cls="Ext.Component" ext:member="#stateful" href="output/Ext.Component.html#stateful">Component</a></td>
929
<tr class="config-row inherited expandable">
930
<td class="micon"><a class="exi" href="#expand"> </a></td>
932
<a id="Ext.tree.TreePanel-style"></a>
933
<b>style</b> : String <div class="mdesc">
934
<div class="short">A custom style specification to be applied to this component's Element. Should be a valid argument to Ext.Element.app...</div>
936
A custom style specification to be applied to this component's Element. Should be a valid argument to <a ext:cls="Ext.Element" ext:member="applyStyles" href="output/Ext.Element.html#applyStyles">Ext.Element.applyStyles</a>. </div>
939
<td class="msource"><a ext:cls="Ext.Component" ext:member="#style" href="output/Ext.Component.html#style">Component</a></td>
941
<tr class="config-row inherited alt expandable">
942
<td class="micon"><a class="exi" href="#expand"> </a></td>
944
<a id="Ext.tree.TreePanel-tabTip"></a>
945
<b>tabTip</b> : String <div class="mdesc">
946
<div class="short">Adds a tooltip when mousing over the tab of a Ext.Panel which is an item of a Ext.TabPanel. Ext.QuickTips.init() must...</div>
948
Adds a tooltip when mousing over the tab of a Ext.Panel which is an item of a Ext.TabPanel. Ext.QuickTips.init() must be called in order for the tips to render. </div>
951
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#tabTip" href="output/Ext.Panel.html#tabTip">Panel</a></td>
953
<tr class="config-row inherited expandable">
954
<td class="micon"><a class="exi" href="#expand"> </a></td>
956
<a id="Ext.tree.TreePanel-tbar"></a>
957
<b>tbar</b> : Object/Array <div class="mdesc">
958
<div class="short">The top toolbar of the panel. This can be either an Ext.Toolbar object or an array of buttons/button configs to be ad...</div>
960
<p>The top toolbar of the panel. This can be either an <a ext:cls="Ext.Toolbar" href="output/Ext.Toolbar.html">Ext.Toolbar</a> object or an array of buttons/button configs to be added to the toolbar. Note that this is not available as a property after render. To access the top toolbar after render, use <a ext:cls="Ext.Panel" ext:member="getTopToolbar" href="output/Ext.Panel.html#getTopToolbar">getTopToolbar</a>.</p> <p><b>Note:</b> Although a Toolbar may contain Field components, these will <b>not<b> be updated by a load of an ancestor FormPanel. A Panel's toolbars are not part of the standard Container->Component hierarchy, and so are not scanned to collect form items. Hoverver, the values <b>will</b> be submitted because form submission parameters are collected from the DOM tree.</p> </div>
963
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#tbar" href="output/Ext.Panel.html#tbar">Panel</a></td>
965
<tr class="config-row inherited alt expandable">
966
<td class="micon"><a class="exi" href="#expand"> </a></td>
968
<a id="Ext.tree.TreePanel-title"></a>
969
<b>title</b> : String <div class="mdesc">
970
<div class="short">The title text to display in the panel header (defaults to ''). When a title is specified the header element will aut...</div>
972
The title text to display in the panel header (defaults to ''). When a title is specified the header element will automatically be created and displayed unless <a ext:cls="Ext.Panel" ext:member="header" href="output/Ext.Panel.html#header">header</a> is explicitly set to false. If you don't want to specify a title at config time, but you may want one later, you must either specify a non-empty title (a blank space ' ' will do) or header:true so that the container element will get created. </div>
975
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#title" href="output/Ext.Panel.html#title">Panel</a></td>
977
<tr class="config-row inherited expandable">
978
<td class="micon"><a class="exi" href="#expand"> </a></td>
980
<a id="Ext.tree.TreePanel-titleCollapse"></a>
981
<b>titleCollapse</b> : Boolean <div class="mdesc">
982
<div class="short">True to allow expanding and collapsing the panel (when collapsible = true) by clicking anywhere in the header bar, fa...</div>
984
True to allow expanding and collapsing the panel (when <a ext:cls="Ext.Panel" ext:member="collapsible" href="output/Ext.Panel.html#collapsible">collapsible</a> = true) by clicking anywhere in the header bar, false to allow it only by clicking to tool button (defaults to false). </div>
987
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#titleCollapse" href="output/Ext.Panel.html#titleCollapse">Panel</a></td>
989
<tr class="config-row inherited alt">
990
<td class="micon"><a class="exi" href="#expand"> </a></td>
992
<a id="Ext.tree.TreePanel-toolTemplate"></a>
993
<b>toolTemplate</b> : Ext.Template/Ext.XTemplate <div class="mdesc">
996
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#toolTemplate" href="output/Ext.Panel.html#toolTemplate">Panel</a></td>
998
<tr class="config-row inherited expandable">
999
<td class="micon"><a class="exi" href="#expand"> </a></td>
1001
<a id="Ext.tree.TreePanel-tools"></a>
1002
<b>tools</b> : Array <div class="mdesc">
1003
<div class="short">An array of tool button configs to be added to the header tool area. When rendered, each tool is stored as an Element...</div>
1005
An array of tool button configs to be added to the header tool area. When rendered, each tool is stored as an <a ext:cls="Ext.Element" href="output/Ext.Element.html">Element</a> referenced by a public property called <tt><b></b>tools.<i><tool-type></i></tt> <p>Each tool config may contain the following properties: <div class="mdetail-params"><ul> <li><b>id</b> : String<div class="sub-desc"><b>Required.</b> The type of tool to create. By default, this assigns a CSS class of the form <tt>x-tool-<i><tool-type></i></tt> to the resulting tool Element. Ext provides CSS rules, and an icon sprite containing images for the tool types listed below. The developer may implement custom tools by supplying alternate CSS rules and background images:<ul> <li><tt>toggle</tt> (Created by default when <a ext:cls="Ext.Panel" ext:member="collapsible" href="output/Ext.Panel.html#collapsible">collapsible</a> is <tt>true</tt>)</li> <li><tt>close</tt></li> <li><tt>minimize</tt></li> <li><tt>maximize</tt></li> <li><tt>restore</tt></li> <li><tt>gear</tt></li> <li><tt>pin</tt></li> <li><tt>unpin</tt></li> <li><tt>right</tt></li> <li><tt>left</tt></li> <li><tt>up</tt></li> <li><tt>down</tt></li> <li><tt>refresh</tt></li> <li><tt>minus</tt></li> <li><tt>plus</tt></li> <li><tt>help</tt></li> <li><tt>search</tt></li> <li><tt>save</tt></li> <li><tt>print</tt></li> </ul></div></li> <li><b>handler</b> : Function<div class="sub-desc"><b>Required.</b> The function to call when clicked. Arguments passed are:<ul> <li><b>event</b> : Ext.EventObject<div class="sub-desc">The click event.</div></li> <li><b>toolEl</b> : Ext.Element<div class="sub-desc">The tool Element.</div></li> <li><b>Panel</b> : Ext.Panel<div class="sub-desc">The host Panel</div></li> </ul></div></li> <li><b>scope</b> : Object<div class="sub-desc">The scope in which to call the handler.</div></li> <li><b>qtip</b> : String/Object<div class="sub-desc">A tip string, or a config argument to <a ext:cls="Ext.QuickTip" ext:member="register" href="output/Ext.QuickTip.html#register">Ext.QuickTip.register</a></div></li> <li><b>hidden</b> : Boolean<div class="sub-desc">True to initially render hidden.</div></li> <li><b>on</b> : Object<div class="sub-desc">A listener config object specifiying event listeners in the format of an argument to <a ext:cls="Ext.Panel" ext:member="addListener" href="output/Ext.Panel.html#addListener">addListener</a></div></li> </ul></div> Example usage: <pre><code>tools:[{
1006
id:<em>'refresh'</em>,
1007
qtip: <em>'Refresh form Data'</em>,
1008
<i>// hidden:true,</i>
1009
handler: <b>function</b>(event, toolEl, panel){
1010
<i>// refresh logic</i>
1012
}]</code></pre> Note that apart from the toggle tool which is provided when a panel is collapsible, these tools only provide the visual button. Any required functionality must be provided by adding handlers that implement the necessary behavior. </div>
1015
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#tools" href="output/Ext.Panel.html#tools">Panel</a></td>
1017
<tr class="config-row alt">
1018
<td class="micon"><a class="exi" href="#expand"> </a></td>
1020
<a id="Ext.tree.TreePanel-trackMouseOver"></a>
1021
<b>trackMouseOver</b> : Boolean <div class="mdesc">
1022
False to disable mouse over highlighting </div>
1024
<td class="msource">TreePanel</td>
1026
<tr class="config-row">
1027
<td class="micon"><a class="exi" href="#expand"> </a></td>
1029
<a id="Ext.tree.TreePanel-useArrows"></a>
1030
<b>useArrows</b> : Boolean <div class="mdesc">
1031
True to use Vista-style arrows in the tree (defaults to false) </div>
1033
<td class="msource">TreePanel</td>
1035
<tr class="config-row inherited alt">
1036
<td class="micon"><a class="exi" href="#expand"> </a></td>
1038
<a id="Ext.tree.TreePanel-width"></a>
1039
<b>width</b> : Number <div class="mdesc">
1040
The width of this component in pixels (defaults to auto). </div>
1042
<td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#width" href="output/Ext.BoxComponent.html#width">BoxComponent</a></td>
1044
<tr class="config-row inherited">
1045
<td class="micon"><a class="exi" href="#expand"> </a></td>
1047
<a id="Ext.tree.TreePanel-x"></a>
1048
<b>x</b> : Number <div class="mdesc">
1049
The local x (left) coordinate for this component if contained within a positioning container. </div>
1051
<td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#x" href="output/Ext.BoxComponent.html#x">BoxComponent</a></td>
1053
<tr class="config-row inherited alt expandable">
1054
<td class="micon"><a class="exi" href="#expand"> </a></td>
1056
<a id="Ext.tree.TreePanel-xtype"></a>
1057
<b>xtype</b> : String <div class="mdesc">
1058
<div class="short">The registered xtype to create. This config option is not used when passing a config object into a constructor. This ...</div>
1060
The registered xtype to create. This config option is not used when passing a config object into a constructor. This config option is used only when lazy instantiation is being used, and a child item of a Container is being specified not as a fully instantiated Component, but as a <i>Component config object</i>. The xtype will be looked up at render time up to determine what type of child Component to create.<br><br> The predefined xtypes are listed <a ext:cls="Ext.Component" href="output/Ext.Component.html">here</a>. <br><br> If you subclass Components to create your own Components, you may register them using <a ext:cls="Ext.ComponentMgr" ext:member="registerType" href="output/Ext.ComponentMgr.html#registerType">Ext.ComponentMgr.registerType</a> in order to be able to take advantage of lazy instantiation and rendering. </div>
1063
<td class="msource"><a ext:cls="Ext.Component" ext:member="#xtype" href="output/Ext.Component.html#xtype">Component</a></td>
1065
<tr class="config-row inherited">
1066
<td class="micon"><a class="exi" href="#expand"> </a></td>
1068
<a id="Ext.tree.TreePanel-y"></a>
1069
<b>y</b> : Number <div class="mdesc">
1070
The local y (top) coordinate for this component if contained within a positioning container. </div>
1072
<td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#y" href="output/Ext.BoxComponent.html#y">BoxComponent</a></td>
1075
<a id="Ext.tree.TreePanel-props"></a>
1076
<h2>Public Properties</h2>
1077
<table cellspacing="0" class="member-table">
1079
<th class="sig-header" colspan="2">Property</th>
1080
<th class="msource-header">Defined By</th>
1082
<tr class="property-row inherited expandable">
1083
<td class="micon"><a class="exi" href="#expand"> </a></td>
1085
<a id="Ext.tree.TreePanel-body"></a>
1086
<b>body</b> : Ext.Element <div class="mdesc">
1088
The Panel's body Element which may be used to contain HTML content.
1089
The content may be specified in the html config,...</div>
1092
The Panel's body <a ext:cls="Ext.Element" href="output/Ext.Element.html">Element</a> which may be used to contain HTML content.
1093
The content may be specified in the <a ext:cls="Ext.Panel" ext:member="html" href="output/Ext.Panel.html#html">html</a> config, or it may be loaded using the
1094
<a ext:cls="autoLoad" href="output/autoLoad.html">autoLoad</a> config, or through the Panel's <a ext:cls="Ext.Panel" ext:member="getUpdater" href="output/Ext.Panel.html#getUpdater">Updater</a>. Read-only.
1095
<p>If this is used to load visible HTML elements in either way, then
1096
the Panel may not be used as a Layout for hosting nested Panels.</p>
1097
<p>If this Panel is intended to be used as the host of a Layout (See <a ext:cls="Ext.Panel" ext:member="layout" href="output/Ext.Panel.html#layout">layout</a>
1098
then the body Element must not be loaded or changed - it is under the control
1099
of the Panel's Layout. </div>
1102
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#body" href="output/Ext.Panel.html#body">Panel</a></td>
1104
<tr class="property-row inherited alt">
1105
<td class="micon"><a class="exi" href="#expand"> </a></td>
1107
<a id="Ext.tree.TreePanel-buttons"></a>
1108
<b>buttons</b> : Array <div class="mdesc">
1109
This Panel's Array of buttons as created from the <tt>buttons</tt>
1110
config property. Read only. </div>
1112
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#buttons" href="output/Ext.Panel.html#buttons">Panel</a></td>
1114
<tr class="property-row inherited expandable">
1115
<td class="micon"><a class="exi" href="#expand"> </a></td>
1117
<a id="Ext.tree.TreePanel-dd"></a>
1118
<b>dd</b> : Ext.dd.DragSource. <div class="mdesc">
1119
<div class="short">If this Panel is configured draggable, this property will contain
1120
an instance of Ext.dd.DragSource which handles drag...</div>
1122
<p>If this Panel is configured <a ext:cls="Ext.Panel" ext:member="draggable" href="output/Ext.Panel.html#draggable">draggable</a>, this property will contain
1123
an instance of <a ext:cls="Ext.dd.DragSource" href="output/Ext.dd.DragSource.html">Ext.dd.DragSource</a> which handles dragging the Panel.</p>
1124
The developer must provide implementations of the abstract methods of <a ext:cls="Ext.dd.DragSource" href="output/Ext.dd.DragSource.html">Ext.dd.DragSource</a>
1125
in order to supply behaviour for each stage of the drag/drop process. See <a ext:cls="Ext.Panel" ext:member="draggable" href="output/Ext.Panel.html#draggable">draggable</a>. </div>
1128
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#dd" href="output/Ext.Panel.html#dd">Panel</a></td>
1130
<tr class="property-row alt">
1131
<td class="micon"><a class="exi" href="#expand"> </a></td>
1133
<a id="Ext.tree.TreePanel-dragZone"></a>
1134
<b>dragZone</b> : Ext.tree.TreeDragZone <div class="mdesc">
1135
The dragZone used by this tree if drag is enabled </div>
1137
<td class="msource">TreePanel</td>
1139
<tr class="property-row">
1140
<td class="micon"><a class="exi" href="#expand"> </a></td>
1142
<a id="Ext.tree.TreePanel-dropZone"></a>
1143
<b>dropZone</b> : Ext.tree.TreeDropZone <div class="mdesc">
1144
The dropZone used by this tree if drop is enabled </div>
1146
<td class="msource">TreePanel</td>
1148
<tr class="property-row inherited alt">
1149
<td class="micon"><a class="exi" href="#expand"> </a></td>
1151
<a id="Ext.tree.TreePanel-footer"></a>
1152
<b>footer</b> : Ext.Element <div class="mdesc">
1154
The Panel's footer <a ext:cls="Ext.Element" href="output/Ext.Element.html">Element</a>. Read-only.
1155
<p>This Element is used to house the Panel's <a ext:cls="Ext.Panel" ext:member="buttons" href="output/Ext.Panel.html#buttons">buttons</a>.</p> </div>
1157
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#footer" href="output/Ext.Panel.html#footer">Panel</a></td>
1159
<tr class="property-row inherited">
1160
<td class="micon"><a class="exi" href="#expand"> </a></td>
1162
<a id="Ext.tree.TreePanel-header"></a>
1163
<b>header</b> : Ext.Element <div class="mdesc">
1164
The Panel's header <a ext:cls="Ext.Element" href="output/Ext.Element.html">Element</a>. Read-only.
1165
<p>This Element is used to house the <a ext:cls="Ext.Panel" ext:member="title" href="output/Ext.Panel.html#title">title</a> and <a ext:cls="Ext.Panel" ext:member="tools" href="output/Ext.Panel.html#tools">tools</a></p> </div>
1167
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#header" href="output/Ext.Panel.html#header">Panel</a></td>
1169
<tr class="property-row inherited alt">
1170
<td class="micon"><a class="exi" href="#expand"> </a></td>
1172
<a id="Ext.tree.TreePanel-hidden"></a>
1173
<b>hidden</b> : Boolean <div class="mdesc">
1175
True if this component is hidden. Read-only. </div>
1177
<td class="msource"><a ext:cls="Ext.Component" ext:member="#hidden" href="output/Ext.Component.html#hidden">Component</a></td>
1179
<tr class="property-row inherited">
1180
<td class="micon"><a class="exi" href="#expand"> </a></td>
1182
<a id="Ext.tree.TreePanel-initialConfig"></a>
1183
<b>initialConfig</b> : Object <div class="mdesc">
1184
This Component's initial configuration specification. Read-only. </div>
1186
<td class="msource"><a ext:cls="Ext.Component" ext:member="#initialConfig" href="output/Ext.Component.html#initialConfig">Component</a></td>
1188
<tr class="property-row inherited alt expandable">
1189
<td class="micon"><a class="exi" href="#expand"> </a></td>
1191
<a id="Ext.tree.TreePanel-ownerCt"></a>
1192
<b>ownerCt</b> : Ext.Container <div class="mdesc">
1193
<div class="short">The component's owner Ext.Container (defaults to undefined, and is set automatically when
1194
the component is added to a...</div>
1196
The component's owner <a ext:cls="Ext.Container" href="output/Ext.Container.html">Ext.Container</a> (defaults to undefined, and is set automatically when
1197
the component is added to a container). Read-only. </div>
1200
<td class="msource"><a ext:cls="Ext.Component" ext:member="#ownerCt" href="output/Ext.Component.html#ownerCt">Component</a></td>
1202
<tr class="property-row inherited">
1203
<td class="micon"><a class="exi" href="#expand"> </a></td>
1205
<a id="Ext.tree.TreePanel-rendered"></a>
1206
<b>rendered</b> : Boolean <div class="mdesc">
1207
True if this component has been rendered. Read-only. </div>
1209
<td class="msource"><a ext:cls="Ext.Component" ext:member="#rendered" href="output/Ext.Component.html#rendered">Component</a></td>
1211
<tr class="property-row alt">
1212
<td class="micon"><a class="exi" href="#expand"> </a></td>
1214
<a id="Ext.tree.TreePanel-root"></a>
1215
<b>root</b> : Ext.tree.TreeNode <div class="mdesc">
1216
The root node of this tree. </div>
1218
<td class="msource">TreePanel</td>
1221
<a id="Ext.tree.TreePanel-methods"></a>
1222
<h2>Public Methods</h2>
1223
<table cellspacing="0" class="member-table">
1225
<th class="sig-header" colspan="2">Method</th>
1226
<th class="msource-header">Defined By</th>
1228
<tr class="method-row expandable">
1229
<td class="micon"><a class="exi" href="#expand"> </a></td>
1231
<a id="Ext.tree.TreePanel-TreePanel"></a>
1232
<b>TreePanel</b>( <code>Object config</code> ) <div class="mdesc">
1233
<div class="short"></div>
1235
<div class="mdetail-params">
1236
<strong>Parameters:</strong>
1237
<ul><li><code>config</code> : Object<div class="sub-desc"></div></li> </ul>
1238
<strong>Returns:</strong>
1240
<li><code></code></li>
1246
<td class="msource">TreePanel</td>
1248
<tr class="method-row inherited alt expandable">
1249
<td class="micon"><a class="exi" href="#expand"> </a></td>
1251
<a id="Ext.tree.TreePanel-add"></a>
1252
<b>add</b>( <code>Ext.Component/Object component</code> ) : Ext.Component <div class="mdesc">
1253
<div class="short">Adds a Component to this Container. Fires the beforeadd event before
1254
adding, then fires the add event after the compo...</div>
1256
<p>Adds a <a ext:cls="Ext.Component" href="output/Ext.Component.html">Component</a> to this Container. Fires the <a ext:cls="Ext.Container" ext:member="beforeadd" href="output/Ext.Container.html#beforeadd">beforeadd</a> event before
1257
adding, then fires the <a ext:cls="Ext.Container" ext:member="add" href="output/Ext.Container.html#add">add</a> event after the component has been added.</p>
1258
<p>You will never call the render method of a child Component when using a Container.
1259
Child Components are rendered by this Container's <a ext:cls="Ext.Container" ext:member="layout" href="output/Ext.Container.html#layout">layout</a> manager when
1260
this Container is first rendered.</p>
1261
<p>Certain layout managers allow dynamic addition of child components. Those that do
1262
include <a ext:cls="Ext.layout.CardLayout" href="output/Ext.layout.CardLayout.html">Ext.layout.CardLayout</a>, <a ext:cls="Ext.layout.AnchorLayout" href="output/Ext.layout.AnchorLayout.html">Ext.layout.AnchorLayout</a>,
1263
<a ext:cls="Ext.layout.FormLayout" href="output/Ext.layout.FormLayout.html">Ext.layout.FormLayout</a>, <a ext:cls="Ext.layout.TableLayout" href="output/Ext.layout.TableLayout.html">Ext.layout.TableLayout</a>.</p>
1264
<p>If the Container is already rendered when add is called, you may need to call
1265
<a ext:cls="Ext.Container" ext:member="doLayout" href="output/Ext.Container.html#doLayout">doLayout</a> to refresh the view which causes any unrendered child Components
1266
to be rendered. This is required so that you can add multiple child components if needed
1267
while only refreshing the layout once.</p>
1268
<p>When creating complex UIs, it is important to remember that sizing and positioning
1269
of child items is the responsibility of the Container's <a ext:cls="Ext.Container" ext:member="layout" href="output/Ext.Container.html#layout">layout</a> manager. If
1270
you expect child items to be sized in response to user interactions, you must
1271
specify a layout manager which creates and manages the type of layout you have in mind.</p>
1272
<p><b>Omitting the <a ext:cls="Ext.Container" ext:member="layout" href="output/Ext.Container.html#layout">layout</a> config means that a basic layout manager is
1273
used which does nothnig but render child components sequentially into the Container.
1274
No sizing or positioning will be performed in this situation.</b></p> <div class="mdetail-params">
1275
<strong>Parameters:</strong>
1276
<ul><li><code>component</code> : Ext.Component/Object<div class="sub-desc">The Component to add.<br><br>
1277
Ext uses lazy rendering, and will only render the added Component should
1278
it become necessary, that is: when the Container is layed out either on first render
1279
or in response to a <a ext:cls="Ext.Container" ext:member="doLayout" href="output/Ext.Container.html#doLayout">doLayout</a> call.<br><br>
1280
A Component config object may be passed instead of an instantiated Component object.
1281
The type of Component created from a config object is determined by the <a ext:cls="Ext.Component" ext:member="xtype" href="output/Ext.Component.html#xtype">xtype</a>
1282
config property. If no xtype is configured, the Container's <a ext:cls="Ext.Container" ext:member="defaultType" href="output/Ext.Container.html#defaultType">defaultType</a>
1284
For a list of all available xtypes, see <a ext:cls="Ext.Component" href="output/Ext.Component.html">Ext.Component</a>.</div></li> </ul>
1285
<strong>Returns:</strong>
1287
<li><code>Ext.Component</code><div class="sub-desc">component The Component (or config object) that was added with the Container's default config values applied. <p>example:</p><pre><code> var myNewGrid = new Ext.grid.GridPanel({ store: myStore, colModel: myColModel }); myTabPanel.add(myNewGrid); myTabPanel.setActiveTab(myNewGrid); </code></pre></div></li>
1293
<td class="msource"><a ext:cls="Ext.Container" ext:member="#add" href="output/Ext.Container.html#add">Container</a></td>
1295
<tr class="method-row inherited expandable">
1296
<td class="micon"><a class="exi" href="#expand"> </a></td>
1298
<a id="Ext.tree.TreePanel-addButton"></a>
1299
<b>addButton</b>( <code>String/Object config</code>, <code>Function handler</code>, <code>Object scope</code> ) : Ext.Button <div class="mdesc">
1300
<div class="short">Adds a button to this panel. Note that this method must be called prior to rendering. The preferred
1301
approach is to ...</div>
1303
Adds a button to this panel. Note that this method must be called prior to rendering. The preferred
1304
approach is to add buttons via the <a ext:cls="Ext.Panel" ext:member="buttons" href="output/Ext.Panel.html#buttons">buttons</a> config. <div class="mdetail-params">
1305
<strong>Parameters:</strong>
1306
<ul><li><code>config</code> : String/Object<div class="sub-desc">A valid <a ext:cls="Ext.Button" href="output/Ext.Button.html">Ext.Button</a> config. A string will become the text for a default
1307
button config, an object will be treated as a button config object.</div></li><li><code>handler</code> : Function<div class="sub-desc">The function to be called on button <a ext:cls="Ext.Button" ext:member="click" href="output/Ext.Button.html#click">Ext.Button.click</a></div></li><li><code>scope</code> : Object<div class="sub-desc">The scope to use for the button handler function</div></li> </ul>
1308
<strong>Returns:</strong>
1310
<li><code>Ext.Button</code><div class="sub-desc">The button that was added</div></li>
1316
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#addButton" href="output/Ext.Panel.html#addButton">Panel</a></td>
1318
<tr class="method-row inherited alt expandable">
1319
<td class="micon"><a class="exi" href="#expand"> </a></td>
1321
<a id="Ext.tree.TreePanel-addClass"></a>
1322
<b>addClass</b>( <code>string cls</code> ) : void <div class="mdesc">
1323
<div class="short">Adds a CSS class to the component's underlying element.</div>
1325
Adds a CSS class to the component's underlying element. <div class="mdetail-params">
1326
<strong>Parameters:</strong>
1327
<ul><li><code>cls</code> : string<div class="sub-desc">The CSS class name to add</div></li> </ul>
1328
<strong>Returns:</strong>
1330
<li><code>void</code></li>
1336
<td class="msource"><a ext:cls="Ext.Component" ext:member="#addClass" href="output/Ext.Component.html#addClass">Component</a></td>
1338
<tr class="method-row inherited expandable">
1339
<td class="micon"><a class="exi" href="#expand"> </a></td>
1341
<a id="Ext.tree.TreePanel-addEvents"></a>
1342
<b>addEvents</b>( <code>Object object</code> ) : void <div class="mdesc">
1343
<div class="short">Used to define events on this Observable</div>
1345
Used to define events on this Observable <div class="mdetail-params">
1346
<strong>Parameters:</strong>
1347
<ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li> </ul>
1348
<strong>Returns:</strong>
1350
<li><code>void</code></li>
1356
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td>
1358
<tr class="method-row inherited alt expandable">
1359
<td class="micon"><a class="exi" href="#expand"> </a></td>
1361
<a id="Ext.tree.TreePanel-addListener"></a>
1362
<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">
1363
<div class="short">Appends an event handler to this component</div>
1365
Appends an event handler to this component <div class="mdetail-params">
1366
<strong>Parameters:</strong>
1367
<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 (<code><b>this</b></code> reference) in which the handler function is executed.
1368
<b>If omitted, defaults to the object which fired the event.</b></div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration
1369
properties. This may contain any of the following properties:<ul>
1370
<li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
1371
<b>If omitted, defaults to the object which fired the event.</b></div></li>
1372
<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>
1373
<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>
1374
<li><b>buffer</b> : Number<div 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
1375
by the specified number of milliseconds. If the event fires again within that time, the original
1376
handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
1377
<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>
1378
if the event was bubbled up from a child Observable.</div></li>
1381
<b>Combining Options</b><br>
1382
Using the options argument, it is possible to combine different types of listeners:<br>
1384
A delayed, one-time listener.
1385
<pre><code>myDataView.on(<em>'click'</em>, <b>this</b>.onClick, <b>this</b>, {
1390
<b>Attaching multiple handlers in 1 call</b><br>
1391
The method also allows for a single argument to be passed which is a config object containing properties
1392
which specify multiple handlers.
1394
<pre><code>myGridPanel.on({
1395
<em>'click'</em> : {
1396
fn: <b>this</b>.onClick,
1400
<em>'mouseover'</em> : {
1401
fn: <b>this</b>.onMouseOver,
1404
<em>'mouseout'</em> : {
1405
fn: <b>this</b>.onMouseOut,
1410
Or a shorthand syntax:<br>
1411
<pre><code>myGridPanel.on({
1412
<em>'click'</em> : <b>this</b>.onClick,
1413
<em>'mouseover'</em> : <b>this</b>.onMouseOver,
1414
<em>'mouseout'</em> : <b>this</b>.onMouseOut,
1416
});</code></pre></div></li> </ul>
1417
<strong>Returns:</strong>
1419
<li><code>void</code></li>
1425
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td>
1427
<tr class="method-row inherited expandable">
1428
<td class="micon"><a class="exi" href="#expand"> </a></td>
1430
<a id="Ext.tree.TreePanel-bubble"></a>
1431
<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">
1432
<div class="short">Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of...</div>
1434
Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (<i>this</i>) of
1435
function call will be the scope provided or the current component. The arguments to the function
1436
will be the args provided or the current component. If the function returns false at any point,
1437
the bubble is stopped. <div class="mdetail-params">
1438
<strong>Parameters:</strong>
1439
<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 component)</div></li> </ul>
1440
<strong>Returns:</strong>
1442
<li><code>void</code></li>
1448
<td class="msource"><a ext:cls="Ext.Container" ext:member="#bubble" href="output/Ext.Container.html#bubble">Container</a></td>
1450
<tr class="method-row inherited alt expandable">
1451
<td class="micon"><a class="exi" href="#expand"> </a></td>
1453
<a id="Ext.tree.TreePanel-cloneConfig"></a>
1454
<b>cloneConfig</b>( <code>Object overrides</code> ) : Ext.Component <div class="mdesc">
1455
<div class="short">Clone the current component using the original config values passed into this instance by default.</div>
1457
Clone the current component using the original config values passed into this instance by default. <div class="mdetail-params">
1458
<strong>Parameters:</strong>
1459
<ul><li><code>overrides</code> : Object<div class="sub-desc">A new config containing any properties to override in the cloned version.
1460
An id property can be passed on this object, otherwise one will be generated to avoid duplicates.</div></li> </ul>
1461
<strong>Returns:</strong>
1463
<li><code>Ext.Component</code><div class="sub-desc">clone The cloned copy of this component</div></li>
1469
<td class="msource"><a ext:cls="Ext.Component" ext:member="#cloneConfig" href="output/Ext.Component.html#cloneConfig">Component</a></td>
1471
<tr class="method-row inherited expandable">
1472
<td class="micon"><a class="exi" href="#expand"> </a></td>
1474
<a id="Ext.tree.TreePanel-collapse"></a>
1475
<b>collapse</b>( <code>Boolean animate</code> ) : Ext.Panel <div class="mdesc">
1476
<div class="short">Collapses the panel body so that it becomes hidden. Fires the beforecollapse event which will
1477
cancel the collapse ac...</div>
1479
Collapses the panel body so that it becomes hidden. Fires the <a ext:cls="Ext.Panel" ext:member="beforecollapse" href="output/Ext.Panel.html#beforecollapse">beforecollapse</a> event which will
1480
cancel the collapse action if it returns false. <div class="mdetail-params">
1481
<strong>Parameters:</strong>
1482
<ul><li><code>animate</code> : Boolean<div class="sub-desc">True to animate the transition, else false (defaults to the value of the
1483
<a ext:cls="Ext.Panel" ext:member="animCollapse" href="output/Ext.Panel.html#animCollapse">animCollapse</a> panel config)</div></li> </ul>
1484
<strong>Returns:</strong>
1486
<li><code>Ext.Panel</code><div class="sub-desc">this</div></li>
1492
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#collapse" href="output/Ext.Panel.html#collapse">Panel</a></td>
1494
<tr class="method-row alt expandable">
1495
<td class="micon"><a class="exi" href="#expand"> </a></td>
1497
<a id="Ext.tree.TreePanel-collapseAll"></a>
1498
<b>collapseAll</b>() : void <div class="mdesc">
1499
<div class="short">Collapse all nodes</div>
1501
Collapse all nodes <div class="mdetail-params">
1502
<strong>Parameters:</strong>
1503
<ul><li>None.</li> </ul>
1504
<strong>Returns:</strong>
1506
<li><code>void</code></li>
1512
<td class="msource">TreePanel</td>
1514
<tr class="method-row inherited expandable">
1515
<td class="micon"><a class="exi" href="#expand"> </a></td>
1517
<a id="Ext.tree.TreePanel-destroy"></a>
1518
<b>destroy</b>() : void <div class="mdesc">
1519
<div class="short">Destroys this component by purging any event listeners, removing the component's element from the DOM,
1520
removing the c...</div>
1522
Destroys this component by purging any event listeners, removing the component's element from the DOM,
1523
removing the component from its <a ext:cls="Ext.Container" href="output/Ext.Container.html">Ext.Container</a> (if applicable) and unregistering it from
1524
<a ext:cls="Ext.ComponentMgr" href="output/Ext.ComponentMgr.html">Ext.ComponentMgr</a>. Destruction is generally handled automatically by the framework and this method
1525
should usually not need to be called directly. <div class="mdetail-params">
1526
<strong>Parameters:</strong>
1527
<ul><li>None.</li> </ul>
1528
<strong>Returns:</strong>
1530
<li><code>void</code></li>
1536
<td class="msource"><a ext:cls="Ext.Component" ext:member="#destroy" href="output/Ext.Component.html#destroy">Component</a></td>
1538
<tr class="method-row inherited alt expandable">
1539
<td class="micon"><a class="exi" href="#expand"> </a></td>
1541
<a id="Ext.tree.TreePanel-expand"></a>
1542
<b>expand</b>( <code>Boolean animate</code> ) : Ext.Panel <div class="mdesc">
1543
<div class="short">Expands the panel body so that it becomes visible. Fires the beforeexpand event which will
1544
cancel the expand action ...</div>
1546
Expands the panel body so that it becomes visible. Fires the <a ext:cls="Ext.Panel" ext:member="beforeexpand" href="output/Ext.Panel.html#beforeexpand">beforeexpand</a> event which will
1547
cancel the expand action if it returns false. <div class="mdetail-params">
1548
<strong>Parameters:</strong>
1549
<ul><li><code>animate</code> : Boolean<div class="sub-desc">True to animate the transition, else false (defaults to the value of the
1550
<a ext:cls="Ext.Panel" ext:member="animCollapse" href="output/Ext.Panel.html#animCollapse">animCollapse</a> panel config)</div></li> </ul>
1551
<strong>Returns:</strong>
1553
<li><code>Ext.Panel</code><div class="sub-desc">this</div></li>
1559
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#expand" href="output/Ext.Panel.html#expand">Panel</a></td>
1561
<tr class="method-row expandable">
1562
<td class="micon"><a class="exi" href="#expand"> </a></td>
1564
<a id="Ext.tree.TreePanel-expandAll"></a>
1565
<b>expandAll</b>() : void <div class="mdesc">
1566
<div class="short">Expand all nodes</div>
1568
Expand all nodes <div class="mdetail-params">
1569
<strong>Parameters:</strong>
1570
<ul><li>None.</li> </ul>
1571
<strong>Returns:</strong>
1573
<li><code>void</code></li>
1579
<td class="msource">TreePanel</td>
1581
<tr class="method-row alt expandable">
1582
<td class="micon"><a class="exi" href="#expand"> </a></td>
1584
<a id="Ext.tree.TreePanel-expandPath"></a>
1585
<b>expandPath</b>( <code>String path</code>, <span class="optional" title="Optional">[<code>String attr</code>]</span>, <span class="optional" title="Optional">[<code>Function callback</code>]</span> ) : void <div class="mdesc">
1586
<div class="short">Expands a specified path in this TreePanel. A path can be retrieved from a node with <a ext:cls="Ext.data.Node" ext:member="getPath" href="output/Ext.data.Node.html#getPath">Ext.data.Node.getPath</a></div>
1588
Expands a specified path in this TreePanel. A path can be retrieved from a node with <a ext:cls="Ext.data.Node" ext:member="getPath" href="output/Ext.data.Node.html#getPath">Ext.data.Node.getPath</a> <div class="mdetail-params">
1589
<strong>Parameters:</strong>
1590
<ul><li><code>path</code> : String<div class="sub-desc"></div></li><li><code>attr</code> : String<div class="sub-desc">(optional) The attribute used in the path (see <a ext:cls="Ext.data.Node" ext:member="getPath" href="output/Ext.data.Node.html#getPath">Ext.data.Node.getPath</a> for more info)</div></li><li><code>callback</code> : Function<div class="sub-desc">(optional) The callback to call when the expand is complete. The callback will be called with
1591
(bSuccess, oLastNode) where bSuccess is if the expand was successful and oLastNode is the last node that was expanded.</div></li> </ul>
1592
<strong>Returns:</strong>
1594
<li><code>void</code></li>
1600
<td class="msource">TreePanel</td>
1602
<tr class="method-row inherited expandable">
1603
<td class="micon"><a class="exi" href="#expand"> </a></td>
1605
<a id="Ext.tree.TreePanel-findParentBy"></a>
1606
<b>findParentBy</b>( <code>Function fcn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : Ext.Container <div class="mdesc">
1607
<div class="short">Find a container above this component at any level by a custom function. If the passed function returns
1608
true, the con...</div>
1610
Find a container above this component at any level by a custom function. If the passed function returns
1611
true, the container will be returned. The passed function is called with the arguments (container, this component). <div class="mdetail-params">
1612
<strong>Parameters:</strong>
1613
<ul><li><code>fcn</code> : Function<div class="sub-desc"></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional)</div></li> </ul>
1614
<strong>Returns:</strong>
1616
<li><code>Ext.Container</code><div class="sub-desc">The first Container for which the custom function returns true</div></li>
1622
<td class="msource"><a ext:cls="Ext.Component" ext:member="#findParentBy" href="output/Ext.Component.html#findParentBy">Component</a></td>
1624
<tr class="method-row inherited alt expandable">
1625
<td class="micon"><a class="exi" href="#expand"> </a></td>
1627
<a id="Ext.tree.TreePanel-findParentByType"></a>
1628
<b>findParentByType</b>( <code>String/Class xtype</code> ) : Ext.Container <div class="mdesc">
1629
<div class="short">Find a container above this component at any level by xtype or class</div>
1631
Find a container above this component at any level by xtype or class <div class="mdetail-params">
1632
<strong>Parameters:</strong>
1633
<ul><li><code>xtype</code> : String/Class<div class="sub-desc">The xtype string for a component, or the class of the component directly</div></li> </ul>
1634
<strong>Returns:</strong>
1636
<li><code>Ext.Container</code><div class="sub-desc">The first Container which matches the given xtype or class</div></li>
1642
<td class="msource"><a ext:cls="Ext.Component" ext:member="#findParentByType" href="output/Ext.Component.html#findParentByType">Component</a></td>
1644
<tr class="method-row inherited expandable">
1645
<td class="micon"><a class="exi" href="#expand"> </a></td>
1647
<a id="Ext.tree.TreePanel-fireEvent"></a>
1648
<b>fireEvent</b>( <code>String eventName</code>, <code>Object... args</code> ) : Boolean <div class="mdesc">
1649
<div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
1651
Fires the specified event with the passed parameters (minus the event name). <div class="mdetail-params">
1652
<strong>Parameters:</strong>
1653
<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>
1654
<strong>Returns:</strong>
1656
<li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li>
1662
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td>
1664
<tr class="method-row inherited alt expandable">
1665
<td class="micon"><a class="exi" href="#expand"> </a></td>
1667
<a id="Ext.tree.TreePanel-focus"></a>
1668
<b>focus</b>( <span class="optional" title="Optional">[<code>Boolean selectText</code>]</span>, <span class="optional" title="Optional">[<code>Boolean/Number delay</code>]</span> ) : Ext.Component <div class="mdesc">
1669
<div class="short">Try to focus this component.</div>
1671
Try to focus this component. <div class="mdetail-params">
1672
<strong>Parameters:</strong>
1673
<ul><li><code>selectText</code> : Boolean<div class="sub-desc">(optional) If applicable, true to also select the text in this component</div></li><li><code>delay</code> : Boolean/Number<div class="sub-desc">(optional) Delay the focus this number of milliseconds (true for 10 milliseconds)</div></li> </ul>
1674
<strong>Returns:</strong>
1676
<li><code>Ext.Component</code><div class="sub-desc">this</div></li>
1682
<td class="msource"><a ext:cls="Ext.Component" ext:member="#focus" href="output/Ext.Component.html#focus">Component</a></td>
1684
<tr class="method-row inherited expandable">
1685
<td class="micon"><a class="exi" href="#expand"> </a></td>
1687
<a id="Ext.tree.TreePanel-getBottomToolbar"></a>
1688
<b>getBottomToolbar</b>() : Ext.Toolbar <div class="mdesc">
1689
<div class="short">Returns the toolbar from the bottom (bbar) section of the panel.</div>
1691
Returns the toolbar from the bottom (bbar) section of the panel. <div class="mdetail-params">
1692
<strong>Parameters:</strong>
1693
<ul><li>None.</li> </ul>
1694
<strong>Returns:</strong>
1696
<li><code>Ext.Toolbar</code><div class="sub-desc">The toolbar</div></li>
1702
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#getBottomToolbar" href="output/Ext.Panel.html#getBottomToolbar">Panel</a></td>
1704
<tr class="method-row inherited alt expandable">
1705
<td class="micon"><a class="exi" href="#expand"> </a></td>
1707
<a id="Ext.tree.TreePanel-getBox"></a>
1708
<b>getBox</b>( <span class="optional" title="Optional">[<code>Boolean local</code>]</span> ) : Object <div class="mdesc">
1709
<div class="short">Gets the current box measurements of the component's underlying element.</div>
1711
Gets the current box measurements of the component's underlying element. <div class="mdetail-params">
1712
<strong>Parameters:</strong>
1713
<ul><li><code>local</code> : Boolean<div class="sub-desc">(optional) If true the element's left and top are returned instead of page XY (defaults to false)</div></li> </ul>
1714
<strong>Returns:</strong>
1716
<li><code>Object</code><div class="sub-desc">box An object in the format {x, y, width, height}</div></li>
1722
<td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#getBox" href="output/Ext.BoxComponent.html#getBox">BoxComponent</a></td>
1724
<tr class="method-row expandable">
1725
<td class="micon"><a class="exi" href="#expand"> </a></td>
1727
<a id="Ext.tree.TreePanel-getChecked"></a>
1728
<b>getChecked</b>( <span class="optional" title="Optional">[<code>String attribute</code>]</span>, <span class="optional" title="Optional">[<code>TreeNode startNode</code>]</span> ) : Array <div class="mdesc">
1729
<div class="short">Retrieve an array of checked nodes, or an array of a specific attribute of checked nodes (e.g. "id")</div>
1731
Retrieve an array of checked nodes, or an array of a specific attribute of checked nodes (e.g. "id") <div class="mdetail-params">
1732
<strong>Parameters:</strong>
1733
<ul><li><code>attribute</code> : String<div class="sub-desc">(optional) Defaults to null (return the actual nodes)</div></li><li><code>startNode</code> : TreeNode<div class="sub-desc">(optional) The node to start from, defaults to the root</div></li> </ul>
1734
<strong>Returns:</strong>
1736
<li><code>Array</code></li>
1742
<td class="msource">TreePanel</td>
1744
<tr class="method-row alt expandable">
1745
<td class="micon"><a class="exi" href="#expand"> </a></td>
1747
<a id="Ext.tree.TreePanel-getEl"></a>
1748
<b>getEl</b>() : Element <div class="mdesc">
1749
<div class="short">Returns the container element for this TreePanel.</div>
1751
Returns the container element for this TreePanel. <div class="mdetail-params">
1752
<strong>Parameters:</strong>
1753
<ul><li>None.</li> </ul>
1754
<strong>Returns:</strong>
1756
<li><code>Element</code><div class="sub-desc">The container element for this TreePanel.</div></li>
1762
<td class="msource">TreePanel</td>
1764
<tr class="method-row inherited expandable">
1765
<td class="micon"><a class="exi" href="#expand"> </a></td>
1767
<a id="Ext.tree.TreePanel-getFrameHeight"></a>
1768
<b>getFrameHeight</b>() : Number <div class="mdesc">
1769
<div class="short">Returns the height in pixels of the framing elements of this panel (including any top and bottom bars and
1770
header and ...</div>
1772
Returns the height in pixels of the framing elements of this panel (including any top and bottom bars and
1773
header and footer elements, but not including the body height). To retrieve the body height see <a ext:cls="Ext.Panel" ext:member="getInnerHeight" href="output/Ext.Panel.html#getInnerHeight">getInnerHeight</a>. <div class="mdetail-params">
1774
<strong>Parameters:</strong>
1775
<ul><li>None.</li> </ul>
1776
<strong>Returns:</strong>
1778
<li><code>Number</code><div class="sub-desc">The frame height</div></li>
1784
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#getFrameHeight" href="output/Ext.Panel.html#getFrameHeight">Panel</a></td>
1786
<tr class="method-row inherited alt expandable">
1787
<td class="micon"><a class="exi" href="#expand"> </a></td>
1789
<a id="Ext.tree.TreePanel-getFrameWidth"></a>
1790
<b>getFrameWidth</b>() : Number <div class="mdesc">
1791
<div class="short">Returns the width in pixels of the framing elements of this panel (not including the body width). To
1792
retrieve the bo...</div>
1794
Returns the width in pixels of the framing elements of this panel (not including the body width). To
1795
retrieve the body width see <a ext:cls="Ext.Panel" ext:member="getInnerWidth" href="output/Ext.Panel.html#getInnerWidth">getInnerWidth</a>. <div class="mdetail-params">
1796
<strong>Parameters:</strong>
1797
<ul><li>None.</li> </ul>
1798
<strong>Returns:</strong>
1800
<li><code>Number</code><div class="sub-desc">The frame width</div></li>
1806
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#getFrameWidth" href="output/Ext.Panel.html#getFrameWidth">Panel</a></td>
1808
<tr class="method-row inherited expandable">
1809
<td class="micon"><a class="exi" href="#expand"> </a></td>
1811
<a id="Ext.tree.TreePanel-getId"></a>
1812
<b>getId</b>() : String <div class="mdesc">
1813
<div class="short">Returns the id of this component.</div>
1815
Returns the id of this component. <div class="mdetail-params">
1816
<strong>Parameters:</strong>
1817
<ul><li>None.</li> </ul>
1818
<strong>Returns:</strong>
1820
<li><code>String</code></li>
1826
<td class="msource"><a ext:cls="Ext.Component" ext:member="#getId" href="output/Ext.Component.html#getId">Component</a></td>
1828
<tr class="method-row inherited alt expandable">
1829
<td class="micon"><a class="exi" href="#expand"> </a></td>
1831
<a id="Ext.tree.TreePanel-getInnerHeight"></a>
1832
<b>getInnerHeight</b>() : Number <div class="mdesc">
1833
<div class="short">Returns the height in pixels of the body element (not including the height of any framing elements).
1834
For the frame he...</div>
1836
Returns the height in pixels of the body element (not including the height of any framing elements).
1837
For the frame height see <a ext:cls="Ext.Panel" ext:member="getFrameHeight" href="output/Ext.Panel.html#getFrameHeight">getFrameHeight</a>. <div class="mdetail-params">
1838
<strong>Parameters:</strong>
1839
<ul><li>None.</li> </ul>
1840
<strong>Returns:</strong>
1842
<li><code>Number</code><div class="sub-desc">The body height</div></li>
1848
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#getInnerHeight" href="output/Ext.Panel.html#getInnerHeight">Panel</a></td>
1850
<tr class="method-row inherited expandable">
1851
<td class="micon"><a class="exi" href="#expand"> </a></td>
1853
<a id="Ext.tree.TreePanel-getInnerWidth"></a>
1854
<b>getInnerWidth</b>() : Number <div class="mdesc">
1855
<div class="short">Returns the width in pixels of the body element (not including the width of any framing elements).
1856
For the frame widt...</div>
1858
Returns the width in pixels of the body element (not including the width of any framing elements).
1859
For the frame width see <a ext:cls="Ext.Panel" ext:member="getFrameWidth" href="output/Ext.Panel.html#getFrameWidth">getFrameWidth</a>. <div class="mdetail-params">
1860
<strong>Parameters:</strong>
1861
<ul><li>None.</li> </ul>
1862
<strong>Returns:</strong>
1864
<li><code>Number</code><div class="sub-desc">The body width</div></li>
1870
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#getInnerWidth" href="output/Ext.Panel.html#getInnerWidth">Panel</a></td>
1872
<tr class="method-row inherited alt expandable">
1873
<td class="micon"><a class="exi" href="#expand"> </a></td>
1875
<a id="Ext.tree.TreePanel-getItemId"></a>
1876
<b>getItemId</b>() : String <div class="mdesc">
1877
<div class="short">Returns the item id of this component.</div>
1879
Returns the item id of this component. <div class="mdetail-params">
1880
<strong>Parameters:</strong>
1881
<ul><li>None.</li> </ul>
1882
<strong>Returns:</strong>
1884
<li><code>String</code></li>
1890
<td class="msource"><a ext:cls="Ext.Component" ext:member="#getItemId" href="output/Ext.Component.html#getItemId">Component</a></td>
1892
<tr class="method-row inherited expandable">
1893
<td class="micon"><a class="exi" href="#expand"> </a></td>
1895
<a id="Ext.tree.TreePanel-getLayoutTarget"></a>
1896
<b>getLayoutTarget</b>() : Ext.Element <div class="mdesc">
1897
<div class="short">Returns the Element to be used to contain the child Components of this Container.
1898
An implementation is provided which...</div>
1900
<p>Returns the Element to be used to contain the child Components of this Container.</p>
1901
<p>An implementation is provided which returns the Container's <a ext:cls="Ext.Container" ext:member="getEl" href="output/Ext.Container.html#getEl">Element</a>, but
1902
if there is a more complex structure to a Container, this may be overridden to return
1903
the element into which the <a ext:cls="Ext.Container" ext:member="layout" href="output/Ext.Container.html#layout">layout</a> renders child Components.</p> <div class="mdetail-params">
1904
<strong>Parameters:</strong>
1905
<ul><li>None.</li> </ul>
1906
<strong>Returns:</strong>
1908
<li><code>Ext.Element</code><div class="sub-desc">The Element to render child Components into.</div></li>
1914
<td class="msource"><a ext:cls="Ext.Container" ext:member="#getLayoutTarget" href="output/Ext.Container.html#getLayoutTarget">Container</a></td>
1916
<tr class="method-row alt expandable">
1917
<td class="micon"><a class="exi" href="#expand"> </a></td>
1919
<a id="Ext.tree.TreePanel-getLoader"></a>
1920
<b>getLoader</b>() : Ext.tree.TreeLoader <div class="mdesc">
1921
<div class="short">Returns the default <a ext:cls="Ext.tree.TreeLoader" href="output/Ext.tree.TreeLoader.html">Ext.tree.TreeLoader</a> for this TreePanel.</div>
1923
Returns the default <a ext:cls="Ext.tree.TreeLoader" href="output/Ext.tree.TreeLoader.html">Ext.tree.TreeLoader</a> for this TreePanel. <div class="mdetail-params">
1924
<strong>Parameters:</strong>
1925
<ul><li>None.</li> </ul>
1926
<strong>Returns:</strong>
1928
<li><code>Ext.tree.TreeLoader</code><div class="sub-desc">The TreeLoader for this TreePanel.</div></li>
1934
<td class="msource">TreePanel</td>
1936
<tr class="method-row expandable">
1937
<td class="micon"><a class="exi" href="#expand"> </a></td>
1939
<a id="Ext.tree.TreePanel-getNodeById"></a>
1940
<b>getNodeById</b>( <code>String id</code> ) : Node <div class="mdesc">
1941
<div class="short">Gets a node in this tree by its id</div>
1943
Gets a node in this tree by its id <div class="mdetail-params">
1944
<strong>Parameters:</strong>
1945
<ul><li><code>id</code> : String<div class="sub-desc"></div></li> </ul>
1946
<strong>Returns:</strong>
1948
<li><code>Node</code></li>
1954
<td class="msource">TreePanel</td>
1956
<tr class="method-row inherited alt expandable">
1957
<td class="micon"><a class="exi" href="#expand"> </a></td>
1959
<a id="Ext.tree.TreePanel-getPosition"></a>
1960
<b>getPosition</b>( <span class="optional" title="Optional">[<code>Boolean local</code>]</span> ) : Array <div class="mdesc">
1961
<div class="short">Gets the current XY position of the component's underlying element.</div>
1963
Gets the current XY position of the component's underlying element. <div class="mdetail-params">
1964
<strong>Parameters:</strong>
1965
<ul><li><code>local</code> : Boolean<div class="sub-desc">(optional) If true the element's left and top are returned instead of page XY (defaults to false)</div></li> </ul>
1966
<strong>Returns:</strong>
1968
<li><code>Array</code><div class="sub-desc">The XY position of the element (e.g., [100, 200])</div></li>
1974
<td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#getPosition" href="output/Ext.BoxComponent.html#getPosition">BoxComponent</a></td>
1976
<tr class="method-row expandable">
1977
<td class="micon"><a class="exi" href="#expand"> </a></td>
1979
<a id="Ext.tree.TreePanel-getRootNode"></a>
1980
<b>getRootNode</b>() : Node <div class="mdesc">
1981
<div class="short">Returns this root node for this tree</div>
1983
Returns this root node for this tree <div class="mdetail-params">
1984
<strong>Parameters:</strong>
1985
<ul><li>None.</li> </ul>
1986
<strong>Returns:</strong>
1988
<li><code>Node</code></li>
1994
<td class="msource">TreePanel</td>
1996
<tr class="method-row alt expandable">
1997
<td class="micon"><a class="exi" href="#expand"> </a></td>
1999
<a id="Ext.tree.TreePanel-getSelectionModel"></a>
2000
<b>getSelectionModel</b>() : TreeSelectionModel <div class="mdesc">
2001
<div class="short">Returns the selection model used by this TreePanel.</div>
2003
Returns the selection model used by this TreePanel. <div class="mdetail-params">
2004
<strong>Parameters:</strong>
2005
<ul><li>None.</li> </ul>
2006
<strong>Returns:</strong>
2008
<li><code>TreeSelectionModel</code><div class="sub-desc">The selection model used by this TreePanel</div></li>
2014
<td class="msource">TreePanel</td>
2016
<tr class="method-row inherited expandable">
2017
<td class="micon"><a class="exi" href="#expand"> </a></td>
2019
<a id="Ext.tree.TreePanel-getSize"></a>
2020
<b>getSize</b>() : Object <div class="mdesc">
2021
<div class="short">Gets the current size of the component's underlying element.</div>
2023
Gets the current size of the component's underlying element. <div class="mdetail-params">
2024
<strong>Parameters:</strong>
2025
<ul><li>None.</li> </ul>
2026
<strong>Returns:</strong>
2028
<li><code>Object</code><div class="sub-desc">An object containing the element's size {width: (element width), height: (element height)}</div></li>
2034
<td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#getSize" href="output/Ext.BoxComponent.html#getSize">BoxComponent</a></td>
2036
<tr class="method-row inherited alt expandable">
2037
<td class="micon"><a class="exi" href="#expand"> </a></td>
2039
<a id="Ext.tree.TreePanel-getTool"></a>
2040
<b>getTool</b>( <code>String id</code> ) : Object <div class="mdesc">
2041
<div class="short">Retrieve a tool by id.</div>
2043
Retrieve a tool by id. <div class="mdetail-params">
2044
<strong>Parameters:</strong>
2045
<ul><li><code>id</code> : String<div class="sub-desc"></div></li> </ul>
2046
<strong>Returns:</strong>
2048
<li><code>Object</code><div class="sub-desc">tool</div></li>
2054
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#getTool" href="output/Ext.Panel.html#getTool">Panel</a></td>
2056
<tr class="method-row inherited expandable">
2057
<td class="micon"><a class="exi" href="#expand"> </a></td>
2059
<a id="Ext.tree.TreePanel-getTopToolbar"></a>
2060
<b>getTopToolbar</b>() : Ext.Toolbar <div class="mdesc">
2061
<div class="short">Returns the toolbar from the top (tbar) section of the panel.</div>
2063
Returns the toolbar from the top (tbar) section of the panel. <div class="mdetail-params">
2064
<strong>Parameters:</strong>
2065
<ul><li>None.</li> </ul>
2066
<strong>Returns:</strong>
2068
<li><code>Ext.Toolbar</code><div class="sub-desc">The toolbar</div></li>
2074
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#getTopToolbar" href="output/Ext.Panel.html#getTopToolbar">Panel</a></td>
2076
<tr class="method-row alt expandable">
2077
<td class="micon"><a class="exi" href="#expand"> </a></td>
2079
<a id="Ext.tree.TreePanel-getTreeEl"></a>
2080
<b>getTreeEl</b>() : Ext.Element <div class="mdesc">
2081
<div class="short">Returns the underlying Element for this tree</div>
2083
Returns the underlying Element for this tree <div class="mdetail-params">
2084
<strong>Parameters:</strong>
2085
<ul><li>None.</li> </ul>
2086
<strong>Returns:</strong>
2088
<li><code>Ext.Element</code><div class="sub-desc">The Element</div></li>
2094
<td class="msource">TreePanel</td>
2096
<tr class="method-row inherited expandable">
2097
<td class="micon"><a class="exi" href="#expand"> </a></td>
2099
<a id="Ext.tree.TreePanel-getXType"></a>
2100
<b>getXType</b>() : String <div class="mdesc">
2101
<div class="short">Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
2102
available xtypes, see the Ex...</div>
2104
Gets the xtype for this component as registered with <a ext:cls="Ext.ComponentMgr" href="output/Ext.ComponentMgr.html">Ext.ComponentMgr</a>. For a list of all
2105
available xtypes, see the <a ext:cls="Ext.Component" href="output/Ext.Component.html">Ext.Component</a> header. Example usage:
2106
<pre><code>var t = <b>new</b> Ext.form.TextField();
2107
alert(t.getXType()); // alerts <em>'textfield'</em></code></pre> <div class="mdetail-params">
2108
<strong>Parameters:</strong>
2109
<ul><li>None.</li> </ul>
2110
<strong>Returns:</strong>
2112
<li><code>String</code><div class="sub-desc">The xtype</div></li>
2118
<td class="msource"><a ext:cls="Ext.Component" ext:member="#getXType" href="output/Ext.Component.html#getXType">Component</a></td>
2120
<tr class="method-row inherited alt expandable">
2121
<td class="micon"><a class="exi" href="#expand"> </a></td>
2123
<a id="Ext.tree.TreePanel-getXTypes"></a>
2124
<b>getXTypes</b>() : String <div class="mdesc">
2125
<div class="short">Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all
2126
available xtypes, see the Ext...</div>
2128
<p>Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all
2129
available xtypes, see the <a ext:cls="Ext.Component" href="output/Ext.Component.html">Ext.Component</a> header.</p>
2130
<p><b>If using your own subclasses, be aware that a Component must register its own xtype
2131
to participate in determination of inherited xtypes.</b></p>
2132
<p>Example usage:</p>
2134
var t = new Ext.form.TextField();
2135
alert(t.getXTypes()); // alerts 'component/box/field/textfield'</pre></code> <div class="mdetail-params">
2136
<strong>Parameters:</strong>
2137
<ul><li>None.</li> </ul>
2138
<strong>Returns:</strong>
2140
<li><code>String</code><div class="sub-desc">The xtype hierarchy string</div></li>
2146
<td class="msource"><a ext:cls="Ext.Component" ext:member="#getXTypes" href="output/Ext.Component.html#getXTypes">Component</a></td>
2148
<tr class="method-row inherited expandable">
2149
<td class="micon"><a class="exi" href="#expand"> </a></td>
2151
<a id="Ext.tree.TreePanel-hasListener"></a>
2152
<b>hasListener</b>( <code>String eventName</code> ) : Boolean <div class="mdesc">
2153
<div class="short">Checks to see if this object has any listeners for a specified event</div>
2155
Checks to see if this object has any listeners for a specified event <div class="mdetail-params">
2156
<strong>Parameters:</strong>
2157
<ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li> </ul>
2158
<strong>Returns:</strong>
2160
<li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li>
2166
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td>
2168
<tr class="method-row inherited alt expandable">
2169
<td class="micon"><a class="exi" href="#expand"> </a></td>
2171
<a id="Ext.tree.TreePanel-hide"></a>
2172
<b>hide</b>() : Ext.Component <div class="mdesc">
2173
<div class="short">Hide this component.</div>
2175
Hide this component. <div class="mdetail-params">
2176
<strong>Parameters:</strong>
2177
<ul><li>None.</li> </ul>
2178
<strong>Returns:</strong>
2180
<li><code>Ext.Component</code><div class="sub-desc">this</div></li>
2186
<td class="msource"><a ext:cls="Ext.Component" ext:member="#hide" href="output/Ext.Component.html#hide">Component</a></td>
2188
<tr class="method-row inherited expandable">
2189
<td class="micon"><a class="exi" href="#expand"> </a></td>
2191
<a id="Ext.tree.TreePanel-isVisible"></a>
2192
<b>isVisible</b>() : Boolean <div class="mdesc">
2193
<div class="short">Returns true if this component is visible.</div>
2195
Returns true if this component is visible. <div class="mdetail-params">
2196
<strong>Parameters:</strong>
2197
<ul><li>None.</li> </ul>
2198
<strong>Returns:</strong>
2200
<li><code>Boolean</code><div class="sub-desc">True if this component is visible, false otherwise.</div></li>
2206
<td class="msource"><a ext:cls="Ext.Component" ext:member="#isVisible" href="output/Ext.Component.html#isVisible">Component</a></td>
2208
<tr class="method-row inherited alt expandable">
2209
<td class="micon"><a class="exi" href="#expand"> </a></td>
2211
<a id="Ext.tree.TreePanel-isXType"></a>
2212
<b>isXType</b>( <code>String xtype</code>, <span class="optional" title="Optional">[<code>Boolean shallow</code>]</span> ) : Boolean <div class="mdesc">
2213
<div class="short">Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended
2216
<p>Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended
2217
from the xtype (default) or whether it is directly of the xtype specified (shallow = true).</p>
2218
<p><b>If using your own subclasses, be aware that a Component must register its own xtype
2219
to participate in determination of inherited xtypes.</b></p>
2220
<p>For a list of all available xtypes, see the <a ext:cls="Ext.Component" href="output/Ext.Component.html">Ext.Component</a> header.</p>
2221
<p>Example usage:</p>
2222
<pre><code>var t = <b>new</b> Ext.form.TextField();
2223
<b>var</b> isText = t.isXType(<em>'textfield'</em>); <i>// true</i>
2224
<b>var</b> isBoxSubclass = t.isXType(<em>'box'</em>); <i>// true, descended from BoxComponent</i>
2225
<b>var</b> isBoxInstance = t.isXType(<em>'box'</em>, true); // false, not a direct BoxComponent instance</code></pre> <div class="mdetail-params">
2226
<strong>Parameters:</strong>
2227
<ul><li><code>xtype</code> : String<div class="sub-desc">The xtype to check for this Component</div></li><li><code>shallow</code> : Boolean<div class="sub-desc">(optional) False to check whether this Component is descended from the xtype (this is
2228
the default), or true to check whether this Component is directly of the specified xtype.</div></li> </ul>
2229
<strong>Returns:</strong>
2231
<li><code>Boolean</code><div class="sub-desc">True if this component descends from the specified xtype, false otherwise.</div></li>
2237
<td class="msource"><a ext:cls="Ext.Component" ext:member="#isXType" href="output/Ext.Component.html#isXType">Component</a></td>
2239
<tr class="method-row inherited expandable">
2240
<td class="micon"><a class="exi" href="#expand"> </a></td>
2242
<a id="Ext.tree.TreePanel-on"></a>
2243
<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">
2244
<div class="short">Appends an event handler to this element (shorthand for addListener)</div>
2246
Appends an event handler to this element (shorthand for addListener) <div class="mdetail-params">
2247
<strong>Parameters:</strong>
2248
<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
2249
function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li> </ul>
2250
<strong>Returns:</strong>
2252
<li><code>void</code></li>
2258
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td>
2260
<tr class="method-row inherited alt expandable">
2261
<td class="micon"><a class="exi" href="#expand"> </a></td>
2263
<a id="Ext.tree.TreePanel-purgeListeners"></a>
2264
<b>purgeListeners</b>() : void <div class="mdesc">
2265
<div class="short">Removes all listeners for this object</div>
2267
Removes all listeners for this object <div class="mdetail-params">
2268
<strong>Parameters:</strong>
2269
<ul><li>None.</li> </ul>
2270
<strong>Returns:</strong>
2272
<li><code>void</code></li>
2278
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td>
2280
<tr class="method-row inherited expandable">
2281
<td class="micon"><a class="exi" href="#expand"> </a></td>
2283
<a id="Ext.tree.TreePanel-relayEvents"></a>
2284
<b>relayEvents</b>( <code>Object o</code>, <code>Array events</code> ) : void <div class="mdesc">
2285
<div class="short">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.</div>
2287
Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>. <div class="mdetail-params">
2288
<strong>Parameters:</strong>
2289
<ul><li><code>o</code> : Object<div class="sub-desc">The Observable whose events this object is to relay.</div></li><li><code>events</code> : Array<div class="sub-desc">Array of event names to relay.</div></li> </ul>
2290
<strong>Returns:</strong>
2292
<li><code>void</code></li>
2298
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#relayEvents" href="output/Ext.util.Observable.html#relayEvents">Observable</a></td>
2300
<tr class="method-row inherited alt expandable">
2301
<td class="micon"><a class="exi" href="#expand"> </a></td>
2303
<a id="Ext.tree.TreePanel-removeClass"></a>
2304
<b>removeClass</b>( <code>string cls</code> ) : void <div class="mdesc">
2305
<div class="short">Removes a CSS class from the component's underlying element.</div>
2307
Removes a CSS class from the component's underlying element. <div class="mdetail-params">
2308
<strong>Parameters:</strong>
2309
<ul><li><code>cls</code> : string<div class="sub-desc">The CSS class name to remove</div></li> </ul>
2310
<strong>Returns:</strong>
2312
<li><code>void</code></li>
2318
<td class="msource"><a ext:cls="Ext.Component" ext:member="#removeClass" href="output/Ext.Component.html#removeClass">Component</a></td>
2320
<tr class="method-row inherited expandable">
2321
<td class="micon"><a class="exi" href="#expand"> </a></td>
2323
<a id="Ext.tree.TreePanel-removeListener"></a>
2324
<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">
2325
<div class="short">Removes a listener</div>
2327
Removes a listener <div class="mdetail-params">
2328
<strong>Parameters:</strong>
2329
<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>
2330
<strong>Returns:</strong>
2332
<li><code>void</code></li>
2338
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td>
2340
<tr class="method-row inherited alt expandable">
2341
<td class="micon"><a class="exi" href="#expand"> </a></td>
2343
<a id="Ext.tree.TreePanel-render"></a>
2344
<b>render</b>( <span class="optional" title="Optional">[<code>Element/HTMLElement/String container</code>]</span>, <span class="optional" title="Optional">[<code>String/Number position</code>]</span> ) : void <div class="mdesc">
2345
<div class="short">Render this Component into the passed HTML element.
2346
If you are using a Container object to house this Component, then...</div>
2348
<p>Render this Component into the passed HTML element.</p>
2349
<p><b>If you are using a <a ext:cls="Ext.Container" href="output/Ext.Container.html">Container</a> object to house this Component, then
2350
do not use the render method.</b></p>
2351
<p>A Container's child Components are rendered by that Container's
2352
<a ext:cls="Ext.Container" ext:member="layout" href="output/Ext.Container.html#layout">layout</a> manager when the Container is first rendered.</p>
2353
<p>Certain layout managers allow dynamic addition of child components. Those that do
2354
include <a ext:cls="Ext.layout.CardLayout" href="output/Ext.layout.CardLayout.html">Ext.layout.CardLayout</a>, <a ext:cls="Ext.layout.AnchorLayout" href="output/Ext.layout.AnchorLayout.html">Ext.layout.AnchorLayout</a>,
2355
<a ext:cls="Ext.layout.FormLayout" href="output/Ext.layout.FormLayout.html">Ext.layout.FormLayout</a>, <a ext:cls="Ext.layout.TableLayout" href="output/Ext.layout.TableLayout.html">Ext.layout.TableLayout</a>.</p>
2356
<p>If the Container is already rendered when a new child Component is added, you may need to call
2357
the Container's <a ext:cls="Ext.Container" ext:member="doLayout" href="output/Ext.Container.html#doLayout">doLayout</a> to refresh the view which causes any
2358
unrendered child Components to be rendered. This is required so that you can add multiple
2359
child components if needed while only refreshing the layout once.</p>
2360
<p>When creating complex UIs, it is important to remember that sizing and positioning
2361
of child items is the responsibility of the Container's <a ext:cls="Ext.Container" ext:member="layout" href="output/Ext.Container.html#layout">layout</a> manager.
2362
If you expect child items to be sized in response to user interactions, you must
2363
configure the Container with a layout manager which creates and manages the type of layout you
2365
<p><b>Omitting the Container's <a ext:cls="Ext.Container" ext:member="layout" href="output/Ext.Container.html#layout">layout</a> config means that a basic
2366
layout manager is used which does nothing but render child components sequentially into the
2367
Container. No sizing or positioning will be performed in this situation.</b></p> <div class="mdetail-params">
2368
<strong>Parameters:</strong>
2369
<ul><li><code>container</code> : Element/HTMLElement/String<div class="sub-desc">(optional) The element this Component should be
2370
rendered into. If it is being created from existing markup, this should be omitted.</div></li><li><code>position</code> : String/Number<div class="sub-desc">(optional) The element ID or DOM node index within the container <b>before</b>
2371
which this component will be inserted (defaults to appending to the end of the container)</div></li> </ul>
2372
<strong>Returns:</strong>
2374
<li><code>void</code></li>
2380
<td class="msource"><a ext:cls="Ext.Component" ext:member="#render" href="output/Ext.Component.html#render">Component</a></td>
2382
<tr class="method-row inherited expandable">
2383
<td class="micon"><a class="exi" href="#expand"> </a></td>
2385
<a id="Ext.tree.TreePanel-resumeEvents"></a>
2386
<b>resumeEvents</b>() : void <div class="mdesc">
2387
<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>
2389
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">
2390
<strong>Parameters:</strong>
2391
<ul><li>None.</li> </ul>
2392
<strong>Returns:</strong>
2394
<li><code>void</code></li>
2400
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td>
2402
<tr class="method-row alt expandable">
2403
<td class="micon"><a class="exi" href="#expand"> </a></td>
2405
<a id="Ext.tree.TreePanel-selectPath"></a>
2406
<b>selectPath</b>( <code>String path</code>, <span class="optional" title="Optional">[<code>String attr</code>]</span>, <span class="optional" title="Optional">[<code>Function callback</code>]</span> ) : void <div class="mdesc">
2407
<div class="short">Selects the node in this tree at the specified path. A path can be retrieved from a node with <a ext:cls="Ext.data.Node" ext:member="getPath" href="output/Ext.data.Node.html#getPath">Ext.data.Node.getPath</a></div>
2409
Selects the node in this tree at the specified path. A path can be retrieved from a node with <a ext:cls="Ext.data.Node" ext:member="getPath" href="output/Ext.data.Node.html#getPath">Ext.data.Node.getPath</a> <div class="mdetail-params">
2410
<strong>Parameters:</strong>
2411
<ul><li><code>path</code> : String<div class="sub-desc"></div></li><li><code>attr</code> : String<div class="sub-desc">(optional) The attribute used in the path (see <a ext:cls="Ext.data.Node" ext:member="getPath" href="output/Ext.data.Node.html#getPath">Ext.data.Node.getPath</a> for more info)</div></li><li><code>callback</code> : Function<div class="sub-desc">(optional) The callback to call when the selection is complete. The callback will be called with
2412
(bSuccess, oSelNode) where bSuccess is if the selection was successful and oSelNode is the selected node.</div></li> </ul>
2413
<strong>Returns:</strong>
2415
<li><code>void</code></li>
2421
<td class="msource">TreePanel</td>
2423
<tr class="method-row inherited expandable">
2424
<td class="micon"><a class="exi" href="#expand"> </a></td>
2426
<a id="Ext.tree.TreePanel-setHeight"></a>
2427
<b>setHeight</b>( <code>Number height</code> ) : Ext.BoxComponent <div class="mdesc">
2428
<div class="short">Sets the height of the component. This method fires the <a ext:cls="Ext.BoxComponent" ext:member="resize" href="output/Ext.BoxComponent.html#resize">resize</a> event.</div>
2430
Sets the height of the component. This method fires the <a ext:cls="Ext.BoxComponent" ext:member="resize" href="output/Ext.BoxComponent.html#resize">resize</a> event. <div class="mdetail-params">
2431
<strong>Parameters:</strong>
2432
<ul><li><code>height</code> : Number<div class="sub-desc">The new height to set. This may be one of:<div class="mdetail-params"><ul>
2433
<li>A Number specifying the new height in the <a ext:cls="Ext.BoxComponent" ext:member="getEl" href="output/Ext.BoxComponent.html#getEl">Element</a>'s <a ext:cls="Ext.Element" ext:member="defaultUnit" href="output/Ext.Element.html#defaultUnit">Ext.Element.defaultUnit</a>s (by default, pixels).</li>
2434
<li>A String used to set the CSS height style.</li>
2435
<li><i>undefined</i> to leave the height unchanged.</li>
2436
</ul></div></div></li> </ul>
2437
<strong>Returns:</strong>
2439
<li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li>
2445
<td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#setHeight" href="output/Ext.BoxComponent.html#setHeight">BoxComponent</a></td>
2447
<tr class="method-row inherited alt expandable">
2448
<td class="micon"><a class="exi" href="#expand"> </a></td>
2450
<a id="Ext.tree.TreePanel-setIconClass"></a>
2451
<b>setIconClass</b>( <code>String cls</code> ) : void <div class="mdesc">
2452
<div class="short">Sets the CSS class that provides the icon image for this panel. This method will replace any existing
2453
icon class if ...</div>
2455
Sets the CSS class that provides the icon image for this panel. This method will replace any existing
2456
icon class if one has already been set. <div class="mdetail-params">
2457
<strong>Parameters:</strong>
2458
<ul><li><code>cls</code> : String<div class="sub-desc">The new CSS class name</div></li> </ul>
2459
<strong>Returns:</strong>
2461
<li><code>void</code></li>
2467
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#setIconClass" href="output/Ext.Panel.html#setIconClass">Panel</a></td>
2469
<tr class="method-row inherited expandable">
2470
<td class="micon"><a class="exi" href="#expand"> </a></td>
2472
<a id="Ext.tree.TreePanel-setPagePosition"></a>
2473
<b>setPagePosition</b>( <code>Number x</code>, <code>Number y</code> ) : Ext.BoxComponent <div class="mdesc">
2474
<div class="short">Sets the page XY position of the component. To set the left and top instead, use setPosition.
2475
This method fires the ...</div>
2477
Sets the page XY position of the component. To set the left and top instead, use <a ext:cls="Ext.BoxComponent" ext:member="setPosition" href="output/Ext.BoxComponent.html#setPosition">setPosition</a>.
2478
This method fires the <a ext:cls="Ext.BoxComponent" ext:member="move" href="output/Ext.BoxComponent.html#move">move</a> event. <div class="mdetail-params">
2479
<strong>Parameters:</strong>
2480
<ul><li><code>x</code> : Number<div class="sub-desc">The new x position</div></li><li><code>y</code> : Number<div class="sub-desc">The new y position</div></li> </ul>
2481
<strong>Returns:</strong>
2483
<li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li>
2489
<td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#setPagePosition" href="output/Ext.BoxComponent.html#setPagePosition">BoxComponent</a></td>
2491
<tr class="method-row inherited alt expandable">
2492
<td class="micon"><a class="exi" href="#expand"> </a></td>
2494
<a id="Ext.tree.TreePanel-setPosition"></a>
2495
<b>setPosition</b>( <code>Number left</code>, <code>Number top</code> ) : Ext.BoxComponent <div class="mdesc">
2496
<div class="short">Sets the left and top of the component. To set the page XY position instead, use setPagePosition.
2497
This method fires ...</div>
2499
Sets the left and top of the component. To set the page XY position instead, use <a ext:cls="Ext.BoxComponent" ext:member="setPagePosition" href="output/Ext.BoxComponent.html#setPagePosition">setPagePosition</a>.
2500
This method fires the <a ext:cls="Ext.BoxComponent" ext:member="move" href="output/Ext.BoxComponent.html#move">move</a> event. <div class="mdetail-params">
2501
<strong>Parameters:</strong>
2502
<ul><li><code>left</code> : Number<div class="sub-desc">The new left</div></li><li><code>top</code> : Number<div class="sub-desc">The new top</div></li> </ul>
2503
<strong>Returns:</strong>
2505
<li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li>
2511
<td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#setPosition" href="output/Ext.BoxComponent.html#setPosition">BoxComponent</a></td>
2513
<tr class="method-row expandable">
2514
<td class="micon"><a class="exi" href="#expand"> </a></td>
2516
<a id="Ext.tree.TreePanel-setRootNode"></a>
2517
<b>setRootNode</b>( <code>Node node</code> ) : Node <div class="mdesc">
2518
<div class="short">Sets the root node for this tree during initialization.</div>
2520
Sets the root node for this tree during initialization. <div class="mdetail-params">
2521
<strong>Parameters:</strong>
2522
<ul><li><code>node</code> : Node<div class="sub-desc"></div></li> </ul>
2523
<strong>Returns:</strong>
2525
<li><code>Node</code></li>
2531
<td class="msource">TreePanel</td>
2533
<tr class="method-row inherited alt expandable">
2534
<td class="micon"><a class="exi" href="#expand"> </a></td>
2536
<a id="Ext.tree.TreePanel-setSize"></a>
2537
<b>setSize</b>( <code>Mixed width</code>, <code>Mixed height</code> ) : Ext.BoxComponent <div class="mdesc">
2538
<div class="short">Sets the width and height of this BoxComponent. This method fires the resize event. This method can accept
2541
Sets the width and height of this BoxComponent. This method fires the <a ext:cls="Ext.BoxComponent" ext:member="resize" href="output/Ext.BoxComponent.html#resize">resize</a> event. This method can accept
2542
either width and height as separate arguments, or you can pass a size object like <code>{width:10, height:20}</code>. <div class="mdetail-params">
2543
<strong>Parameters:</strong>
2544
<ul><li><code>width</code> : Mixed<div class="sub-desc">The new width to set. This may be one of:<div class="mdetail-params"><ul>
2545
<li>A Number specifying the new width in the <a ext:cls="Ext.BoxComponent" ext:member="getEl" href="output/Ext.BoxComponent.html#getEl">Element</a>'s <a ext:cls="Ext.Element" ext:member="defaultUnit" href="output/Ext.Element.html#defaultUnit">Ext.Element.defaultUnit</a>s (by default, pixels).</li>
2546
<li>A String used to set the CSS width style.</li>
2547
<li>A size object in the format <code>{width: widthValue, height: heightValue}</code>.</li>
2548
<li><code>undefined</code> to leave the width unchanged.</li>
2549
</ul></div></div></li><li><code>height</code> : Mixed<div class="sub-desc">The new height to set (not required if a size object is passed as the first arg).
2550
This may be one of:<div class="mdetail-params"><ul>
2551
<li>A Number specifying the new height in the <a ext:cls="Ext.BoxComponent" ext:member="getEl" href="output/Ext.BoxComponent.html#getEl">Element</a>'s <a ext:cls="Ext.Element" ext:member="defaultUnit" href="output/Ext.Element.html#defaultUnit">Ext.Element.defaultUnit</a>s (by default, pixels).</li>
2552
<li>A String used to set the CSS height style. Animation may <b>not</b> be used.</li>
2553
<li><code>undefined</code> to leave the height unchanged.</li>
2554
</ul></div></div></li> </ul>
2555
<strong>Returns:</strong>
2557
<li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li>
2563
<td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#setSize" href="output/Ext.BoxComponent.html#setSize">BoxComponent</a></td>
2565
<tr class="method-row inherited expandable">
2566
<td class="micon"><a class="exi" href="#expand"> </a></td>
2568
<a id="Ext.tree.TreePanel-setTitle"></a>
2569
<b>setTitle</b>( <code>String title</code>, <span class="optional" title="Optional">[<code>String iconCls</code>]</span> ) : void <div class="mdesc">
2570
<div class="short">Sets the title text for the panel and optionally the icon class.
2571
In order to be able to set the title, a header eleme...</div>
2573
<p>Sets the title text for the panel and optionally the icon class.</p>
2574
<p>In order to be able to set the title, a header element must have been created
2575
for the Panel. This is triggered either by configuring the Panel with a non-blank title,
2576
or configuring it with <tt><b><a ext:cls="Ext.Panel" ext:member="header" href="output/Ext.Panel.html#header">header</a>: true</b></tt>.</p> <div class="mdetail-params">
2577
<strong>Parameters:</strong>
2578
<ul><li><code>title</code> : String<div class="sub-desc">The title text to set</div></li><li><code>iconCls</code> : String<div class="sub-desc">(optional) iconCls A user-defined CSS class that provides the icon image for this panel</div></li> </ul>
2579
<strong>Returns:</strong>
2581
<li><code>void</code></li>
2587
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#setTitle" href="output/Ext.Panel.html#setTitle">Panel</a></td>
2589
<tr class="method-row inherited alt expandable">
2590
<td class="micon"><a class="exi" href="#expand"> </a></td>
2592
<a id="Ext.tree.TreePanel-setVisible"></a>
2593
<b>setVisible</b>( <code>Boolean visible</code> ) : Ext.Component <div class="mdesc">
2594
<div class="short">Convenience function to hide or show this component by boolean.</div>
2596
Convenience function to hide or show this component by boolean. <div class="mdetail-params">
2597
<strong>Parameters:</strong>
2598
<ul><li><code>visible</code> : Boolean<div class="sub-desc">True to show, false to hide</div></li> </ul>
2599
<strong>Returns:</strong>
2601
<li><code>Ext.Component</code><div class="sub-desc">this</div></li>
2607
<td class="msource"><a ext:cls="Ext.Component" ext:member="#setVisible" href="output/Ext.Component.html#setVisible">Component</a></td>
2609
<tr class="method-row inherited expandable">
2610
<td class="micon"><a class="exi" href="#expand"> </a></td>
2612
<a id="Ext.tree.TreePanel-setWidth"></a>
2613
<b>setWidth</b>( <code>Number width</code> ) : Ext.BoxComponent <div class="mdesc">
2614
<div class="short">Sets the width of the component. This method fires the <a ext:cls="Ext.BoxComponent" ext:member="resize" href="output/Ext.BoxComponent.html#resize">resize</a> event.</div>
2616
Sets the width of the component. This method fires the <a ext:cls="Ext.BoxComponent" ext:member="resize" href="output/Ext.BoxComponent.html#resize">resize</a> event. <div class="mdetail-params">
2617
<strong>Parameters:</strong>
2618
<ul><li><code>width</code> : Number<div class="sub-desc">The new width to setThis may be one of:<div class="mdetail-params"><ul>
2619
<li>A Number specifying the new width in the <a ext:cls="Ext.BoxComponent" ext:member="getEl" href="output/Ext.BoxComponent.html#getEl">Element</a>'s <a ext:cls="Ext.Element" ext:member="defaultUnit" href="output/Ext.Element.html#defaultUnit">Ext.Element.defaultUnit</a>s (by default, pixels).</li>
2620
<li>A String used to set the CSS width style.</li>
2621
</ul></div></div></li> </ul>
2622
<strong>Returns:</strong>
2624
<li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li>
2630
<td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#setWidth" href="output/Ext.BoxComponent.html#setWidth">BoxComponent</a></td>
2632
<tr class="method-row inherited alt expandable">
2633
<td class="micon"><a class="exi" href="#expand"> </a></td>
2635
<a id="Ext.tree.TreePanel-show"></a>
2636
<b>show</b>() : Ext.Component <div class="mdesc">
2637
<div class="short">Show this component.</div>
2639
Show this component. <div class="mdetail-params">
2640
<strong>Parameters:</strong>
2641
<ul><li>None.</li> </ul>
2642
<strong>Returns:</strong>
2644
<li><code>Ext.Component</code><div class="sub-desc">this</div></li>
2650
<td class="msource"><a ext:cls="Ext.Component" ext:member="#show" href="output/Ext.Component.html#show">Component</a></td>
2652
<tr class="method-row inherited expandable">
2653
<td class="micon"><a class="exi" href="#expand"> </a></td>
2655
<a id="Ext.tree.TreePanel-suspendEvents"></a>
2656
<b>suspendEvents</b>() : void <div class="mdesc">
2657
<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>
2659
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">
2660
<strong>Parameters:</strong>
2661
<ul><li>None.</li> </ul>
2662
<strong>Returns:</strong>
2664
<li><code>void</code></li>
2670
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td>
2672
<tr class="method-row inherited alt expandable">
2673
<td class="micon"><a class="exi" href="#expand"> </a></td>
2675
<a id="Ext.tree.TreePanel-syncSize"></a>
2676
<b>syncSize</b>() : Ext.BoxComponent <div class="mdesc">
2677
<div class="short">Force the component's size to recalculate based on the underlying element's current height and width.</div>
2679
Force the component's size to recalculate based on the underlying element's current height and width. <div class="mdetail-params">
2680
<strong>Parameters:</strong>
2681
<ul><li>None.</li> </ul>
2682
<strong>Returns:</strong>
2684
<li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li>
2690
<td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#syncSize" href="output/Ext.BoxComponent.html#syncSize">BoxComponent</a></td>
2692
<tr class="method-row inherited expandable">
2693
<td class="micon"><a class="exi" href="#expand"> </a></td>
2695
<a id="Ext.tree.TreePanel-toggleCollapse"></a>
2696
<b>toggleCollapse</b>( <code>Boolean animate</code> ) : Ext.Panel <div class="mdesc">
2697
<div class="short">Shortcut for performing an <a ext:cls="Ext.Panel" ext:member="expand" href="output/Ext.Panel.html#expand">expand</a> or <a ext:cls="Ext.Panel" ext:member="collapse" href="output/Ext.Panel.html#collapse">collapse</a> based on the current state of the panel.</div>
2699
Shortcut for performing an <a ext:cls="Ext.Panel" ext:member="expand" href="output/Ext.Panel.html#expand">expand</a> or <a ext:cls="Ext.Panel" ext:member="collapse" href="output/Ext.Panel.html#collapse">collapse</a> based on the current state of the panel. <div class="mdetail-params">
2700
<strong>Parameters:</strong>
2701
<ul><li><code>animate</code> : Boolean<div class="sub-desc">True to animate the transition, else false (defaults to the value of the
2702
<a ext:cls="Ext.Panel" ext:member="animCollapse" href="output/Ext.Panel.html#animCollapse">animCollapse</a> panel config)</div></li> </ul>
2703
<strong>Returns:</strong>
2705
<li><code>Ext.Panel</code><div class="sub-desc">this</div></li>
2711
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#toggleCollapse" href="output/Ext.Panel.html#toggleCollapse">Panel</a></td>
2713
<tr class="method-row inherited alt expandable">
2714
<td class="micon"><a class="exi" href="#expand"> </a></td>
2716
<a id="Ext.tree.TreePanel-un"></a>
2717
<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">
2718
<div class="short">Removes a listener (shorthand for removeListener)</div>
2720
Removes a listener (shorthand for removeListener) <div class="mdetail-params">
2721
<strong>Parameters:</strong>
2722
<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>
2723
<strong>Returns:</strong>
2725
<li><code>void</code></li>
2731
<td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td>
2733
<tr class="method-row inherited expandable">
2734
<td class="micon"><a class="exi" href="#expand"> </a></td>
2736
<a id="Ext.tree.TreePanel-updateBox"></a>
2737
<b>updateBox</b>( <code>Object box</code> ) : Ext.BoxComponent <div class="mdesc">
2738
<div class="short">Sets the current box measurements of the component's underlying element.</div>
2740
Sets the current box measurements of the component's underlying element. <div class="mdetail-params">
2741
<strong>Parameters:</strong>
2742
<ul><li><code>box</code> : Object<div class="sub-desc">An object in the format {x, y, width, height}</div></li> </ul>
2743
<strong>Returns:</strong>
2745
<li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li>
2751
<td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#updateBox" href="output/Ext.BoxComponent.html#updateBox">BoxComponent</a></td>
2754
<a id="Ext.tree.TreePanel-events"></a>
2755
<h2>Public Events</h2>
2756
<table cellspacing="0" class="member-table">
2758
<th class="sig-header" colspan="2">Event</th>
2759
<th class="msource-header">Defined By</th>
2761
<tr class="event-row inherited expandable">
2762
<td class="micon"><a class="exi" href="#expand"> </a></td>
2764
<a id="Ext.tree.TreePanel-activate"></a>
2765
<b>activate</b> : ( <code>Ext.Panel p</code> ) <div class="mdesc">
2766
<div class="short">Fires after the Panel has been visually activated.
2767
Note that Panels do not directly support being activated, but some...</div>
2769
Fires after the Panel has been visually activated.
2770
Note that Panels do not directly support being activated, but some Panel subclasses
2771
do (like <a ext:cls="Ext.Window" href="output/Ext.Window.html">Ext.Window</a>). Panels which are child Components of a TabPanel fire the
2772
activate and deactivate events under the control of the TabPanel. <div class="mdetail-params">
2773
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
2774
<ul><li><code>p</code> : Ext.Panel<div class="sub-desc">The Panel that has been activated.</div></li> </ul>
2779
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#event-activate" href="output/Ext.Panel.html#event-activate">Panel</a></td>
2781
<tr class="event-row inherited alt expandable">
2782
<td class="micon"><a class="exi" href="#expand"> </a></td>
2784
<a id="Ext.tree.TreePanel-add"></a>
2785
<b>add</b> : ( <code>Ext.Container this</code>, <code>Ext.Component component</code>, <code>Number index</code> ) <div class="mdesc">
2786
<div class="short">Fires after any <a ext:cls="Ext.Component" href="output/Ext.Component.html">Ext.Component</a> is added or inserted into the container.</div>
2788
Fires after any <a ext:cls="Ext.Component" href="output/Ext.Component.html">Ext.Component</a> is added or inserted into the container. <div class="mdetail-params">
2789
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
2790
<ul><li><code>this</code> : Ext.Container<div class="sub-desc"></div></li><li><code>component</code> : Ext.Component<div class="sub-desc">The component that was added</div></li><li><code>index</code> : Number<div class="sub-desc">The index at which the component was added to the container's items collection</div></li> </ul>
2795
<td class="msource"><a ext:cls="Ext.Container" ext:member="#event-add" href="output/Ext.Container.html#event-add">Container</a></td>
2797
<tr class="event-row inherited expandable">
2798
<td class="micon"><a class="exi" href="#expand"> </a></td>
2800
<a id="Ext.tree.TreePanel-afterlayout"></a>
2801
<b>afterlayout</b> : ( <code>Ext.Container this</code>, <code>ContainerLayout layout</code> ) <div class="mdesc">
2802
<div class="short">Fires when the components in this container are arranged by the associated layout manager.</div>
2804
Fires when the components in this container are arranged by the associated layout manager. <div class="mdetail-params">
2805
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
2806
<ul><li><code>this</code> : Ext.Container<div class="sub-desc"></div></li><li><code>layout</code> : ContainerLayout<div class="sub-desc">The ContainerLayout implementation for this container</div></li> </ul>
2811
<td class="msource"><a ext:cls="Ext.Container" ext:member="#event-afterlayout" href="output/Ext.Container.html#event-afterlayout">Container</a></td>
2813
<tr class="event-row alt expandable">
2814
<td class="micon"><a class="exi" href="#expand"> </a></td>
2816
<a id="Ext.tree.TreePanel-append"></a>
2817
<b>append</b> : ( <code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code>, <code>Number index</code> ) <div class="mdesc">
2818
<div class="short">Fires when a new child node is appended to a node in this tree.</div>
2820
Fires when a new child node is appended to a node in this tree. <div class="mdetail-params">
2821
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
2822
<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>
2827
<td class="msource">TreePanel</td>
2829
<tr class="event-row inherited expandable">
2830
<td class="micon"><a class="exi" href="#expand"> </a></td>
2832
<a id="Ext.tree.TreePanel-beforeadd"></a>
2833
<b>beforeadd</b> : ( <code>Ext.Container this</code>, <code>Ext.Component component</code>, <code>Number index</code> ) <div class="mdesc">
2834
<div class="short">Fires before any <a ext:cls="Ext.Component" href="output/Ext.Component.html">Ext.Component</a> is added or inserted into the container.
2835
A handler can return false to cancel the add.</div>
2837
Fires before any <a ext:cls="Ext.Component" href="output/Ext.Component.html">Ext.Component</a> is added or inserted into the container.
2838
A handler can return false to cancel the add. <div class="mdetail-params">
2839
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
2840
<ul><li><code>this</code> : Ext.Container<div class="sub-desc"></div></li><li><code>component</code> : Ext.Component<div class="sub-desc">The component being added</div></li><li><code>index</code> : Number<div class="sub-desc">The index at which the component will be added to the container's items collection</div></li> </ul>
2845
<td class="msource"><a ext:cls="Ext.Container" ext:member="#event-beforeadd" href="output/Ext.Container.html#event-beforeadd">Container</a></td>
2847
<tr class="event-row alt expandable">
2848
<td class="micon"><a class="exi" href="#expand"> </a></td>
2850
<a id="Ext.tree.TreePanel-beforeappend"></a>
2851
<b>beforeappend</b> : ( <code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code> ) <div class="mdesc">
2852
<div class="short">Fires before a new child is appended to a node in this tree, return false to cancel the append.</div>
2854
Fires before a new child is appended to a node in this tree, return false to cancel the append. <div class="mdetail-params">
2855
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
2856
<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>
2861
<td class="msource">TreePanel</td>
2863
<tr class="event-row expandable">
2864
<td class="micon"><a class="exi" href="#expand"> </a></td>
2866
<a id="Ext.tree.TreePanel-beforechildrenrendered"></a>
2867
<b>beforechildrenrendered</b> : ( <code>Node node</code> ) <div class="mdesc">
2868
<div class="short">Fires right before the child nodes for a node are rendered</div>
2870
Fires right before the child nodes for a node are rendered <div class="mdetail-params">
2871
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
2872
<ul><li><code>node</code> : Node<div class="sub-desc">The node</div></li> </ul>
2877
<td class="msource">TreePanel</td>
2879
<tr class="event-row alt expandable">
2880
<td class="micon"><a class="exi" href="#expand"> </a></td>
2882
<a id="Ext.tree.TreePanel-beforeclick"></a>
2883
<b>beforeclick</b> : ( <code>Node node</code>, <code>Ext.EventObject e</code> ) <div class="mdesc">
2884
<div class="short">Fires before click processing on a node. Return false to cancel the default action.</div>
2886
Fires before click processing on a node. Return false to cancel the default action. <div class="mdetail-params">
2887
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
2888
<ul><li><code>node</code> : Node<div class="sub-desc">The node</div></li><li><code>e</code> : Ext.EventObject<div class="sub-desc">The event object</div></li> </ul>
2893
<td class="msource">TreePanel</td>
2895
<tr class="event-row inherited expandable">
2896
<td class="micon"><a class="exi" href="#expand"> </a></td>
2898
<a id="Ext.tree.TreePanel-beforeclose"></a>
2899
<b>beforeclose</b> : ( <code>Ext.Panel p</code> ) <div class="mdesc">
2900
<div class="short">Fires before the Panel is closed. Note that Panels do not directly support being closed, but some
2901
Panel subclasses d...</div>
2903
Fires before the Panel is closed. Note that Panels do not directly support being closed, but some
2904
Panel subclasses do (like <a ext:cls="Ext.Window" href="output/Ext.Window.html">Ext.Window</a>). This event only applies to such subclasses.
2905
A handler can return false to cancel the close. <div class="mdetail-params">
2906
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
2907
<ul><li><code>p</code> : Ext.Panel<div class="sub-desc">The Panel being closed.</div></li> </ul>
2912
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#event-beforeclose" href="output/Ext.Panel.html#event-beforeclose">Panel</a></td>
2914
<tr class="event-row inherited alt expandable">
2915
<td class="micon"><a class="exi" href="#expand"> </a></td>
2917
<a id="Ext.tree.TreePanel-beforecollapse"></a>
2918
<b>beforecollapse</b> : ( <code>Ext.Panel p</code>, <code>Boolean animate</code> ) <div class="mdesc">
2919
<div class="short">Fires before the Panel is collapsed. A handler can return false to cancel the collapse.</div>
2921
Fires before the Panel is collapsed. A handler can return false to cancel the collapse. <div class="mdetail-params">
2922
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
2923
<ul><li><code>p</code> : Ext.Panel<div class="sub-desc">the Panel being collapsed.</div></li><li><code>animate</code> : Boolean<div class="sub-desc">True if the collapse is animated, else false.</div></li> </ul>
2928
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#event-beforecollapse" href="output/Ext.Panel.html#event-beforecollapse">Panel</a></td>
2930
<tr class="event-row expandable">
2931
<td class="micon"><a class="exi" href="#expand"> </a></td>
2933
<a id="Ext.tree.TreePanel-beforecollapsenode"></a>
2934
<b>beforecollapsenode</b> : ( <code>Node node</code>, <code>Boolean deep</code>, <code>Boolean anim</code> ) <div class="mdesc">
2935
<div class="short">Fires before a node is collapsed, return false to cancel.</div>
2937
Fires before a node is collapsed, return false to cancel. <div class="mdetail-params">
2938
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
2939
<ul><li><code>node</code> : Node<div class="sub-desc">The node</div></li><li><code>deep</code> : Boolean<div class="sub-desc"></div></li><li><code>anim</code> : Boolean<div class="sub-desc"></div></li> </ul>
2944
<td class="msource">TreePanel</td>
2946
<tr class="event-row inherited alt expandable">
2947
<td class="micon"><a class="exi" href="#expand"> </a></td>
2949
<a id="Ext.tree.TreePanel-beforedestroy"></a>
2950
<b>beforedestroy</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
2951
<div class="short">Fires before the component is destroyed. Return false to stop the destroy.</div>
2953
Fires before the component is destroyed. Return false to stop the destroy. <div class="mdetail-params">
2954
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
2955
<ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
2960
<td class="msource"><a ext:cls="Ext.Component" ext:member="#event-beforedestroy" href="output/Ext.Component.html#event-beforedestroy">Component</a></td>
2962
<tr class="event-row inherited expandable">
2963
<td class="micon"><a class="exi" href="#expand"> </a></td>
2965
<a id="Ext.tree.TreePanel-beforeexpand"></a>
2966
<b>beforeexpand</b> : ( <code>Ext.Panel p</code>, <code>Boolean animate</code> ) <div class="mdesc">
2967
<div class="short">Fires before the Panel is expanded. A handler can return false to cancel the expand.</div>
2969
Fires before the Panel is expanded. A handler can return false to cancel the expand. <div class="mdetail-params">
2970
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
2971
<ul><li><code>p</code> : Ext.Panel<div class="sub-desc">The Panel being expanded.</div></li><li><code>animate</code> : Boolean<div class="sub-desc">True if the expand is animated, else false.</div></li> </ul>
2976
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#event-beforeexpand" href="output/Ext.Panel.html#event-beforeexpand">Panel</a></td>
2978
<tr class="event-row alt expandable">
2979
<td class="micon"><a class="exi" href="#expand"> </a></td>
2981
<a id="Ext.tree.TreePanel-beforeexpandnode"></a>
2982
<b>beforeexpandnode</b> : ( <code>Node node</code>, <code>Boolean deep</code>, <code>Boolean anim</code> ) <div class="mdesc">
2983
<div class="short">Fires before a node is expanded, return false to cancel.</div>
2985
Fires before a node is expanded, return false to cancel. <div class="mdetail-params">
2986
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
2987
<ul><li><code>node</code> : Node<div class="sub-desc">The node</div></li><li><code>deep</code> : Boolean<div class="sub-desc"></div></li><li><code>anim</code> : Boolean<div class="sub-desc"></div></li> </ul>
2992
<td class="msource">TreePanel</td>
2994
<tr class="event-row inherited expandable">
2995
<td class="micon"><a class="exi" href="#expand"> </a></td>
2997
<a id="Ext.tree.TreePanel-beforehide"></a>
2998
<b>beforehide</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
2999
<div class="short">Fires before the component is hidden. Return false to stop the hide.</div>
3001
Fires before the component is hidden. Return false to stop the hide. <div class="mdetail-params">
3002
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3003
<ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
3008
<td class="msource"><a ext:cls="Ext.Component" ext:member="#event-beforehide" href="output/Ext.Component.html#event-beforehide">Component</a></td>
3010
<tr class="event-row alt expandable">
3011
<td class="micon"><a class="exi" href="#expand"> </a></td>
3013
<a id="Ext.tree.TreePanel-beforeinsert"></a>
3014
<b>beforeinsert</b> : ( <code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code>, <code>Node refNode</code> ) <div class="mdesc">
3015
<div class="short">Fires before a new child is inserted in a node in this tree, return false to cancel the insert.</div>
3017
Fires before a new child is inserted in a node in this tree, return false to cancel the insert. <div class="mdetail-params">
3018
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3019
<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>
3024
<td class="msource">TreePanel</td>
3026
<tr class="event-row expandable">
3027
<td class="micon"><a class="exi" href="#expand"> </a></td>
3029
<a id="Ext.tree.TreePanel-beforeload"></a>
3030
<b>beforeload</b> : ( <code>Node node</code> ) <div class="mdesc">
3031
<div class="short">Fires before a node is loaded, return false to cancel</div>
3033
Fires before a node is loaded, return false to cancel <div class="mdetail-params">
3034
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3035
<ul><li><code>node</code> : Node<div class="sub-desc">The node being loaded</div></li> </ul>
3040
<td class="msource">TreePanel</td>
3042
<tr class="event-row alt expandable">
3043
<td class="micon"><a class="exi" href="#expand"> </a></td>
3045
<a id="Ext.tree.TreePanel-beforemovenode"></a>
3046
<b>beforemovenode</b> : ( <code>Tree tree</code>, <code>Node node</code>, <code>Node oldParent</code>, <code>Node newParent</code>, <code>Number index</code> ) <div class="mdesc">
3047
<div class="short">Fires before a node is moved to a new location in the tree. Return false to cancel the move.</div>
3049
Fires before a node is moved to a new location in the tree. Return false to cancel the move. <div class="mdetail-params">
3050
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3051
<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>
3056
<td class="msource">TreePanel</td>
3058
<tr class="event-row expandable">
3059
<td class="micon"><a class="exi" href="#expand"> </a></td>
3061
<a id="Ext.tree.TreePanel-beforenodedrop"></a>
3062
<b>beforenodedrop</b> : ( <code>Object dropEvent</code> ) <div class="mdesc">
3063
<div class="short">Fires when a DD object is dropped on a node in this tree for preprocessing. Return false to cancel the drop. The drop...</div>
3065
Fires when a DD object is dropped on a node in this tree for preprocessing. Return false to cancel the drop. The dropEvent
3066
passed to handlers has the following properties:<br />
3067
<ul style="padding:5px;padding-left:16px;">
3068
<li>tree - The TreePanel</li>
3069
<li>target - The node being targeted for the drop</li>
3070
<li>data - The drag data from the drag source</li>
3071
<li>point - The point of the drop - append, above or below</li>
3072
<li>source - The drag source</li>
3073
<li>rawEvent - Raw mouse event</li>
3074
<li>dropNode - Drop node(s) provided by the source <b>OR</b> you can supply node(s)
3075
to be inserted by setting them on this object.</li>
3076
<li>cancel - Set this to true to cancel the drop.</li>
3077
<li>dropStatus - If the default drop action is cancelled but the drop is valid, setting this to true
3078
will prevent the animated "repair" from appearing.</li>
3079
</ul> <div class="mdetail-params">
3080
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3081
<ul><li><code>dropEvent</code> : Object<div class="sub-desc"></div></li> </ul>
3086
<td class="msource">TreePanel</td>
3088
<tr class="event-row alt expandable">
3089
<td class="micon"><a class="exi" href="#expand"> </a></td>
3091
<a id="Ext.tree.TreePanel-beforeremove"></a>
3092
<b>beforeremove</b> : ( <code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code> ) <div class="mdesc">
3093
<div class="short">Fires before a child is removed from a node in this tree, return false to cancel the remove.</div>
3095
Fires before a child is removed from a node in this tree, return false to cancel the remove. <div class="mdetail-params">
3096
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3097
<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>
3102
<td class="msource">TreePanel</td>
3104
<tr class="event-row inherited expandable">
3105
<td class="micon"><a class="exi" href="#expand"> </a></td>
3107
<a id="Ext.tree.TreePanel-beforerender"></a>
3108
<b>beforerender</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
3109
<div class="short">Fires before the component is rendered. Return false to stop the render.</div>
3111
Fires before the component is rendered. Return false to stop the render. <div class="mdetail-params">
3112
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3113
<ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
3118
<td class="msource"><a ext:cls="Ext.Component" ext:member="#event-beforerender" href="output/Ext.Component.html#event-beforerender">Component</a></td>
3120
<tr class="event-row inherited alt expandable">
3121
<td class="micon"><a class="exi" href="#expand"> </a></td>
3123
<a id="Ext.tree.TreePanel-beforeshow"></a>
3124
<b>beforeshow</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
3125
<div class="short">Fires before the component is shown. Return false to stop the show.</div>
3127
Fires before the component is shown. Return false to stop the show. <div class="mdetail-params">
3128
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3129
<ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
3134
<td class="msource"><a ext:cls="Ext.Component" ext:member="#event-beforeshow" href="output/Ext.Component.html#event-beforeshow">Component</a></td>
3136
<tr class="event-row inherited expandable">
3137
<td class="micon"><a class="exi" href="#expand"> </a></td>
3139
<a id="Ext.tree.TreePanel-beforestaterestore"></a>
3140
<b>beforestaterestore</b> : ( <code>Ext.Component this</code>, <code>Object state</code> ) <div class="mdesc">
3141
<div class="short">Fires before the state of the component is restored. Return false to stop the restore.</div>
3143
Fires before the state of the component is restored. Return false to stop the restore. <div class="mdetail-params">
3144
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3145
<ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>state</code> : Object<div class="sub-desc">The hash of state values</div></li> </ul>
3150
<td class="msource"><a ext:cls="Ext.Component" ext:member="#event-beforestaterestore" href="output/Ext.Component.html#event-beforestaterestore">Component</a></td>
3152
<tr class="event-row inherited alt expandable">
3153
<td class="micon"><a class="exi" href="#expand"> </a></td>
3155
<a id="Ext.tree.TreePanel-beforestatesave"></a>
3156
<b>beforestatesave</b> : ( <code>Ext.Component this</code>, <code>Object state</code> ) <div class="mdesc">
3157
<div class="short">Fires before the state of the component is saved to the configured state provider. Return false to stop the save.</div>
3159
Fires before the state of the component is saved to the configured state provider. Return false to stop the save. <div class="mdetail-params">
3160
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3161
<ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>state</code> : Object<div class="sub-desc">The hash of state values</div></li> </ul>
3166
<td class="msource"><a ext:cls="Ext.Component" ext:member="#event-beforestatesave" href="output/Ext.Component.html#event-beforestatesave">Component</a></td>
3168
<tr class="event-row inherited expandable">
3169
<td class="micon"><a class="exi" href="#expand"> </a></td>
3171
<a id="Ext.tree.TreePanel-bodyresize"></a>
3172
<b>bodyresize</b> : ( <code>Ext.Panel p</code>, <code>Number width</code>, <code>Number height</code> ) <div class="mdesc">
3173
<div class="short">Fires after the Panel has been resized.</div>
3175
Fires after the Panel has been resized. <div class="mdetail-params">
3176
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3177
<ul><li><code>p</code> : Ext.Panel<div class="sub-desc">the Panel which has been resized.</div></li><li><code>width</code> : Number<div class="sub-desc">The Panel's new width.</div></li><li><code>height</code> : Number<div class="sub-desc">The Panel's new height.</div></li> </ul>
3182
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#event-bodyresize" href="output/Ext.Panel.html#event-bodyresize">Panel</a></td>
3184
<tr class="event-row alt expandable">
3185
<td class="micon"><a class="exi" href="#expand"> </a></td>
3187
<a id="Ext.tree.TreePanel-checkchange"></a>
3188
<b>checkchange</b> : ( <code>Node this</code>, <code>Boolean checked</code> ) <div class="mdesc">
3189
<div class="short">Fires when a node with a checkbox's checked property changes</div>
3191
Fires when a node with a checkbox's checked property changes <div class="mdetail-params">
3192
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3193
<ul><li><code>this</code> : Node<div class="sub-desc">This node</div></li><li><code>checked</code> : Boolean<div class="sub-desc"></div></li> </ul>
3198
<td class="msource">TreePanel</td>
3200
<tr class="event-row expandable">
3201
<td class="micon"><a class="exi" href="#expand"> </a></td>
3203
<a id="Ext.tree.TreePanel-click"></a>
3204
<b>click</b> : ( <code>Node node</code>, <code>Ext.EventObject e</code> ) <div class="mdesc">
3205
<div class="short">Fires when a node is clicked</div>
3207
Fires when a node is clicked <div class="mdetail-params">
3208
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3209
<ul><li><code>node</code> : Node<div class="sub-desc">The node</div></li><li><code>e</code> : Ext.EventObject<div class="sub-desc">The event object</div></li> </ul>
3214
<td class="msource">TreePanel</td>
3216
<tr class="event-row inherited alt expandable">
3217
<td class="micon"><a class="exi" href="#expand"> </a></td>
3219
<a id="Ext.tree.TreePanel-close"></a>
3220
<b>close</b> : ( <code>Ext.Panel p</code> ) <div class="mdesc">
3221
<div class="short">Fires after the Panel is closed. Note that Panels do not directly support being closed, but some
3222
Panel subclasses do...</div>
3224
Fires after the Panel is closed. Note that Panels do not directly support being closed, but some
3225
Panel subclasses do (like <a ext:cls="Ext.Window" href="output/Ext.Window.html">Ext.Window</a>). <div class="mdetail-params">
3226
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3227
<ul><li><code>p</code> : Ext.Panel<div class="sub-desc">The Panel that has been closed.</div></li> </ul>
3232
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#event-close" href="output/Ext.Panel.html#event-close">Panel</a></td>
3234
<tr class="event-row inherited expandable">
3235
<td class="micon"><a class="exi" href="#expand"> </a></td>
3237
<a id="Ext.tree.TreePanel-collapse"></a>
3238
<b>collapse</b> : ( <code>Ext.Panel p</code> ) <div class="mdesc">
3239
<div class="short">Fires after the Panel has been collapsed.</div>
3241
Fires after the Panel has been collapsed. <div class="mdetail-params">
3242
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3243
<ul><li><code>p</code> : Ext.Panel<div class="sub-desc">the Panel that has been collapsed.</div></li> </ul>
3248
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#event-collapse" href="output/Ext.Panel.html#event-collapse">Panel</a></td>
3250
<tr class="event-row alt expandable">
3251
<td class="micon"><a class="exi" href="#expand"> </a></td>
3253
<a id="Ext.tree.TreePanel-collapsenode"></a>
3254
<b>collapsenode</b> : ( <code>Node node</code> ) <div class="mdesc">
3255
<div class="short">Fires when a node is collapsed</div>
3257
Fires when a node is collapsed <div class="mdetail-params">
3258
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3259
<ul><li><code>node</code> : Node<div class="sub-desc">The node</div></li> </ul>
3264
<td class="msource">TreePanel</td>
3266
<tr class="event-row expandable">
3267
<td class="micon"><a class="exi" href="#expand"> </a></td>
3269
<a id="Ext.tree.TreePanel-contextmenu"></a>
3270
<b>contextmenu</b> : ( <code>Node node</code>, <code>Ext.EventObject e</code> ) <div class="mdesc">
3271
<div class="short">Fires when a node is right clicked. To display a context menu in response to this
3272
event, first create a Menu object (...</div>
3274
Fires when a node is right clicked. To display a context menu in response to this
3275
event, first create a Menu object (see <a ext:cls="Ext.menu.Menu" href="output/Ext.menu.Menu.html">Ext.menu.Menu</a> for details), then add
3276
a handler for this event:<code><pre>new Ext.tree.TreePanel({
3277
title: 'My TreePanel',
3278
root: new Ext.tree.AsyncTreeNode({
3281
{ text: 'Child node 1', leaf: true },
3282
{ text: 'Child node 2', leaf: true }
3285
contextMenu: new Ext.menu.Menu({
3291
itemclick: function(item) {
3294
var n = item.parentMenu.contextNode;
3304
contextmenu: function(node, e) {
3305
// Register the context node with the menu so that a Menu Item's handler function can access
3306
// it via its <a ext:cls="Ext.menu.BaseItem" ext:member="parentMenu" href="output/Ext.menu.BaseItem.html#parentMenu">parentMenu</a> property.
3308
var c = node.getOwnerTree().contextMenu;
3309
c.contextNode = node;
3310
c.showAt(e.getXY());
3313
});</pre></code> <div class="mdetail-params">
3314
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3315
<ul><li><code>node</code> : Node<div class="sub-desc">The node</div></li><li><code>e</code> : Ext.EventObject<div class="sub-desc">The event object</div></li> </ul>
3320
<td class="msource">TreePanel</td>
3322
<tr class="event-row alt expandable">
3323
<td class="micon"><a class="exi" href="#expand"> </a></td>
3325
<a id="Ext.tree.TreePanel-dblclick"></a>
3326
<b>dblclick</b> : ( <code>Node node</code>, <code>Ext.EventObject e</code> ) <div class="mdesc">
3327
<div class="short">Fires when a node is double clicked</div>
3329
Fires when a node is double clicked <div class="mdetail-params">
3330
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3331
<ul><li><code>node</code> : Node<div class="sub-desc">The node</div></li><li><code>e</code> : Ext.EventObject<div class="sub-desc">The event object</div></li> </ul>
3336
<td class="msource">TreePanel</td>
3338
<tr class="event-row inherited expandable">
3339
<td class="micon"><a class="exi" href="#expand"> </a></td>
3341
<a id="Ext.tree.TreePanel-deactivate"></a>
3342
<b>deactivate</b> : ( <code>Ext.Panel p</code> ) <div class="mdesc">
3343
<div class="short">Fires after the Panel has been visually deactivated.
3344
Note that Panels do not directly support being deactivated, but ...</div>
3346
Fires after the Panel has been visually deactivated.
3347
Note that Panels do not directly support being deactivated, but some Panel subclasses
3348
do (like <a ext:cls="Ext.Window" href="output/Ext.Window.html">Ext.Window</a>). Panels which are child Components of a TabPanel fire the
3349
activate and deactivate events under the control of the TabPanel. <div class="mdetail-params">
3350
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3351
<ul><li><code>p</code> : Ext.Panel<div class="sub-desc">The Panel that has been deactivated.</div></li> </ul>
3356
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#event-deactivate" href="output/Ext.Panel.html#event-deactivate">Panel</a></td>
3358
<tr class="event-row inherited alt expandable">
3359
<td class="micon"><a class="exi" href="#expand"> </a></td>
3361
<a id="Ext.tree.TreePanel-destroy"></a>
3362
<b>destroy</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
3363
<div class="short">Fires after the component is destroyed.</div>
3365
Fires after the component is destroyed. <div class="mdetail-params">
3366
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3367
<ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
3372
<td class="msource"><a ext:cls="Ext.Component" ext:member="#event-destroy" href="output/Ext.Component.html#event-destroy">Component</a></td>
3374
<tr class="event-row inherited expandable">
3375
<td class="micon"><a class="exi" href="#expand"> </a></td>
3377
<a id="Ext.tree.TreePanel-disable"></a>
3378
<b>disable</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
3379
<div class="short">Fires after the component is disabled.</div>
3381
Fires after the component is disabled. <div class="mdetail-params">
3382
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3383
<ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
3388
<td class="msource"><a ext:cls="Ext.Component" ext:member="#event-disable" href="output/Ext.Component.html#event-disable">Component</a></td>
3390
<tr class="event-row alt expandable">
3391
<td class="micon"><a class="exi" href="#expand"> </a></td>
3393
<a id="Ext.tree.TreePanel-disabledchange"></a>
3394
<b>disabledchange</b> : ( <code>Node node</code>, <code>Boolean disabled</code> ) <div class="mdesc">
3395
<div class="short">Fires when the disabled status of a node changes</div>
3397
Fires when the disabled status of a node changes <div class="mdetail-params">
3398
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3399
<ul><li><code>node</code> : Node<div class="sub-desc">The node</div></li><li><code>disabled</code> : Boolean<div class="sub-desc"></div></li> </ul>
3404
<td class="msource">TreePanel</td>
3406
<tr class="event-row expandable">
3407
<td class="micon"><a class="exi" href="#expand"> </a></td>
3409
<a id="Ext.tree.TreePanel-dragdrop"></a>
3410
<b>dragdrop</b> : ( <code>Ext.tree.TreePanel this</code>, <code>Ext.tree.TreeNode node</code>, <code>DD dd</code>, <code>event e</code> ) <div class="mdesc">
3411
<div class="short">Fires when a dragged node is dropped on a valid DD target</div>
3413
Fires when a dragged node is dropped on a valid DD target <div class="mdetail-params">
3414
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3415
<ul><li><code>this</code> : Ext.tree.TreePanel<div class="sub-desc"></div></li><li><code>node</code> : Ext.tree.TreeNode<div class="sub-desc"></div></li><li><code>dd</code> : DD<div class="sub-desc">The dd it was dropped on</div></li><li><code>e</code> : event<div class="sub-desc">The raw browser event</div></li> </ul>
3420
<td class="msource">TreePanel</td>
3422
<tr class="event-row inherited alt expandable">
3423
<td class="micon"><a class="exi" href="#expand"> </a></td>
3425
<a id="Ext.tree.TreePanel-enable"></a>
3426
<b>enable</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
3427
<div class="short">Fires after the component is enabled.</div>
3429
Fires after the component is enabled. <div class="mdetail-params">
3430
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3431
<ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
3436
<td class="msource"><a ext:cls="Ext.Component" ext:member="#event-enable" href="output/Ext.Component.html#event-enable">Component</a></td>
3438
<tr class="event-row expandable">
3439
<td class="micon"><a class="exi" href="#expand"> </a></td>
3441
<a id="Ext.tree.TreePanel-enddrag"></a>
3442
<b>enddrag</b> : ( <code>Ext.tree.TreePanel this</code>, <code>Ext.tree.TreeNode node</code>, <code>event e</code> ) <div class="mdesc">
3443
<div class="short">Fires when a drag operation is complete</div>
3445
Fires when a drag operation is complete <div class="mdetail-params">
3446
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3447
<ul><li><code>this</code> : Ext.tree.TreePanel<div class="sub-desc"></div></li><li><code>node</code> : Ext.tree.TreeNode<div class="sub-desc"></div></li><li><code>e</code> : event<div class="sub-desc">The raw browser event</div></li> </ul>
3452
<td class="msource">TreePanel</td>
3454
<tr class="event-row inherited alt expandable">
3455
<td class="micon"><a class="exi" href="#expand"> </a></td>
3457
<a id="Ext.tree.TreePanel-expand"></a>
3458
<b>expand</b> : ( <code>Ext.Panel p</code> ) <div class="mdesc">
3459
<div class="short">Fires after the Panel has been expanded.</div>
3461
Fires after the Panel has been expanded. <div class="mdetail-params">
3462
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3463
<ul><li><code>p</code> : Ext.Panel<div class="sub-desc">The Panel that has been expanded.</div></li> </ul>
3468
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#event-expand" href="output/Ext.Panel.html#event-expand">Panel</a></td>
3470
<tr class="event-row expandable">
3471
<td class="micon"><a class="exi" href="#expand"> </a></td>
3473
<a id="Ext.tree.TreePanel-expandnode"></a>
3474
<b>expandnode</b> : ( <code>Node node</code> ) <div class="mdesc">
3475
<div class="short">Fires when a node is expanded</div>
3477
Fires when a node is expanded <div class="mdetail-params">
3478
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3479
<ul><li><code>node</code> : Node<div class="sub-desc">The node</div></li> </ul>
3484
<td class="msource">TreePanel</td>
3486
<tr class="event-row inherited alt expandable">
3487
<td class="micon"><a class="exi" href="#expand"> </a></td>
3489
<a id="Ext.tree.TreePanel-hide"></a>
3490
<b>hide</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
3491
<div class="short">Fires after the component is hidden.</div>
3493
Fires after the component is hidden. <div class="mdetail-params">
3494
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3495
<ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
3500
<td class="msource"><a ext:cls="Ext.Component" ext:member="#event-hide" href="output/Ext.Component.html#event-hide">Component</a></td>
3502
<tr class="event-row inherited expandable">
3503
<td class="micon"><a class="exi" href="#expand"> </a></td>
3505
<a id="Ext.tree.TreePanel-iconchange"></a>
3506
<b>iconchange</b> : ( <code>Ext.Panel p</code>, <code>String The</code>, <code>String The</code> ) <div class="mdesc">
3507
<div class="short">Fires after the Panel icon class has been set or changed.</div>
3509
Fires after the Panel icon class has been set or changed. <div class="mdetail-params">
3510
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3511
<ul><li><code>p</code> : Ext.Panel<div class="sub-desc">the Panel which has had its icon class changed.</div></li><li><code>The</code> : String<div class="sub-desc">new icon class.</div></li><li><code>The</code> : String<div class="sub-desc">old icon class.</div></li> </ul>
3516
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#event-iconchange" href="output/Ext.Panel.html#event-iconchange">Panel</a></td>
3518
<tr class="event-row alt expandable">
3519
<td class="micon"><a class="exi" href="#expand"> </a></td>
3521
<a id="Ext.tree.TreePanel-insert"></a>
3522
<b>insert</b> : ( <code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code>, <code>Node refNode</code> ) <div class="mdesc">
3523
<div class="short">Fires when a new child node is inserted in a node in this tree.</div>
3525
Fires when a new child node is inserted in a node in this tree. <div class="mdetail-params">
3526
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3527
<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>
3532
<td class="msource">TreePanel</td>
3534
<tr class="event-row expandable">
3535
<td class="micon"><a class="exi" href="#expand"> </a></td>
3537
<a id="Ext.tree.TreePanel-load"></a>
3538
<b>load</b> : ( <code>Node node</code> ) <div class="mdesc">
3539
<div class="short">Fires when a node is loaded</div>
3541
Fires when a node is loaded <div class="mdetail-params">
3542
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3543
<ul><li><code>node</code> : Node<div class="sub-desc">The node that was loaded</div></li> </ul>
3548
<td class="msource">TreePanel</td>
3550
<tr class="event-row inherited alt expandable">
3551
<td class="micon"><a class="exi" href="#expand"> </a></td>
3553
<a id="Ext.tree.TreePanel-move"></a>
3554
<b>move</b> : ( <code>Ext.Component this</code>, <code>Number x</code>, <code>Number y</code> ) <div class="mdesc">
3555
<div class="short">Fires after the component is moved.</div>
3557
Fires after the component is moved. <div class="mdetail-params">
3558
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3559
<ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>x</code> : Number<div class="sub-desc">The new x position</div></li><li><code>y</code> : Number<div class="sub-desc">The new y position</div></li> </ul>
3564
<td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#event-move" href="output/Ext.BoxComponent.html#event-move">BoxComponent</a></td>
3566
<tr class="event-row expandable">
3567
<td class="micon"><a class="exi" href="#expand"> </a></td>
3569
<a id="Ext.tree.TreePanel-movenode"></a>
3570
<b>movenode</b> : ( <code>Tree tree</code>, <code>Node node</code>, <code>Node oldParent</code>, <code>Node newParent</code>, <code>Number index</code> ) <div class="mdesc">
3571
<div class="short">Fires when a node is moved to a new location in the tree</div>
3573
Fires when a node is moved to a new location in the tree <div class="mdetail-params">
3574
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3575
<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>
3580
<td class="msource">TreePanel</td>
3582
<tr class="event-row alt expandable">
3583
<td class="micon"><a class="exi" href="#expand"> </a></td>
3585
<a id="Ext.tree.TreePanel-nodedragover"></a>
3586
<b>nodedragover</b> : ( <code>Object dragOverEvent</code> ) <div class="mdesc">
3587
<div class="short">Fires when a tree node is being targeted for a drag drop, return false to signal drop not allowed. The dragOverEvent
3590
Fires when a tree node is being targeted for a drag drop, return false to signal drop not allowed. The dragOverEvent
3591
passed to handlers has the following properties:<br />
3592
<ul style="padding:5px;padding-left:16px;">
3593
<li>tree - The TreePanel</li>
3594
<li>target - The node being targeted for the drop</li>
3595
<li>data - The drag data from the drag source</li>
3596
<li>point - The point of the drop - append, above or below</li>
3597
<li>source - The drag source</li>
3598
<li>rawEvent - Raw mouse event</li>
3599
<li>dropNode - Drop node(s) provided by the source.</li>
3600
<li>cancel - Set this to true to signal drop not allowed.</li>
3601
</ul> <div class="mdetail-params">
3602
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3603
<ul><li><code>dragOverEvent</code> : Object<div class="sub-desc"></div></li> </ul>
3608
<td class="msource">TreePanel</td>
3610
<tr class="event-row expandable">
3611
<td class="micon"><a class="exi" href="#expand"> </a></td>
3613
<a id="Ext.tree.TreePanel-nodedrop"></a>
3614
<b>nodedrop</b> : ( <code>Object dropEvent</code> ) <div class="mdesc">
3615
<div class="short">Fires after a DD object is dropped on a node in this tree. The dropEvent
3616
passed to handlers has the following propert...</div>
3618
Fires after a DD object is dropped on a node in this tree. The dropEvent
3619
passed to handlers has the following properties:<br />
3620
<ul style="padding:5px;padding-left:16px;">
3621
<li>tree - The TreePanel</li>
3622
<li>target - The node being targeted for the drop</li>
3623
<li>data - The drag data from the drag source</li>
3624
<li>point - The point of the drop - append, above or below</li>
3625
<li>source - The drag source</li>
3626
<li>rawEvent - Raw mouse event</li>
3627
<li>dropNode - Dropped node(s).</li>
3628
</ul> <div class="mdetail-params">
3629
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3630
<ul><li><code>dropEvent</code> : Object<div class="sub-desc"></div></li> </ul>
3635
<td class="msource">TreePanel</td>
3637
<tr class="event-row alt expandable">
3638
<td class="micon"><a class="exi" href="#expand"> </a></td>
3640
<a id="Ext.tree.TreePanel-remove"></a>
3641
<b>remove</b> : ( <code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code> ) <div class="mdesc">
3642
<div class="short">Fires when a child node is removed from a node in this tree.</div>
3644
Fires when a child node is removed from a node in this tree. <div class="mdetail-params">
3645
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3646
<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>
3651
<td class="msource">TreePanel</td>
3653
<tr class="event-row inherited expandable">
3654
<td class="micon"><a class="exi" href="#expand"> </a></td>
3656
<a id="Ext.tree.TreePanel-render"></a>
3657
<b>render</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
3658
<div class="short">Fires after the component is rendered.</div>
3660
Fires after the component is rendered. <div class="mdetail-params">
3661
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3662
<ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
3667
<td class="msource"><a ext:cls="Ext.Component" ext:member="#event-render" href="output/Ext.Component.html#event-render">Component</a></td>
3669
<tr class="event-row inherited alt expandable">
3670
<td class="micon"><a class="exi" href="#expand"> </a></td>
3672
<a id="Ext.tree.TreePanel-resize"></a>
3673
<b>resize</b> : ( <code>Ext.Component this</code>, <code>Number adjWidth</code>, <code>Number adjHeight</code>, <code>Number rawWidth</code>, <code>Number rawHeight</code> ) <div class="mdesc">
3674
<div class="short">Fires after the component is resized.</div>
3676
Fires after the component is resized. <div class="mdetail-params">
3677
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3678
<ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>adjWidth</code> : Number<div class="sub-desc">The box-adjusted width that was set</div></li><li><code>adjHeight</code> : Number<div class="sub-desc">The box-adjusted height that was set</div></li><li><code>rawWidth</code> : Number<div class="sub-desc">The width that was originally specified</div></li><li><code>rawHeight</code> : Number<div class="sub-desc">The height that was originally specified</div></li> </ul>
3683
<td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#event-resize" href="output/Ext.BoxComponent.html#event-resize">BoxComponent</a></td>
3685
<tr class="event-row inherited expandable">
3686
<td class="micon"><a class="exi" href="#expand"> </a></td>
3688
<a id="Ext.tree.TreePanel-show"></a>
3689
<b>show</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
3690
<div class="short">Fires after the component is shown.</div>
3692
Fires after the component is shown. <div class="mdetail-params">
3693
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3694
<ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
3699
<td class="msource"><a ext:cls="Ext.Component" ext:member="#event-show" href="output/Ext.Component.html#event-show">Component</a></td>
3701
<tr class="event-row alt expandable">
3702
<td class="micon"><a class="exi" href="#expand"> </a></td>
3704
<a id="Ext.tree.TreePanel-startdrag"></a>
3705
<b>startdrag</b> : ( <code>Ext.tree.TreePanel this</code>, <code>Ext.tree.TreeNode node</code>, <code>event e</code> ) <div class="mdesc">
3706
<div class="short">Fires when a node starts being dragged</div>
3708
Fires when a node starts being dragged <div class="mdetail-params">
3709
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3710
<ul><li><code>this</code> : Ext.tree.TreePanel<div class="sub-desc"></div></li><li><code>node</code> : Ext.tree.TreeNode<div class="sub-desc"></div></li><li><code>e</code> : event<div class="sub-desc">The raw browser event</div></li> </ul>
3715
<td class="msource">TreePanel</td>
3717
<tr class="event-row inherited expandable">
3718
<td class="micon"><a class="exi" href="#expand"> </a></td>
3720
<a id="Ext.tree.TreePanel-staterestore"></a>
3721
<b>staterestore</b> : ( <code>Ext.Component this</code>, <code>Object state</code> ) <div class="mdesc">
3722
<div class="short">Fires after the state of the component is restored.</div>
3724
Fires after the state of the component is restored. <div class="mdetail-params">
3725
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3726
<ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>state</code> : Object<div class="sub-desc">The hash of state values</div></li> </ul>
3731
<td class="msource"><a ext:cls="Ext.Component" ext:member="#event-staterestore" href="output/Ext.Component.html#event-staterestore">Component</a></td>
3733
<tr class="event-row inherited alt expandable">
3734
<td class="micon"><a class="exi" href="#expand"> </a></td>
3736
<a id="Ext.tree.TreePanel-statesave"></a>
3737
<b>statesave</b> : ( <code>Ext.Component this</code>, <code>Object state</code> ) <div class="mdesc">
3738
<div class="short">Fires after the state of the component is saved to the configured state provider.</div>
3740
Fires after the state of the component is saved to the configured state provider. <div class="mdetail-params">
3741
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3742
<ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>state</code> : Object<div class="sub-desc">The hash of state values</div></li> </ul>
3747
<td class="msource"><a ext:cls="Ext.Component" ext:member="#event-statesave" href="output/Ext.Component.html#event-statesave">Component</a></td>
3749
<tr class="event-row expandable">
3750
<td class="micon"><a class="exi" href="#expand"> </a></td>
3752
<a id="Ext.tree.TreePanel-textchange"></a>
3753
<b>textchange</b> : ( <code>Node node</code>, <code>String text</code>, <code>String oldText</code> ) <div class="mdesc">
3754
<div class="short">Fires when the text for a node is changed</div>
3756
Fires when the text for a node is changed <div class="mdetail-params">
3757
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3758
<ul><li><code>node</code> : Node<div class="sub-desc">The node</div></li><li><code>text</code> : String<div class="sub-desc">The new text</div></li><li><code>oldText</code> : String<div class="sub-desc">The old text</div></li> </ul>
3763
<td class="msource">TreePanel</td>
3765
<tr class="event-row inherited alt expandable">
3766
<td class="micon"><a class="exi" href="#expand"> </a></td>
3768
<a id="Ext.tree.TreePanel-titlechange"></a>
3769
<b>titlechange</b> : ( <code>Ext.Panel p</code>, <code>String The</code> ) <div class="mdesc">
3770
<div class="short">Fires after the Panel title has been set or changed.</div>
3772
Fires after the Panel title has been set or changed. <div class="mdetail-params">
3773
<strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
3774
<ul><li><code>p</code> : Ext.Panel<div class="sub-desc">the Panel which has had its title changed.</div></li><li><code>The</code> : String<div class="sub-desc">new title.</div></li> </ul>
3779
<td class="msource"><a ext:cls="Ext.Panel" ext:member="#event-titlechange" href="output/Ext.Panel.html#event-titlechange">Panel</a></td>
added
removed
WebContent/js/extjs-2/docs/output/Ext.tree.TreePanel.html
