-<div
class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.tree.TreePanel-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a> <a class="inner-link" href="#Ext.tree.TreePanel-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a> <a class="inner-link" href="#Ext.tree.TreePanel-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a> <a class="inner-link" href="#Ext.tree.TreePanel-configs"><img src="resources/images/default/s.gif" class="item-icon icon-config">Config Options</a> <a class="bookmark" href="../docs/?class=Ext.tree.TreePanel"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a> </div><div class="inheritance res-block"><pre class="res-block-inner"><a href="output/Ext.util.Observable.html" ext:member="" ext:cls="Ext.util.Observable">Observable</a> <img src="resources/elbow-end.gif"><a href="output/Ext.Component.html" ext:member="" ext:cls="Ext.Component">Component</a> <img src="resources/elbow-end.gif"><a href="output/Ext.BoxComponent.html" ext:member="" ext:cls="Ext.BoxComponent">BoxComponent</a> <img src="resources/elbow-end.gif"><a href="output/Ext.Container.html" ext:member="" ext:cls="Ext.Container">Container</a> <img src="resources/elbow-end.gif"><a href="output/Ext.Panel.html" ext:member="" ext:cls="Ext.Panel">Panel</a> <img src="resources/elbow-end.gif">TreePanel</pre></div><h1>Class <a href="source/TreePanel.html#cls-Ext.tree.TreePanel">Ext.tree.TreePanel</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.tree</td></tr><tr><td class="label">Defined In:</td><td class="hd-info">TreePanel.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/TreePanel.html#cls-Ext.tree.TreePanel">TreePanel</a></td></tr><tr><td class="label">Subclasses:</td><td class="hd-info"><a href="output/Ext.ux.tree.ColumnTree.html" ext:cls="Ext.ux.tree.ColumnTree">ColumnTree</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.Panel.html" ext:cls="Ext.Panel" ext:member="">Panel</a></td></tr><tr><td class="hd-info"></td></tr><tr><td class="label">xtype:</td><td class="hd-info">treepanel</td></tr></table><div class="description"><p>The TreePanel provides tree-structured UI representation of tree-structured data.</p>
\r+<div
xmlns:ext="http://www.extjs.com" class="body-wrap"><div class="inheritance res-block"><pre class="res-block-inner"><a href="output/Ext.util.Observable.html" ext:member="" ext:cls="Ext.util.Observable">Observable</a> <img src="resources/elbow-end.gif"><a href="output/Ext.Component.html" ext:member="" ext:cls="Ext.Component">Component</a> <img src="resources/elbow-end.gif"><a href="output/Ext.BoxComponent.html" ext:member="" ext:cls="Ext.BoxComponent">BoxComponent</a> <img src="resources/elbow-end.gif"><a href="output/Ext.Container.html" ext:member="" ext:cls="Ext.Container">Container</a> <img src="resources/elbow-end.gif"><a href="output/Ext.Panel.html" ext:member="" ext:cls="Ext.Panel">Panel</a> <img src="resources/elbow-end.gif">TreePanel</pre></div><h1>Class <a href="source/TreePanel.html#cls-Ext.tree.TreePanel">Ext.tree.TreePanel</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.tree</td></tr><tr><td class="label">Defined In:</td><td class="hd-info">TreePanel.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/TreePanel.html#cls-Ext.tree.TreePanel">TreePanel</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.Panel.html" ext:cls="Ext.Panel" ext:member="">Panel</a></td></tr></table><div class="description"><p>The TreePanel provides tree-structured UI representation of tree-structured data.</p>
\r <p><a href="output/Ext.tree.TreeNode.html" ext:cls="Ext.tree.TreeNode">TreeNode</a>s added to the TreePanel may each contain metadata\r
used by your application in their <a href="output/Ext.tree.TreeNode.html#Ext.tree.TreeNode-attributes" ext:member="attributes" ext:cls="Ext.tree.TreeNode">attributes</a> property.</p>\r
<p><b>A TreePanel must have a <a href="output/Ext.tree.TreePanel.html#Ext.tree.TreePanel-root" ext:member="root" ext:cls="Ext.tree.TreePanel">root</a> node before it is rendered.</b> This may either be\r
based on its contents, and that Ext will not manage it at all. If the panel is within a layout that
manages dimensions (<code>fit</code>, <code>border</code>, etc.) then setting <code>autoHeight: true</code>
can cause issues with scrolling and will not generally work as expected since the panel will take
-on the height of its contents rather than the height required by the Ext layout.</div></div></td><td class="msource"><a href="output/Ext.Panel.html#autoHeight" ext:member="#autoHeight" ext:cls="Ext.Panel">Panel</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Panel-autoScroll"></a><b><a href="source/Panel.html#cfg-Ext.Panel-autoScroll">autoScroll</a></b> : Boolean<div class="mdesc"><div class="short">true to use overflow:'auto' on the panel's body element and show scroll bars automatically when\r
-necessary, false to c...</div><div class="long"><code>true</code> to use overflow:'auto' on the panel's body element and show scroll bars automatically when
-necessary, <code>false</code> to clip any overflowing content (defaults to <code>false</code>).</div></div></td><td class="msource"><a href="output/Ext.
Panel.html#autoScroll" ext:member="#autoScroll" ext:cls="Ext.Panel">Panel</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-autoShow"></a><b><a href="source/Component.html#cfg-Ext.Component-autoShow">autoShow</a></b> : Boolean<div class="mdesc"><div class="short">True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove
\r+on the height of its contents rather than the height required by the Ext layout.</div></div></td><td class="msource"><a href="output/Ext.Panel.html#autoHeight" ext:member="#autoHeight" ext:cls="Ext.Panel">Panel</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-autoScroll"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-autoScroll">autoScroll</a></b> : Boolean<div class="mdesc"><div class="short">true to use overflow:'auto' on the components layout element and show scroll bars automatically when\r
+necessary, false...</div><div class="long"><code>true</code> to use overflow:'auto' on the components layout element and show scroll bars automatically when
+necessary, <code>false</code> to clip any overflowing content (defaults to <code>false</code>).</div></div></td><td class="msource"><a href="output/Ext.
BoxComponent.html#autoScroll" ext:member="#autoScroll" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-autoShow"></a><b><a href="source/Component.html#cfg-Ext.Component-autoShow">autoShow</a></b> : Boolean<div class="mdesc"><div class="short">True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove
\r them on render...</div><div class="long">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></div></td><td class="msource"><a href="output/Ext.Component.html#autoShow" ext:member="#autoShow" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Panel-baseCls"></a><b><a href="source/Panel.html#cfg-Ext.Panel-baseCls">baseCls</a></b> : String<div class="mdesc"><div class="short">The base CSS class to apply to this panel's element (defaults to 'x-panel').\r
Another option available by default is t...</div><div class="long">The base CSS class to apply to this panel's element (defaults to <code><em>'x-panel'</em></code>).
Ext.Element.applyStyles (defaults to nu...</div><div class="long">Custom CSS styles to be applied to the <a href="output/Ext.Panel.html#Ext.Panel-body" ext:member="body" ext:cls="Ext.Panel">body</a> element in the format expected by
<a href="output/Ext.Element.html#Ext.Element-applyStyles" ext:member="applyStyles" ext:cls="Ext.Element">Ext.Element.applyStyles</a> (defaults to null). See <a href="output/Ext.Panel.html#Ext.Panel-bodyCfg" ext:member="bodyCfg" ext:cls="Ext.Panel">bodyCfg</a>.</div></div></td><td class="msource"><a href="output/Ext.Panel.html#bodyStyle" ext:member="#bodyStyle" ext:cls="Ext.Panel">Panel</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Panel-border"></a><b><a href="source/Panel.html#cfg-Ext.Panel-border">border</a></b> : Boolean<div class="mdesc"><div class="short">True to display the borders of the panel's body element, false to hide them (defaults to true). By default,\r
the bord...</div><div class="long">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 href="output/Ext.Panel.html#Ext.Panel-bodyBorder" ext:member="bodyBorder" ext:cls="Ext.Panel">bodyBorder</a> to false.</div></div></td><td class="msource"><a href="output/Ext.Panel.html#border" ext:member="#border" ext:cls="Ext.Panel">Panel</a></td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-bubbleEvents"></a><b><a href="source/TreePanel.html#cfg-Ext.tree.TreePanel-bubbleEvents">bubbleEvents</a></b> : Array<div class="mdesc"><p>An array of events that, when fired, should be bubbled to any parent container.\r
-Defaults to <tt>['add', 'remove']</tt>.</div></td><td class="msource">TreePanel</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Panel-buttonAlign"></a><b><a href="source/Panel.html#cfg-Ext.Panel-buttonAlign">buttonAlign</a></b> : String<div class="mdesc"><div class="short">The alignment of any buttons added to this panel. Valid values are 'right',\r
+the border is a 2px wide inset border, but this can be further altered by setting <a href="output/Ext.Panel.html#Ext.Panel-bodyBorder" ext:member="bodyBorder" ext:cls="Ext.Panel">bodyBorder</a> to false.</div></div></td><td class="msource"><a href="output/Ext.Panel.html#border" ext:member="#border" ext:cls="Ext.Panel">Panel</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-boxMaxHeight"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-boxMaxHeight">boxMaxHeight</a></b> : Number<div class="mdesc"><div class="short">The maximum value in pixels which this BoxComponent will set its height to.\r
+Warning: This will override any size mana...</div><div class="long"><p>The maximum value in pixels which this BoxComponent will set its height to.</p>
+<p><b>Warning:</b> This will override any size management applied by layout managers.</p></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#boxMaxHeight" ext:member="#boxMaxHeight" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-boxMaxWidth"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-boxMaxWidth">boxMaxWidth</a></b> : Number<div class="mdesc"><div class="short">The maximum value in pixels which this BoxComponent will set its width to.\r
+Warning: This will override any size manag...</div><div class="long"><p>The maximum value in pixels which this BoxComponent will set its width to.</p>
+<p><b>Warning:</b> This will override any size management applied by layout managers.</p></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#boxMaxWidth" ext:member="#boxMaxWidth" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-boxMinHeight"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-boxMinHeight">boxMinHeight</a></b> : Number<div class="mdesc"><div class="short">The minimum value in pixels which this BoxComponent will set its height to.\r
+Warning: This will override any size mana...</div><div class="long"><p>The minimum value in pixels which this BoxComponent will set its height to.</p>
+<p><b>Warning:</b> This will override any size management applied by layout managers.</p></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#boxMinHeight" ext:member="#boxMinHeight" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-boxMinWidth"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-boxMinWidth">boxMinWidth</a></b> : Number<div class="mdesc"><div class="short">The minimum value in pixels which this BoxComponent will set its width to.\r
+Warning: This will override any size manag...</div><div class="long"><p>The minimum value in pixels which this BoxComponent will set its width to.</p>
+<p><b>Warning:</b> This will override any size management applied by layout managers.</p></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#boxMinWidth" ext:member="#boxMinWidth" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-bubbleEvents"></a><b><a href="source/TreePanel.html#cfg-Ext.tree.TreePanel-bubbleEvents">bubbleEvents</a></b> : Array<div class="mdesc"><div class="short">An array of events that, when fired, should be bubbled to any parent container. \r
+See Ext.util.Observable.enableBubble...</div><div class="long"><p>An array of events that, when fired, should be bubbled to any parent container.\r
+See <a href="output/Ext.util.Observable.html#Ext.util.Observable-enableBubble" ext:member="enableBubble" ext:cls="Ext.util.Observable">Ext.util.Observable.enableBubble</a>.\r
+Defaults to <tt>[]</tt>.</div></div></td><td class="msource">TreePanel</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Panel-buttonAlign"></a><b><a href="source/Panel.html#cfg-Ext.Panel-buttonAlign">buttonAlign</a></b> : String<div class="mdesc"><div class="short">The alignment of any buttons added to this panel. Valid values are 'right',\r
'left' and 'center' (defaults to 'right'...</div><div class="long">The alignment of any <a href="output/Ext.Panel.html#Ext.Panel-buttons" ext:member="buttons" ext:cls="Ext.Panel">buttons</a> added to this panel. Valid values are <code><em>'right'</em></code>,
<code><em>'left'</em></code> and <code><em>'center'</em></code> (defaults to <code><em>'right'</em></code>).</div></div></td><td class="msource"><a href="output/Ext.Panel.html#buttonAlign" ext:member="#buttonAlign" ext:cls="Ext.Panel">Panel</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Panel-buttons"></a><b><a href="source/Panel.html#cfg-Ext.Panel-buttons">buttons</a></b> : Array<div class="mdesc"><div class="short">buttons will be used as items for the toolbar in\r
the footer (fbar). Typically the value of this configuration propert...</div><div class="long"><code>buttons</code> will be used as <code><a href="output/Ext.Container.html#Ext.Container-items" ext:member="items" ext:cls="Ext.Container">items</a></code> for the toolbar in
</ul></div>
To configure the above Class with an extra CSS class append to the default. For example,
for BoxLayout (Hbox and Vbox):<pre><code>ctCls: <em>'x-box-layout-ct custom-class'</em></code></pre>
-</p></div></div></td><td class="msource"><a href="output/Ext.Component.html#ctCls" ext:member="#ctCls" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-ddAppendOnly"></a><b><a href="source/TreePanel.html#cfg-Ext.tree.TreePanel-ddAppendOnly">ddAppendOnly</a></b> : Boolean<div class="mdesc"><tt>true</tt> if the tree should only allow append drops (use for trees which are sorted)</div></td><td class="msource">TreePanel</td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-ddGroup"></a><b><a href="source/TreePanel.html#cfg-Ext.tree.TreePanel-ddGroup">ddGroup</a></b> : String<div class="mdesc">The DD group this TreePanel belongs to</div></td><td class="msource">TreePanel</td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-ddScroll"></a><b><a href="source/TreePanel.html#cfg-Ext.tree.TreePanel-ddScroll">ddScroll</a></b> : Boolean<div class="mdesc"><tt>true</tt> to enable body scrolling</div></td><td class="msource">TreePanel</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Panel-disabled"></a><b><a href="source/Panel.html#cfg-Ext.Panel-disabled">disabled</a></b> : Boolean<div class="mdesc"><div class="short">Render this panel disabled (default is false). An important note when using the disabled\r
+</p></div></div></td><td class="msource"><a href="output/Ext.Component.html#ctCls" ext:member="#ctCls" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-data"></a><b><a href="source/Component.html#cfg-Ext.Component-data">data</a></b> : Mixed<div class="mdesc">The initial set of data to apply to the <code><a href="output/Ext.Component.html#Ext.Component-tpl" ext:member="tpl" ext:cls="Ext.Component">tpl</a></code> to
+update the content area of the Component.</div></td><td class="msource"><a href="output/Ext.Component.html#data" ext:member="#data" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-ddAppendOnly"></a><b><a href="source/TreePanel.html#cfg-Ext.tree.TreePanel-ddAppendOnly">ddAppendOnly</a></b> : Boolean<div class="mdesc"><tt>true</tt> if the tree should only allow append drops (use for trees which are sorted)</div></td><td class="msource">TreePanel</td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-ddGroup"></a><b><a href="source/TreePanel.html#cfg-Ext.tree.TreePanel-ddGroup">ddGroup</a></b> : String<div class="mdesc">The DD group this TreePanel belongs to</div></td><td class="msource">TreePanel</td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-ddScroll"></a><b><a href="source/TreePanel.html#cfg-Ext.tree.TreePanel-ddScroll">ddScroll</a></b> : Boolean<div class="mdesc"><tt>true</tt> to enable body scrolling</div></td><td class="msource">TreePanel</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Panel-disabled"></a><b><a href="source/Panel.html#cfg-Ext.Panel-disabled">disabled</a></b> : Boolean<div class="mdesc"><div class="short">Render this panel disabled (default is false). An important note when using the disabled\r
config on panels is that IE ...</div><div class="long">Render this panel disabled (default is <code>false</code>). An important note when using the disabled
config on panels is that IE will often fail to initialize the disabled mask element correectly if
the panel's layout has not yet completed by the time the Panel is disabled during the render process.
will be created automatically if <code><a href="output/Ext.Panel.html#Ext.Panel-buttons" ext:member="buttons" ext:cls="Ext.Panel">buttons</a></code> or a <code><a href="output/Ext.Panel.html#Ext.Panel-fbar" ext:member="fbar" ext:cls="Ext.Panel">fbar</a></code> have
been configured. See <code><a href="output/Ext.Panel.html#Ext.Panel-bodyCfg" ext:member="bodyCfg" ext:cls="Ext.Panel">bodyCfg</a></code> for an example.</div></div></td><td class="msource"><a href="output/Ext.Panel.html#footer" ext:member="#footer" ext:cls="Ext.Panel">Panel</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Panel-footerCfg"></a><b><a href="source/Panel.html#cfg-Ext.Panel-footerCfg">footerCfg</a></b> : Object<div class="mdesc"><div class="short">A DomHelper element specification object specifying the element structure\r
of this Panel's footer Element. See bodyCf...</div><div class="long"><p>A <a href="output/Ext.DomHelper.html" ext:cls="Ext.DomHelper">DomHelper</a> element specification object specifying the element structure
-of this Panel's <a href="output/Ext.Panel.html#Ext.Panel-footer" ext:member="footer" ext:cls="Ext.Panel">footer</a> Element. See <code><a href="output/Ext.Panel.html#Ext.Panel-bodyCfg" ext:member="bodyCfg" ext:cls="Ext.Panel">bodyCfg</a></code> also.</p></div></div></td><td class="msource"><a href="output/Ext.Panel.html#footerCfg" ext:member="#footerCfg" ext:cls="Ext.Panel">Panel</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Container-forceLayout"></a><b><a href="source/Container.html#cfg-Ext.Container-forceLayout">forceLayout</a></b> : Boolean<div class="mdesc"><div class="short">If true the container will force a layout initially even if hidden or collapsed. This option \r
-is useful for forcing f...</div><div class="long">If true the container will force a layout initially even if hidden or collapsed. This option\r
+of this Panel's <a href="output/Ext.Panel.html#Ext.Panel-footer" ext:member="footer" ext:cls="Ext.Panel">footer</a> Element. See <code><a href="output/Ext.Panel.html#Ext.Panel-bodyCfg" ext:member="bodyCfg" ext:cls="Ext.Panel">bodyCfg</a></code> also.</p></div></div></td><td class="msource"><a href="output/Ext.Panel.html#footerCfg" ext:member="#footerCfg" ext:cls="Ext.Panel">Panel</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Container-forceLayout"></a><b><a href="source/Container.html#cfg-Ext.Container-forceLayout">forceLayout</a></b> : Boolean<div class="mdesc"><div class="short">If true the container will force a layout initially even if hidden or collapsed. This option\r
+is useful for forcing fo...</div><div class="long">If true the container will force a layout initially even if hidden or collapsed. This option
is useful for forcing forms to render in collapsed or hidden containers. (defaults to false).</div></div></td><td class="msource"><a href="output/Ext.Container.html#forceLayout" ext:member="#forceLayout" ext:cls="Ext.Container">Container</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Panel-frame"></a><b><a href="source/Panel.html#cfg-Ext.Panel-frame">frame</a></b> : Boolean<div class="mdesc"><div class="short">false by default to render with plain 1px square borders. true to render with\r
9 elements, complete with custom rounde...</div><div class="long"><code>false</code> by default to render with plain 1px square borders. <code>true</code> to render with
9 elements, complete with custom rounded corners (also see <a href="output/Ext.Element.html#Ext.Element-boxWrap" ext:member="boxWrap" ext:cls="Ext.Element">Ext.Element.boxWrap</a>).
disabled.</div></div></td><td class="msource"><a href="output/Ext.Panel.html#maskDisabled" ext:member="#maskDisabled" ext:cls="Ext.Panel">Panel</a></td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Panel-minButtonWidth"></a><b><a href="source/Panel.html#cfg-Ext.Panel-minButtonWidth">minButtonWidth</a></b> : Number<div class="mdesc">Minimum width in pixels of all <a href="output/Ext.Panel.html#Ext.Panel-buttons" ext:member="buttons" ext:cls="Ext.Panel">buttons</a> in this panel (defaults to <code>75</code>)</div></td><td class="msource"><a href="output/Ext.Panel.html#minButtonWidth" ext:member="#minButtonWidth" ext:cls="Ext.Panel">Panel</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-overCls"></a><b><a href="source/Component.html#cfg-Ext.Component-overCls">overCls</a></b> : String<div class="mdesc"><div class="short">An optional extra CSS class that will be added to this component's Element when the mouse moves\r
over the Element, and...</div><div class="long">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></div></td><td class="msource"><a href="output/Ext.Component.html#overCls" ext:member="#overCls" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-pageX"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-pageX">pageX</a></b> : Number<div class="mdesc">The page level x coordinate for this component if contained within a positioning container.</div></td><td class="msource"><a href="output/Ext.BoxComponent.html#pageX" ext:member="#pageX" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-pageY"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-pageY">pageY</a></b> : Number<div class="mdesc">The page level y coordinate for this component if contained within a positioning container.</div></td><td class="msource"><a href="output/Ext.BoxComponent.html#pageY" ext:member="#pageY" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-pathSeparator"></a><b><a href="source/TreePanel.html#cfg-Ext.tree.TreePanel-pathSeparator">pathSeparator</a></b> : String<div class="mdesc">The token used to separate sub-paths in path strings (defaults to <tt>'/'</tt>)</div></td><td class="msource">TreePanel</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-plugins"></a><b><a href="source/Component.html#cfg-Ext.Component-plugins">plugins</a></b> : Object/Array<div class="mdesc"><div class="short">An object or array of objects that will provide custom functionality for this component. The only\r
+useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules.</div></div></td><td class="msource"><a href="output/Ext.Component.html#overCls" ext:member="#overCls" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Panel-padding"></a><b><a href="source/Panel.html#cfg-Ext.Panel-padding">padding</a></b> : Number/String<div class="mdesc"><div class="short">A shortcut for setting a padding style on the body element. The value can either be\r
+a number to be applied to all sid...</div><div class="long">A shortcut for setting a padding style on the body element. The value can either be
+a number to be applied to all sides, or a normal css string describing padding.
+Defaults to <tt>undefined</tt>.</div></div></td><td class="msource"><a href="output/Ext.Panel.html#padding" ext:member="#padding" ext:cls="Ext.Panel">Panel</a></td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-pageX"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-pageX">pageX</a></b> : Number<div class="mdesc">The page level x coordinate for this component if contained within a positioning container.</div></td><td class="msource"><a href="output/Ext.BoxComponent.html#pageX" ext:member="#pageX" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-pageY"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-pageY">pageY</a></b> : Number<div class="mdesc">The page level y coordinate for this component if contained within a positioning container.</div></td><td class="msource"><a href="output/Ext.BoxComponent.html#pageY" ext:member="#pageY" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-pathSeparator"></a><b><a href="source/TreePanel.html#cfg-Ext.tree.TreePanel-pathSeparator">pathSeparator</a></b> : String<div class="mdesc">The token used to separate sub-paths in path strings (defaults to <tt>'/'</tt>)</div></td><td class="msource">TreePanel</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-plugins"></a><b><a href="source/Component.html#cfg-Ext.Component-plugins">plugins</a></b> : Object/Array<div class="mdesc"><div class="short">An object or array of objects that will provide custom functionality for this component. The only\r
requirement for a ...</div><div class="long">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
type of Plugin to create.<br><br>
If you create your own Plugins, you may register them using
<a href="output/Ext.ComponentMgr.html#Ext.ComponentMgr-registerPlugin" ext:member="registerPlugin" ext:cls="Ext.ComponentMgr">Ext.ComponentMgr.registerPlugin</a> in order to be able to
-take advantage of lazy instantiation and rendering.</div></div></td><td class="msource"><a href="output/Ext.Component.html#ptype" ext:member="#ptype" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-ref"></a><b><a href="source/Component.html#cfg-Ext.Component-ref">ref</a></b> : String<div class="mdesc"><div class="short">A path specification, relative to the Component's ownerCt specifying into which\r
-ancestor Container to place a named r...</div><div class="long"><p>A path specification, relative to the Component's <a href="output/Ext.Component.html#Ext.Component-ownerCt" ext:member="ownerCt" ext:cls="Ext.Component">ownerCt</a> specifying into which
-ancestor Container to place a named reference to this Component.</p>
+take advantage of lazy instantiation and rendering.</div></div></td><td class="msource"><a href="output/Ext.Component.html#ptype" ext:member="#ptype" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-ref"></a><b><a href="source/Component.html#cfg-Ext.Component-ref">ref</a></b> : String<div class="mdesc"><div class="short">A path specification, relative to the Component's ownerCt\r
+specifying into which ancestor Container to place a named r...</div><div class="long"><p>A path specification, relative to the Component's <code><a href="output/Ext.Component.html#Ext.Component-ownerCt" ext:member="ownerCt" ext:cls="Ext.Component">ownerCt</a></code>
+specifying into which ancestor Container to place a named reference to this Component.</p>
<p>The ancestor axis can be traversed by using '/' characters in the path.
For example, to put a reference to a Toolbar Button into <i>the Panel which owns the Toolbar</i>:</p><pre><code><b>var</b> myGrid = <b>new</b> Ext.grid.EditorGridPanel({
title: <em>'My EditorGridPanel'</em>,
}
}
});</code></pre>
-<p>In the code above, if the ref had been <code><em>'saveButton'</em></code> the reference would
-have been placed into the Toolbar. Each '/' in the ref moves up one level from the
-Component's <a href="output/Ext.Component.html#Ext.Component-ownerCt" ext:member="ownerCt" ext:cls="Ext.Component">ownerCt</a>.</p></div></div></td><td class="msource"><a href="output/Ext.Component.html#ref" ext:member="#ref" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-region"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-region">region</a></b> : String<div class="mdesc"><div class="short">Note: this config is only used when this BoxComponent is rendered\r
+<p>In the code above, if the <code>ref</code> had been <code><em>'saveButton'</em></code>
+the reference would have been placed into the Toolbar. Each '/' in the <code>ref</code>
+moves up one level from the Component's <code><a href="output/Ext.Component.html#Ext.Component-ownerCt" ext:member="ownerCt" ext:cls="Ext.Component">ownerCt</a></code>.</p>
+<p>Also see the <code><a href="output/Ext.Component.html#Ext.Component-added" ext:member="added" ext:cls="Ext.Component">added</a></code> and <code><a href="output/Ext.Component.html#Ext.Component-removed" ext:member="removed" ext:cls="Ext.Component">removed</a></code> events.</p></div></div></td><td class="msource"><a href="output/Ext.Component.html#ref" ext:member="#ref" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-region"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-region">region</a></b> : String<div class="mdesc"><div class="short">Note: this config is only used when this BoxComponent is rendered\r
by a Container which has been configured to use the...</div><div class="long"><p><b>Note</b>: this config is only used when this BoxComponent is rendered
by a Container which has been configured to use the <b><a href="output/Ext.layout.BorderLayout.html" ext:cls="Ext.layout.BorderLayout">BorderLayout</a></b>
layout manager (e.g. specifying <tt>layout:'border'</tt>).</p><br>
<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>
-<li><b>tc</b> :
Ext.Panel<div class="sub-desc">The tool configuration object</div></li>
+<li><b>tc</b> :
Object<div class="sub-desc">The tool configuration object</div></li>
</ul></div></li>
<li><b>stopEvent</b> : Boolean<div class="sub-desc">Defaults to true. Specify as false to allow click event to propagate.</div></li>
<li><b>scope</b> : Object<div class="sub-desc">The scope in which to call the handler.</div></li>
.x-tool-help-over {background-image: url(images/help_over.png);}
<i>// <b>if</b> using an image sprite:</i>
.x-tool-help {background-image: url(images/help.png) no-repeat 0 0;}
-.x-tool-help-over {background-position:-15px 0;}</code></pre></div></div></td><td class="msource"><a href="output/Ext.Panel.html#tools" ext:member="#tools" ext:cls="Ext.Panel">Panel</a></td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-trackMouseOver"></a><b><a href="source/TreePanel.html#cfg-Ext.tree.TreePanel-trackMouseOver">trackMouseOver</a></b> : Boolean<div class="mdesc"><tt>false</tt> to disable mouse over highlighting</div></td><td class="msource">TreePanel</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Panel-unstyled"></a><b><a href="source/Panel.html#cfg-Ext.Panel-unstyled">unstyled</a></b> : Boolean<div class="mdesc"><div class="short">Overrides the baseCls setting to baseCls = 'x-plain' which renders\r
+.x-tool-help-over {background-position:-15px 0;}</code></pre></div></div></td><td class="msource"><a href="output/Ext.Panel.html#tools" ext:member="#tools" ext:cls="Ext.Panel">Panel</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-tpl"></a><b><a href="source/Component.html#cfg-Ext.Component-tpl">tpl</a></b> : Mixed<div class="mdesc"><div class="short">An Ext.Template, Ext.XTemplate\r
+or an array of strings to form an Ext.XTemplate.\r
+Used in conjunction with the data and...</div><div class="long">An <bold><a href="output/Ext.Template.html" ext:cls="Ext.Template">Ext.Template</a></bold>, <bold><a href="output/Ext.XTemplate.html" ext:cls="Ext.XTemplate">Ext.XTemplate</a></bold>
+or an array of strings to form an Ext.XTemplate.
+Used in conjunction with the <code><a href="output/Ext.Component.html#Ext.Component-data" ext:member="data" ext:cls="Ext.Component">data</a></code> and
+<code><a href="output/Ext.Component.html#Ext.Component-tplWriteMode" ext:member="tplWriteMode" ext:cls="Ext.Component">tplWriteMode</a></code> configurations.</div></div></td><td class="msource"><a href="output/Ext.Component.html#tpl" ext:member="#tpl" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-tplWriteMode"></a><b><a href="source/Component.html#cfg-Ext.Component-tplWriteMode">tplWriteMode</a></b> : String<div class="mdesc"><div class="short">The Ext.(X)Template method to use when\r
+updating the content area of the Component. Defaults to 'overwrite'\r
+(see Ext.X...</div><div class="long">The Ext.(X)Template method to use when
+updating the content area of the Component. Defaults to <tt>'overwrite'</tt>
+(see <code><a href="output/Ext.XTemplate.html#Ext.XTemplate-overwrite" ext:member="overwrite" ext:cls="Ext.XTemplate">Ext.XTemplate.overwrite</a></code>).</div></div></td><td class="msource"><a href="output/Ext.Component.html#tplWriteMode" ext:member="#tplWriteMode" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-trackMouseOver"></a><b><a href="source/TreePanel.html#cfg-Ext.tree.TreePanel-trackMouseOver">trackMouseOver</a></b> : Boolean<div class="mdesc"><tt>false</tt> to disable mouse over highlighting</div></td><td class="msource">TreePanel</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Panel-unstyled"></a><b><a href="source/Panel.html#cfg-Ext.Panel-unstyled">unstyled</a></b> : Boolean<div class="mdesc"><div class="short">Overrides the baseCls setting to baseCls = 'x-plain' which renders\r
the panel unstyled except for required attributes ...</div><div class="long">Overrides the <code><a href="output/Ext.Panel.html#Ext.Panel-baseCls" ext:member="baseCls" ext:cls="Ext.Panel">baseCls</a></code> setting to <code><a href="output/Ext.Panel.html#Ext.Panel-baseCls" ext:member="baseCls" ext:cls="Ext.Panel">baseCls</a> = <em>'x-plain'</em></code> which renders
the panel unstyled except for required attributes for Ext layouts to function (e.g. overflow:hidden).</div></div></td><td class="msource"><a href="output/Ext.Panel.html#unstyled" ext:member="#unstyled" ext:cls="Ext.Panel">Panel</a></td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-useArrows"></a><b><a href="source/TreePanel.html#cfg-Ext.tree.TreePanel-useArrows">useArrows</a></b> : Boolean<div class="mdesc"><tt>true</tt> to use Vista-style arrows in the tree (defaults to <tt>false</tt>)</div></td><td class="msource">TreePanel</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-width"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-width">width</a></b> : Number<div class="mdesc"><div class="short">The width of this component in pixels (defaults to auto).\r
Note to express this dimension as a percentage or offset se...</div><div class="long">The width of this component in pixels (defaults to auto).
<br><p><b>Note</b>: see the Note for <code><a href="output/Ext.Component.html#Ext.Component-el" ext:member="el" ext:cls="Ext.Component">el</a></code> also.</p></div></div></td><td class="msource"><a href="output/Ext.Panel.html#header" ext:member="#header" ext:cls="Ext.Panel">Panel</a></td></tr><tr class="property-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-hidden"></a><b><a href="source/Component.html#prop-Ext.Component-hidden">hidden</a></b> : Boolean<div class="mdesc">True if this component is hidden. Read-only.</div></td><td class="msource"><a href="output/Ext.Component.html#hidden" ext:member="#hidden" ext:cls="Ext.Component">Component</a></td></tr><tr class="property-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-initialConfig"></a><b><a href="source/Component.html#prop-Ext.Component-initialConfig">initialConfig</a></b> : Object<div class="mdesc">This Component's initial configuration specification. Read-only.</div></td><td class="msource"><a href="output/Ext.Component.html#initialConfig" ext:member="#initialConfig" ext:cls="Ext.Component">Component</a></td></tr><tr class="property-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-ownerCt"></a><b><a href="source/Component.html#prop-Ext.Component-ownerCt">ownerCt</a></b> : Ext.Container<div class="mdesc"><div class="short">This Component's owner Container (defaults to undefined, and is set automatically when\r
this Component is added to a C...</div><div class="long">This Component's owner <a href="output/Ext.Container.html" ext:cls="Ext.Container">Container</a> (defaults to undefined, and is set automatically when
this Component is added to a Container). Read-only.
-<p><b>Note</b>: to access items within the Container see <tt><a href="output/Ext.Component.html#Ext.Component-itemId" ext:member="itemId" ext:cls="Ext.Component">itemId</a></tt>.</p></div></div></td><td class="msource"><a href="output/Ext.Component.html#ownerCt" ext:member="#ownerCt" ext:cls="Ext.Component">Component</a></td></tr><tr class="property-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-rendered"></a><b><a href="source/Component.html#prop-Ext.Component-rendered">rendered</a></b> : Boolean<div class="mdesc">True if this component has been rendered. Read-only.</div></td><td class="msource"><a href="output/Ext.Component.html#rendered" ext:member="#rendered" ext:cls="Ext.Component">Component</a></td></tr><tr class="property-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-root"></a><b><a href="source/TreePanel.html#prop-Ext.tree.TreePanel-root">root</a></b> : Ext.tree.TreeNode<div class="mdesc">The root node of this tree.</div></td><td class="msource">TreePanel</td></tr></tbody></table><a id="Ext.tree.TreePanel-methods"></a><h2>Public Methods</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-TreePanel"></a><b><a href="source/TreePanel.html#cls-Ext.tree.TreePanel">TreePanel</a></b>( <code>Object config</code> )\r
- <div class="mdesc"><div class="short"></div><div class="long"><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>config</code> : Object<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div><table><tr><td class="label">xtype:</td><td class="hd-info">treepanel</td></tr></table></div></div></td><td class="msource">TreePanel</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Container-add"></a><b><a href="source/Container.html#method-Ext.Container-add">add</a></b>( <code>Object/Array component</code>, <code>Object (Optional)</code>, <code>Object (Optional)</code> )\r
- :\r
- Ext.Component<div class="mdesc"><div class="short">Adds Component(s) to this Container. \r
-Description : \r
-<ul class="mdetail-params"> \r
-Fires the beforeadd event before ad...</div><div class="long"><p>Adds <a href="output/Ext.Component.html" ext:cls="Ext.Component">Component</a>(s) to this Container.</p>\r
-<br><p><b>Description</b></u> :\r
-<div><ul class="mdetail-params">\r
-<li>Fires the <a href="output/Ext.Container.html#Ext.Container-beforeadd" ext:member="beforeadd" ext:cls="Ext.Container">beforeadd</a> event before adding</li>\r
-<li>The Container's <a href="output/Ext.Container.html#Ext.Container-defaults" ext:member="defaults" ext:cls="Ext.Container">default config values</a> will be applied\r
-accordingly (see <code><a href="output/Ext.Container.html#Ext.Container-defaults" ext:member="defaults" ext:cls="Ext.Container">defaults</a></code> for details).</li>\r
-<li>Fires the <a href="output/Ext.Container.html#Ext.Container-add" ext:member="add" ext:cls="Ext.Container">add</a> event after the component has been added.</li>\r
-</ul></div>\r
-<br><p><b>Notes</b></u> :\r
-<div><ul class="mdetail-params">\r
-<li>If the Container is <i>already rendered</i> when <tt>add</tt>\r
-is called, you may need to call <a href="output/Ext.Container.html#Ext.Container-doLayout" ext:member="doLayout" ext:cls="Ext.Container">doLayout</a> to refresh the view which causes\r
-any unrendered child Components to be rendered. This is required so that you can\r
-<tt>add</tt> multiple child components if needed while only refreshing the layout\r
-once. For example:<pre><code><b>var</b> tb = <b>new</b> <a href="output/Ext.Toolbar.html" ext:cls="Ext.Toolbar">Ext.Toolbar</a>();\r
-tb.render(document.body); <i>// toolbar is rendered\r</i>
-tb.add({text:<em>'Button 1'</em>}); <i>// add multiple items (<a href="output/Ext.Container.html#Ext.Container-defaultType" ext:member="defaultType" ext:cls="Ext.Container">defaultType</a> <b>for</b> <a href="output/Ext.Toolbar.html" ext:cls="Ext.Toolbar">Toolbar</a> is <em>'button'</em>)\r</i>
-tb.add({text:<em>'Button 2'</em>});\r
-tb.<a href="output/Ext.Container.html#Ext.Container-doLayout" ext:member="doLayout" ext:cls="Ext.Container">doLayout</a>(); <i>// refresh the layout</i></code></pre></li>\r
-<li><i>Warning:</i> Containers directly managed by the BorderLayout layout manager\r
-may not be removed or added. See the Notes for <a href="output/Ext.layout.BorderLayout.html" ext:cls="Ext.layout.BorderLayout">BorderLayout</a>\r
-for more details.</li>\r
-</ul></div><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>component</code> : Object/Array<div class="sub-desc"><p>Either a single component or an Array of components to add. See\r
+<p><b>Note</b>: to access items within the Container see <tt><a href="output/Ext.Component.html#Ext.Component-itemId" ext:member="itemId" ext:cls="Ext.Component">itemId</a></tt>.</p></div></div></td><td class="msource"><a href="output/Ext.Component.html#ownerCt" ext:member="#ownerCt" ext:cls="Ext.Component">Component</a></td></tr><tr class="property-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-refOwner"></a><b><a href="source/Component.html#prop-Ext.Component-refOwner">refOwner</a></b> : Ext.Container<div class="mdesc"><div class="short">The ancestor Container into which the ref reference was inserted if this Component\r
+is a child of a Container, and has...</div><div class="long">The ancestor Container into which the <a href="output/Ext.Component.html#Ext.Component-ref" ext:member="ref" ext:cls="Ext.Component">ref</a> reference was inserted if this Component
+is a child of a Container, and has been configured with a <code>ref</code>.</div></div></td><td class="msource"><a href="output/Ext.Component.html#refOwner" ext:member="#refOwner" ext:cls="Ext.Component">Component</a></td></tr><tr class="property-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-rendered"></a><b><a href="source/Component.html#prop-Ext.Component-rendered">rendered</a></b> : Boolean<div class="mdesc">True if this component has been rendered. Read-only.</div></td><td class="msource"><a href="output/Ext.Component.html#rendered" ext:member="#rendered" ext:cls="Ext.Component">Component</a></td></tr><tr class="property-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-root"></a><b><a href="source/TreePanel.html#prop-Ext.tree.TreePanel-root">root</a></b> : Ext.tree.TreeNode<div class="mdesc">The root node of this tree.</div></td><td class="msource">TreePanel</td></tr></tbody></table><a id="Ext.tree.TreePanel-methods"></a><h2>Public Methods</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-TreePanel"></a><b><a href="source/TreePanel.html#cls-Ext.tree.TreePanel">TreePanel</a></b>( <code>Object config</code> )\r
+ <div class="mdesc"><div class="short"></div><div class="long"><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>config</code> : Object<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">TreePanel</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Container-add"></a><b><a href="source/Container.html#method-Ext.Container-add">add</a></b>( <code>Object/Array component</code>, <code>Object (Optional)</code>, <code>Object (Optional)</code> )\r
+ :\r
+ Ext.Component<div class="mdesc"><div class="short">Adds Component(s) to this Container.\r
+Description :\r
+<ul class="mdetail-params">\r
+Fires the beforeadd event before addin...</div><div class="long"><p>Adds <a href="output/Ext.Component.html" ext:cls="Ext.Component">Component</a>(s) to this Container.</p>
+<br><p><b>Description</b></u> :
+<div><ul class="mdetail-params">
+<li>Fires the <a href="output/Ext.Container.html#Ext.Container-beforeadd" ext:member="beforeadd" ext:cls="Ext.Container">beforeadd</a> event before adding</li>
+<li>The Container's <a href="output/Ext.Container.html#Ext.Container-defaults" ext:member="defaults" ext:cls="Ext.Container">default config values</a> will be applied
+accordingly (see <code><a href="output/Ext.Container.html#Ext.Container-defaults" ext:member="defaults" ext:cls="Ext.Container">defaults</a></code> for details).</li>
+<li>Fires the <a href="output/Ext.Container.html#Ext.Container-add" ext:member="add" ext:cls="Ext.Container">add</a> event after the component has been added.</li>
+</ul></div>
+<br><p><b>Notes</b></u> :
+<div><ul class="mdetail-params">
+<li>If the Container is <i>already rendered</i> when <code>add</code>
+is called, you may need to call <a href="output/Ext.Container.html#Ext.Container-doLayout" ext:member="doLayout" ext:cls="Ext.Container">doLayout</a> to refresh the view which causes
+any unrendered child Components to be rendered. This is required so that you can
+<code>add</code> multiple child components if needed while only refreshing the layout
+once. For example:<pre><code><b>var</b> tb = <b>new</b> <a href="output/Ext.Toolbar.html" ext:cls="Ext.Toolbar">Ext.Toolbar</a>();
+tb.render(document.body); <i>// toolbar is rendered</i>
+tb.add({text:<em>'Button 1'</em>}); <i>// add multiple items (<a href="output/Ext.Container.html#Ext.Container-defaultType" ext:member="defaultType" ext:cls="Ext.Container">defaultType</a> <b>for</b> <a href="output/Ext.Toolbar.html" ext:cls="Ext.Toolbar">Toolbar</a> is <em>'button'</em>)</i>
+tb.add({text:<em>'Button 2'</em>});
+tb.<a href="output/Ext.Container.html#Ext.Container-doLayout" ext:member="doLayout" ext:cls="Ext.Container">doLayout</a>(); <i>// refresh the layout</i></code></pre></li>
+<li><i>Warning:</i> Containers directly managed by the BorderLayout layout manager
+may not be removed or added. See the Notes for <a href="output/Ext.layout.BorderLayout.html" ext:cls="Ext.layout.BorderLayout">BorderLayout</a>
+for more details.</li>
+</ul></div><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>component</code> : Object/Array<div class="sub-desc"><p>Either a single component or an Array of components to add. See
<code><a href="output/Ext.Container.html#Ext.Container-items" ext:member="items" ext:cls="Ext.Container">items</a></code> for additional information.</p></div></li><li><code>(Optional)</code> : Object<div class="sub-desc">component_2</div></li><li><code>(Optional)</code> : Object<div class="sub-desc">component_n</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Component</code><div class="sub-desc">component The Component (or config object) that was added.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Container.html#add" ext:member="#add" ext:cls="Ext.Container">Container</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Panel-addButton"></a><b><a href="source/Panel.html#method-Ext.Panel-addButton">addButton</a></b>( <code>String/Object config</code>, <code>Function handler</code>, <code>Object scope</code> )\r
:\r
Ext.Button<div class="mdesc"><div class="short">Adds a button to this panel. Note that this method must be called prior to rendering. The preferred\r
approach is to ...</div><div class="long">Adds a button to this panel. Note that this method must be called prior to rendering. The preferred
approach is to add buttons via the <a href="output/Ext.Panel.html#Ext.Panel-buttons" ext:member="buttons" ext:cls="Ext.Panel">buttons</a> config.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>config</code> : String/Object<div class="sub-desc">A valid <a href="output/Ext.Button.html" ext:cls="Ext.Button">Ext.Button</a> config. A string will become the text for a default
-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 href="output/Ext.Button.html#Ext.Button-click" ext:member="click" ext:cls="Ext.Button">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><strong>Returns:</strong><ul><li><code>Ext.Button</code><div class="sub-desc">The button that was added</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Panel.html#addButton" ext:member="#addButton" ext:cls="Ext.Panel">Panel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-addClass"></a><b><a href="source/Component.html#method-Ext.Component-addClass">addClass</a></b>( <code>string cls</code> )
\r+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 href="output/Ext.Button.html#Ext.Button-click" ext:member="click" ext:cls="Ext.Button">Ext.Button.click</a></div></li><li><code>scope</code> : Object<div class="sub-desc">The scope
(<code>this</code> reference) in which the button handler function is executed. Defaults to the Button.</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Button</code><div class="sub-desc">The button that was added</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Panel.html#addButton" ext:member="#addButton" ext:cls="Ext.Panel">Panel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-addClass"></a><b><a href="source/Component.html#method-Ext.Component-addClass">addClass</a></b>( <code>string cls</code> )
\r :\r
Ext.Component<div class="mdesc"><div class="short">Adds a CSS class to the component's underlying element.</div><div class="long">Adds a CSS class to the component's underlying element.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>cls</code> : string<div class="sub-desc">The CSS class name to add</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Component</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#addClass" ext:member="#addClass" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-addEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-addEvents">addEvents</a></b>( <code>Object|String o</code>, <code>string Optional.</code> )\r
:\r
scope: this
});</code></pre></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#addListener" ext:member="#addListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Container-bubble"></a><b><a href="source/Container.html#method-Ext.Container-bubble">bubble</a></b>( <code>Function fn</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span>, <span title="Optional" class="optional">[<code>Array args</code>]</span> )\r
:\r
- Ext.Container<div class="mdesc"><div class="short">Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of...</div><div class="long">Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (<i>this</i>) of\r
-function call will be the scope provided or the current component. The arguments to the function\r
-will be the args provided or the current component. If the function returns false at any point,\r
-the bubble is stopped.<div class="mdetail-params"><strong>Parameters:</strong><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><strong>Returns:</strong><ul><li><code>Ext.Container</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Container.html#bubble" ext:member="#bubble" ext:cls="Ext.Container">Container</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-cloneConfig"></a><b><a href="source/Component.html#method-Ext.Component-cloneConfig">cloneConfig</a></b>( <code>Object overrides</code> )\r
+ Ext.Container<div class="mdesc"><div class="short">Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of...</div><div class="long">Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (<i>this</i>) of
+function call will be the scope provided or the current component. The arguments to the function
+will be the args provided or the current component. If the function returns false at any point,
+the bubble is stopped.<div class="mdetail-params"><strong>Parameters:</strong><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><strong>Returns:</strong><ul><li><code>Ext.Container</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Container.html#bubble" ext:member="#bubble" ext:cls="Ext.Container">Container</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Container-canLayout"></a><b><a href="source/Container.html#method-Ext.Container-canLayout">canLayout</a></b>()\r
+ :\r
+ void<div class="mdesc"><div class="short">We can only lay out if there is a view area in which to layout.\r
+display:none on the layout target, *or any of its par...</div><div class="long">We can only lay out if there is a view area in which to layout.
+display:none on the layout target, *or any of its parent elements* will mean it has no view area.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Container.html#canLayout" ext:member="#canLayout" ext:cls="Ext.Container">Container</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-cloneConfig"></a><b><a href="source/Component.html#method-Ext.Component-cloneConfig">cloneConfig</a></b>( <code>Object overrides</code> )\r
:\r
Ext.Component<div class="mdesc"><div class="short">Clone the current component using the original config values passed into this instance by default.</div><div class="long">Clone the current component using the original config values passed into this instance by default.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>overrides</code> : Object<div class="sub-desc">A new config containing any properties to override in the cloned version.
An id property can be passed on this object, otherwise one will be generated to avoid duplicates.</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Component</code><div class="sub-desc">clone The cloned copy of this component</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#cloneConfig" ext:member="#cloneConfig" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Panel-collapse"></a><b><a href="source/Panel.html#method-Ext.Panel-collapse">collapse</a></b>( <code>Boolean animate</code> )\r
removing the c...</div><div class="long">Destroys this component by purging any event listeners, removing the component's element from the DOM,
removing the component from its <a href="output/Ext.Container.html" ext:cls="Ext.Container">Ext.Container</a> (if applicable) and unregistering it from
<a href="output/Ext.ComponentMgr.html" ext:cls="Ext.ComponentMgr">Ext.ComponentMgr</a>. Destruction is generally handled automatically by the framework and this method
-should usually not need to be called directly.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#destroy" ext:member="#destroy" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-enableBubble"></a><b><a href="source/Observable-more.html#method-Ext.util.Observable-enableBubble">enableBubble</a></b>( <code>Object events</code> )\r
+should usually not need to be called directly.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#destroy" ext:member="#destroy" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-enableBubble"></a><b><a href="source/Observable-more.html#method-Ext.util.Observable-enableBubble">enableBubble</a></b>( <code>String/Array events</code> )\r
:\r
void<div class="mdesc"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling \r
this.getBubbleTarget() if present...</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling\r
implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to\r
access the required target more quickly.</p>\r
<p>Example:</p><pre><code>Ext.override(Ext.form.Field, {\r
-<i>// Add functionality to Field<em>'s initComponent to enable the change event to bubble\r</i>
- initComponent: Ext.form.Field.prototype.initComponent.createSequence(<b>function</b>() {\r
- this.enableBubble('</em>change<em>');\r
+ <i>// Add functionality to Field's initComponent to enable the change event to bubble\r</i>
+ initComponent : Ext.form.Field.prototype.initComponent.createSequence(<b>function</b>() {\r
+ this.enableBubble(<em>'change'</em>);\r
}),\r
\r
-<i>// We know that we want Field'</em>s events to bubble directly to the FormPanel.\r</i>
- getBubbleTarget: <b>function</b>() {\r
+ <i>// We know that we want Field's events to bubble directly to the FormPanel.\r</i>
+ getBubbleTarget : <b>function</b>() {\r
<b>if</b> (!this.formPanel) {\r
this.formPanel = this.findParentByType(<em>'form'</em>);\r
}\r
}],\r
listeners: {\r
change: <b>function</b>() {\r
-<i>// Title goes red <b>if</b> form has been modified.\r</i>
- myForm.header.setStyle(<em>"color"</em>, <em>"red"</em>);\r
+ <i>// Title goes red <b>if</b> form has been modified.\r</i>
+ myForm.header.setStyle(<em>'color'</em>, <em>'red'</em>);\r
}\r
}\r
-});</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>events</code> :
Object<div class="sub-desc">The event name to bubble, or an Array of event names.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#enableBubble" ext:member="#enableBubble" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Panel-expand"></a><b><a href="source/Panel.html#method-Ext.Panel-expand">expand</a></b>( <code>Boolean animate</code> )
\r+});</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>events</code> :
String/Array<div class="sub-desc">The event name to bubble, or an Array of event names.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#enableBubble" ext:member="#enableBubble" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Panel-expand"></a><b><a href="source/Panel.html#method-Ext.Panel-expand">expand</a></b>( <code>Boolean animate</code> )
\r :\r
Ext.Panel<div class="mdesc"><div class="short">Expands the panel body so that it becomes visible. Fires the beforeexpand event which will\r
cancel the expand action ...</div><div class="long">Expands the panel body so that it becomes visible. Fires the <a href="output/Ext.Panel.html#Ext.Panel-beforeexpand" ext:member="beforeexpand" ext:cls="Ext.Panel">beforeexpand</a> event which will
:\r
Ext.Container<div class="mdesc"><div class="short">Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy.</div><div class="long">Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.Container</code><div class="sub-desc">the Container which owns this Component.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#getBubbleTarget" ext:member="#getBubbleTarget" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-getChecked"></a><b><a href="source/TreePanel.html#method-Ext.tree.TreePanel-getChecked">getChecked</a></b>( <span title="Optional" class="optional">[<code>String attribute</code>]</span>, <span title="Optional" class="optional">[<code>TreeNode startNode</code>]</span> )\r
:\r
- Array<div class="mdesc"><div class="short">Retrieve an array of checked nodes, or an array of a specific attribute of checked nodes (e.g. "id")</div><div class="long">Retrieve an array of checked nodes, or an array of a specific attribute of checked nodes (e.g. "id")<div class="mdetail-params"><strong>Parameters:</strong><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><strong>Returns:</strong><ul><li><code>Array</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">TreePanel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-getEl"></a><b><a href="source/TreePanel.html#method-Ext.tree.TreePanel-getEl">getEl</a></b>()\r
+ Array<div class="mdesc"><div class="short">Retrieve an array of checked nodes, or an array of a specific attribute of checked nodes (e.g. 'id')</div><div class="long">Retrieve an array of checked nodes, or an array of a specific attribute of checked nodes (e.g. 'id')<div class="mdetail-params"><strong>Parameters:</strong><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><strong>Returns:</strong><ul><li><code>Array</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">TreePanel</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-getEl"></a><b><a href="source/Component.html#method-Ext.Component-getEl">getEl</a></b>()\r
:\r
- Element<div class="mdesc"><div class="short">Returns the container element for this TreePanel.</div><div class="long">Returns the container element for this TreePanel.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Element</code><div class="sub-desc">The container element for this TreePanel.</div></li></ul></div></div></div></td><td class="msource">TreePanel</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Panel-getFrameHeight"></a><b><a href="source/Panel.html#method-Ext.Panel-getFrameHeight">getFrameHeight</a></b>()\r
+ Ext.Element<div class="mdesc"><div class="short">Returns the Ext.Element which encapsulates this Component.\r
+This will usually be a &lt;DIV> element created by the cla...</div><div class="long"><p>Returns the <a href="output/Ext.Element.html" ext:cls="Ext.Element">Ext.Element</a> which encapsulates this Component.</p>
+<p>This will <i>usually</i> be a <DIV> element created by the class's onRender method, but
+that may be overridden using the <a href="output/Ext.Component.html#Ext.Component-autoEl" ext:member="autoEl" ext:cls="Ext.Component">autoEl</a> config.</p>
+<br><p><b>Note</b>: this element will not be available until this Component has been rendered.</p><br>
+<p>To add listeners for <b>DOM events</b> to this Component (as opposed to listeners
+for this Component's own Observable events), see the <a href="output/Ext.Component.html#Ext.Component-listeners" ext:member="listeners" ext:cls="Ext.Component">listeners</a> config for a suggestion,
+or use a render listener directly:</p><pre><code><b>new</b> Ext.Panel({
+ title: <em>'The Clickable Panel'</em>,
+ listeners: {
+ render: <b>function</b>(p) {
+ <i>// Append the Panel to the click handler's argument list.</i>
+ p.getEl().on(<em>'click'</em>, handlePanelClick.createDelegate(null, [p], true));
+ },
+ single: true <i>// Remove the listener after first invocation</i>
+ }
+});</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.Element</code><div class="sub-desc">The Element which encapsulates this Component.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#getEl" ext:member="#getEl" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Panel-getFrameHeight"></a><b><a href="source/Panel.html#method-Ext.Panel-getFrameHeight">getFrameHeight</a></b>()\r
:\r
Number<div class="mdesc"><div class="short">Returns the height in pixels of the framing elements of this panel (including any top and bottom bars and\r
header and ...</div><div class="long">Returns the height in pixels of the framing elements of this panel (including any top and bottom bars and
<code><a href="output/Ext.Component.html#Ext.Component-itemId" ext:member="itemId" ext:cls="Ext.Component">itemId</a></code> was not assigned through configuration the
<code>id</code> is returned using <code><a href="output/Ext.Component.html#Ext.Component-getId" ext:member="getId" ext:cls="Ext.Component">getId</a></code>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#getItemId" ext:member="#getItemId" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Container-getLayoutTarget"></a><b><a href="source/Container.html#method-Ext.Container-getLayoutTarget">getLayoutTarget</a></b>()\r
:\r
- Ext.Element<div class="mdesc"><div class="short">Returns the Element to be used to contain the child Components of this Container. \r
-An implementation is provided whic...</div><div class="long"><p>Returns the Element to be used to contain the child Components of this Container.</p>\r
-<p>An implementation is provided which returns the Container's <a href="output/Ext.Container.html#Ext.Container-getEl" ext:member="getEl" ext:cls="Ext.Container">Element</a>, but\r
-if there is a more complex structure to a Container, this may be overridden to return\r
+ Ext.Element<div class="mdesc"><div class="short">Returns the Element to be used to contain the child Components of this Container.\r
+An implementation is provided which...</div><div class="long"><p>Returns the Element to be used to contain the child Components of this Container.</p>
+<p>An implementation is provided which returns the Container's <a href="output/Ext.Container.html#Ext.Container-getEl" ext:member="getEl" ext:cls="Ext.Container">Element</a>, but
+if there is a more complex structure to a Container, this may be overridden to return
the element into which the <a href="output/Ext.Container.html#Ext.Container-layout" ext:member="layout" ext:cls="Ext.Container">layout</a> renders child Components.</p><div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.Element</code><div class="sub-desc">The Element to render child Components into.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Container.html#getLayoutTarget" ext:member="#getLayoutTarget" ext:cls="Ext.Container">Container</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-getLoader"></a><b><a href="source/TreePanel.html#method-Ext.tree.TreePanel-getLoader">getLoader</a></b>()\r
:\r
Ext.tree.TreeLoader<div class="mdesc"><div class="short">Returns the default Ext.tree.TreeLoader for this TreePanel.</div><div class="long">Returns the default <a href="output/Ext.tree.TreeLoader.html" ext:cls="Ext.tree.TreeLoader">Ext.tree.TreeLoader</a> for this TreePanel.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.tree.TreeLoader</code><div class="sub-desc">The TreeLoader for this TreePanel.</div></li></ul></div></div></div></td><td class="msource">TreePanel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-getNodeById"></a><b><a href="source/TreePanel.html#method-Ext.tree.TreePanel-getNodeById">getNodeById</a></b>( <code>String id</code> )\r
:\r
Array<div class="mdesc"><div class="short">Gets the current XY position of the component's underlying element.</div><div class="long">Gets the current XY position of the component's underlying element.<div class="mdetail-params"><strong>Parameters:</strong><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><strong>Returns:</strong><ul><li><code>Array</code><div class="sub-desc">The XY position of the element (e.g., [100, 200])</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#getPosition" ext:member="#getPosition" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-getResizeEl"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-getResizeEl">getResizeEl</a></b>()\r
:\r
-
void<div class="mdesc"><div class="short">Returns the outermost Element of this Component which defines the Components overall size.
\r+
Ext.Element<div class="mdesc"><div class="short">Returns the outermost Element of this Component which defines the Components overall size.
\r Usually this will return t...</div><div class="long"><p>Returns the outermost Element of this Component which defines the Components overall size.</p>
<p><i>Usually</i> this will return the same Element as <code><a href="output/Ext.BoxComponent.html#Ext.BoxComponent-getEl" ext:member="getEl" ext:cls="Ext.BoxComponent">getEl</a></code>,
but in some cases, a Component may have some more wrapping Elements around its main
<p>An example is a ComboBox. It is encased in a <i>wrapping</i> Element which
contains both the <code><input></code> Element (which is what would be returned
by its <code><a href="output/Ext.BoxComponent.html#Ext.BoxComponent-getEl" ext:member="getEl" ext:cls="Ext.BoxComponent">getEl</a></code> method, <i>and</i> the trigger button Element.
-This Element is returned as the <code>resizeEl</code>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>
void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#getResizeEl" ext:member="#getResizeEl" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-getRootNode"></a><b><a href="source/TreePanel.html#method-Ext.tree.TreePanel-getRootNode">getRootNode</a></b>()
\r+This Element is returned as the <code>resizeEl</code>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>
<code>Ext.Element</code><div class="sub-desc">The Element which is to be resized by size managing layouts.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#getResizeEl" ext:member="#getResizeEl" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-getRootNode"></a><b><a href="source/TreePanel.html#method-Ext.tree.TreePanel-getRootNode">getRootNode</a></b>()
\r :\r
Node<div class="mdesc"><div class="short">Returns this root node for this tree</div><div class="long">Returns this root node for this tree<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Node</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">TreePanel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-getSelectionModel"></a><b><a href="source/TreePanel.html#method-Ext.tree.TreePanel-getSelectionModel">getSelectionModel</a></b>()\r
:\r
<b>var</b> isText = t.isXType(<em>'textfield'</em>); <i>// true</i>
<b>var</b> isBoxSubclass = t.isXType(<em>'box'</em>); <i>// true, descended from BoxComponent</i>
<b>var</b> isBoxInstance = t.isXType(<em>'box'</em>, true); <i>// false, not a direct BoxComponent instance</i></code></pre><div class="mdetail-params"><strong>Parameters:</strong><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
-the default), or true to check whether this Component is directly of the specified xtype.</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True if this component descends from the specified xtype, false otherwise.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#isXType" ext:member="#isXType" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-nextSibling"></a><b><a href="source/Component.html#method-Ext.Component-nextSibling">nextSibling</a></b>()\r
+the default), or true to check whether this Component is directly of the specified xtype.</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True if this component descends from the specified xtype, false otherwise.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#isXType" ext:member="#isXType" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-mon"></a><b><a href="source/Component.html#method-Ext.Component-mon">mon</a></b>( <code>Observable|Element item</code>, <code>Object|String ename</code>, <code>Function fn</code>, <code>Object scope</code>, <code>Object opt</code> )\r
+ :\r
+ void<div class="mdesc"><div class="short">Adds listeners to any Observable object (or Elements) which are automatically removed when this Component\r
+is destroye...</div><div class="long"><p>Adds listeners to any Observable object (or Elements) which are automatically removed when this Component
+is destroyed. Usage:</p><code><pre>
+myGridPanel.mon(myGridPanel.getSelectionModel(), <em>'selectionchange'</em>, handleSelectionChange, null, {buffer: 50});
+</pre></code>
+<p>or:</p><code><pre>
+myGridPanel.mon(myGridPanel.getSelectionModel(), {
+ selectionchange: handleSelectionChange,
+ buffer: 50
+});
+</pre></code><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>item</code> : Observable|Element<div class="sub-desc">The item to which to add a listener/listeners.</div></li><li><code>ename</code> : Object|String<div class="sub-desc">The event name, or an object containing event name properties.</div></li><li><code>fn</code> : Function<div class="sub-desc">Optional. If the <code>ename</code> parameter was an event name, this
+is the handler function.</div></li><li><code>scope</code> : Object<div class="sub-desc">Optional. If the <code>ename</code> parameter was an event name, this
+is the scope (<code>this</code> reference) in which the handler function is executed.</div></li><li><code>opt</code> : Object<div class="sub-desc">Optional. If the <code>ename</code> parameter was an event name, this
+is the <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> options.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#mon" ext:member="#mon" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-mun"></a><b><a href="source/Component.html#method-Ext.Component-mun">mun</a></b>( <code>Observable|Element item</code>, <code>Object|String ename</code>, <code>Function fn</code>, <code>Object scope</code> )\r
+ :\r
+ void<div class="mdesc"><div class="short">Removes listeners that were added by the mon method.</div><div class="long">Removes listeners that were added by the <a href="output/Ext.Component.html#Ext.Component-mon" ext:member="mon" ext:cls="Ext.Component">mon</a> method.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>item</code> : Observable|Element<div class="sub-desc">The item from which to remove a listener/listeners.</div></li><li><code>ename</code> : Object|String<div class="sub-desc">The event name, or an object containing event name properties.</div></li><li><code>fn</code> : Function<div class="sub-desc">Optional. If the <code>ename</code> parameter was an event name, this
+is the handler function.</div></li><li><code>scope</code> : Object<div class="sub-desc">Optional. If the <code>ename</code> parameter was an event name, this
+is the scope (<code>this</code> reference) in which the handler function is executed.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#mun" ext:member="#mun" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-nextSibling"></a><b><a href="source/Component.html#method-Ext.Component-nextSibling">nextSibling</a></b>()\r
:\r
Ext.Component<div class="mdesc"><div class="short">Returns the next component in the owning container</div><div class="long">Returns the next component in the owning container<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.Component</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#nextSibling" ext:member="#nextSibling" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-on"></a><b><a href="source/Observable.html#method-Ext.util.Observable-on">on</a></b>( <code>String eventName</code>, <code>Function handler</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span>, <span title="Optional" class="optional">[<code>Object options</code>]</span> )\r
:\r
events fired during event suspension will be sent to any listeners now.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#resumeEvents" ext:member="#resumeEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-selectPath"></a><b><a href="source/TreePanel.html#method-Ext.tree.TreePanel-selectPath">selectPath</a></b>( <code>String path</code>, <span title="Optional" class="optional">[<code>String attr</code>]</span>, <span title="Optional" class="optional">[<code>Function callback</code>]</span> )\r
:\r
void<div class="mdesc"><div class="short">Selects the node in this tree at the specified path. A path can be retrieved from a node with Ext.data.Node.getPath</div><div class="long">Selects the node in this tree at the specified path. A path can be retrieved from a node with <a href="output/Ext.data.Node.html#Ext.data.Node-getPath" ext:member="getPath" ext:cls="Ext.data.Node">Ext.data.Node.getPath</a><div class="mdetail-params"><strong>Parameters:</strong><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 href="output/Ext.data.Node.html#Ext.data.Node-getPath" ext:member="getPath" ext:cls="Ext.data.Node">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\r
-(bSuccess, oSelNode) where bSuccess is if the selection was successful and oSelNode is the selected node.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">TreePanel</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-setHeight"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-setHeight">setHeight</a></b>( <code>Number height</code> )\r
+(bSuccess, oSelNode) where bSuccess is if the selection was successful and oSelNode is the selected node.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">TreePanel</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-setAutoScroll"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-setAutoScroll">setAutoScroll</a></b>( <code>Boolean scroll</code> )\r
+ :\r
+ Ext.BoxComponent<div class="mdesc"><div class="short">Sets the overflow on the content element of the component.</div><div class="long">Sets the overflow on the content element of the component.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>scroll</code> : Boolean<div class="sub-desc">True to allow the Component to auto scroll.</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#setAutoScroll" ext:member="#setAutoScroll" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-setHeight"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-setHeight">setHeight</a></b>( <code>Number height</code> )\r
:\r
Ext.BoxComponent<div class="mdesc"><div class="short">Sets the height of the component. This method fires the resize event.</div><div class="long">Sets the height of the component. This method fires the <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-resize" ext:member="resize" ext:cls="Ext.BoxComponent">resize</a> event.<div class="mdetail-params"><strong>Parameters:</strong><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>
<li>A Number specifying the new height in the <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-getEl" ext:member="getEl" ext:cls="Ext.BoxComponent">Element</a>'s <a href="output/Ext.Element.html#Ext.Element-defaultUnit" ext:member="defaultUnit" ext:cls="Ext.Element">Ext.Element.defaultUnit</a>s (by default, pixels).</li>
Ext.Panel<div class="mdesc"><div class="short">Shortcut for performing an expand or collapse based on the current state of the panel.</div><div class="long">Shortcut for performing an <a href="output/Ext.Panel.html#Ext.Panel-expand" ext:member="expand" ext:cls="Ext.Panel">expand</a> or <a href="output/Ext.Panel.html#Ext.Panel-collapse" ext:member="collapse" ext:cls="Ext.Panel">collapse</a> based on the current state of the panel.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>animate</code> : Boolean<div class="sub-desc">True to animate the transition, else false (defaults to the value of the
<a href="output/Ext.Panel.html#Ext.Panel-animCollapse" ext:member="animCollapse" ext:cls="Ext.Panel">animCollapse</a> panel config)</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Panel</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Panel.html#toggleCollapse" ext:member="#toggleCollapse" ext:cls="Ext.Panel">Panel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-un"></a><b><a href="source/Observable.html#method-Ext.util.Observable-un">un</a></b>( <code>String eventName</code>, <code>Function handler</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span> )\r
:\r
- void<div class="mdesc"><div class="short">Removes an event handler (shorthand for removeListener.)</div><div class="long">Removes an event handler (shorthand for <a href="output/Ext.util.Observable.html#Ext.util.Observable-removeListener" ext:member="removeListener" ext:cls="Ext.util.Observable">removeListener</a>.)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event the handler was associated with.</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove. <b>This must be a reference to the function passed into the <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> call.</b></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope originally specified for the handler.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#un" ext:member="#un" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-updateBox"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-updateBox">updateBox</a></b>( <code>Object box</code> )\r
+ void<div class="mdesc"><div class="short">Removes an event handler (shorthand for removeListener.)</div><div class="long">Removes an event handler (shorthand for <a href="output/Ext.util.Observable.html#Ext.util.Observable-removeListener" ext:member="removeListener" ext:cls="Ext.util.Observable">removeListener</a>.)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event the handler was associated with.</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove. <b>This must be a reference to the function passed into the <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> call.</b></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope originally specified for the handler.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#un" ext:member="#un" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-update"></a><b><a href="source/Component.html#method-Ext.Component-update">update</a></b>( <code>Mixed htmlOrData</code>, <span title="Optional" class="optional">[<code>Boolean loadScripts</code>]</span>, <span title="Optional" class="optional">[<code>Function callback</code>]</span> )\r
+ :\r
+ void<div class="mdesc"><div class="short">Update the content area of a component.</div><div class="long">Update the content area of a component.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>htmlOrData</code> : Mixed<div class="sub-desc">If this component has been configured with a template via the tpl config
+then it will use this argument as data to populate the template.
+If this component was not configured with a template, the components
+content area will be updated via Ext.Element update</div></li><li><code>loadScripts</code> : Boolean<div class="sub-desc">(optional) Only legitimate when using the html configuration. Defaults to false</div></li><li><code>callback</code> : Function<div class="sub-desc">(optional) Only legitimate when using the html configuration. Callback to execute when scripts have finished loading</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#update" ext:member="#update" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-updateBox"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-updateBox">updateBox</a></b>( <code>Object box</code> )\r
:\r
Ext.BoxComponent<div class="mdesc"><div class="short">Sets the current box measurements of the component's underlying element.</div><div class="long">Sets the current box measurements of the component's underlying element.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>box</code> : Object<div class="sub-desc">An object in the format {x, y, width, height}</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#updateBox" ext:member="#updateBox" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr></tbody></table><a id="Ext.tree.TreePanel-events"></a><h2>Public Events</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Event</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Panel-activate"></a><b><a href="source/Panel.html#event-Ext.Panel-activate">activate</a></b> :\r
( <code>Ext.Panel p</code> )\r
Note that Panels do not directly support being activated, but some...</div><div class="long">Fires after the Panel has been visually activated.
Note that Panels do not directly support being activated, but some Panel subclasses
do (like <a href="output/Ext.Window.html" ext:cls="Ext.Window">Ext.Window</a>). Panels which are child Components of a TabPanel fire the
-activate and deactivate events under the control of the TabPanel.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>p</code> : Ext.Panel<div class="sub-desc">The Panel that has been activated.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Panel.html#activate" ext:member="#activate" ext:cls="Ext.Panel">Panel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Container-afterlayout"></a><b><a href="source/Container.html#event-Ext.Container-afterlayout">afterlayout</a></b> :\r
+activate and deactivate events under the control of the TabPanel.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>p</code> : Ext.Panel<div class="sub-desc">The Panel that has been activated.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Panel.html#activate" ext:member="#activate" ext:cls="Ext.Panel">Panel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-added"></a><b><a href="source/Component.html#event-Ext.Component-added">added</a></b> :\r
+ ( <code>Ext.Component this</code>, <code>Ext.Container ownerCt</code>, <code>number index</code> )\r
+ <div class="mdesc"><div class="short">Fires when a component is added to an Ext.Container</div><div class="long">Fires when a component is added to an Ext.Container<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>ownerCt</code> : Ext.Container<div class="sub-desc">Container which holds the component</div></li><li><code>index</code> : number<div class="sub-desc">Position at which the component was added</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#added" ext:member="#added" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Container-afterlayout"></a><b><a href="source/Container.html#event-Ext.Container-afterlayout">afterlayout</a></b> :\r
( <code>Ext.Container this</code>, <code>ContainerLayout layout</code> )\r
<div class="mdesc"><div class="short">Fires when the components in this container are arranged by the associated layout manager.</div><div class="long">Fires when the components in this container are arranged by the associated layout manager.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><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></div></div></div></td><td class="msource"><a href="output/Ext.Container.html#afterlayout" ext:member="#afterlayout" ext:cls="Ext.Container">Container</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-afterrender"></a><b><a href="source/Component.html#event-Ext.Component-afterrender">afterrender</a></b> :\r
( <code>Ext.Component this</code> )\r
to be inserted by setting them on this object.</li>\r
<li>cancel - Set this to true to cancel the drop.</li>\r
<li>dropStatus - If the default drop action is cancelled but the drop is valid, setting this to true\r
-will prevent the animated "repair" from appearing.</li>\r
+will prevent the animated 'repair' from appearing.</li>\r
</ul><div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>dropEvent</code> : Object<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">TreePanel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-beforeremove"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-beforeremove">beforeremove</a></b> :\r
( <code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code> )\r
<div class="mdesc"><div class="short">Fires before a child is removed from a node in this tree, return false to cancel the remove.</div><div class="long">Fires before a child is removed from a node in this tree, return false to cancel the remove.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><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></div></div></div></td><td class="msource">TreePanel</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-beforerender"></a><b><a href="source/Component.html#event-Ext.Component-beforerender">beforerender</a></b> :\r
( <code>Ext.Panel p</code> )\r
<div class="mdesc"><div class="short">Fires after the Panel has been collapsed.</div><div class="long">Fires after the Panel has been collapsed.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>p</code> : Ext.Panel<div class="sub-desc">the Panel that has been collapsed.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Panel.html#collapse" ext:member="#collapse" ext:cls="Ext.Panel">Panel</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-collapsenode"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-collapsenode">collapsenode</a></b> :\r
( <code>Node node</code> )\r
- <div class="mdesc"><div class="short">Fires when a node is collapsed</div><div class="long">Fires when a node is collapsed<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>node</code> : Node<div class="sub-desc">The node</div></li></ul></div></div></div></td><td class="msource">TreePanel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-contextmenu"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-contextmenu">contextmenu</a></b> :\r
+ <div class="mdesc"><div class="short">Fires when a node is collapsed</div><div class="long">Fires when a node is collapsed<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>node</code> : Node<div class="sub-desc">The node</div></li></ul></div></div></div></td><td class="msource">TreePanel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-containerclick"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-containerclick">containerclick</a></b> :\r
+ ( <code>Tree this</code>, <code>Ext.EventObject e</code> )\r
+ <div class="mdesc"><div class="short">Fires when the tree container is clicked</div><div class="long">Fires when the tree container is clicked<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Tree<div class="sub-desc"></div></li><li><code>e</code> : Ext.EventObject<div class="sub-desc">The event object</div></li></ul></div></div></div></td><td class="msource">TreePanel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-containercontextmenu"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-containercontextmenu">containercontextmenu</a></b> :\r
+ ( <code>Tree this</code>, <code>Ext.EventObject e</code> )\r
+ <div class="mdesc"><div class="short">Fires when the tree container is right clicked</div><div class="long">Fires when the tree container is right clicked<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Tree<div class="sub-desc"></div></li><li><code>e</code> : Ext.EventObject<div class="sub-desc">The event object</div></li></ul></div></div></div></td><td class="msource">TreePanel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-containerdblclick"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-containerdblclick">containerdblclick</a></b> :\r
+ ( <code>Tree this</code>, <code>Ext.EventObject e</code> )\r
+ <div class="mdesc"><div class="short">Fires when the tree container is double clicked</div><div class="long">Fires when the tree container is double clicked<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Tree<div class="sub-desc"></div></li><li><code>e</code> : Ext.EventObject<div class="sub-desc">The event object</div></li></ul></div></div></div></td><td class="msource">TreePanel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-contextmenu"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-contextmenu">contextmenu</a></b> :\r
( <code>Node node</code>, <code>Ext.EventObject e</code> )\r
<div class="mdesc"><div class="short">Fires when a node is right clicked. To display a context menu in response to this \r
event, first create a Menu object ...</div><div class="long">Fires when a node is right clicked. To display a context menu in response to this\r
<li>dropNode - Dropped node(s).</li>\r
</ul><div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>dropEvent</code> : Object<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">TreePanel</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-remove"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-remove">remove</a></b> :\r
( <code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code> )\r
- <div class="mdesc"><div class="short">Fires when a child node is removed from a node in this tree.</div><div class="long">Fires when a child node is removed from a node in this tree.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><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></div></div></div></td><td class="msource">TreePanel</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-render"></a><b><a href="source/Component.html#event-Ext.Component-render">render</a></b> :\r
+ <div class="mdesc"><div class="short">Fires when a child node is removed from a node in this tree.</div><div class="long">Fires when a child node is removed from a node in this tree.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><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></div></div></div></td><td class="msource">TreePanel</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-removed"></a><b><a href="source/Component.html#event-Ext.Component-removed">removed</a></b> :\r
+ ( <code>Ext.Component this</code>, <code>Ext.Container ownerCt</code> )\r
+ <div class="mdesc"><div class="short">Fires when a component is removed from an Ext.Container</div><div class="long">Fires when a component is removed from an Ext.Container<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>ownerCt</code> : Ext.Container<div class="sub-desc">Container which holds the component</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#removed" ext:member="#removed" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-render"></a><b><a href="source/Component.html#event-Ext.Component-render">render</a></b> :\r
( <code>Ext.Component this</code> )\r
<div class="mdesc"><div class="short">Fires after the component markup is rendered.</div><div class="long">Fires after the component markup is <a href="output/Ext.Component.html#Ext.Component-rendered" ext:member="rendered" ext:cls="Ext.Component">rendered</a>.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#render" ext:member="#render" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-resize"></a><b><a href="source/BoxComponent.html#event-Ext.BoxComponent-resize">resize</a></b> :\r
( <code>Ext.Component this</code>, <code>Number adjWidth</code>, <code>Number adjHeight</code>, <code>Number rawWidth</code>, <code>Number rawHeight</code> )\r
git.ithinksw.org / extjs.git / blobdiff