- <div class="body-wrap">
- <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 ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a>
- <img src="resources/elbow-end.gif"/><a ext:cls="Ext.Component" ext:member="" href="output/Ext.Component.html">Component</a>
- <img src="resources/elbow-end.gif"/><a ext:cls="Ext.BoxComponent" ext:member="" href="output/Ext.BoxComponent.html">BoxComponent</a>
- <img src="resources/elbow-end.gif"/><a ext:cls="Ext.Container" ext:member="" href="output/Ext.Container.html">Container</a>
- <img src="resources/elbow-end.gif"/><a ext:cls="Ext.Panel" ext:member="" href="output/Ext.Panel.html">Panel</a>
- <img src="resources/elbow-end.gif"/>TreePanel</pre></div>
- <h1>Class Ext.tree.TreePanel</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"><a href="../src/TreePanel.js" target="_blank">TreePanel.js</a></td></tr>
- <tr><td class="label">Class:</td><td class="hd-info">TreePanel</td></tr>
- <tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.Panel" ext:member="" href="output/Ext.Panel.html">Panel</a></td></tr>
- </table>
- <div class="description">
- *
-<p>The TreePanel provides tree-structured UI representation of tree-structured data.</p>
-<p><a ext:cls="Ext.tree.TreeNode" href="output/Ext.tree.TreeNode.html">TreeNode</a>s added to the TreePanel may each contain metadata
-used by your application in their <a ext:cls="Ext.tree.TreeNode" ext:member="attributes" href="output/Ext.tree.TreeNode.html#attributes">attributes</a> property.</p>
-<p><b>A TreePanel must have a <a ext:cls="Ext.tree.TreePanel" ext:member="root" href="output/Ext.tree.TreePanel.html#root">root</a> node before it is rendered.</b> This may either be
-specified using the <a ext:cls="Ext.tree.TreePanel" ext:member="root" href="output/Ext.tree.TreePanel.html#root">root</a> config option, or using the <a ext:cls="Ext.tree.TreePanel" ext:member="setRootNode" href="output/Ext.tree.TreePanel.html#setRootNode">setRootNode</a> method. </div>
-
- <div class="hr"></div>
- <a id="Ext.tree.TreePanel-configs"></a>
- <h2>Config Options</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Config Options</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="config-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-animCollapse"></a>\r
- <b>animCollapse</b> : Boolean <div class="mdesc">\r
- <div class="short">True to animate the transition when the panel is collapsed, false to skip the animation (defaults to true if the Ext....</div>\r
- <div class="long">\r
- True to animate the transition when the panel is collapsed, false to skip the animation (defaults to true if the <a ext:cls="Ext.Fx" href="output/Ext.Fx.html">Ext.Fx</a> class is available, otherwise false). </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#animCollapse" href="output/Ext.Panel.html#animCollapse">Panel</a></td>\r
- </tr>\r
- <tr class="config-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-animate"></a>\r
- <b>animate</b> : Boolean <div class="mdesc">\r
- true to enable animated expand/collapse (defaults to the value of Ext.enableFx) </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="config-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-autoHeight"></a>\r
- <b>autoHeight</b> : Boolean <div class="mdesc">\r
- <div class="short">True to use height:'auto', false to use fixed height (defaults to false). Note: Although many components inherit this...</div>\r
- <div class="long">\r
- True to use height:'auto', false to use fixed height (defaults to false). <b>Note</b>: Although many components inherit this config option, not all will function as expected with a height of 'auto'. Setting autoHeight:true means that the browser will manage height based on the element's contents, and that Ext will not manage it at all. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#autoHeight" href="output/Ext.BoxComponent.html#autoHeight">BoxComponent</a></td>\r
- </tr>\r
- <tr class="config-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-autoScroll"></a>\r
- <b>autoScroll</b> : Boolean <div class="mdesc">\r
- <div class="short">True to use overflow:'auto' on the panel's body element and show scroll bars automatically when necessary, false to c...</div>\r
- <div class="long">\r
- True to use overflow:'auto' on the panel's body element and show scroll bars automatically when necessary, false to clip any overflowing content (defaults to false). </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#autoScroll" href="output/Ext.Panel.html#autoScroll">Panel</a></td>\r
- </tr>\r
- <tr class="config-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-autoShow"></a>\r
- <b>autoShow</b> : Boolean <div class="mdesc">\r
- <div class="short">True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove them on render...</div>\r
- <div class="long">\r
- 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>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#autoShow" href="output/Ext.Component.html#autoShow">Component</a></td>\r
- </tr>\r
- <tr class="config-row inherited alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-baseCls"></a>\r
- <b>baseCls</b> : String <div class="mdesc">\r
- The base CSS class to apply to this panel's element (defaults to 'x-panel'). </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#baseCls" href="output/Ext.Panel.html#baseCls">Panel</a></td>\r
- </tr>\r
- <tr class="config-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-bbar"></a>\r
- <b>bbar</b> : Object/Array <div class="mdesc">\r
- <div class="short">The bottom toolbar of the panel. This can be either an Ext.Toolbar object or an array of buttons/button configs to be...</div>\r
- <div class="long">\r
- The bottom toolbar of the panel. This can be either an <a ext:cls="Ext.Toolbar" href="output/Ext.Toolbar.html">Ext.Toolbar</a> object or an array of buttons/button configs to be added to the toolbar. Note that this is not available as a property after render. To access the bottom toolbar after render, use <a ext:cls="Ext.Panel" ext:member="getBottomToolbar" href="output/Ext.Panel.html#getBottomToolbar">getBottomToolbar</a>. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#bbar" href="output/Ext.Panel.html#bbar">Panel</a></td>\r
- </tr>\r
- <tr class="config-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-bodyBorder"></a>\r
- <b>bodyBorder</b> : Boolean <div class="mdesc">\r
- <div class="short">True to display an interior border on the body element of the panel, false to hide it (defaults to true). This only a...</div>\r
- <div class="long">\r
- True to display an interior border on the body element of the panel, false to hide it (defaults to true). This only applies when <a ext:cls="Ext.Panel" ext:member="border" href="output/Ext.Panel.html#border">border</a> == true. If border == true and bodyBorder == false, the border will display as a 1px wide inset border, giving the entire body element an inset appearance. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#bodyBorder" href="output/Ext.Panel.html#bodyBorder">Panel</a></td>\r
- </tr>\r
- <tr class="config-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-bodyCfg"></a>\r
- <b>bodyCfg</b> : Object <div class="mdesc">\r
- <div class="short">A DomHelper configuration object specifying the element structure of this Panel's body Element. This may be used to f...</div>\r
- <div class="long">\r
- <p>A <a ext:cls="Ext.DomHelper" href="output/Ext.DomHelper.html">DomHelper</a> configuration object specifying the element structure of this Panel's <a ext:cls="Ext.Panel" ext:member="body" href="output/Ext.Panel.html#body">body</a> Element.</p> <p>This may be used to force the body Element to use a different form of markup than is created automatically. An example of this might be to create a child Panel containing custom content, such as a header, or forcing centering of all Panel content by having the body be a <center> element:</p><code><pre>new Ext.Panel({\r
- title: 'New Message',\r
- collapsible: true,\r
- renderTo: Ext.getBody(),\r
- width: 400,\r
- bodyCfg: {\r
- tag: 'center',\r
- cls: 'x-panel-body'\r
- },\r
- items: [{\r
- border: false,\r
- header: false,\r
- bodyCfg: {tag: 'h2', html: 'Message'}\r
- }, {\r
- xtype: 'textarea',\r
- style: {\r
- width: '95%',\r
- marginBottom: '10px'\r
- }\r
- },\r
- new Ext.Button({\r
- text: 'Send',\r
- minWidth: '100',\r
- style: {\r
- marginBottom: '10px'\r
- }\r
- })\r
- ]\r
-});</pre></code> </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#bodyCfg" href="output/Ext.Panel.html#bodyCfg">Panel</a></td>\r
- </tr>\r
- <tr class="config-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-bodyStyle"></a>\r
- <b>bodyStyle</b> : String/Object/Function <div class="mdesc">\r
- <div class="short">Custom CSS styles to be applied to the body element in the format expected by Ext.Element.applyStyles (defaults to nu...</div>\r
- <div class="long">\r
- Custom CSS styles to be applied to the body element in the format expected by <a ext:cls="Ext.Element" ext:member="applyStyles" href="output/Ext.Element.html#applyStyles">Ext.Element.applyStyles</a> (defaults to null). </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#bodyStyle" href="output/Ext.Panel.html#bodyStyle">Panel</a></td>\r
- </tr>\r
- <tr class="config-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-border"></a>\r
- <b>border</b> : Boolean <div class="mdesc">\r
- <div class="short">True to display the borders of the panel's body element, false to hide them (defaults to true). By default, the borde...</div>\r
- <div class="long">\r
- True to display the borders of the panel's body element, false to hide them (defaults to true). By default, the border is a 2px wide inset border, but this can be further altered by setting <a ext:cls="Ext.Panel" ext:member="bodyBorder" href="output/Ext.Panel.html#bodyBorder">bodyBorder</a> to false. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#border" href="output/Ext.Panel.html#border">Panel</a></td>\r
- </tr>\r
- <tr class="config-row inherited alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-buttonAlign"></a>\r
- <b>buttonAlign</b> : String <div class="mdesc">\r
- The alignment of any buttons added to this panel. Valid values are 'right,' 'left' and 'center' (defaults to 'right'). </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#buttonAlign" href="output/Ext.Panel.html#buttonAlign">Panel</a></td>\r
- </tr>\r
- <tr class="config-row inherited">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-buttons"></a>\r
- <b>buttons</b> : Array <div class="mdesc">\r
- An array of <a ext:cls="Ext.Button" href="output/Ext.Button.html">Ext.Button</a>s or <a ext:cls="Ext.Button" href="output/Ext.Button.html">Ext.Button</a> configs used to add buttons to the footer of this panel. </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#buttons" href="output/Ext.Panel.html#buttons">Panel</a></td>\r
- </tr>\r
- <tr class="config-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-clearCls"></a>\r
- <b>clearCls</b> : String <div class="mdesc">\r
- <div class="short">The CSS class used to provide field clearing (defaults to 'x-form-clear-left'). This config is only used when this Co...</div>\r
- <div class="long">\r
- The CSS class used to provide field clearing (defaults to 'x-form-clear-left'). <p><b>This config is only used when this Component is rendered by a Container which has been configured to use the <a ext:cls="Ext.form.FormLayout" href="output/Ext.form.FormLayout.html">FormLayout</a> layout manager.</b></p> </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#clearCls" href="output/Ext.Component.html#clearCls">Component</a></td>\r
- </tr>\r
- <tr class="config-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-cls"></a>\r
- <b>cls</b> : String <div class="mdesc">\r
- <div class="short">An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be useful for a...</div>\r
- <div class="long">\r
- An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be useful for adding customized styles to the component or any of its children using standard CSS rules. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#cls" href="output/Ext.Component.html#cls">Component</a></td>\r
- </tr>\r
- <tr class="config-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-collapseFirst"></a>\r
- <b>collapseFirst</b> : Boolean <div class="mdesc">\r
- <div class="short">True to make sure the collapse/expand toggle button always renders first (to the left of) any other tools in the pane...</div>\r
- <div class="long">\r
- True to make sure the collapse/expand toggle button always renders first (to the left of) any other tools in the panel's title bar, false to render it last (defaults to true). </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#collapseFirst" href="output/Ext.Panel.html#collapseFirst">Panel</a></td>\r
- </tr>\r
- <tr class="config-row inherited">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-collapsed"></a>\r
- <b>collapsed</b> : Boolean <div class="mdesc">\r
- True to render the panel collapsed, false to render it expanded (defaults to false). </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#collapsed" href="output/Ext.Panel.html#collapsed">Panel</a></td>\r
- </tr>\r
- <tr class="config-row inherited alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-collapsedCls"></a>\r
- <b>collapsedCls</b> : String <div class="mdesc">\r
- A CSS class to add to the panel's element after it has been collapsed (defaults to 'x-panel-collapsed'). </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#collapsedCls" href="output/Ext.Panel.html#collapsedCls">Panel</a></td>\r
- </tr>\r
- <tr class="config-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-collapsible"></a>\r
- <b>collapsible</b> : Boolean <div class="mdesc">\r
- <div class="short">True to make the panel collapsible and have the expand/collapse toggle button automatically rendered into the header ...</div>\r
- <div class="long">\r
- True to make the panel collapsible and have the expand/collapse toggle button automatically rendered into the header tool button area, false to keep the panel statically sized with no button (defaults to false). </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#collapsible" href="output/Ext.Panel.html#collapsible">Panel</a></td>\r
- </tr>\r
- <tr class="config-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-containerScroll"></a>\r
- <b>containerScroll</b> : Boolean <div class="mdesc">\r
- true to register this container with ScrollManager </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="config-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-ctCls"></a>\r
- <b>ctCls</b> : String <div class="mdesc">\r
- <div class="short">An optional extra CSS class that will be added to this component's container (defaults to ''). This can be useful for...</div>\r
- <div class="long">\r
- An optional extra CSS class that will be added to this component's container (defaults to ''). This can be useful for adding customized styles to the container or any of its children using standard CSS rules. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#ctCls" href="output/Ext.Component.html#ctCls">Component</a></td>\r
- </tr>\r
- <tr class="config-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-ddAppendOnly"></a>\r
- <b>ddAppendOnly</b> : String <div class="mdesc">\r
- True if the tree should only allow append drops (use for trees which are sorted) </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="config-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-ddGroup"></a>\r
- <b>ddGroup</b> : String <div class="mdesc">\r
- The DD group this TreePanel belongs to </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="config-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-ddScroll"></a>\r
- <b>ddScroll</b> : Boolean <div class="mdesc">\r
- true to enable body scrolling </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="config-row inherited">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-disabled"></a>\r
- <b>disabled</b> : Boolean <div class="mdesc">\r
- Render this component disabled (default is false). </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#disabled" href="output/Ext.Component.html#disabled">Component</a></td>\r
- </tr>\r
- <tr class="config-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-dragConfig"></a>\r
- <b>dragConfig</b> : Object <div class="mdesc">\r
- Custom config to pass to the <a ext:cls="Ext.tree.TreeDragZone" href="output/Ext.tree.TreeDragZone.html">Ext.tree.TreeDragZone</a> instance </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="config-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-draggable"></a>\r
- <b>draggable</b> : Boolean <div class="mdesc">\r
- <div class="short">True to enable dragging of this Panel (defaults to false). For custom drag/drop implementations, an Ext.Panel.DD conf...</div>\r
- <div class="long">\r
- <p>True to enable dragging of this Panel (defaults to false).</p> <p>For custom drag/drop implementations, an Ext.Panel.DD config could also be passed in this config instead of true. Ext.Panel.DD is an internal, undocumented class which moves a proxy Element around in place of the Panel's element, but provides no other behaviour during dragging or on drop. It is a subclass of <a ext:cls="Ext.dd.DragSource" href="output/Ext.dd.DragSource.html">Ext.dd.DragSource</a>, so behaviour may be added by implementing the interface methods of <a ext:cls="Ext.dd.DragDrop" href="output/Ext.dd.DragDrop.html">Ext.dd.DragDrop</a> eg: <pre><code>new Ext.Panel({
+<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"><a href="source/TreePanel.html#cls-Ext.tree.TreePanel">TreePanel.js</a></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>
+<p><a href="output/Ext.tree.TreeNode.html" ext:cls="Ext.tree.TreeNode">TreeNode</a>s added to the TreePanel may each contain metadata
+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>
+<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
+specified using the <a href="output/Ext.tree.TreePanel.html#Ext.tree.TreePanel-root" ext:member="root" ext:cls="Ext.tree.TreePanel">root</a> config option, or using the <a href="output/Ext.tree.TreePanel.html#Ext.tree.TreePanel-setRootNode" ext:member="setRootNode" ext:cls="Ext.tree.TreePanel">setRootNode</a> method.
+<p>An example of tree rendered to an existing div:</p><pre><code><b>var</b> tree = <b>new</b> Ext.tree.TreePanel({
+ renderTo: <em>'tree-div'</em>,
+ useArrows: true,
+ autoScroll: true,
+ animate: true,
+ enableDD: true,
+ containerScroll: true,
+ border: false,
+ <i>// auto create TreeLoader</i>
+ dataUrl: <em>'get-nodes.php'</em>,
+
+ root: {
+ nodeType: <em>'async'</em>,
+ text: <em>'Ext JS'</em>,
+ draggable: false,
+ id: <em>'source'</em>
+ }
+});
+
+tree.getRootNode().expand();</code></pre>
+<p>The example above would work with a data packet similar to this:</p><pre><code>[{
+ <em>"text"</em>: <em>"adapter"</em>,
+ <em>"id"</em>: <em>"source\/adapter"</em>,
+ <em>"cls"</em>: <em>"folder"</em>
+}, {
+ <em>"text"</em>: <em>"dd"</em>,
+ <em>"id"</em>: <em>"source\/dd"</em>,
+ <em>"cls"</em>: <em>"folder"</em>
+}, {
+ <em>"text"</em>: <em>"debug.js"</em>,
+ <em>"id"</em>: <em>"source\/debug.js"</em>,
+ <em>"leaf"</em>: true,
+ <em>"cls"</em>: <em>"file"</em>
+}]</code></pre>
+<p>An example of tree within a Viewport:</p><pre><code><b>new</b> Ext.Viewport({
+ layout: <em>'border'</em>,
+ items: [{
+ region: <em>'west'</em>,
+ collapsible: true,
+ title: <em>'Navigation'</em>,
+ xtype: <em>'treepanel'</em>,
+ width: 200,
+ autoScroll: true,
+ split: true,
+ loader: <b>new</b> Ext.tree.TreeLoader(),
+ root: <b>new</b> Ext.tree.AsyncTreeNode({
+ expanded: true,
+ children: [{
+ text: <em>'Menu Option 1'</em>,
+ leaf: true
+ }, {
+ text: <em>'Menu Option 2'</em>,
+ leaf: true
+ }, {
+ text: <em>'Menu Option 3'</em>,
+ leaf: true
+ }]
+ }),
+ rootVisible: false,
+ listeners: {
+ click: <b>function</b>(n) {
+ Ext.Msg.alert(<em>'Navigation Tree Click'</em>, <em>'You clicked: <em>"'</em> + n.attributes.text + <em>'"</em>'</em>);
+ }
+ }
+ }, {
+ region: <em>'center'</em>,
+ xtype: <em>'tabpanel'</em>,
+ <i>// remaining code not shown ...</i>
+ }]
+});</code></pre></div><div class="hr"></div><a id="Ext.tree.TreePanel-configs"></a><h2>Config Options</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Config Options</th><th class="msource-header">Defined By</th></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-anchor"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-anchor">anchor</a></b> : String<div class="mdesc"><div class="short">Note: this config is only used when this Component is rendered
+by a Container which has been configured to use an Anc...</div><div class="long"><p><b>Note</b>: this config is only used when this Component is rendered
+by a Container which has been configured to use an <b><a href="output/Ext.layout.AnchorLayout.html" ext:cls="Ext.layout.AnchorLayout">AnchorLayout</a> (or subclass thereof).</b>
+based layout manager, for example:<div class="mdetail-params"><ul>
+<li><a href="output/Ext.form.FormPanel.html" ext:cls="Ext.form.FormPanel">Ext.form.FormPanel</a></li>
+<li>specifying <code>layout: <em>'anchor'</em> <i>// or <em>'form'</em>, or <em>'absolute'</em></i></code></li>
+</ul></div></p>
+<p>See <a href="output/Ext.layout.AnchorLayout.html" ext:cls="Ext.layout.AnchorLayout">Ext.layout.AnchorLayout</a>.<a href="output/Ext.layout.AnchorLayout.html#Ext.layout.AnchorLayout-anchor" ext:member="anchor" ext:cls="Ext.layout.AnchorLayout">anchor</a> also.</p></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#anchor" ext:member="#anchor" 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.Panel-animCollapse"></a><b><a href="source/Panel.html#cfg-Ext.Panel-animCollapse">animCollapse</a></b> : Boolean<div class="mdesc"><div class="short">true to animate the transition when the panel is collapsed, false to skip the
+animation (defaults to true if the Ext....</div><div class="long"><code>true</code> to animate the transition when the panel is collapsed, <code>false</code> to skip the
+animation (defaults to <code>true</code> if the <a href="output/Ext.Fx.html" ext:cls="Ext.Fx">Ext.Fx</a> class is available, otherwise <code>false</code>).</div></div></td><td class="msource"><a href="output/Ext.Panel.html#animCollapse" ext:member="#animCollapse" 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-animate"></a><b><a href="source/TreePanel.html#cfg-Ext.tree.TreePanel-animate">animate</a></b> : Boolean<div class="mdesc"><tt>true</tt> to enable animated expand/collapse (defaults to the value of <a href="output/Ext.html#Ext-enableFx" ext:member="enableFx" ext:cls="Ext">Ext.enableFx</a>)</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-autoHeight"></a><b><a href="source/Panel.html#cfg-Ext.Panel-autoHeight">autoHeight</a></b> : Boolean<div class="mdesc"><div class="short">true to use height:'auto', false to use fixed height (defaults to false).
+Note: Setting autoHeight: true means that t...</div><div class="long"><code>true</code> to use height:'auto', <code>false</code> to use fixed height (defaults to <code>false</code>).
+<b>Note</b>: Setting <code>autoHeight: true</code> means that the browser will manage the panel's height
+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.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
+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
+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').
+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>).
+<p>Another option available by default is to specify <code><em>'x-plain'</em></code> which strips all styling
+except for required attributes for Ext layouts to function (e.g. overflow:hidden).
+See <code><a href="output/Ext.Panel.html#Ext.Panel-unstyled" ext:member="unstyled" ext:cls="Ext.Panel">unstyled</a></code> also.</p></div></div></td><td class="msource"><a href="output/Ext.Panel.html#baseCls" ext:member="#baseCls" 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-bbar"></a><b><a href="source/Panel.html#cfg-Ext.Panel-bbar">bbar</a></b> : Object/Array<div class="mdesc"><div class="short">The bottom toolbar of the panel. This can be a Ext.Toolbar object, a toolbar config, or an array of
+buttons/button co...</div><div class="long"><p>The bottom toolbar of the panel. This can be a <a href="output/Ext.Toolbar.html" ext:cls="Ext.Toolbar">Ext.Toolbar</a> object, a toolbar config, or an array of
+buttons/button configs to be added to the toolbar. Note that this is not available as a property after render.
+To access the bottom toolbar after render, use <a href="output/Ext.Panel.html#Ext.Panel-getBottomToolbar" ext:member="getBottomToolbar" ext:cls="Ext.Panel">getBottomToolbar</a>.</p>
+<p><b>Note:</b> Although a Toolbar may contain Field components, these will <b>not</b> be updated by a load
+of an ancestor FormPanel. A Panel's toolbars are not part of the standard Container->Component hierarchy, and
+so are not scanned to collect form items. However, the values <b>will</b> be submitted because form
+submission parameters are collected from the DOM tree.</p></div></div></td><td class="msource"><a href="output/Ext.Panel.html#bbar" ext:member="#bbar" 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-bbarCfg"></a><b><a href="source/Panel.html#cfg-Ext.Panel-bbarCfg">bbarCfg</a></b> : Object<div class="mdesc"><div class="short">A DomHelper element specification object specifying the element structure
+of this Panel's bbar Element. See bodyCfg ...</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-bbar" ext:member="bbar" ext:cls="Ext.Panel">bbar</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#bbarCfg" ext:member="#bbarCfg" 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-bodyBorder"></a><b><a href="source/Panel.html#cfg-Ext.Panel-bodyBorder">bodyBorder</a></b> : Boolean<div class="mdesc"><div class="short">True to display an interior border on the body element of the panel, false to hide it (defaults to true).
+This only a...</div><div class="long">True to display an interior border on the body element of the panel, false to hide it (defaults to true).
+This only applies when <a href="output/Ext.Panel.html#Ext.Panel-border" ext:member="border" ext:cls="Ext.Panel">border</a> == true. If border == true and bodyBorder == false, the border will display
+as a 1px wide inset border, giving the entire body element an inset appearance.</div></div></td><td class="msource"><a href="output/Ext.Panel.html#bodyBorder" ext:member="#bodyBorder" 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-bodyCfg"></a><b><a href="source/Panel.html#cfg-Ext.Panel-bodyCfg">bodyCfg</a></b> : Object<div class="mdesc"><div class="short">A DomHelper element specification object may be specified for any
+Panel Element.
+By default, the Default element in t...</div><div class="long"><p>A <a href="output/Ext.DomHelper.html" ext:cls="Ext.DomHelper">DomHelper</a> element specification object may be specified for any
+Panel Element.</p>
+<p>By default, the Default element in the table below will be used for the html markup to
+create a child element with the commensurate Default class name (<code>baseCls</code> will be
+replaced by <code><a href="output/Ext.Panel.html#Ext.Panel-baseCls" ext:member="baseCls" ext:cls="Ext.Panel">baseCls</a></code>):</p>
+<pre>
+Panel Default Default Custom Additional Additional
+Element element class element class style
+======== ========================== ========= ============== ===========
+<a href="output/Ext.Panel.html#Ext.Panel-header" ext:member="header" ext:cls="Ext.Panel">header</a> div <a href="output/Ext.Panel.html#Ext.Panel-baseCls" ext:member="baseCls" ext:cls="Ext.Panel">baseCls</a>+'-header' <a href="output/Ext.Panel.html#Ext.Panel-headerCfg" ext:member="headerCfg" ext:cls="Ext.Panel">headerCfg</a> headerCssClass headerStyle
+<a href="output/Ext.Panel.html#Ext.Panel-bwrap" ext:member="bwrap" ext:cls="Ext.Panel">bwrap</a> div <a href="output/Ext.Panel.html#Ext.Panel-baseCls" ext:member="baseCls" ext:cls="Ext.Panel">baseCls</a>+'-bwrap' <a href="output/Ext.Panel.html#Ext.Panel-bwrapCfg" ext:member="bwrapCfg" ext:cls="Ext.Panel">bwrapCfg</a> bwrapCssClass bwrapStyle
++ tbar div <a href="output/Ext.Panel.html#Ext.Panel-baseCls" ext:member="baseCls" ext:cls="Ext.Panel">baseCls</a>+'-tbar' <a href="output/Ext.Panel.html#Ext.Panel-tbarCfg" ext:member="tbarCfg" ext:cls="Ext.Panel">tbarCfg</a> tbarCssClass tbarStyle
++ <a href="output/Ext.Panel.html#Ext.Panel-body" ext:member="body" ext:cls="Ext.Panel">body</a> div <a href="output/Ext.Panel.html#Ext.Panel-baseCls" ext:member="baseCls" ext:cls="Ext.Panel">baseCls</a>+'-body' <a href="output/Ext.Panel.html#Ext.Panel-bodyCfg" ext:member="bodyCfg" ext:cls="Ext.Panel">bodyCfg</a> <a href="output/Ext.Panel.html#Ext.Panel-bodyCssClass" ext:member="bodyCssClass" ext:cls="Ext.Panel">bodyCssClass</a> <a href="output/Ext.Panel.html#Ext.Panel-bodyStyle" ext:member="bodyStyle" ext:cls="Ext.Panel">bodyStyle</a>
++ bbar div <a href="output/Ext.Panel.html#Ext.Panel-baseCls" ext:member="baseCls" ext:cls="Ext.Panel">baseCls</a>+'-bbar' <a href="output/Ext.Panel.html#Ext.Panel-bbarCfg" ext:member="bbarCfg" ext:cls="Ext.Panel">bbarCfg</a> bbarCssClass bbarStyle
++ <a href="output/Ext.Panel.html#Ext.Panel-footer" ext:member="footer" ext:cls="Ext.Panel">footer</a> div <a href="output/Ext.Panel.html#Ext.Panel-baseCls" ext:member="baseCls" ext:cls="Ext.Panel">baseCls</a>+'-footer' <a href="output/Ext.Panel.html#Ext.Panel-footerCfg" ext:member="footerCfg" ext:cls="Ext.Panel">footerCfg</a> footerCssClass footerStyle
+</pre>
+<p>Configuring a Custom element may be used, for example, to force the <a href="output/Ext.Panel.html#Ext.Panel-body" ext:member="body" ext:cls="Ext.Panel">body</a> Element
+to use a different form of markup than is created by default. An example of this might be
+to <a href="output/Ext.Element.html#Ext.Element-createChild" ext:member="createChild" ext:cls="Ext.Element">create a child</a> Panel containing a custom content, such as
+a header, or forcing centering of all Panel content by having the body be a <center>
+element:</p>
+<pre><code><b>new</b> Ext.Panel({
+ title: <em>'Message Title'</em>,
+ renderTo: Ext.getBody(),
+ width: 200, height: 130,
+ <b>bodyCfg</b>: {
+ tag: <em>'center'</em>,
+ cls: <em>'x-panel-body'</em>, <i>// Default class not applied <b>if</b> Custom element specified</i>
+ html: <em>'Message'</em>
+ },
+ footerCfg: {
+ tag: <em>'h2'</em>,
+ cls: <em>'x-panel-footer'</em>, <i>// same as the Default class</i>
+ html: <em>'footer html'</em>
+ },
+ footerCssClass: <em>'custom-footer'</em>, <i>// additional css class, see <a href="output/Ext.element.html#Ext.element-addClass" ext:member="addClass" ext:cls="Ext.element">addClass</a></i>
+ footerStyle: <em>'background-color:red'</em> <i>// see <a href="output/Ext.Panel.html#Ext.Panel-bodyStyle" ext:member="bodyStyle" ext:cls="Ext.Panel">bodyStyle</a></i>
+});</code></pre>
+<p>The example above also explicitly creates a <code><a href="output/Ext.Panel.html#Ext.Panel-footer" ext:member="footer" ext:cls="Ext.Panel">footer</a></code> with custom markup and
+styling applied.</p></div></div></td><td class="msource"><a href="output/Ext.Panel.html#bodyCfg" ext:member="#bodyCfg" 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-bodyCssClass"></a><b><a href="source/Panel.html#cfg-Ext.Panel-bodyCssClass">bodyCssClass</a></b> : String/Object/Function<div class="mdesc"><div class="short">Additional css class selector to be applied to the body element in the format expected by
+Ext.Element.addClass (defau...</div><div class="long">Additional css class selector 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-addClass" ext:member="addClass" ext:cls="Ext.Element">Ext.Element.addClass</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#bodyCssClass" ext:member="#bodyCssClass" 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-bodyStyle"></a><b><a href="source/Panel.html#cfg-Ext.Panel-bodyStyle">bodyStyle</a></b> : String/Object/Function<div class="mdesc"><div class="short">Custom CSS styles to be applied to the body element in the format expected by
+Ext.Element.applyStyles (defaults to nu...</div><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,
+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 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.
+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.
+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.
+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.
+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.
+See Ext.util.Observable.enableBubble....</div><div class="long"><p>An array of events that, when fired, should be bubbled to any parent container.
+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>.
+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',
+'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
+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
+the footer (<code><a href="output/Ext.Panel.html#Ext.Panel-fbar" ext:member="fbar" ext:cls="Ext.Panel">fbar</a></code>). Typically the value of this configuration property will be
+an array of <a href="output/Ext.Button.html" ext:cls="Ext.Button">Ext.Button</a>s or <a href="output/Ext.Button.html" ext:cls="Ext.Button">Ext.Button</a> configuration objects.
+If an item is configured with <code>minWidth</code> or the Panel is configured with <code>minButtonWidth</code>,
+that width will be applied to the item.</div></div></td><td class="msource"><a href="output/Ext.Panel.html#buttons" ext:member="#buttons" 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-bwrapCfg"></a><b><a href="source/Panel.html#cfg-Ext.Panel-bwrapCfg">bwrapCfg</a></b> : Object<div class="mdesc"><div class="short">A DomHelper element specification object specifying the element structure
+of this Panel's bwrap Element. See bodyCfg...</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-bwrap" ext:member="bwrap" ext:cls="Ext.Panel">bwrap</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#bwrapCfg" ext:member="#bwrapCfg" 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-clearCls"></a><b><a href="source/Component.html#cfg-Ext.Component-clearCls">clearCls</a></b> : String<div class="mdesc"><div class="short">The CSS class used to to apply to the special clearing div rendered
+directly after each form field wrapper to provide...</div><div class="long"><p>The CSS class used to to apply to the special clearing div rendered
+directly after each form field wrapper to provide field clearing (defaults to
+<tt>'x-form-clear-left'</tt>).</p>
+<br><p><b>Note</b>: this config is only used when this Component is rendered by a Container
+which has been configured to use the <b><a href="output/Ext.layout.FormLayout.html" ext:cls="Ext.layout.FormLayout">FormLayout</a></b> layout
+manager (e.g. <a href="output/Ext.form.FormPanel.html" ext:cls="Ext.form.FormPanel">Ext.form.FormPanel</a> or specifying <tt>layout:'form'</tt>) and either a
+<tt><a href="output/Ext.Component.html#Ext.Component-fieldLabel" ext:member="fieldLabel" ext:cls="Ext.Component">fieldLabel</a></tt> is specified or <tt>isFormField=true</tt> is specified.</p><br>
+<p>See <a href="output/Ext.layout.FormLayout.html" ext:cls="Ext.layout.FormLayout">Ext.layout.FormLayout</a>.<a href="output/Ext.layout.FormLayout.html#Ext.layout.FormLayout-fieldTpl" ext:member="fieldTpl" ext:cls="Ext.layout.FormLayout">fieldTpl</a> also.</p></div></div></td><td class="msource"><a href="output/Ext.Component.html#clearCls" ext:member="#clearCls" 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-closable"></a><b><a href="source/Panel.html#cfg-Ext.Panel-closable">closable</a></b> : Boolean<div class="mdesc"><div class="short">Panels themselves do not directly support being closed, but some Panel subclasses do (like
+Ext.Window) or a Panel Cla...</div><div class="long">Panels themselves do not directly support being closed, but some Panel subclasses do (like
+<a href="output/Ext.Window.html" ext:cls="Ext.Window">Ext.Window</a>) or a Panel Class within an <a href="output/Ext.TabPanel.html" ext:cls="Ext.TabPanel">Ext.TabPanel</a>. Specify <code>true</code>
+to enable closing in such situations. Defaults to <code>false</code>.</div></div></td><td class="msource"><a href="output/Ext.Panel.html#closable" ext:member="#closable" 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-cls"></a><b><a href="source/Component.html#cfg-Ext.Component-cls">cls</a></b> : String<div class="mdesc"><div class="short">An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be
+useful for ...</div><div class="long">An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be
+useful for adding customized styles to the component or any of its children using standard CSS rules.</div></div></td><td class="msource"><a href="output/Ext.Component.html#cls" ext:member="#cls" 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-collapseFirst"></a><b><a href="source/Panel.html#cfg-Ext.Panel-collapseFirst">collapseFirst</a></b> : Boolean<div class="mdesc"><div class="short">true to make sure the collapse/expand toggle button always renders first (to the left of)
+any other tools in the pane...</div><div class="long"><code>true</code> to make sure the collapse/expand toggle button always renders first (to the left of)
+any other tools in the panel's title bar, <code>false</code> to render it last (defaults to <code>true</code>).</div></div></td><td class="msource"><a href="output/Ext.Panel.html#collapseFirst" ext:member="#collapseFirst" 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-collapsed"></a><b><a href="source/Panel.html#cfg-Ext.Panel-collapsed">collapsed</a></b> : Boolean<div class="mdesc"><code>true</code> to render the panel collapsed, <code>false</code> to render it expanded (defaults to
+<code>false</code>).</div></td><td class="msource"><a href="output/Ext.Panel.html#collapsed" ext:member="#collapsed" 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-collapsedCls"></a><b><a href="source/Panel.html#cfg-Ext.Panel-collapsedCls">collapsedCls</a></b> : String<div class="mdesc">A CSS class to add to the panel's element after it has been collapsed (defaults to
+<code><em>'x-panel-collapsed'</em></code>).</div></td><td class="msource"><a href="output/Ext.Panel.html#collapsedCls" ext:member="#collapsedCls" 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-collapsible"></a><b><a href="source/Panel.html#cfg-Ext.Panel-collapsible">collapsible</a></b> : Boolean<div class="mdesc"><div class="short">True to make the panel collapsible and have the expand/collapse toggle button automatically rendered into
+the header ...</div><div class="long">True to make the panel collapsible and have the expand/collapse toggle button automatically rendered into
+the header tool button area, false to keep the panel statically sized with no button (defaults to false).</div></div></td><td class="msource"><a href="output/Ext.Panel.html#collapsible" ext:member="#collapsible" 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-containerScroll"></a><b><a href="source/TreePanel.html#cfg-Ext.tree.TreePanel-containerScroll">containerScroll</a></b> : Boolean<div class="mdesc"><tt>true</tt> to register this container with ScrollManager</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-ctCls"></a><b><a href="source/Component.html#cfg-Ext.Component-ctCls">ctCls</a></b> : String<div class="mdesc"><div class="short">An optional extra CSS class that will be added to this component's container. This can be useful for
+adding customize...</div><div class="long"><p>An optional extra CSS class that will be added to this component's container. This can be useful for
+adding customized styles to the container or any of its children using standard CSS rules. See
+<a href="output/Ext.layout.ContainerLayout.html" ext:cls="Ext.layout.ContainerLayout">Ext.layout.ContainerLayout</a>.<a href="output/Ext.layout.ContainerLayout.html#Ext.layout.ContainerLayout-extraCls" ext:member="extraCls" ext:cls="Ext.layout.ContainerLayout">extraCls</a> also.</p>
+<p><b>Note</b>: <tt>ctCls</tt> defaults to <tt>''</tt> except for the following class
+which assigns a value by default:
+<div class="mdetail-params"><ul>
+<li><a href="output/Ext.layout.Box.html" ext:cls="Ext.layout.Box">Box Layout</a> : <tt>'x-box-layout-ct'</tt></li>
+</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
+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.
+If you experience this issue, you may need to instead use the <a href="output/Ext.Panel.html#Ext.Panel-afterlayout" ext:member="afterlayout" ext:cls="Ext.Panel">afterlayout</a> event to initialize
+the disabled state:
+<pre><code><b>new</b> Ext.Panel({
+ ...
+ listeners: {
+ <em>'afterlayout'</em>: {
+ fn: <b>function</b>(p){
+ p.disable();
+ },
+ single: true <i>// important, as many layouts can occur</i>
+ }
+ }
+});</code></pre></div></div></td><td class="msource"><a href="output/Ext.Panel.html#disabled" ext:member="#disabled" 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-dragConfig"></a><b><a href="source/TreePanel.html#cfg-Ext.tree.TreePanel-dragConfig">dragConfig</a></b> : Object<div class="mdesc">Custom config to pass to the <a href="output/Ext.tree.TreeDragZone.html" ext:cls="Ext.tree.TreeDragZone">Ext.tree.TreeDragZone</a> instance</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-draggable"></a><b><a href="source/Panel.html#cfg-Ext.Panel-draggable">draggable</a></b> : Boolean/Object<div class="mdesc"><div class="short">true to enable dragging of this Panel (defaults to false).
+For custom drag/drop implementations, an Ext.Panel.DD conf...</div><div class="long"><p><code>true</code> to enable dragging of this Panel (defaults to <code>false</code>).</p>
+<p>For custom drag/drop implementations, an <b>Ext.Panel.DD</b> config could also be passed
+in this config instead of <code>true</code>. Ext.Panel.DD is an internal, undocumented class which
+moves a proxy Element around in place of the Panel's element, but provides no other behaviour
+during dragging or on drop. It is a subclass of <a href="output/Ext.dd.DragSource.html" ext:cls="Ext.dd.DragSource">Ext.dd.DragSource</a>, so behaviour may be
+added by implementing the interface methods of <a href="output/Ext.dd.DragDrop.html" ext:cls="Ext.dd.DragDrop">Ext.dd.DragDrop</a> e.g.:
+<pre><code><b>new</b> Ext.Panel({
title: <em>'Drag me'</em>,
x: 100,
y: 100,
height: 200,
draggable: {
<i>// Config option of Ext.Panel.DD class.</i>
-<i>// It's a floating Panel, so <b>do</b> not show a placeholder proxy <b>in</b> the original position.</i>
+<i>// It's a floating Panel, so <b>do</b> not show a placeholder proxy <b>in</b> the original position.</i>
insertProxy: false,
<i>// Called <b>for</b> each mousemove event <b>while</b> dragging the DD object.</i>
onDrag : <b>function</b>(e){
<i>// Record the x,y position of the drag proxy so that we can</i>
<i>// position the Panel at end of drag.</i>
- <b>var</b> pel = <b>this</b>.proxy.getEl();
- <b>this</b>.x = pel.getLeft(true);
- <b>this</b>.y = pel.getTop(true);
+ <b>var</b> pel = this.proxy.getEl();
+ this.x = pel.getLeft(true);
+ this.y = pel.getTop(true);
<i>// Keep the Shadow aligned <b>if</b> there is one.</i>
- <b>var</b> s = <b>this</b>.panel.getEl().shadow;
+ <b>var</b> s = this.panel.getEl().shadow;
<b>if</b> (s) {
- s.realign(<b>this</b>.x, <b>this</b>.y, pel.getWidth(), pel.getHeight());
+ s.realign(this.x, this.y, pel.getWidth(), pel.getHeight());
}
},
<i>// Called on the mouseup event.</i>
endDrag : <b>function</b>(e){
- <b>this</b>.panel.setPosition(<b>this</b>.x, <b>this</b>.y);
+ this.panel.setPosition(this.x, this.y);
}
}
-}).show();</code></pre> </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#draggable" href="output/Ext.Panel.html#draggable">Panel</a></td>\r
- </tr>\r
- <tr class="config-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-dropConfig"></a>\r
- <b>dropConfig</b> : Object <div class="mdesc">\r
- Custom config to pass to the <a ext:cls="Ext.tree.TreeDropZone" href="output/Ext.tree.TreeDropZone.html">Ext.tree.TreeDropZone</a> instance </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="config-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-enableDD"></a>\r
- <b>enableDD</b> : Boolean <div class="mdesc">\r
- true to enable drag and drop </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="config-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-enableDrag"></a>\r
- <b>enableDrag</b> : Boolean <div class="mdesc">\r
- true to enable just drag </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="config-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-enableDrop"></a>\r
- <b>enableDrop</b> : Boolean <div class="mdesc">\r
- true to enable just drop </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="config-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-fieldLabel"></a>\r
- <b>fieldLabel</b> : String <div class="mdesc">\r
- <div class="short">The label text to display next to this Component (defaults to '') This config is only used when this Component is ren...</div>\r
- <div class="long">\r
- The label text to display next to this Component (defaults to '') <p><b>This config is only used when this Component is rendered by a Container which has been configured to use the <a ext:cls="Ext.form.FormLayout" href="output/Ext.form.FormLayout.html">FormLayout</a> layout manager.</b></p> Example use:<pre><code>new Ext.FormPanel({
+}).show();</code></pre></div></div></td><td class="msource"><a href="output/Ext.Panel.html#draggable" ext:member="#draggable" 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-dropConfig"></a><b><a href="source/TreePanel.html#cfg-Ext.tree.TreePanel-dropConfig">dropConfig</a></b> : Object<div class="mdesc">Custom config to pass to the <a href="output/Ext.tree.TreeDropZone.html" ext:cls="Ext.tree.TreeDropZone">Ext.tree.TreeDropZone</a> instance</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-enableDD"></a><b><a href="source/TreePanel.html#cfg-Ext.tree.TreePanel-enableDD">enableDD</a></b> : Boolean<div class="mdesc"><tt>true</tt> to enable drag and drop</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-enableDrag"></a><b><a href="source/TreePanel.html#cfg-Ext.tree.TreePanel-enableDrag">enableDrag</a></b> : Boolean<div class="mdesc"><tt>true</tt> to enable just drag</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-enableDrop"></a><b><a href="source/TreePanel.html#cfg-Ext.tree.TreePanel-enableDrop">enableDrop</a></b> : Boolean<div class="mdesc"><tt>true</tt> to enable just drop</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-fbar"></a><b><a href="source/Panel.html#cfg-Ext.Panel-fbar">fbar</a></b> : Object/Array<div class="mdesc"><div class="short">A Toolbar object, a Toolbar config, or an array of
+Buttons/Button configs, describing a Toolbar to be rendered into t...</div><div class="long"><p>A <a href="output/Ext.Toolbar.html" ext:cls="Ext.Toolbar">Toolbar</a> object, a Toolbar config, or an array of
+<a href="output/Ext.Button.html" ext:cls="Ext.Button">Button</a>s/<a href="output/Ext.Button.html" ext:cls="Ext.Button">Button</a> configs, describing a <a href="output/Ext.Toolbar.html" ext:cls="Ext.Toolbar">Toolbar</a> to be rendered into this Panel's footer element.</p>
+<p>After render, the <code>fbar</code> property will be an <a href="output/Ext.Toolbar.html" ext:cls="Ext.Toolbar">Toolbar</a> instance.</p>
+<p>If <code><a href="output/Ext.Panel.html#Ext.Panel-buttons" ext:member="buttons" ext:cls="Ext.Panel">buttons</a></code> are specified, they will supersede the <code>fbar</code> configuration property.</p>
+The Panel's <code><a href="output/Ext.Panel.html#Ext.Panel-buttonAlign" ext:member="buttonAlign" ext:cls="Ext.Panel">buttonAlign</a></code> configuration affects the layout of these items, for example:
+<pre><code><b>var</b> w = <b>new</b> Ext.Window({
+ height: 250,
+ width: 500,
+ bbar: <b>new</b> Ext.Toolbar({
+ items: [{
+ text: <em>'bbar Left'</em>
+ },<em>'->'</em>,{
+ text: <em>'bbar Right'</em>
+ }]
+ }),
+ <a href="output/Ext.Panel.html#Ext.Panel-buttonAlign" ext:member="buttonAlign" ext:cls="Ext.Panel">buttonAlign</a>: <em>'left'</em>, <i>// anything but <em>'center'</em> or <em>'right'</em> and you can use <em>'-'</em>, and <em>'->'</em></i>
+ <i>// to control the alignment of fbar items</i>
+ fbar: [{
+ text: <em>'fbar Left'</em>
+ },<em>'->'</em>,{
+ text: <em>'fbar Right'</em>
+ }]
+}).show();</code></pre>
+<p><b>Note:</b> Although a Toolbar may contain Field components, these will <b>not</b> be updated by a load
+of an ancestor FormPanel. A Panel's toolbars are not part of the standard Container->Component hierarchy, and
+so are not scanned to collect form items. However, the values <b>will</b> be submitted because form
+submission parameters are collected from the DOM tree.</p></div></div></td><td class="msource"><a href="output/Ext.Panel.html#fbar" ext:member="#fbar" 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-fieldLabel"></a><b><a href="source/Component.html#cfg-Ext.Component-fieldLabel">fieldLabel</a></b> : String<div class="mdesc"><div class="short">The label text to display next to this Component (defaults to '').
+Note: this config is only used when this Component...</div><div class="long"><p>The label text to display next to this Component (defaults to '').</p>
+<br><p><b>Note</b>: this config is only used when this Component is rendered by a Container which
+has been configured to use the <b><a href="output/Ext.layout.FormLayout.html" ext:cls="Ext.layout.FormLayout">FormLayout</a></b> layout manager (e.g.
+<a href="output/Ext.form.FormPanel.html" ext:cls="Ext.form.FormPanel">Ext.form.FormPanel</a> or specifying <tt>layout:'form'</tt>).</p><br>
+<p>Also see <tt><a href="output/Ext.Component.html#Ext.Component-hideLabel" ext:member="hideLabel" ext:cls="Ext.Component">hideLabel</a></tt> and
+<a href="output/Ext.layout.FormLayout.html" ext:cls="Ext.layout.FormLayout">Ext.layout.FormLayout</a>.<a href="output/Ext.layout.FormLayout.html#Ext.layout.FormLayout-fieldTpl" ext:member="fieldTpl" ext:cls="Ext.layout.FormLayout">fieldTpl</a>.</p>
+Example use:<pre><code><b>new</b> Ext.FormPanel({
height: 100,
renderTo: Ext.getBody(),
items: [{
xtype: <em>'textfield'</em>,
fieldLabel: <em>'Name'</em>
}]
-});</code></pre> </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#fieldLabel" href="output/Ext.Component.html#fieldLabel">Component</a></td>\r
- </tr>\r
- <tr class="config-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-floating"></a>\r
- <b>floating</b> : Boolean <div class="mdesc">\r
- <div class="short">True to float the panel (absolute position it with automatic shimming and shadow), false to display it inline where i...</div>\r
- <div class="long">\r
- True to float the panel (absolute position it with automatic shimming and shadow), false to display it inline where it is rendered (defaults to false). Note that by default, setting floating to true will cause the panel to display at negative offsets so that it is hidden -- because the panel is absolute positioned, the position must be set explicitly after render (e.g., myPanel.setPosition(100,100);). Also, when floating a panel you should always assign a fixed width, otherwise it will be auto width and will expand to fill to the right edge of the viewport. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#floating" href="output/Ext.Panel.html#floating">Panel</a></td>\r
- </tr>\r
- <tr class="config-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-footer"></a>\r
- <b>footer</b> : Boolean <div class="mdesc">\r
- <div class="short">True to create the footer element explicitly, false to skip creating it. By default, when footer is not specified, if...</div>\r
- <div class="long">\r
- True to create the footer element explicitly, false to skip creating it. By default, when footer is not specified, if one or more buttons have been added to the panel the footer will be created automatically, otherwise it will not. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#footer" href="output/Ext.Panel.html#footer">Panel</a></td>\r
- </tr>\r
- <tr class="config-row inherited">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-frame"></a>\r
- <b>frame</b> : Boolean <div class="mdesc">\r
- True to render the panel with custom rounded borders, false to render with plain 1px square borders (defaults to false). </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#frame" href="output/Ext.Panel.html#frame">Panel</a></td>\r
- </tr>\r
- <tr class="config-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-header"></a>\r
- <b>header</b> : Boolean <div class="mdesc">\r
- <div class="short">True to create the header element explicitly, false to skip creating it. By default, when header is not specified, if...</div>\r
- <div class="long">\r
- True to create the header element explicitly, false to skip creating it. By default, when header is not specified, if a <a ext:cls="Ext.Panel" ext:member="title" href="output/Ext.Panel.html#title">title</a> is set the header will be created automatically, otherwise it will not. If a title is set but header is explicitly set to false, the header will not be rendered. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#header" href="output/Ext.Panel.html#header">Panel</a></td>\r
- </tr>\r
- <tr class="config-row inherited">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-headerAsText"></a>\r
- <b>headerAsText</b> : Boolean <div class="mdesc">\r
- True to display the panel title in the header, false to hide it (defaults to true). </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#headerAsText" href="output/Ext.Panel.html#headerAsText">Panel</a></td>\r
- </tr>\r
- <tr class="config-row inherited alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-height"></a>\r
- <b>height</b> : Number <div class="mdesc">\r
- The height of this component in pixels (defaults to auto). </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#height" href="output/Ext.BoxComponent.html#height">BoxComponent</a></td>\r
- </tr>\r
- <tr class="config-row inherited">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-hidden"></a>\r
- <b>hidden</b> : Boolean <div class="mdesc">\r
- Render this component hidden (default is false). </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#hidden" href="output/Ext.Component.html#hidden">Component</a></td>\r
- </tr>\r
- <tr class="config-row inherited alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-hideCollapseTool"></a>\r
- <b>hideCollapseTool</b> : Boolean <div class="mdesc">\r
- True to hide the expand/collapse toggle button when <a ext:cls="Ext.Panel" ext:member="collapsible" href="output/Ext.Panel.html#collapsible">collapsible</a> = true, false to display it (defaults to false). </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#hideCollapseTool" href="output/Ext.Panel.html#hideCollapseTool">Panel</a></td>\r
- </tr>\r
- <tr class="config-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-hideLabel"></a>\r
- <b>hideLabel</b> : Boolean <div class="mdesc">\r
- <div class="short">True to completely hide the label element (defaults to false). By default, even if you do not specify a fieldLabel th...</div>\r
- <div class="long">\r
- True to completely hide the label element (defaults to false). By default, even if you do not specify a <a ext:cls="fieldLabel" href="output/fieldLabel.html">fieldLabel</a> the space will still be reserved so that the field will line up with other fields that do have labels. Setting this to true will cause the field to not reserve that space. <p><b>This config is only used when this Component is rendered by a Container which has been configured to use the <a ext:cls="Ext.form.FormLayout" href="output/Ext.form.FormLayout.html">FormLayout</a> layout manager.</b></p> Example use:<pre><code>new Ext.FormPanel({
+});</code></pre></div></div></td><td class="msource"><a href="output/Ext.Component.html#fieldLabel" ext:member="#fieldLabel" 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-flex"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-flex">flex</a></b> : Number<div class="mdesc"><div class="short">Note: this config is only used when this Component is rendered
+by a Container which has been configured to use a BoxL...</div><div class="long"><p><b>Note</b>: this config is only used when this Component is rendered
+by a Container which has been configured to use a <b><a href="output/Ext.layout.BoxLayout.html" ext:cls="Ext.layout.BoxLayout">BoxLayout</a>.</b>
+Each child Component with a <code>flex</code> property will be flexed either vertically (by a VBoxLayout)
+or horizontally (by an HBoxLayout) according to the item's <b>relative</b> <code>flex</code> value
+compared to the sum of all Components with <code>flex</flex> value specified. Any child items that have
+either a <code>flex = 0</code> or <code>flex = undefined</code> will not be 'flexed' (the initial size will not be changed).</div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#flex" ext:member="#flex" 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.Panel-floating"></a><b><a href="source/Panel.html#cfg-Ext.Panel-floating">floating</a></b> : Mixed<div class="mdesc"><div class="short">This property is used to configure the underlying Ext.Layer. Acceptable values for this
+configuration property are:<d...</div><div class="long"><p>This property is used to configure the underlying <a href="output/Ext.Layer.html" ext:cls="Ext.Layer">Ext.Layer</a>. Acceptable values for this
+configuration property are:</p><div class="mdetail-params"><ul>
+<li><b><code>false</code></b> : <b>Default.</b><div class="sub-desc">Display the panel inline where it is
+rendered.</div></li>
+<li><b><code>true</code></b> : <div class="sub-desc">Float the panel (absolute position it with automatic
+shimming and shadow).<ul>
+<div class="sub-desc">Setting floating to true will create an Ext.Layer for this panel and display the
+panel at negative offsets so that it is hidden.</div>
+<div class="sub-desc">Since the panel will be absolute positioned, the position must be set explicitly
+<i>after</i> render (e.g., <code>myPanel.setPosition(100,100);</code>).</div>
+<div class="sub-desc"><b>Note</b>: when floating a panel you should always assign a fixed width,
+otherwise it will be auto width and will expand to fill to the right edge of the viewport.</div>
+</ul></div></li>
+<li><b><code><a href="output/Ext.Layer.html" ext:cls="Ext.Layer">object</a></code></b> : <div class="sub-desc">The specified object will be used
+as the configuration object for the <a href="output/Ext.Layer.html" ext:cls="Ext.Layer">Ext.Layer</a> that will be created.</div></li>
+</ul></div></div></div></td><td class="msource"><a href="output/Ext.Panel.html#floating" ext:member="#floating" 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-footer"></a><b><a href="source/Panel.html#cfg-Ext.Panel-footer">footer</a></b> : Boolean<div class="mdesc"><div class="short">true to create the footer element explicitly, false to skip creating it. The footer
+will be created automatically if ...</div><div class="long"><code>true</code> to create the footer element explicitly, false to skip creating it. The footer
+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
+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
+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
+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>).
+<p>The template generated for each condition is depicted below:</p><pre><code><i>// frame = false</i>
+<div id=<em>"developer-specified-id-goes-here"</em> class=<em>"x-panel"</em>>
+
+ <div class=<em>"x-panel-header"</em>><span class=<em>"x-panel-header-text"</em>>Title: (frame:false)</span></div>
+
+ <div class=<em>"x-panel-bwrap"</em>>
+ <div class=<em>"x-panel-body"</em>><p>html value goes here</p></div>
+ </div>
+</div>
+
+<i>// frame = true (create 9 elements)</i>
+<div id=<em>"developer-specified-id-goes-here"</em> class=<em>"x-panel"</em>>
+ <div class=<em>"x-panel-tl"</em>><div class=<em>"x-panel-tr"</em>><div class=<em>"x-panel-tc"</em>>
+ <div class=<em>"x-panel-header"</em>><span class=<em>"x-panel-header-text"</em>>Title: (frame:true)</span></div>
+ </div></div></div>
+
+ <div class=<em>"x-panel-bwrap"</em>>
+ <div class=<em>"x-panel-ml"</em>><div class=<em>"x-panel-mr"</em>><div class=<em>"x-panel-mc"</em>>
+ <div class=<em>"x-panel-body"</em>><p>html value goes here</p></div>
+ </div></div></div>
+
+ <div class=<em>"x-panel-bl"</em>><div class=<em>"x-panel-br"</em>><div class=<em>"x-panel-bc"</em>/>
+ </div></div></div>
+</div></code></pre></div></div></td><td class="msource"><a href="output/Ext.Panel.html#frame" ext:member="#frame" 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-header"></a><b><a href="source/Panel.html#cfg-Ext.Panel-header">header</a></b> : Boolean<div class="mdesc"><div class="short">true to create the Panel's header element explicitly, false to skip creating
+it. If a title is set the header will b...</div><div class="long"><code>true</code> to create the Panel's header element explicitly, <code>false</code> to skip creating
+it. If a <code><a href="output/Ext.Panel.html#Ext.Panel-title" ext:member="title" ext:cls="Ext.Panel">title</a></code> is set the header will be created automatically, otherwise it will not.
+If a <code><a href="output/Ext.Panel.html#Ext.Panel-title" ext:member="title" ext:cls="Ext.Panel">title</a></code> is set but <code>header</code> is explicitly set to <code>false</code>, the header
+will not be rendered.</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="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Panel-headerAsText"></a><b><a href="source/Panel.html#cfg-Ext.Panel-headerAsText">headerAsText</a></b> : Boolean<div class="mdesc"><code>true</code> to display the panel <code><a href="output/Ext.Panel.html#Ext.Panel-title" ext:member="title" ext:cls="Ext.Panel">title</a></code> in the <code><a href="output/Ext.Panel.html#Ext.Panel-header" ext:member="header" ext:cls="Ext.Panel">header</a></code>,
+<code>false</code> to hide it (defaults to <code>true</code>).</div></td><td class="msource"><a href="output/Ext.Panel.html#headerAsText" ext:member="#headerAsText" 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-headerCfg"></a><b><a href="source/Panel.html#cfg-Ext.Panel-headerCfg">headerCfg</a></b> : Object<div class="mdesc"><div class="short">A DomHelper element specification object specifying the element structure
+of this Panel's header 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-header" ext:member="header" ext:cls="Ext.Panel">header</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#headerCfg" ext:member="#headerCfg" 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-height"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-height">height</a></b> : Number<div class="mdesc"><div class="short">The height of this component in pixels (defaults to auto).
+Note to express this dimension as a percentage or offset s...</div><div class="long">The height of this component in pixels (defaults to auto).
+<b>Note</b> to express this dimension as a percentage or offset see <a href="output/Ext.Component.html#Ext.Component-anchor" ext:member="anchor" ext:cls="Ext.Component">Ext.Component.anchor</a>.</div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#height" ext:member="#height" 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.Component-hidden"></a><b><a href="source/Component.html#cfg-Ext.Component-hidden">hidden</a></b> : Boolean<div class="mdesc">Render this component hidden (default is false). If <tt>true</tt>, the
+<a href="output/Ext.Component.html#Ext.Component-hide" ext:member="hide" ext:cls="Ext.Component">hide</a> method will be called internally.</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="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Panel-hideCollapseTool"></a><b><a href="source/Panel.html#cfg-Ext.Panel-hideCollapseTool">hideCollapseTool</a></b> : Boolean<div class="mdesc"><code>true</code> to hide the expand/collapse toggle button when <code><a href="output/Ext.Panel.html#Ext.Panel-collapsible" ext:member="collapsible" ext:cls="Ext.Panel">collapsible</a> == true</code>,
+<code>false</code> to display it (defaults to <code>false</code>).</div></td><td class="msource"><a href="output/Ext.Panel.html#hideCollapseTool" ext:member="#hideCollapseTool" 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-hideLabel"></a><b><a href="source/Component.html#cfg-Ext.Component-hideLabel">hideLabel</a></b> : Boolean<div class="mdesc"><div class="short">true to completely hide the label element
+(label and separator). Defaults to false.
+By default, even if you do not sp...</div><div class="long"><p><tt>true</tt> to completely hide the label element
+(<a href="output/Ext.Component.html#Ext.Component-fieldLabel" ext:member="fieldLabel" ext:cls="Ext.Component">label</a> and <a href="output/Ext.Component.html#Ext.Component-labelSeparator" ext:member="labelSeparator" ext:cls="Ext.Component">separator</a>). Defaults to <tt>false</tt>.
+By default, even if you do not specify a <tt><a href="output/Ext.Component.html#Ext.Component-fieldLabel" ext:member="fieldLabel" ext:cls="Ext.Component">fieldLabel</a></tt> the space will still be
+reserved so that the field will line up with other fields that do have labels.
+Setting this to <tt>true</tt> will cause the field to not reserve that space.</p>
+<br><p><b>Note</b>: see the note for <tt><a href="output/Ext.Component.html#Ext.Component-clearCls" ext:member="clearCls" ext:cls="Ext.Component">clearCls</a></tt>.</p><br>
+Example use:<pre><code><b>new</b> Ext.FormPanel({
height: 100,
renderTo: Ext.getBody(),
items: [{
xtype: <em>'textfield'</em>
hideLabel: true
}]
-});</code></pre> </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#hideLabel" href="output/Ext.Component.html#hideLabel">Component</a></td>\r
- </tr>\r
- <tr class="config-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-hideMode"></a>\r
- <b>hideMode</b> : String <div class="mdesc">\r
- <div class="short">How this component should be hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset p...</div>\r
- <div class="long">\r
- <p>How this component should be hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset position) and "display" (css display) - defaults to "display".</p> <p>For Containers which may be hidden and shown as part of a <a ext:cls="Ext.layout.CardLayout" href="output/Ext.layout.CardLayout.html">card layout</a> Container such as a <a ext:cls="Ext.TabPanel" href="output/Ext.TabPanel.html">TabPanel</a>, it is recommended that hideMode is configured as "offsets". This ensures that hidden Components still have height and width so that layout managers can perform measurements when calculating layouts.</p> </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#hideMode" href="output/Ext.Component.html#hideMode">Component</a></td>\r
- </tr>\r
- <tr class="config-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-hideParent"></a>\r
- <b>hideParent</b> : Boolean <div class="mdesc">\r
- <div class="short">True to hide and show the component's container when hide/show is called on the component, false to hide and show the...</div>\r
- <div class="long">\r
- True to hide and show the component's container when hide/show is called on the component, false to hide and show the component itself (defaults to false). For example, this can be used as a shortcut for a hide button on a window by setting hide:true on the button when adding it to its parent container. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#hideParent" href="output/Ext.Component.html#hideParent">Component</a></td>\r
- </tr>\r
- <tr class="config-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-hlColor"></a>\r
- <b>hlColor</b> : String <div class="mdesc">\r
- The color of the node highlight (defaults to C3DAF9) </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="config-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-hlDrop"></a>\r
- <b>hlDrop</b> : Boolean <div class="mdesc">\r
- false to disable node highlight on drop (defaults to the value of Ext.enableFx) </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="config-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-iconCls"></a>\r
- <b>iconCls</b> : String <div class="mdesc">\r
- <div class="short">A CSS class that will provide a background image to be used as the header icon (defaults to ''). An example custom ic...</div>\r
- <div class="long">\r
- A CSS class that will provide a background image to be used as the header icon (defaults to ''). An example custom icon class would be something like: .my-icon { background: url(../images/my-icon.gif) 0 6px no-repeat !important;} </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#iconCls" href="output/Ext.Panel.html#iconCls">Panel</a></td>\r
- </tr>\r
- <tr class="config-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-id"></a>\r
- <b>id</b> : String <div class="mdesc">\r
- <div class="short">The unique id of this component (defaults to an auto-assigned id). You should assign an id if you need to be able to ...</div>\r
- <div class="long">\r
- The unique id of this component (defaults to an auto-assigned id). You should assign an id if you need to be able to access the component later and you do not have an object reference available (e.g., using <a ext:cls="Ext.ComponentMgr" ext:member="getCmp" href="output/Ext.ComponentMgr.html#getCmp">Ext.ComponentMgr.getCmp</a>). Note that this id will also be used as the element id for the containing HTML element that is rendered to the page for this component. This allows you to write id-based CSS rules to style the specific instance of this component uniquely, and also to select sub-elements using this component's id as the parent. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#id" href="output/Ext.Component.html#id">Component</a></td>\r
- </tr>\r
- <tr class="config-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-itemCls"></a>\r
- <b>itemCls</b> : String <div class="mdesc">\r
- <div class="short">An additional CSS class to apply to the wrapper's form item element of this field (defaults to the container's itemCl...</div>\r
- <div class="long">\r
- An additional CSS class to apply to the wrapper's form item element of this field (defaults to the container's itemCls value if set, or ''). Since it is applied to the item wrapper, it allows you to write standard CSS rules that can apply to the field, the label (if specified) or any other element within the markup for the field. <p><b>This config is only used when this Component is rendered by a Container which has been configured to use the <a ext:cls="Ext.form.FormLayout" href="output/Ext.form.FormLayout.html">FormLayout</a> layout manager.</b></p> Example use:<pre><code><i>// Apply a style to the field's label:</i>
+});</code></pre></div></div></td><td class="msource"><a href="output/Ext.Component.html#hideLabel" ext:member="#hideLabel" 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-hideMode"></a><b><a href="source/Component.html#cfg-Ext.Component-hideMode">hideMode</a></b> : String<div class="mdesc"><div class="short">How this component should be hidden. Supported values are 'visibility'
+(css visibility), 'offsets' (negative offset p...</div><div class="long"><p>How this component should be hidden. Supported values are <tt>'visibility'</tt>
+(css visibility), <tt>'offsets'</tt> (negative offset position) and <tt>'display'</tt>
+(css display).</p>
+<br><p><b>Note</b>: the default of <tt>'display'</tt> is generally preferred
+since items are automatically laid out when they are first shown (no sizing
+is done while hidden).</p></div></div></td><td class="msource"><a href="output/Ext.Component.html#hideMode" ext:member="#hideMode" 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-hideParent"></a><b><a href="source/Component.html#cfg-Ext.Component-hideParent">hideParent</a></b> : Boolean<div class="mdesc"><div class="short">True to hide and show the component's container when hide/show is called on the component, false to hide
+and show the...</div><div class="long">True to hide and show the component's container when hide/show is called on the component, false to hide
+and show the component itself (defaults to false). For example, this can be used as a shortcut for a hide
+button on a window by setting hide:true on the button when adding it to its parent container.</div></div></td><td class="msource"><a href="output/Ext.Component.html#hideParent" ext:member="#hideParent" 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-hlColor"></a><b><a href="source/TreePanel.html#cfg-Ext.tree.TreePanel-hlColor">hlColor</a></b> : String<div class="mdesc">The color of the node highlight (defaults to <tt>'C3DAF9'</tt>)</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-hlDrop"></a><b><a href="source/TreePanel.html#cfg-Ext.tree.TreePanel-hlDrop">hlDrop</a></b> : Boolean<div class="mdesc"><tt>false</tt> to disable node highlight on drop (defaults to the value of <a href="output/Ext.html#Ext-enableFx" ext:member="enableFx" ext:cls="Ext">Ext.enableFx</a>)</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-iconCls"></a><b><a href="source/Panel.html#cfg-Ext.Panel-iconCls">iconCls</a></b> : String<div class="mdesc"><div class="short">The CSS class selector that specifies a background image to be used as the header icon (defaults to '').
+An example o...</div><div class="long">The CSS class selector that specifies a background image to be used as the header icon (defaults to '').
+<p>An example of specifying a custom icon class would be something like:
+</p><pre><code><i>// specify the property <b>in</b> the config <b>for</b> the class:</i>
+ ...
+ iconCls: <em>'my-icon'</em>
+
+<i>// css class that specifies background image to be used as the icon image:</i>
+.my-icon { background-image: url(../images/my-icon.gif) 0 6px no-repeat !important; }</code></pre></div></div></td><td class="msource"><a href="output/Ext.Panel.html#iconCls" ext:member="#iconCls" 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-id"></a><b><a href="source/Component.html#cfg-Ext.Component-id">id</a></b> : String<div class="mdesc"><div class="short">The unique id of this component (defaults to an auto-assigned id).
+You should assign an id if you need to be able to ...</div><div class="long"><p>The <b>unique</b> id of this component (defaults to an <a href="output/Ext.Component.html#Ext.Component-getId" ext:member="getId" ext:cls="Ext.Component">auto-assigned id</a>).
+You should assign an id if you need to be able to access the component later and you do
+not have an object reference available (e.g., using <a href="output/Ext.html" ext:cls="Ext">Ext</a>.<a href="output/Ext.html#Ext-getCmp" ext:member="getCmp" ext:cls="Ext">getCmp</a>).</p>
+<p>Note that this id will also be used as the element id for the containing HTML element
+that is rendered to the page for this component. This allows you to write id-based CSS
+rules to style the specific instance of this component uniquely, and also to select
+sub-elements using this component's id as the parent.</p>
+<p><b>Note</b>: to avoid complications imposed by a unique <tt>id</tt> also see
+<code><a href="output/Ext.Component.html#Ext.Component-itemId" ext:member="itemId" ext:cls="Ext.Component">itemId</a></code> and <code><a href="output/Ext.Component.html#Ext.Component-ref" ext:member="ref" ext:cls="Ext.Component">ref</a></code>.</p>
+<p><b>Note</b>: to access the container of an item see <code><a href="output/Ext.Component.html#Ext.Component-ownerCt" ext:member="ownerCt" ext:cls="Ext.Component">ownerCt</a></code>.</p></div></div></td><td class="msource"><a href="output/Ext.Component.html#id" ext:member="#id" 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-itemCls"></a><b><a href="source/Component.html#cfg-Ext.Component-itemCls">itemCls</a></b> : String<div class="mdesc"><div class="short">Note: this config is only used when this Component is rendered by a Container which
+has been configured to use the Fo...</div><div class="long"><p><b>Note</b>: this config is only used when this Component is rendered by a Container which
+has been configured to use the <b><a href="output/Ext.layout.FormLayout.html" ext:cls="Ext.layout.FormLayout">FormLayout</a></b> layout manager (e.g.
+<a href="output/Ext.form.FormPanel.html" ext:cls="Ext.form.FormPanel">Ext.form.FormPanel</a> or specifying <tt>layout:'form'</tt>).</p><br>
+<p>An additional CSS class to apply to the div wrapping the form item
+element of this field. If supplied, <tt>itemCls</tt> at the <b>field</b> level will override
+the default <tt>itemCls</tt> supplied at the <b>container</b> level. The value specified for
+<tt>itemCls</tt> will be added to the default class (<tt>'x-form-item'</tt>).</p>
+<p>Since it is applied to the item wrapper (see
+<a href="output/Ext.layout.FormLayout.html" ext:cls="Ext.layout.FormLayout">Ext.layout.FormLayout</a>.<a href="output/Ext.layout.FormLayout.html#Ext.layout.FormLayout-fieldTpl" ext:member="fieldTpl" ext:cls="Ext.layout.FormLayout">fieldTpl</a>), it allows
+you to write standard CSS rules that can apply to the field, the label (if specified), or
+any other element within the markup for the field.</p>
+<br><p><b>Note</b>: see the note for <tt><a href="output/Ext.Component.html#Ext.Component-fieldLabel" ext:member="fieldLabel" ext:cls="Ext.Component">fieldLabel</a></tt>.</p><br>
+Example use:<pre><code><i>// Apply a style to the field's <b>label</b>:</i>
<style>
- .required .x-form-item-label {font-weight:bold;color:red;}
+ .required .x-form-item-<b>label</b> {font-weight:bold;color:red;}
</style>
<b>new</b> Ext.FormPanel({
items: [{
xtype: <em>'textfield'</em>,
fieldLabel: <em>'Name'</em>,
- itemCls: <em>'required'</em> <i>//<b>this</b> label will be styled</i>
+ itemCls: <em>'required'</em> <i>//this <b>label</b> will be styled</i>
},{
xtype: <em>'textfield'</em>,
fieldLabel: <em>'Favorite Color'</em>
}]
-});</code></pre> </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#itemCls" href="output/Ext.Component.html#itemCls">Component</a></td>\r
- </tr>\r
- <tr class="config-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-keys"></a>\r
- <b>keys</b> : Object/Array <div class="mdesc">\r
- <div class="short">A KeyMap config object (in the format expected by Ext.KeyMap.addBinding used to assign custom key handling to this pa...</div>\r
- <div class="long">\r
- A KeyMap config object (in the format expected by <a ext:cls="Ext.KeyMap" ext:member="addBinding" href="output/Ext.KeyMap.html#addBinding">Ext.KeyMap.addBinding</a> used to assign custom key handling to this panel (defaults to null). </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#keys" href="output/Ext.Panel.html#keys">Panel</a></td>\r
- </tr>\r
- <tr class="config-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-labelSeparator"></a>\r
- <b>labelSeparator</b> : String <div class="mdesc">\r
- <div class="short">The standard separator to display after the text of each form label (defaults to the value of Ext.layout.FormLayout.l...</div>\r
- <div class="long">\r
- The standard separator to display after the text of each form label (defaults to the value of <a ext:cls="Ext.layout.FormLayout" ext:member="labelSeparator" href="output/Ext.layout.FormLayout.html#labelSeparator">Ext.layout.FormLayout.labelSeparator</a>, which is a colon ':' by default). To display no separator for this field's label specify empty string ''. <p><b>This config is only used when this Component is rendered by a Container which has been configured to use the <a ext:cls="Ext.form.FormLayout" href="output/Ext.form.FormLayout.html">FormLayout</a> layout manager.</b></p> Example use:<pre><code>new Ext.FormPanel({
+});</code></pre></div></div></td><td class="msource"><a href="output/Ext.Component.html#itemCls" ext:member="#itemCls" 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-itemId"></a><b><a href="source/Component.html#cfg-Ext.Component-itemId">itemId</a></b> : String<div class="mdesc"><div class="short">An itemId can be used as an alternative way to get a reference to a component
+when no object reference is available. ...</div><div class="long"><p>An <tt>itemId</tt> can be used as an alternative way to get a reference to a component
+when no object reference is available. Instead of using an <code><a href="output/Ext.Component.html#Ext.Component-id" ext:member="id" ext:cls="Ext.Component">id</a></code> with
+<a href="output/Ext.html" ext:cls="Ext">Ext</a>.<a href="output/Ext.html#Ext-getCmp" ext:member="getCmp" ext:cls="Ext">getCmp</a>, use <code>itemId</code> with
+<a href="output/Ext.Container.html" ext:cls="Ext.Container">Ext.Container</a>.<a href="output/Ext.Container.html#Ext.Container-getComponent" ext:member="getComponent" ext:cls="Ext.Container">getComponent</a> which will retrieve
+<code>itemId</code>'s or <tt><a href="output/Ext.Component.html#Ext.Component-id" ext:member="id" ext:cls="Ext.Component">id</a></tt>'s. Since <code>itemId</code>'s are an index to the
+container's internal MixedCollection, the <code>itemId</code> is scoped locally to the container --
+avoiding potential conflicts with <a href="output/Ext.ComponentMgr.html" ext:cls="Ext.ComponentMgr">Ext.ComponentMgr</a> which requires a <b>unique</b>
+<code><a href="output/Ext.Component.html#Ext.Component-id" ext:member="id" ext:cls="Ext.Component">id</a></code>.</p>
+<pre><code><b>var</b> c = <b>new</b> Ext.Panel({ <i>//</i>
+ <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-height" ext:member="height" ext:cls="Ext.BoxComponent">height</a>: 300,
+ <a href="output/Ext.Component.html#Ext.Component-renderTo" ext:member="renderTo" ext:cls="Ext.Component">renderTo</a>: document.body,
+ <a href="output/Ext.Container.html#Ext.Container-layout" ext:member="layout" ext:cls="Ext.Container">layout</a>: <em>'auto'</em>,
+ <a href="output/Ext.Container.html#Ext.Container-items" ext:member="items" ext:cls="Ext.Container">items</a>: [
+ {
+ itemId: <em>'p1'</em>,
+ <a href="output/Ext.Panel.html#Ext.Panel-title" ext:member="title" ext:cls="Ext.Panel">title</a>: <em>'Panel 1'</em>,
+ <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-height" ext:member="height" ext:cls="Ext.BoxComponent">height</a>: 150
+ },
+ {
+ itemId: <em>'p2'</em>,
+ <a href="output/Ext.Panel.html#Ext.Panel-title" ext:member="title" ext:cls="Ext.Panel">title</a>: <em>'Panel 2'</em>,
+ <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-height" ext:member="height" ext:cls="Ext.BoxComponent">height</a>: 150
+ }
+ ]
+})
+p1 = c.<a href="output/Ext.Container.html#Ext.Container-getComponent" ext:member="getComponent" ext:cls="Ext.Container">getComponent</a>(<em>'p1'</em>); <i>// not the same as <a href="output/Ext.html#Ext-getCmp" ext:member="getCmp" ext:cls="Ext">Ext.getCmp()</a></i>
+p2 = p1.<a href="output/Ext.Component.html#Ext.Component-ownerCt" ext:member="ownerCt" ext:cls="Ext.Component">ownerCt</a>.<a href="output/Ext.Container.html#Ext.Container-getComponent" ext:member="getComponent" ext:cls="Ext.Container">getComponent</a>(<em>'p2'</em>); <i>// reference via a sibling</i></code></pre>
+<p>Also see <tt><a href="output/Ext.Component.html#Ext.Component-id" ext:member="id" ext:cls="Ext.Component">id</a></tt> and <code><a href="output/Ext.Component.html#Ext.Component-ref" ext:member="ref" ext:cls="Ext.Component">ref</a></code>.</p>
+<p><b>Note</b>: to access the container of an item see <tt><a href="output/Ext.Component.html#Ext.Component-ownerCt" ext:member="ownerCt" ext:cls="Ext.Component">ownerCt</a></tt>.</p></div></div></td><td class="msource"><a href="output/Ext.Component.html#itemId" ext:member="#itemId" 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-keys"></a><b><a href="source/Panel.html#cfg-Ext.Panel-keys">keys</a></b> : Object/Array<div class="mdesc"><div class="short">A Ext.KeyMap config object (in the format expected by Ext.KeyMap.addBinding
+used to assign custom key handling to thi...</div><div class="long">A <a href="output/Ext.KeyMap.html" ext:cls="Ext.KeyMap">Ext.KeyMap</a> config object (in the format expected by <a href="output/Ext.KeyMap.html#Ext.KeyMap-addBinding" ext:member="addBinding" ext:cls="Ext.KeyMap">Ext.KeyMap.addBinding</a>
+used to assign custom key handling to this panel (defaults to <code>null</code>).</div></div></td><td class="msource"><a href="output/Ext.Panel.html#keys" ext:member="#keys" 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-labelSeparator"></a><b><a href="source/Component.html#cfg-Ext.Component-labelSeparator">labelSeparator</a></b> : String<div class="mdesc"><div class="short">The separator to display after the text of each
+fieldLabel. This property may be configured at various levels.
+The o...</div><div class="long"><p>The separator to display after the text of each
+<tt><a href="output/Ext.Component.html#Ext.Component-fieldLabel" ext:member="fieldLabel" ext:cls="Ext.Component">fieldLabel</a></tt>. This property may be configured at various levels.
+The order of precedence is:
+<div class="mdetail-params"><ul>
+<li>field / component level</li>
+<li>container level</li>
+<li><a href="output/Ext.layout.FormLayout.html#Ext.layout.FormLayout-labelSeparator" ext:member="labelSeparator" ext:cls="Ext.layout.FormLayout">layout level</a> (defaults to colon <tt>':'</tt>)</li>
+</ul></div>
+To display no separator for this field's label specify empty string ''.</p>
+<br><p><b>Note</b>: see the note for <tt><a href="output/Ext.Component.html#Ext.Component-clearCls" ext:member="clearCls" ext:cls="Ext.Component">clearCls</a></tt>.</p><br>
+<p>Also see <tt><a href="output/Ext.Component.html#Ext.Component-hideLabel" ext:member="hideLabel" ext:cls="Ext.Component">hideLabel</a></tt> and
+<a href="output/Ext.layout.FormLayout.html" ext:cls="Ext.layout.FormLayout">Ext.layout.FormLayout</a>.<a href="output/Ext.layout.FormLayout.html#Ext.layout.FormLayout-fieldTpl" ext:member="fieldTpl" ext:cls="Ext.layout.FormLayout">fieldTpl</a>.</p>
+Example use:<pre><code><b>new</b> Ext.FormPanel({
height: 100,
renderTo: Ext.getBody(),
+ layoutConfig: {
+ labelSeparator: <em>'~'</em> <i>// layout config has lowest priority (defaults to <em>':'</em>)</i>
+ },
+ <a href="output/Ext.layout.FormLayout.html#Ext.layout.FormLayout-labelSeparator" ext:member="labelSeparator" ext:cls="Ext.layout.FormLayout">labelSeparator</a>: <em>'>>'</em>, <i>// config at container level</i>
items: [{
xtype: <em>'textfield'</em>,
- fieldLabel: <em>'Name'</em>,
- labelSeparator: <em>'...'</em>
+ fieldLabel: <em>'Field 1'</em>,
+ labelSeparator: <em>'...'</em> <i>// field/component level config supersedes others</i>
+ },{
+ xtype: <em>'textfield'</em>,
+ fieldLabel: <em>'Field 2'</em> <i>// labelSeparator will be <em>'='</em></i>
}]
-});</code></pre> </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#labelSeparator" href="output/Ext.Component.html#labelSeparator">Component</a></td>\r
- </tr>\r
- <tr class="config-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-labelStyle"></a>\r
- <b>labelStyle</b> : String <div class="mdesc">\r
- <div class="short">A CSS style specification to apply directly to this field's label (defaults to the container's labelStyle value if se...</div>\r
- <div class="long">\r
- A CSS style specification to apply directly to this field's label (defaults to the container's labelStyle value if set, or '').<code></code>. <p><b>This config is only used when this Component is rendered by a Container which has been configured to use the <a ext:cls="Ext.form.FormLayout" href="output/Ext.form.FormLayout.html">FormLayout</a> layout manager.</b></p> Example use:<pre><code>new Ext.FormPanel({
+});</code></pre></div></div></td><td class="msource"><a href="output/Ext.Component.html#labelSeparator" ext:member="#labelSeparator" 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-labelStyle"></a><b><a href="source/Component.html#cfg-Ext.Component-labelStyle">labelStyle</a></b> : String<div class="mdesc"><div class="short">A CSS style specification string to apply directly to this field's
+label. Defaults to the container's labelStyle val...</div><div class="long"><p>A CSS style specification string to apply directly to this field's
+label. Defaults to the container's labelStyle value if set (e.g.,
+<tt><a href="output/Ext.layout.FormLayout.html#Ext.layout.FormLayout-labelStyle" ext:member="labelStyle" ext:cls="Ext.layout.FormLayout">Ext.layout.FormLayout.labelStyle</a></tt> , or '').</p>
+<br><p><b>Note</b>: see the note for <code><a href="output/Ext.Component.html#Ext.Component-clearCls" ext:member="clearCls" ext:cls="Ext.Component">clearCls</a></code>.</p><br>
+<p>Also see <code><a href="output/Ext.Component.html#Ext.Component-hideLabel" ext:member="hideLabel" ext:cls="Ext.Component">hideLabel</a></code> and
+<code><a href="output/Ext.layout.FormLayout.html" ext:cls="Ext.layout.FormLayout">Ext.layout.FormLayout</a>.<a href="output/Ext.layout.FormLayout.html#Ext.layout.FormLayout-fieldTpl" ext:member="fieldTpl" ext:cls="Ext.layout.FormLayout">fieldTpl</a>.</code></p>
+Example use:<pre><code><b>new</b> Ext.FormPanel({
height: 100,
renderTo: Ext.getBody(),
items: [{
fieldLabel: <em>'Name'</em>,
labelStyle: <em>'font-weight:bold;'</em>
}]
-});</code></pre> </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#labelStyle" href="output/Ext.Component.html#labelStyle">Component</a></td>\r
- </tr>\r
- <tr class="config-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-lines"></a>\r
- <b>lines</b> : Boolean <div class="mdesc">\r
- false to disable tree lines (defaults to true) </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="config-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-listeners"></a>\r
- <b>listeners</b> : Object <div class="mdesc">\r
- <div class="short">(optional) A config object containing one or more event handlers to be added to this object during initialization. Th...</div>\r
- <div class="long">\r
- (optional) A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the <a ext:cls="Ext.util.Observable" ext:member="addListener" href="output/Ext.util.Observable.html#addListener">addListener</a> example for attaching multiple handlers at once. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td>\r
- </tr>\r
- <tr class="config-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-loader"></a>\r
- <b>loader</b> : Ext.tree.TreeLoader <div class="mdesc">\r
- A <a ext:cls="Ext.tree.TreeLoader" href="output/Ext.tree.TreeLoader.html">Ext.tree.TreeLoader</a> for use with this TreePanel </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="config-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-maskDisabled"></a>\r
- <b>maskDisabled</b> : Boolean <div class="mdesc">\r
- <div class="short">True to mask the panel when it is disabled, false to not mask it (defaults to true). Either way, the panel will alway...</div>\r
- <div class="long">\r
- True to mask the panel when it is disabled, false to not mask it (defaults to true). Either way, the panel will always tell its contained elements to disable themselves when it is disabled, but masking the panel can provide an additional visual cue that the panel is disabled. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#maskDisabled" href="output/Ext.Panel.html#maskDisabled">Panel</a></td>\r
- </tr>\r
- <tr class="config-row inherited alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-minButtonWidth"></a>\r
- <b>minButtonWidth</b> : Number <div class="mdesc">\r
- Minimum width in pixels of all buttons in this panel (defaults to 75) </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#minButtonWidth" href="output/Ext.Panel.html#minButtonWidth">Panel</a></td>\r
- </tr>\r
- <tr class="config-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-overCls"></a>\r
- <b>overCls</b> : String <div class="mdesc">\r
- <div class="short">An optional extra CSS class that will be added to this component's Element when the mouse moves over the Element, and...</div>\r
- <div class="long">\r
- 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>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#overCls" href="output/Ext.Component.html#overCls">Component</a></td>\r
- </tr>\r
- <tr class="config-row inherited alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-pageX"></a>\r
- <b>pageX</b> : Number <div class="mdesc">\r
- The page level x coordinate for this component if contained within a positioning container. </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#pageX" href="output/Ext.BoxComponent.html#pageX">BoxComponent</a></td>\r
- </tr>\r
- <tr class="config-row inherited">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-pageY"></a>\r
- <b>pageY</b> : Number <div class="mdesc">\r
- The page level y coordinate for this component if contained within a positioning container. </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#pageY" href="output/Ext.BoxComponent.html#pageY">BoxComponent</a></td>\r
- </tr>\r
- <tr class="config-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-pathSeparator"></a>\r
- <b>pathSeparator</b> : String <div class="mdesc">\r
- The token used to separate sub-paths in path strings (defaults to '/') </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="config-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-plugins"></a>\r
- <b>plugins</b> : Object/Array <div class="mdesc">\r
- <div class="short">An object or array of objects that will provide custom functionality for this component. The only requirement for a v...</div>\r
- <div class="long">\r
- An object or array of objects that will provide custom functionality for this component. The only requirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.Component. When a component is created, if any plugins are available, the component will call the init method on each plugin, passing a reference to itself. Each plugin can then call methods or respond to events on the component as needed to provide its functionality. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#plugins" href="output/Ext.Component.html#plugins">Component</a></td>\r
- </tr>\r
- <tr class="config-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-renderTo"></a>\r
- <b>renderTo</b> : Mixed <div class="mdesc">\r
- <div class="short">The id of the node, a DOM node or an existing Element that will be the container to render this component into. Using...</div>\r
- <div class="long">\r
- The id of the node, a DOM node or an existing Element that will be the container to render this component into. Using this config, a call to render() is not required. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#renderTo" href="output/Ext.Component.html#renderTo">Component</a></td>\r
- </tr>\r
- <tr class="config-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-root"></a>\r
- <b>root</b> : Ext.tree.TreeNode <div class="mdesc">\r
- The root node for the tree. </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="config-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-rootVisible"></a>\r
- <b>rootVisible</b> : Boolean <div class="mdesc">\r
- false to hide the root node (defaults to true) </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="config-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-selModel"></a>\r
- <b>selModel</b> : Boolean <div class="mdesc">\r
- A tree selection model to use with this TreePanel (defaults to a <a ext:cls="Ext.tree.DefaultSelectionModel" href="output/Ext.tree.DefaultSelectionModel.html">Ext.tree.DefaultSelectionModel</a>) </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="config-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-shadow"></a>\r
- <b>shadow</b> : Boolean/String <div class="mdesc">\r
- <div class="short">True (or a valid Ext.Shadow Ext.Shadow.mode value) to display a shadow behind the panel, false to display no shadow (...</div>\r
- <div class="long">\r
- True (or a valid Ext.Shadow <a ext:cls="Ext.Shadow" ext:member="mode" href="output/Ext.Shadow.html#mode">Ext.Shadow.mode</a> value) to display a shadow behind the panel, false to display no shadow (defaults to 'sides'). Note that this option only applies when floating = true. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#shadow" href="output/Ext.Panel.html#shadow">Panel</a></td>\r
- </tr>\r
- <tr class="config-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-shadowOffset"></a>\r
- <b>shadowOffset</b> : Number <div class="mdesc">\r
- <div class="short">The number of pixels to offset the shadow if displayed (defaults to 4). Note that this option only applies when float...</div>\r
- <div class="long">\r
- The number of pixels to offset the shadow if displayed (defaults to 4). Note that this option only applies when floating = true. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#shadowOffset" href="output/Ext.Panel.html#shadowOffset">Panel</a></td>\r
- </tr>\r
- <tr class="config-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-shim"></a>\r
- <b>shim</b> : Boolean <div class="mdesc">\r
- <div class="short">False to disable the iframe shim in browsers which need one (defaults to true). Note that this option only applies wh...</div>\r
- <div class="long">\r
- False to disable the iframe shim in browsers which need one (defaults to true). Note that this option only applies when floating = true. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#shim" href="output/Ext.Panel.html#shim">Panel</a></td>\r
- </tr>\r
- <tr class="config-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-singleExpand"></a>\r
- <b>singleExpand</b> : Boolean <div class="mdesc">\r
- true if only 1 node per branch may be expanded </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="config-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-stateEvents"></a>\r
- <b>stateEvents</b> : Array <div class="mdesc">\r
- <div class="short">An array of events that, when fired, should trigger this component to save its state (defaults to none). These can be...</div>\r
- <div class="long">\r
- An array of events that, when fired, should trigger this component to save its state (defaults to none). These can be any types of events supported by this component, including browser or custom events (e.g., ['click', 'customerchange']). <p>See <a ext:cls="Ext.Component" ext:member="stateful" href="output/Ext.Component.html#stateful">stateful</a> for an explanation of saving and restoring Component state.</p> </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#stateEvents" href="output/Ext.Component.html#stateEvents">Component</a></td>\r
- </tr>\r
- <tr class="config-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-stateId"></a>\r
- <b>stateId</b> : String <div class="mdesc">\r
- <div class="short">The unique id for this component to use for state management purposes (defaults to the component id if one was set, o...</div>\r
- <div class="long">\r
- The unique id for this component to use for state management purposes (defaults to the component id if one was set, otherwise null if the component is using a generated id). <p>See <a ext:cls="Ext.Component" ext:member="stateful" href="output/Ext.Component.html#stateful">stateful</a> for an explanation of saving and restoring Component state.</p> </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#stateId" href="output/Ext.Component.html#stateId">Component</a></td>\r
- </tr>\r
- <tr class="config-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-stateful"></a>\r
- <b>stateful</b> : Boolean <div class="mdesc">\r
- <div class="short">A flag which causes the Component to attempt to restore the state of internal properties from a saved state on startu...</div>\r
- <div class="long">\r
- <p>A flag which causes the Component to attempt to restore the state of internal properties from a saved state on startup. The component must have either a <a ext:cls="Ext.Component" ext:member="stateId" href="output/Ext.Component.html#stateId">stateId</a> or <a ext:cls="Ext.Component" ext:member="id" href="output/Ext.Component.html#id">id</a> assigned for state to be managed. Auto-generated ids are not guaranteed to be stable across page loads and cannot be relied upon to save and restore the same state for a component.<p> For state saving to work, the state manager's provider must have been set to an implementation of <a ext:cls="Ext.state.Provider" href="output/Ext.state.Provider.html">Ext.state.Provider</a> which overrides the <a ext:cls="Ext.state.Provider" ext:member="set" href="output/Ext.state.Provider.html#set">set</a> and <a ext:cls="Ext.state.Provider" ext:member="get" href="output/Ext.state.Provider.html#get">get</a> methods to save and recall name/value pairs. A built-in implementation, <a ext:cls="Ext.state.CookieProvider" href="output/Ext.state.CookieProvider.html">Ext.state.CookieProvider</a> is available.</p> <p>To set the state provider for the current page:</p> <pre><code>Ext.state.Manager.setProvider(<b>new</b> Ext.state.CookieProvider());</code></pre> <p>Components attempt to save state when one of the events listed in the <a ext:cls="Ext.Component" ext:member="stateEvents" href="output/Ext.Component.html#stateEvents">stateEvents</a> configuration fires.</p> <p>You can perform extra processing on state save and restore by attaching handlers to the <a ext:cls="Ext.Component" ext:member="beforestaterestore" href="output/Ext.Component.html#beforestaterestore">beforestaterestore</a>, <a ext:cls="Ext.Component" ext:member="staterestore" href="output/Ext.Component.html#staterestore">staterestore</a>, <a ext:cls="Ext.Component" ext:member="beforestatesave" href="output/Ext.Component.html#beforestatesave">beforestatesave</a> and <a ext:cls="Ext.Component" ext:member="statesave" href="output/Ext.Component.html#statesave">statesave</a> events</p> </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#stateful" href="output/Ext.Component.html#stateful">Component</a></td>\r
- </tr>\r
- <tr class="config-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-style"></a>\r
- <b>style</b> : String <div class="mdesc">\r
- <div class="short">A custom style specification to be applied to this component's Element. Should be a valid argument to Ext.Element.app...</div>\r
- <div class="long">\r
- A custom style specification to be applied to this component's Element. Should be a valid argument to <a ext:cls="Ext.Element" ext:member="applyStyles" href="output/Ext.Element.html#applyStyles">Ext.Element.applyStyles</a>. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#style" href="output/Ext.Component.html#style">Component</a></td>\r
- </tr>\r
- <tr class="config-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-tabTip"></a>\r
- <b>tabTip</b> : String <div class="mdesc">\r
- <div class="short">Adds a tooltip when mousing over the tab of a Ext.Panel which is an item of a Ext.TabPanel. Ext.QuickTips.init() must...</div>\r
- <div class="long">\r
- Adds a tooltip when mousing over the tab of a Ext.Panel which is an item of a Ext.TabPanel. Ext.QuickTips.init() must be called in order for the tips to render. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#tabTip" href="output/Ext.Panel.html#tabTip">Panel</a></td>\r
- </tr>\r
- <tr class="config-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-tbar"></a>\r
- <b>tbar</b> : Object/Array <div class="mdesc">\r
- <div class="short">The top toolbar of the panel. This can be either an Ext.Toolbar object or an array of buttons/button configs to be ad...</div>\r
- <div class="long">\r
- The top toolbar of the panel. This can be either an <a ext:cls="Ext.Toolbar" href="output/Ext.Toolbar.html">Ext.Toolbar</a> object or an array of buttons/button configs to be added to the toolbar. Note that this is not available as a property after render. To access the top toolbar after render, use <a ext:cls="Ext.Panel" ext:member="getTopToolbar" href="output/Ext.Panel.html#getTopToolbar">getTopToolbar</a>. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#tbar" href="output/Ext.Panel.html#tbar">Panel</a></td>\r
- </tr>\r
- <tr class="config-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-title"></a>\r
- <b>title</b> : String <div class="mdesc">\r
- <div class="short">The title text to display in the panel header (defaults to ''). When a title is specified the header element will aut...</div>\r
- <div class="long">\r
- The title text to display in the panel header (defaults to ''). When a title is specified the header element will automatically be created and displayed unless <a ext:cls="Ext.Panel" ext:member="header" href="output/Ext.Panel.html#header">header</a> is explicitly set to false. If you don't want to specify a title at config time, but you may want one later, you must either specify a non-empty title (a blank space ' ' will do) or header:true so that the container element will get created. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#title" href="output/Ext.Panel.html#title">Panel</a></td>\r
- </tr>\r
- <tr class="config-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-titleCollapse"></a>\r
- <b>titleCollapse</b> : Boolean <div class="mdesc">\r
- <div class="short">True to allow expanding and collapsing the panel (when collapsible = true) by clicking anywhere in the header bar, fa...</div>\r
- <div class="long">\r
- True to allow expanding and collapsing the panel (when <a ext:cls="Ext.Panel" ext:member="collapsible" href="output/Ext.Panel.html#collapsible">collapsible</a> = true) by clicking anywhere in the header bar, false to allow it only by clicking to tool button (defaults to false). </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#titleCollapse" href="output/Ext.Panel.html#titleCollapse">Panel</a></td>\r
- </tr>\r
- <tr class="config-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-tools"></a>\r
- <b>tools</b> : Array <div class="mdesc">\r
- <div class="short">An array of tool button configs to be added to the header tool area. When rendered, each tool is stored as an Element...</div>\r
- <div class="long">\r
- An array of tool button configs to be added to the header tool area. When rendered, each tool is stored as an <a ext:cls="Ext.Element" href="output/Ext.Element.html">Element</a> referenced by a public property called <tt><b></b>tools.<i><tool-type></i></tt> <p>Each tool config may contain the following properties: <div class="mdetail-params"><ul> <li><b>id</b> : String<div class="sub-desc"><b>Required.</b> The type of tool to create. Values may be<ul> <li><tt>toggle</tt> (Created by default when <a ext:cls="Ext.Panel" ext:member="collapsible" href="output/Ext.Panel.html#collapsible">collapsible</a> is <tt>true</tt>)</li> <li><tt>close</tt></li> <li><tt>minimize</tt></li> <li><tt>maximize</tt></li> <li><tt>restore</tt></li> <li><tt>gear</tt></li> <li><tt>pin</tt></li> <li><tt>unpin</tt></li> <li><tt>right</tt></li> <li><tt>left</tt></li> <li><tt>up</tt></li> <li><tt>down</tt></li> <li><tt>refresh</tt></li> <li><tt>minus</tt></li> <li><tt>plus</tt></li> <li><tt>help</tt></li> <li><tt>search</tt></li> <li><tt>save</tt></li> <li><tt>print</tt></li> </ul></div></li> <li><b>handler</b> : Function<div class="sub-desc"><b>Required.</b> The function to call when clicked. Arguments passed are:<ul> <li><b>event</b> : Ext.EventObject<div class="sub-desc">The click event.</div></li> <li><b>toolEl</b> : Ext.Element<div class="sub-desc">The tool Element.</div></li> <li><b>Panel</b> : Ext.Panel<div class="sub-desc">The host Panel</div></li> </ul></div></li> <li><b>scope</b> : Object<div class="sub-desc">The scope in which to call the handler.</div></li> <li><b>qtip</b> : String/Object<div class="sub-desc">A tip string, or a config argument to <a ext:cls="Ext.QuickTip" ext:member="register" href="output/Ext.QuickTip.html#register">Ext.QuickTip.register</a></div></li> <li><b>hidden</b> : Boolean<div class="sub-desc">True to initially render hidden.</div></li> <li><b>on</b> : Object<div class="sub-desc">A listener config object specifiying event listeners in the format of an argument to <a ext:cls="Ext.Panel" ext:member="addListener" href="output/Ext.Panel.html#addListener">addListener</a></div></li> </ul></div> Example usage: <pre><code>tools:[{
+});</code></pre></div></div></td><td class="msource"><a href="output/Ext.Component.html#labelStyle" ext:member="#labelStyle" 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-lines"></a><b><a href="source/TreePanel.html#cfg-Ext.tree.TreePanel-lines">lines</a></b> : Boolean<div class="mdesc"><tt>false</tt> to disable tree lines (defaults to <tt>true</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.util.Observable-listeners"></a><b><a href="source/Observable.html#cfg-Ext.util.Observable-listeners">listeners</a></b> : Object<div class="mdesc"><div class="short">A config object containing one or more event handlers to be added to this
+object during initialization. This should ...</div><div class="long"><p>A config object containing one or more event handlers to be added to this
+object during initialization. This should be a valid listeners config object as specified in the
+<a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> example for attaching multiple handlers at once.</p>
+<br><p><b><u>DOM events from ExtJs <a href="output/Ext.Component.html" ext:cls="Ext.Component">Components</a></u></b></p>
+<br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
+is usually only done when extra value can be added. For example the <a href="output/Ext.DataView.html" ext:cls="Ext.DataView">DataView</a>'s
+<b><code><a href="output/Ext.DataView.html#Ext.DataView-click" ext:member="click" ext:cls="Ext.DataView">click</a></code></b> event passing the node clicked on. To access DOM
+events directly from a Component's HTMLElement, listeners must be added to the <i><a href="output/Ext.Component.html#Ext.Component-getEl" ext:member="getEl" ext:cls="Ext.Component">Element</a></i> after the Component
+has been rendered. A plugin can simplify this step:<pre><code><i>// Plugin is configured <b>with</b> a listeners config object.</i>
+<i>// The Component is appended to the argument list of all handler functions.</i>
+Ext.DomObserver = Ext.extend(Object, {
+ constructor: <b>function</b>(config) {
+ this.listeners = config.listeners ? config.listeners : config;
+ },
+
+ <i>// Component passes itself into plugin's init method</i>
+ init: <b>function</b>(c) {
+ <b>var</b> p, l = this.listeners;
+ <b>for</b> (p <b>in</b> l) {
+ <b>if</b> (Ext.isFunction(l[p])) {
+ l[p] = this.createHandler(l[p], c);
+ } <b>else</b> {
+ l[p].fn = this.createHandler(l[p].fn, c);
+ }
+ }
+
+ <i>// Add the listeners to the Element immediately following the render call</i>
+ c.render = c.render.<a href="output/Function.html#Function-createSequence" ext:member="createSequence" ext:cls="Function">createSequence</a>(<b>function</b>() {
+ <b>var</b> e = c.getEl();
+ <b>if</b> (e) {
+ e.on(l);
+ }
+ });
+ },
+
+ createHandler: <b>function</b>(fn, c) {
+ <b>return</b> <b>function</b>(e) {
+ fn.call(this, e, c);
+ };
+ }
+});
+
+<b>var</b> combo = <b>new</b> Ext.form.ComboBox({
+
+ <i>// Collapse combo when its element is clicked on</i>
+ plugins: [ <b>new</b> Ext.DomObserver({
+ click: <b>function</b>(evt, comp) {
+ comp.collapse();
+ }
+ })],
+ store: myStore,
+ typeAhead: true,
+ mode: <em>'local'</em>,
+ triggerAction: <em>'all'</em>
+});</code></pre></p></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#listeners" ext:member="#listeners" ext:cls="Ext.util.Observable">Observable</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-loader"></a><b><a href="source/TreePanel.html#cfg-Ext.tree.TreePanel-loader">loader</a></b> : Ext.tree.TreeLoader<div class="mdesc">A <a href="output/Ext.tree.TreeLoader.html" ext:cls="Ext.tree.TreeLoader">Ext.tree.TreeLoader</a> for use with this TreePanel</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-margins"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-margins">margins</a></b> : Object<div class="mdesc"><div class="short">Note: this config is only used when this BoxComponent is rendered
+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>
+or one of the two <b><a href="output/Ext.layout.BoxLayout.html" ext:cls="Ext.layout.BoxLayout">BoxLayout</a> subclasses.</b></p>
+<p>An object containing margins to apply to this BoxComponent in the
+format:</p><pre><code>{
+ top: (top margin),
+ right: (right margin),
+ bottom: (bottom margin),
+ left: (left margin)
+}</code></pre>
+<p>May also be a string containing space-separated, numeric margin values. The order of the
+sides associated with each value matches the way CSS processes margin values:</p>
+<p><div class="mdetail-params"><ul>
+<li>If there is only one value, it applies to all sides.</li>
+<li>If there are two values, the top and bottom borders are set to the first value and the
+right and left are set to the second.</li>
+<li>If there are three values, the top is set to the first value, the left and right are set
+to the second, and the bottom is set to the third.</li>
+<li>If there are four values, they apply to the top, right, bottom, and left, respectively.</li>
+</ul></div></p>
+<p>Defaults to:</p><pre><code>{top:0, right:0, bottom:0, left:0}</code></pre></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#margins" ext:member="#margins" 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.Panel-maskDisabled"></a><b><a href="source/Panel.html#cfg-Ext.Panel-maskDisabled">maskDisabled</a></b> : Boolean<div class="mdesc"><div class="short">true to mask the panel when it is disabled, false to not mask it (defaults
+to true). Either way, the panel will alwa...</div><div class="long"><code>true</code> to mask the panel when it is <a href="output/Ext.Panel.html#Ext.Panel-disabled" ext:member="disabled" ext:cls="Ext.Panel">disabled</a>, <code>false</code> to not mask it (defaults
+to <code>true</code>). Either way, the panel will always tell its contained elements to disable themselves
+when it is disabled, but masking the panel can provide an additional visual cue that the panel is
+disabled.</div></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
+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 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
+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
+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
+plugin, passing a reference to itself. Each plugin can then call methods or respond to events on the
+component as needed to provide its functionality.</div></div></td><td class="msource"><a href="output/Ext.Component.html#plugins" ext:member="#plugins" 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-ptype"></a><b><a href="source/Component.html#cfg-Ext.Component-ptype">ptype</a></b> : String<div class="mdesc"><div class="short">The registered ptype to create. This config option is not used when passing
+a config object into a constructor. This ...</div><div class="long">The registered <tt>ptype</tt> to create. This config option is not used when passing
+a config object into a constructor. This config option is used only when
+lazy instantiation is being used, and a Plugin is being
+specified not as a fully instantiated Component, but as a <i>Component config
+object</i>. The <tt>ptype</tt> will be looked up at render time up to determine what
+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 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>,
+ store: myStore,
+ colModel: myColModel,
+ tbar: [{
+ text: <em>'Save'</em>,
+ handler: saveChanges,
+ disabled: true,
+ ref: <em>'../saveButton'</em>
+ }],
+ listeners: {
+ afteredit: <b>function</b>() {
+<i>// The button reference is <b>in</b> the GridPanel</i>
+ myGrid.saveButton.enable();
+ }
+ }
+});</code></pre>
+<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
+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>
+<p>See <a href="output/Ext.layout.BorderLayout.html" ext:cls="Ext.layout.BorderLayout">Ext.layout.BorderLayout</a> also.</p></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#region" ext:member="#region" 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-renderTo"></a><b><a href="source/Component.html#cfg-Ext.Component-renderTo">renderTo</a></b> : Mixed<div class="mdesc"><div class="short">Specify the id of the element, a DOM element or an existing Element that this component
+will be rendered into.
+Notes ...</div><div class="long"><p>Specify the id of the element, a DOM element or an existing Element that this component
+will be rendered into.</p><div><ul>
+<li><b>Notes</b> : <ul>
+<div class="sub-desc">Do <u>not</u> use this option if the Component is to be a child item of
+a <a href="output/Ext.Container.html" ext:cls="Ext.Container">Container</a>. It is the responsibility of the
+<a href="output/Ext.Container.html" ext:cls="Ext.Container">Container</a>'s <a href="output/Ext.Container.html#Ext.Container-layout" ext:member="layout" ext:cls="Ext.Container">layout manager</a>
+to render and manage its child items.</div>
+<div class="sub-desc">When using this config, a call to render() is not required.</div>
+</ul></li>
+</ul></div>
+<p>See <tt><a href="output/Ext.Component.html#Ext.Component-render" ext:member="render" ext:cls="Ext.Component">render</a></tt> also.</p></div></div></td><td class="msource"><a href="output/Ext.Component.html#renderTo" ext:member="#renderTo" 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-requestMethod"></a><b><a href="source/TreePanel.html#cfg-Ext.tree.TreePanel-requestMethod">requestMethod</a></b> : String<div class="mdesc">The HTTP request method for loading data (defaults to the value of <a href="output/Ext.Ajax.html#Ext.Ajax-method" ext:member="method" ext:cls="Ext.Ajax">Ext.Ajax.method</a>).</div></td><td class="msource">TreePanel</td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Panel-resizeEvent"></a><b><a href="source/Panel.html#cfg-Ext.Panel-resizeEvent">resizeEvent</a></b> : String<div class="mdesc">The event to listen to for resizing in layouts. Defaults to <tt>'bodyresize'</tt>.</div></td><td class="msource"><a href="output/Ext.Panel.html#resizeEvent" ext:member="#resizeEvent" 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-root"></a><b><a href="source/TreePanel.html#cfg-Ext.tree.TreePanel-root">root</a></b> : Ext.tree.TreeNode<div class="mdesc">The root node for the tree.</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-rootVisible"></a><b><a href="source/TreePanel.html#cfg-Ext.tree.TreePanel-rootVisible">rootVisible</a></b> : Boolean<div class="mdesc"><tt>false</tt> to hide the root node (defaults to <tt>true</tt>)</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-selModel"></a><b><a href="source/TreePanel.html#cfg-Ext.tree.TreePanel-selModel">selModel</a></b> : Object<div class="mdesc">A tree selection model to use with this TreePanel (defaults to an <a href="output/Ext.tree.DefaultSelectionModel.html" ext:cls="Ext.tree.DefaultSelectionModel">Ext.tree.DefaultSelectionModel</a>)</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-shadow"></a><b><a href="source/Panel.html#cfg-Ext.Panel-shadow">shadow</a></b> : Boolean/String<div class="mdesc"><div class="short">true (or a valid Ext.Shadow Ext.Shadow.mode value) to display a shadow behind the
+panel, false to display no shadow (...</div><div class="long"><code>true</code> (or a valid Ext.Shadow <a href="output/Ext.Shadow.html#Ext.Shadow-mode" ext:member="mode" ext:cls="Ext.Shadow">Ext.Shadow.mode</a> value) to display a shadow behind the
+panel, <code>false</code> to display no shadow (defaults to <code><em>'sides'</em></code>). Note that this option
+only applies when <code><a href="output/Ext.Panel.html#Ext.Panel-floating" ext:member="floating" ext:cls="Ext.Panel">floating</a> = true</code>.</div></div></td><td class="msource"><a href="output/Ext.Panel.html#shadow" ext:member="#shadow" 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-shadowOffset"></a><b><a href="source/Panel.html#cfg-Ext.Panel-shadowOffset">shadowOffset</a></b> : Number<div class="mdesc"><div class="short">The number of pixels to offset the shadow if displayed (defaults to 4). Note that this
+option only applies when float...</div><div class="long">The number of pixels to offset the shadow if displayed (defaults to <code>4</code>). Note that this
+option only applies when <code><a href="output/Ext.Panel.html#Ext.Panel-floating" ext:member="floating" ext:cls="Ext.Panel">floating</a> = true</code>.</div></div></td><td class="msource"><a href="output/Ext.Panel.html#shadowOffset" ext:member="#shadowOffset" 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-shim"></a><b><a href="source/Panel.html#cfg-Ext.Panel-shim">shim</a></b> : Boolean<div class="mdesc"><div class="short">false to disable the iframe shim in browsers which need one (defaults to true).
+Note that this option only applies wh...</div><div class="long"><code>false</code> to disable the iframe shim in browsers which need one (defaults to <code>true</code>).
+Note that this option only applies when <code><a href="output/Ext.Panel.html#Ext.Panel-floating" ext:member="floating" ext:cls="Ext.Panel">floating</a> = true</code>.</div></div></td><td class="msource"><a href="output/Ext.Panel.html#shim" ext:member="#shim" 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-singleExpand"></a><b><a href="source/TreePanel.html#cfg-Ext.tree.TreePanel-singleExpand">singleExpand</a></b> : Boolean<div class="mdesc"><tt>true</tt> if only 1 node per branch may be expanded</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-stateEvents"></a><b><a href="source/Component.html#cfg-Ext.Component-stateEvents">stateEvents</a></b> : Array<div class="mdesc"><div class="short">An array of events that, when fired, should trigger this component to
+save its state (defaults to none). stateEvents ...</div><div class="long"><p>An array of events that, when fired, should trigger this component to
+save its state (defaults to none). <code>stateEvents</code> may be any type
+of event supported by this component, including browser or custom events
+(e.g., <tt>['click', 'customerchange']</tt>).</p>
+<p>See <code><a href="output/Ext.Component.html#Ext.Component-stateful" ext:member="stateful" ext:cls="Ext.Component">stateful</a></code> for an explanation of saving and
+restoring Component state.</p></div></div></td><td class="msource"><a href="output/Ext.Component.html#stateEvents" ext:member="#stateEvents" 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-stateId"></a><b><a href="source/Component.html#cfg-Ext.Component-stateId">stateId</a></b> : String<div class="mdesc"><div class="short">The unique id for this component to use for state management purposes
+(defaults to the component id if one was set, o...</div><div class="long">The unique id for this component to use for state management purposes
+(defaults to the component id if one was set, otherwise null if the
+component is using a generated id).
+<p>See <code><a href="output/Ext.Component.html#Ext.Component-stateful" ext:member="stateful" ext:cls="Ext.Component">stateful</a></code> for an explanation of saving and
+restoring Component state.</p></div></div></td><td class="msource"><a href="output/Ext.Component.html#stateId" ext:member="#stateId" 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-stateful"></a><b><a href="source/Component.html#cfg-Ext.Component-stateful">stateful</a></b> : Boolean<div class="mdesc"><div class="short">A flag which causes the Component to attempt to restore the state of
+internal properties from a saved state on startu...</div><div class="long"><p>A flag which causes the Component to attempt to restore the state of
+internal properties from a saved state on startup. The component must have
+either a <code><a href="output/Ext.Component.html#Ext.Component-stateId" ext:member="stateId" ext:cls="Ext.Component">stateId</a></code> or <code><a href="output/Ext.Component.html#Ext.Component-id" ext:member="id" ext:cls="Ext.Component">id</a></code> assigned
+for state to be managed. Auto-generated ids are not guaranteed to be stable
+across page loads and cannot be relied upon to save and restore the same
+state for a component.<p>
+<p>For state saving to work, the state manager's provider must have been
+set to an implementation of <a href="output/Ext.state.Provider.html" ext:cls="Ext.state.Provider">Ext.state.Provider</a> which overrides the
+<a href="output/Ext.state.Provider.html#Ext.state.Provider-set" ext:member="set" ext:cls="Ext.state.Provider">set</a> and <a href="output/Ext.state.Provider.html#Ext.state.Provider-get" ext:member="get" ext:cls="Ext.state.Provider">get</a>
+methods to save and recall name/value pairs. A built-in implementation,
+<a href="output/Ext.state.CookieProvider.html" ext:cls="Ext.state.CookieProvider">Ext.state.CookieProvider</a> is available.</p>
+<p>To set the state provider for the current page:</p>
+<pre><code>Ext.state.Manager.setProvider(<b>new</b> Ext.state.CookieProvider({
+ expires: <b>new</b> Date(<b>new</b> Date().getTime()+(1000*60*60*24*7)), <i>//7 days from now</i>
+}));</code></pre>
+<p>A stateful Component attempts to save state when one of the events
+listed in the <code><a href="output/Ext.Component.html#Ext.Component-stateEvents" ext:member="stateEvents" ext:cls="Ext.Component">stateEvents</a></code> configuration fires.</p>
+<p>To save state, a stateful Component first serializes its state by
+calling <b><code>getState</code></b>. By default, this function does
+nothing. The developer must provide an implementation which returns an
+object hash which represents the Component's restorable state.</p>
+<p>The value yielded by getState is passed to <a href="output/Ext.state.Manager.html#Ext.state.Manager-set" ext:member="set" ext:cls="Ext.state.Manager">Ext.state.Manager.set</a>
+which uses the configured <a href="output/Ext.state.Provider.html" ext:cls="Ext.state.Provider">Ext.state.Provider</a> to save the object
+keyed by the Component's <code><a href="output/stateId.html" ext:cls="stateId">stateId</a></code>, or, if that is not
+specified, its <code><a href="output/Ext.Component.html#Ext.Component-id" ext:member="id" ext:cls="Ext.Component">id</a></code>.</p>
+<p>During construction, a stateful Component attempts to <i>restore</i>
+its state by calling <a href="output/Ext.state.Manager.html#Ext.state.Manager-get" ext:member="get" ext:cls="Ext.state.Manager">Ext.state.Manager.get</a> passing the
+<code><a href="output/Ext.Component.html#Ext.Component-stateId" ext:member="stateId" ext:cls="Ext.Component">stateId</a></code>, or, if that is not specified, the
+<code><a href="output/Ext.Component.html#Ext.Component-id" ext:member="id" ext:cls="Ext.Component">id</a></code>.</p>
+<p>The resulting object is passed to <b><code>applyState</code></b>.
+The default implementation of <code>applyState</code> simply copies
+properties into the object, but a developer may override this to support
+more behaviour.</p>
+<p>You can perform extra processing on state save and restore by attaching
+handlers to the <a href="output/Ext.Component.html#Ext.Component-beforestaterestore" ext:member="beforestaterestore" ext:cls="Ext.Component">beforestaterestore</a>, <a href="output/Ext.Component.html#Ext.Component-staterestore" ext:member="staterestore" ext:cls="Ext.Component">staterestore</a>,
+<a href="output/Ext.Component.html#Ext.Component-beforestatesave" ext:member="beforestatesave" ext:cls="Ext.Component">beforestatesave</a> and <a href="output/Ext.Component.html#Ext.Component-statesave" ext:member="statesave" ext:cls="Ext.Component">statesave</a> events.</p></div></div></td><td class="msource"><a href="output/Ext.Component.html#stateful" ext:member="#stateful" 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-style"></a><b><a href="source/Component.html#cfg-Ext.Component-style">style</a></b> : String<div class="mdesc"><div class="short">A custom style specification to be applied to this component's Element. Should be a valid argument to
+Ext.Element.ap...</div><div class="long">A custom style specification to be applied to this component's Element. Should be a valid argument to
+<a href="output/Ext.Element.html#Ext.Element-applyStyles" ext:member="applyStyles" ext:cls="Ext.Element">Ext.Element.applyStyles</a>.
+<pre><code><b>new</b> Ext.Panel({
+ title: <em>'Some Title'</em>,
+ renderTo: Ext.getBody(),
+ width: 400, height: 300,
+ layout: <em>'form'</em>,
+ items: [{
+ xtype: <em>'textarea'</em>,
+ style: {
+ width: <em>'95%'</em>,
+ marginBottom: <em>'10px'</em>
+ }
+ },
+ <b>new</b> Ext.Button({
+ text: <em>'Send'</em>,
+ minWidth: <em>'100'</em>,
+ style: {
+ marginBottom: <em>'10px'</em>
+ }
+ })
+ ]
+});</code></pre></div></div></td><td class="msource"><a href="output/Ext.Component.html#style" ext:member="#style" 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-tabTip"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-tabTip">tabTip</a></b> : String<div class="mdesc"><div class="short">Note: this config is only used when this BoxComponent is a child item of a TabPanel.
+A string to be used as innerHTML...</div><div class="long"><p><b>Note</b>: this config is only used when this BoxComponent is a child item of a TabPanel.</p>
+A string to be used as innerHTML (html tags are accepted) to show in a tooltip when mousing over
+the associated tab selector element. <a href="output/Ext.QuickTips.html" ext:cls="Ext.QuickTips">Ext.QuickTips</a>.init()
+must be called in order for the tips to render.</div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#tabTip" ext:member="#tabTip" 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.Panel-tbar"></a><b><a href="source/Panel.html#cfg-Ext.Panel-tbar">tbar</a></b> : Object/Array<div class="mdesc"><div class="short">The top toolbar of the panel. This can be a Ext.Toolbar object, a toolbar config, or an array of
+buttons/button confi...</div><div class="long"><p>The top toolbar of the panel. This can be a <a href="output/Ext.Toolbar.html" ext:cls="Ext.Toolbar">Ext.Toolbar</a> object, a toolbar config, or an array of
+buttons/button configs to be added to the toolbar. Note that this is not available as a property after render.
+To access the top toolbar after render, use <a href="output/Ext.Panel.html#Ext.Panel-getTopToolbar" ext:member="getTopToolbar" ext:cls="Ext.Panel">getTopToolbar</a>.</p>
+<p><b>Note:</b> Although a Toolbar may contain Field components, these will <b>not</b> be updated by a load
+of an ancestor FormPanel. A Panel's toolbars are not part of the standard Container->Component hierarchy, and
+so are not scanned to collect form items. However, the values <b>will</b> be submitted because form
+submission parameters are collected from the DOM tree.</p></div></div></td><td class="msource"><a href="output/Ext.Panel.html#tbar" ext:member="#tbar" 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-tbarCfg"></a><b><a href="source/Panel.html#cfg-Ext.Panel-tbarCfg">tbarCfg</a></b> : Object<div class="mdesc"><div class="short">A DomHelper element specification object specifying the element structure
+of this Panel's tbar Element. See bodyCfg ...</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-tbar" ext:member="tbar" ext:cls="Ext.Panel">tbar</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#tbarCfg" ext:member="#tbarCfg" 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-title"></a><b><a href="source/Panel.html#cfg-Ext.Panel-title">title</a></b> : String<div class="mdesc"><div class="short">The title text to be used as innerHTML (html tags are accepted) to display in the panel
+header (defaults to ''). When...</div><div class="long">The title text to be used as innerHTML (html tags are accepted) to display in the panel
+<code><a href="output/Ext.Panel.html#Ext.Panel-header" ext:member="header" ext:cls="Ext.Panel">header</a></code> (defaults to ''). When a <code>title</code> is specified the
+<code><a href="output/Ext.Panel.html#Ext.Panel-header" ext:member="header" ext:cls="Ext.Panel">header</a></code> element will automatically be created and displayed unless
+<a href="output/Ext.Panel.html#Ext.Panel-header" ext:member="header" ext:cls="Ext.Panel">header</a> is explicitly set to <code>false</code>. If you do not want to specify a
+<code>title</code> at config time, but you may want one later, you must either specify a non-empty
+<code>title</code> (a blank space ' ' will do) or <code>header:true</code> so that the container
+element will get created.</div></div></td><td class="msource"><a href="output/Ext.Panel.html#title" ext:member="#title" 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-titleCollapse"></a><b><a href="source/Panel.html#cfg-Ext.Panel-titleCollapse">titleCollapse</a></b> : Boolean<div class="mdesc"><div class="short">true to allow expanding and collapsing the panel (when collapsible = true)
+by clicking anywhere in the header bar, fa...</div><div class="long"><code>true</code> to allow expanding and collapsing the panel (when <code><a href="output/Ext.Panel.html#Ext.Panel-collapsible" ext:member="collapsible" ext:cls="Ext.Panel">collapsible</a> = true</code>)
+by clicking anywhere in the header bar, <code>false</code>) to allow it only by clicking to tool button
+(defaults to <code>false</code>)). If this panel is a child item of a border layout also see the
+<a href="output/Ext.layout.BorderLayout.Region.html" ext:cls="Ext.layout.BorderLayout.Region">BorderLayout.Region</a>
+<code><a href="output/Ext.layout.BorderLayout.Region.html#Ext.layout.BorderLayout.Region-floatable" ext:member="floatable" ext:cls="Ext.layout.BorderLayout.Region">floatable</a></code> config option.</div></div></td><td class="msource"><a href="output/Ext.Panel.html#titleCollapse" ext:member="#titleCollapse" 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-toolTemplate"></a><b><a href="source/Panel.html#cfg-Ext.Panel-toolTemplate">toolTemplate</a></b> : Ext.Template/Ext.XTemplate<div class="mdesc"><div class="short">A Template used to create tools in the header Element. Defaults to:new Ext.Template('&lt;div class="x-tool x-tool-{id...</div><div class="long"><p>A Template used to create <a href="output/Ext.Panel.html#Ext.Panel-tools" ext:member="tools" ext:cls="Ext.Panel">tools</a> in the <a href="output/Ext.Panel.html#Ext.Panel-header" ext:member="header" ext:cls="Ext.Panel">header</a> Element. Defaults to:</p><pre><code><b>new</b> Ext.Template(<em>'<div class=<em>"x-tool x-tool-{id}"</em>>&#160;</div>'</em>)</code></pre>
+<p>This may may be overridden to provide a custom DOM structure for tools based upon a more
+complex XTemplate. The template's data is a single tool configuration object (Not the entire Array)
+as specified in <a href="output/Ext.Panel.html#Ext.Panel-tools" ext:member="tools" ext:cls="Ext.Panel">tools</a>. In the following example an <a> tag is used to provide a
+visual indication when hovering over the tool:</p><pre><code><b>var</b> win = <b>new</b> Ext.Window({
+ tools: [{
+ id: <em>'download'</em>,
+ href: <em>'/MyPdfDoc.pdf'</em>
+ }],
+ toolTemplate: <b>new</b> Ext.XTemplate(
+ <em>'<tpl <b>if</b>=<em>"id==\'</em>download\<em>'"</em>>'</em>,
+ <em>'<a class=<em>"x-tool x-tool-pdf"</em> href=<em>"{href}"</em>></a>'</em>,
+ <em>'</tpl>'</em>,
+ <em>'<tpl <b>if</b>=<em>"id!=\'</em>download\<em>'"</em>>'</em>,
+ <em>'<div class=<em>"x-tool x-tool-{id}"</em>>&#160;</div>'</em>,
+ <em>'</tpl>'</em>
+ ),
+ width:500,
+ height:300,
+ closeAction:<em>'hide'</em>
+});</code></pre>
+<p>Note that the CSS class 'x-tool-pdf' should have an associated style rule which provides an
+appropriate background image, something like:</p>
+ <pre><code>a.x-tool-pdf {background-image: url(../shared/extjs/images/pdf.gif)!important;}</code></pre></div></div></td><td class="msource"><a href="output/Ext.Panel.html#toolTemplate" ext:member="#toolTemplate" 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-tools"></a><b><a href="source/Panel.html#cfg-Ext.Panel-tools">tools</a></b> : Array<div class="mdesc"><div class="short">An array of tool button configs to be added to the header tool area. When rendered, each tool is
+stored as an Element...</div><div class="long">An array of tool button configs to be added to the header tool area. When rendered, each tool is
+stored as an <a href="output/Ext.Element.html" ext:cls="Ext.Element">Element</a> referenced by a public property called <code><b></b>tools.<i><tool-type></i></code>
+<p>Each tool config may contain the following properties:
+<div class="mdetail-params"><ul>
+<li><b>id</b> : String<div class="sub-desc"><b>Required.</b> The type
+of tool to create. By default, this assigns a CSS class of the form <code>x-tool-<i><tool-type></i></code> to the
+resulting tool Element. Ext provides CSS rules, and an icon sprite containing images for the tool types listed below.
+The developer may implement custom tools by supplying alternate CSS rules and background images:
+<ul>
+<div class="x-tool x-tool-toggle" style="float:left; margin-right:5;"> </div><div><code>toggle</code> (Created by default when <a href="output/Ext.Panel.html#Ext.Panel-collapsible" ext:member="collapsible" ext:cls="Ext.Panel">collapsible</a> is <code>true</code>)</div>
+<div class="x-tool x-tool-close" style="float:left; margin-right:5;"> </div><div><code>close</code></div>
+<div class="x-tool x-tool-minimize" style="float:left; margin-right:5;"> </div><div><code>minimize</code></div>
+<div class="x-tool x-tool-maximize" style="float:left; margin-right:5;"> </div><div><code>maximize</code></div>
+<div class="x-tool x-tool-restore" style="float:left; margin-right:5;"> </div><div><code>restore</code></div>
+<div class="x-tool x-tool-gear" style="float:left; margin-right:5;"> </div><div><code>gear</code></div>
+<div class="x-tool x-tool-pin" style="float:left; margin-right:5;"> </div><div><code>pin</code></div>
+<div class="x-tool x-tool-unpin" style="float:left; margin-right:5;"> </div><div><code>unpin</code></div>
+<div class="x-tool x-tool-right" style="float:left; margin-right:5;"> </div><div><code>right</code></div>
+<div class="x-tool x-tool-left" style="float:left; margin-right:5;"> </div><div><code>left</code></div>
+<div class="x-tool x-tool-up" style="float:left; margin-right:5;"> </div><div><code>up</code></div>
+<div class="x-tool x-tool-down" style="float:left; margin-right:5;"> </div><div><code>down</code></div>
+<div class="x-tool x-tool-refresh" style="float:left; margin-right:5;"> </div><div><code>refresh</code></div>
+<div class="x-tool x-tool-minus" style="float:left; margin-right:5;"> </div><div><code>minus</code></div>
+<div class="x-tool x-tool-plus" style="float:left; margin-right:5;"> </div><div><code>plus</code></div>
+<div class="x-tool x-tool-help" style="float:left; margin-right:5;"> </div><div><code>help</code></div>
+<div class="x-tool x-tool-search" style="float:left; margin-right:5;"> </div><div><code>search</code></div>
+<div class="x-tool x-tool-save" style="float:left; margin-right:5;"> </div><div><code>save</code></div>
+<div class="x-tool x-tool-print" style="float:left; margin-right:5;"> </div><div><code>print</code></div>
+</ul></div></li>
+<li><b>handler</b> : Function<div class="sub-desc"><b>Required.</b> The function to
+call when clicked. Arguments passed are:<ul>
+<li><b>event</b> : Ext.EventObject<div class="sub-desc">The click event.</div></li>
+<li><b>toolEl</b> : Ext.Element<div class="sub-desc">The tool Element.</div></li>
+<li><b>panel</b> : Ext.Panel<div class="sub-desc">The host Panel</div></li>
+<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>
+<li><b>qtip</b> : String/Object<div class="sub-desc">A tip string, or
+a config argument to <a href="output/Ext.QuickTip.html#Ext.QuickTip-register" ext:member="register" ext:cls="Ext.QuickTip">Ext.QuickTip.register</a></div></li>
+<li><b>hidden</b> : Boolean<div class="sub-desc">True to initially render hidden.</div></li>
+<li><b>on</b> : Object<div class="sub-desc">A listener config object specifiying
+event listeners in the format of an argument to <a href="output/Ext.Panel.html#Ext.Panel-addListener" ext:member="addListener" ext:cls="Ext.Panel">addListener</a></div></li>
+</ul></div>
+<p>Note that, apart from the toggle tool which is provided when a panel is collapsible, these
+tools only provide the visual button. Any required functionality must be provided by adding
+handlers that implement the necessary behavior.</p>
+<p>Example usage:</p>
+<pre><code>tools:[{
id:<em>'refresh'</em>,
qtip: <em>'Refresh form Data'</em>,
<i>// hidden:true,</i>
handler: <b>function</b>(event, toolEl, panel){
<i>// refresh logic</i>
}
-}]</code></pre> Note that apart from the toggle tool which is provided when a panel is collapsible, these tools only provide the visual button. Any required functionality must be provided by adding handlers that implement the necessary behavior. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#tools" href="output/Ext.Panel.html#tools">Panel</a></td>\r
- </tr>\r
- <tr class="config-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-trackMouseOver"></a>\r
- <b>trackMouseOver</b> : Boolean <div class="mdesc">\r
- False to disable mouse over highlighting </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="config-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-useArrows"></a>\r
- <b>useArrows</b> : Boolean <div class="mdesc">\r
- True to use Vista-style arrows in the tree (defaults to false) </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="config-row inherited">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-width"></a>\r
- <b>width</b> : Number <div class="mdesc">\r
- The width of this component in pixels (defaults to auto). </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#width" href="output/Ext.BoxComponent.html#width">BoxComponent</a></td>\r
- </tr>\r
- <tr class="config-row inherited alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-x"></a>\r
- <b>x</b> : Number <div class="mdesc">\r
- The local x (left) coordinate for this component if contained within a positioning container. </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#x" href="output/Ext.BoxComponent.html#x">BoxComponent</a></td>\r
- </tr>\r
- <tr class="config-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-xtype"></a>\r
- <b>xtype</b> : String <div class="mdesc">\r
- <div class="short">The registered xtype to create. This config option is not used when passing a config object into a constructor. This ...</div>\r
- <div class="long">\r
- The registered xtype to create. This config option is not used when passing a config object into a constructor. This config option is used only when lazy instantiation is being used, and a child item of a Container is being specified not as a fully instantiated Component, but as a <i>Component config object</i>. The xtype will be looked up at render time up to determine what type of child Component to create.<br><br> The predefined xtypes are listed <a ext:cls="Ext.Component" href="output/Ext.Component.html">here</a>. <br><br> If you subclass Components to create your own Components, you may register them using <a ext:cls="Ext.ComponentMgr" ext:member="registerType" href="output/Ext.ComponentMgr.html#registerType">Ext.ComponentMgr.registerType</a> in order to be able to take advantage of lazy instantiation and rendering. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#xtype" href="output/Ext.Component.html#xtype">Component</a></td>\r
- </tr>\r
- <tr class="config-row inherited alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-y"></a>\r
- <b>y</b> : Number <div class="mdesc">\r
- The local y (top) coordinate for this component if contained within a positioning container. </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#y" href="output/Ext.BoxComponent.html#y">BoxComponent</a></td>\r
- </tr>\r
- </table>
- <a id="Ext.tree.TreePanel-props"></a>
- <h2>Public Properties</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Property</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="property-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-body"></a>\r
- <b>body</b> : Ext.Element <div class="mdesc">\r
- <div class="short">
-The Panel's body Element which may be used to contain HTML content.
-The content may be specified in the html config,...</div>\r
- <div class="long">\r
-
-The Panel's body <a ext:cls="Ext.Element" href="output/Ext.Element.html">Element</a> which may be used to contain HTML content.
-The content may be specified in the <a ext:cls="Ext.Panel" ext:member="html" href="output/Ext.Panel.html#html">html</a> config, or it may be loaded using the
-<a ext:cls="autoLoad" href="output/autoLoad.html">autoLoad</a> config, or through the Panel's <a ext:cls="Ext.Panel" ext:member="getUpdater" href="output/Ext.Panel.html#getUpdater">Updater</a>. Read-only.
+},
+{
+ id:<em>'help'</em>,
+ qtip: <em>'Get Help'</em>,
+ handler: <b>function</b>(event, toolEl, panel){
+ <i>// whatever</i>
+ }
+}]</code></pre>
+<p>For the custom id of <code><em>'help'</em></code> define two relevant css classes with a link to
+a 15x15 image:</p>
+<pre><code>.x-tool-help {background-image: url(images/help.png);}
+.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
+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).
+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).
+<b>Note</b> to express this dimension as a percentage or offset see <a href="output/Ext.Component.html#Ext.Component-anchor" ext:member="anchor" ext:cls="Ext.Component">Ext.Component.anchor</a>.</div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#width" ext:member="#width" 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-x"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-x">x</a></b> : Number<div class="mdesc">The local x (left) coordinate for this component if contained within a positioning container.</div></td><td class="msource"><a href="output/Ext.BoxComponent.html#x" ext:member="#x" 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-xtype"></a><b><a href="source/Component.html#cfg-Ext.Component-xtype">xtype</a></b> : String<div class="mdesc"><div class="short">The registered xtype to create. This config option is not used when passing
+a config object into a constructor. This ...</div><div class="long">The registered <tt>xtype</tt> to create. This config option is not used when passing
+a config object into a constructor. This config option is used only when
+lazy instantiation is being used, and a child item of a Container is being
+specified not as a fully instantiated Component, but as a <i>Component config
+object</i>. The <tt>xtype</tt> will be looked up at render time up to determine what
+type of child Component to create.<br><br>
+The predefined xtypes are listed <a href="output/Ext.Component.html" ext:cls="Ext.Component">here</a>.
+<br><br>
+If you subclass Components to create your own Components, you may register
+them using <a href="output/Ext.ComponentMgr.html#Ext.ComponentMgr-registerType" ext:member="registerType" ext:cls="Ext.ComponentMgr">Ext.ComponentMgr.registerType</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#xtype" ext:member="#xtype" 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-y"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-y">y</a></b> : Number<div class="mdesc">The local y (top) coordinate for this component if contained within a positioning container.</div></td><td class="msource"><a href="output/Ext.BoxComponent.html#y" ext:member="#y" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr></tbody></table><a id="Ext.tree.TreePanel-props"></a><h2>Public Properties</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Property</th><th class="msource-header">Defined By</th></tr><tr class="property-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Panel-body"></a><b><a href="source/Panel.html#prop-Ext.Panel-body">body</a></b> : Ext.Element<div class="mdesc"><div class="short">The Panel's body Element which may be used to contain HTML content.
+The content may be specified in the html config, ...</div><div class="long">The Panel's body <a href="output/Ext.Element.html" ext:cls="Ext.Element">Element</a> which may be used to contain HTML content.
+The content may be specified in the <a href="output/Ext.Panel.html#Ext.Panel-html" ext:member="html" ext:cls="Ext.Panel">html</a> config, or it may be loaded using the
+<a href="output/autoLoad.html" ext:cls="autoLoad">autoLoad</a> config, or through the Panel's <a href="output/Ext.Panel.html#Ext.Panel-getUpdater" ext:member="getUpdater" ext:cls="Ext.Panel">Updater</a>. Read-only.
<p>If this is used to load visible HTML elements in either way, then
the Panel may not be used as a Layout for hosting nested Panels.</p>
-<p>If this Panel is intended to be used as the host of a Layout (See <a ext:cls="Ext.Panel" ext:member="layout" href="output/Ext.Panel.html#layout">layout</a>
+<p>If this Panel is intended to be used as the host of a Layout (See <a href="output/Ext.Panel.html#Ext.Panel-layout" ext:member="layout" ext:cls="Ext.Panel">layout</a>
then the body Element must not be loaded or changed - it is under the control
-of the Panel's Layout. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#body" href="output/Ext.Panel.html#body">Panel</a></td>\r
- </tr>\r
- <tr class="property-row inherited alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-buttons"></a>\r
- <b>buttons</b> : Array <div class="mdesc">\r
- This Panel's Array of buttons as created from the <tt>buttons</tt>
-config property. Read only. </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#buttons" href="output/Ext.Panel.html#buttons">Panel</a></td>\r
- </tr>\r
- <tr class="property-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-dd"></a>\r
- <b>dd</b> : Ext.dd.DragSource. <div class="mdesc">\r
- <div class="short">If this Panel is configured draggable, this property will contain
-an instance of Ext.dd.DragSource which handles drag...</div>\r
- <div class="long">\r
- <p>If this Panel is configured <a ext:cls="Ext.Panel" ext:member="draggable" href="output/Ext.Panel.html#draggable">draggable</a>, this property will contain
-an instance of <a ext:cls="Ext.dd.DragSource" href="output/Ext.dd.DragSource.html">Ext.dd.DragSource</a> which handles dragging the Panel.</p>
-The developer must provide implementations of the abstract methods of <a ext:cls="Ext.dd.DragSource" href="output/Ext.dd.DragSource.html">Ext.dd.DragSource</a>
-in order to supply behaviour for each stage of the drag/drop process. See <a ext:cls="Ext.Panel" ext:member="draggable" href="output/Ext.Panel.html#draggable">draggable</a>. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#dd" href="output/Ext.Panel.html#dd">Panel</a></td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-dragZone"></a>\r
- <b>dragZone</b> : Ext.tree.TreeDragZone <div class="mdesc">\r
- The dragZone used by this tree if drag is enabled </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-dropZone"></a>\r
- <b>dropZone</b> : Ext.tree.TreeDropZone <div class="mdesc">\r
- The dropZone used by this tree if drop is enabled </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="property-row inherited alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-footer"></a>\r
- <b>footer</b> : Ext.Element <div class="mdesc">\r
-
-The Panel's footer <a ext:cls="Ext.Element" href="output/Ext.Element.html">Element</a>. Read-only.
-<p>This Element is used to house the Panel's <a ext:cls="Ext.Panel" ext:member="buttons" href="output/Ext.Panel.html#buttons">buttons</a>.</p> </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#footer" href="output/Ext.Panel.html#footer">Panel</a></td>\r
- </tr>\r
- <tr class="property-row inherited">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-header"></a>\r
- <b>header</b> : Ext.Element <div class="mdesc">\r
- The Panel's header <a ext:cls="Ext.Element" href="output/Ext.Element.html">Element</a>. Read-only.
-<p>This Element is used to house the <a ext:cls="Ext.Panel" ext:member="title" href="output/Ext.Panel.html#title">title</a> and <a ext:cls="Ext.Panel" ext:member="tools" href="output/Ext.Panel.html#tools">tools</a></p> </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#header" href="output/Ext.Panel.html#header">Panel</a></td>\r
- </tr>\r
- <tr class="property-row inherited alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-hidden"></a>\r
- <b>hidden</b> : Boolean <div class="mdesc">\r
-
-True if this component is hidden. Read-only. </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#hidden" href="output/Ext.Component.html#hidden">Component</a></td>\r
- </tr>\r
- <tr class="property-row inherited">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-initialConfig"></a>\r
- <b>initialConfig</b> : Object <div class="mdesc">\r
- This Component's initial configuration specification. Read-only. </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#initialConfig" href="output/Ext.Component.html#initialConfig">Component</a></td>\r
- </tr>\r
- <tr class="property-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-ownerCt"></a>\r
- <b>ownerCt</b> : Ext.Container <div class="mdesc">\r
- <div class="short">The component's owner Ext.Container (defaults to undefined, and is set automatically when
-the component is added to a...</div>\r
- <div class="long">\r
- The component's owner <a ext:cls="Ext.Container" href="output/Ext.Container.html">Ext.Container</a> (defaults to undefined, and is set automatically when
-the component is added to a container). Read-only. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#ownerCt" href="output/Ext.Component.html#ownerCt">Component</a></td>\r
- </tr>\r
- <tr class="property-row inherited">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-rendered"></a>\r
- <b>rendered</b> : Boolean <div class="mdesc">\r
- True if this component has been rendered. Read-only. </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#rendered" href="output/Ext.Component.html#rendered">Component</a></td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-root"></a>\r
- <b>root</b> : Ext.tree.TreeNode <div class="mdesc">\r
- The root node of this tree. </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- </table>
- <a id="Ext.tree.TreePanel-methods"></a>
- <h2>Public Methods</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Method</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-TreePanel"></a>\r
- <b>TreePanel</b>( <code>Object config</code> ) <div class="mdesc">\r
- <div class="short"></div>\r
- <div class="long">\r
- <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>config</code> : Object<div class="sub-desc"></div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code></code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-addButton"></a>\r
- <b>addButton</b>( <code>String/Object config</code>, <code>Function handler</code>, <code>Object scope</code> ) : Ext.Button <div class="mdesc">\r
- <div class="short">Adds a button to this panel. Note that this method must be called prior to rendering. The preferred
-approach is to ...</div>\r
- <div class="long">\r
- 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 ext:cls="Ext.Panel" ext:member="buttons" href="output/Ext.Panel.html#buttons">buttons</a> config. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>config</code> : String/Object<div class="sub-desc">A valid <a ext:cls="Ext.Button" href="output/Ext.Button.html">Ext.Button</a> config. A string will become the text for a default
-button config, an object will be treated as a button config object.</div></li><li><code>handler</code> : Function<div class="sub-desc">The function to be called on button <a ext:cls="Ext.Button" ext:member="click" href="output/Ext.Button.html#click">Ext.Button.click</a></div></li><li><code>scope</code> : Object<div class="sub-desc">The scope to use for the button handler function</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Button</code><div class="sub-desc">The button that was added</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#addButton" href="output/Ext.Panel.html#addButton">Panel</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-addClass"></a>\r
- <b>addClass</b>( <code>string cls</code> ) : void <div class="mdesc">\r
- <div class="short">Adds a CSS class to the component's underlying element.</div>\r
- <div class="long">\r
- Adds a CSS class to the component's underlying element. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>cls</code> : string<div class="sub-desc">The CSS class name to add</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#addClass" href="output/Ext.Component.html#addClass">Component</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-addEvents"></a>\r
- <b>addEvents</b>( <code>Object object</code> ) : void <div class="mdesc">\r
- <div class="short">Used to define events on this Observable</div>\r
- <div class="long">\r
- Used to define events on this Observable <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-addListener"></a>\r
- <b>addListener</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Appends an event handler to this component</div>\r
- <div class="long">\r
- Appends an event handler to this component <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler
-function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration
+of the Panel's Layout.
+<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#body" ext:member="#body" 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.Panel-buttons"></a><b><a href="source/Panel.html#prop-Ext.Panel-buttons">buttons</a></b> : Array<div class="mdesc">This Panel's Array of buttons as created from the <code><a href="output/Ext.Panel.html#Ext.Panel-buttons" ext:member="buttons" ext:cls="Ext.Panel">buttons</a></code>
+config property. Read only.</div></td><td class="msource"><a href="output/Ext.Panel.html#buttons" ext:member="#buttons" 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.Panel-bwrap"></a><b><a href="source/Panel.html#prop-Ext.Panel-bwrap">bwrap</a></b> : Ext.Element<div class="mdesc">The Panel's bwrap <a href="output/Ext.Element.html" ext:cls="Ext.Element">Element</a> used to contain other Panel elements
+(tbar, body, bbar, footer). See <a href="output/Ext.Panel.html#Ext.Panel-bodyCfg" ext:member="bodyCfg" ext:cls="Ext.Panel">bodyCfg</a>. Read-only.</div></td><td class="msource"><a href="output/Ext.Panel.html#bwrap" ext:member="#bwrap" 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.Panel-collapsed"></a><b><a href="source/Panel.html#prop-Ext.Panel-collapsed">collapsed</a></b> : Boolean<div class="mdesc">True if this panel is collapsed. Read-only.</div></td><td class="msource"><a href="output/Ext.Panel.html#collapsed" ext:member="#collapsed" ext:cls="Ext.Panel">Panel</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.Panel-dd"></a><b><a href="source/Panel.html#prop-Ext.Panel-dd">dd</a></b> : Ext.dd.DragSource.<div class="mdesc"><div class="short">If this Panel is configured draggable, this property will contain
+an instance of Ext.dd.DragSource which handles drag...</div><div class="long"><p>If this Panel is configured <a href="output/Ext.Panel.html#Ext.Panel-draggable" ext:member="draggable" ext:cls="Ext.Panel">draggable</a>, this property will contain
+an instance of <a href="output/Ext.dd.DragSource.html" ext:cls="Ext.dd.DragSource">Ext.dd.DragSource</a> which handles dragging the Panel.</p>
+The developer must provide implementations of the abstract methods of <a href="output/Ext.dd.DragSource.html" ext:cls="Ext.dd.DragSource">Ext.dd.DragSource</a>
+in order to supply behaviour for each stage of the drag/drop process. See <a href="output/Ext.Panel.html#Ext.Panel-draggable" ext:member="draggable" ext:cls="Ext.Panel">draggable</a>.</div></div></td><td class="msource"><a href="output/Ext.Panel.html#dd" ext:member="#dd" ext:cls="Ext.Panel">Panel</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-dragZone"></a><b><a href="source/TreePanel.html#prop-Ext.tree.TreePanel-dragZone">dragZone</a></b> : Ext.tree.TreeDragZone<div class="mdesc">The dragZone used by this tree if drag is enabled (see <a href="output/Ext.tree.TreePanel.html#Ext.tree.TreePanel-enableDD" ext:member="enableDD" ext:cls="Ext.tree.TreePanel">enableDD</a> or <a href="output/Ext.tree.TreePanel.html#Ext.tree.TreePanel-enableDrag" ext:member="enableDrag" ext:cls="Ext.tree.TreePanel">enableDrag</a>)</div></td><td class="msource">TreePanel</td></tr><tr class="property-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.tree.TreePanel-dropZone"></a><b><a href="source/TreePanel.html#prop-Ext.tree.TreePanel-dropZone">dropZone</a></b> : Ext.tree.TreeDropZone<div class="mdesc">The dropZone used by this tree if drop is enabled (see <a href="output/Ext.tree.TreePanel.html#Ext.tree.TreePanel-enableDD" ext:member="enableDD" ext:cls="Ext.tree.TreePanel">enableDD</a> or <a href="output/Ext.tree.TreePanel.html#Ext.tree.TreePanel-enableDrop" ext:member="enableDrop" ext:cls="Ext.tree.TreePanel">enableDrop</a>)</div></td><td class="msource">TreePanel</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-el"></a><b><a href="source/Component.html#prop-Ext.Component-el">el</a></b> : Ext.Element<div class="mdesc"><div class="short">The Ext.Element which encapsulates this Component. Read-only.
+This will usually be a &lt;DIV> element created by the ...</div><div class="long"><p>The <a href="output/Ext.Element.html" ext:cls="Ext.Element">Ext.Element</a> which encapsulates this Component. Read-only.</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 <code><a href="output/Ext.Component.html#Ext.Component-autoEl" ext:member="autoEl" ext:cls="Ext.Component">autoEl</a></code> 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.util.Observable.html#Ext.util.Observable-listeners" ext:member="listeners" ext:cls="Ext.util.Observable">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>
+<p>See also <tt><a href="output/Ext.Component.html#Ext.Component-getEl" ext:member="getEl" ext:cls="Ext.Component">getEl</a></p></div></div></td><td class="msource"><a href="output/Ext.Component.html#el" ext:member="#el" 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.Panel-footer"></a><b><a href="source/Panel.html#prop-Ext.Panel-footer">footer</a></b> : Ext.Element<div class="mdesc"><div class="short">The Panel's footer Element. Read-only.
+This Element is used to house the Panel's buttons or fbar.
+Note: see the Note ...</div><div class="long">The Panel's footer <a href="output/Ext.Element.html" ext:cls="Ext.Element">Element</a>. Read-only.
+<p>This Element is used to house the Panel's <code><a href="output/Ext.Panel.html#Ext.Panel-buttons" ext:member="buttons" ext:cls="Ext.Panel">buttons</a></code> or <code><a href="output/Ext.Panel.html#Ext.Panel-fbar" ext:member="fbar" ext:cls="Ext.Panel">fbar</a></code>.</p>
+<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#footer" ext:member="#footer" ext:cls="Ext.Panel">Panel</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.Panel-header"></a><b><a href="source/Panel.html#prop-Ext.Panel-header">header</a></b> : Ext.Element<div class="mdesc"><div class="short">The Panel's header Element. Read-only.
+This Element is used to house the title and tools
+Note: see the Note for el al...</div><div class="long">The Panel's header <a href="output/Ext.Element.html" ext:cls="Ext.Element">Element</a>. Read-only.
+<p>This Element is used to house the <a href="output/Ext.Panel.html#Ext.Panel-title" ext:member="title" ext:cls="Ext.Panel">title</a> and <a href="output/Ext.Panel.html#Ext.Panel-tools" ext:member="tools" ext:cls="Ext.Panel">tools</a></p>
+<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
+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 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
+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> )
+ <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> )
+ :
+ Ext.Component/Array<div class="mdesc"><div class="short">Adds Component(s) to this Container.
+Description :
+<ul class="mdetail-params">
+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 one or more Components to add 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></ul><strong>Returns:</strong><ul><li><code>Ext.Component/Array</code><div class="sub-desc">The Components that were 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> )
+ :
+ 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
+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 (<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> )
+ :
+ 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> )
+ :
+ void<div class="mdesc"><div class="short">Adds the specified events to the list of events which this Observable may fire.</div><div class="long">Adds the specified events to the list of events which this Observable may fire.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>o</code> : Object|String<div class="sub-desc">Either an object with event names as properties with a value of <code>true</code>
+or the first event name string if multiple event names are being passed as separate parameters.</div></li><li><code>Optional.</code> : string<div class="sub-desc">Event name if multiple event names are being passed as separate parameters.
+Usage:<pre><code>this.addEvents(<em>'storeloaded'</em>, <em>'storecleared'</em>);</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#addEvents" ext:member="#addEvents" 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.util.Observable-addListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-addListener">addListener</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> )
+ :
+ void<div class="mdesc"><div class="short">Appends an event handler to this object.</div><div class="long">Appends an event handler to this object.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to listen for.</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes.</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
+<b>If omitted, defaults to the object which fired the event.</b></div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration.
properties. This may contain any of the following properties:<ul>
-<li><b>scope</b> : Object<p class="sub-desc">The scope in which to execute the handler function. The handler function's "this" context.</p></li>
-<li><b>delay</b> : Number<p class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</p></li>
-<li><b>single</b> : Boolean<p class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</p></li>
-<li><b>buffer</b> : Number<p class="sub-desc">Causes the handler to be scheduled to run in an <a ext:cls="Ext.util.DelayedTask" href="output/Ext.util.DelayedTask.html">Ext.util.DelayedTask</a> delayed
+<li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
+<b>If omitted, defaults to the object which fired the event.</b></div></li>
+<li><b>delay</b> : Number<div class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</div></li>
+<li><b>single</b> : Boolean<div class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</div></li>
+<li><b>buffer</b> : Number<div class="sub-desc">Causes the handler to be scheduled to run in an <a href="output/Ext.util.DelayedTask.html" ext:cls="Ext.util.DelayedTask">Ext.util.DelayedTask</a> delayed
by the specified number of milliseconds. If the event fires again within that time, the original
-handler is <em>not</em> invoked, but the new handler is scheduled in its place.</p></li>
+handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
+<li><b>target</b> : Observable<div class="sub-desc">Only call the handler if the event was fired on the target Observable, <i>not</i>
+if the event was bubbled up from a child Observable.</div></li>
</ul><br>
<p>
<b>Combining Options</b><br>
Using the options argument, it is possible to combine different types of listeners:<br>
<br>
-A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
-<pre><code>el.on(<em>'click'</em>, <b>this</b>.onClick, <b>this</b>, {
- single: true,
- delay: 100,
- forumId: 4
+A delayed, one-time listener.
+<pre><code>myDataView.on(<em>'click'</em>, this.onClick, this, {
+single: true,
+delay: 100
});</code></pre>
<p>
<b>Attaching multiple handlers in 1 call</b><br>
The method also allows for a single argument to be passed which is a config object containing properties
which specify multiple handlers.
<p>
-<pre><code>foo.on({
- <em>'click'</em> : {
- fn: <b>this</b>.onClick,
- scope: <b>this</b>,
- delay: 100
- },
- <em>'mouseover'</em> : {
- fn: <b>this</b>.onMouseOver,
- scope: <b>this</b>
- },
- <em>'mouseout'</em> : {
- fn: <b>this</b>.onMouseOut,
- scope: <b>this</b>
- }
+<pre><code>myGridPanel.on({
+<em>'click'</em> : {
+ fn: this.onClick,
+ scope: this,
+ delay: 100
+},
+<em>'mouseover'</em> : {
+ fn: this.onMouseOver,
+ scope: this
+},
+<em>'mouseout'</em> : {
+ fn: this.onMouseOut,
+ scope: this
+}
});</code></pre>
<p>
Or a shorthand syntax:<br>
-<pre><code>foo.on({
- <em>'click'</em> : <b>this</b>.onClick,
- <em>'mouseover'</em> : <b>this</b>.onMouseOver,
- <em>'mouseout'</em> : <b>this</b>.onMouseOut,
- scope: <b>this</b>
-});</code></pre></div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-bubble"></a>\r
- <b>bubble</b>( <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Array args</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of...</div>\r
- <div class="long">\r
- Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (<i>this</i>) of
+<pre><code>myGridPanel.on({
+<em>'click'</em> : this.onClick,
+<em>'mouseover'</em> : this.onMouseOver,
+<em>'mouseout'</em> : this.onMouseOut,
+ 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.Component-bubble"></a><b><a href="source/Component.html#method-Ext.Component-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> )
+ :
+ Ext.Component<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">\r
- <strong>Parameters:</strong>\r
- <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>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Container" ext:member="#bubble" href="output/Ext.Container.html#bubble">Container</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-cloneConfig"></a>\r
- <b>cloneConfig</b>( <code>Object overrides</code> ) : Ext.Component <div class="mdesc">\r
- <div class="short">Clone the current component using the original config values passed into this instance by default.</div>\r
- <div class="long">\r
- Clone the current component using the original config values passed into this instance by default. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <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>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Component</code><div class="sub-desc">clone The cloned copy of this component</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#cloneConfig" href="output/Ext.Component.html#cloneConfig">Component</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-collapse"></a>\r
- <b>collapse</b>( <code>Boolean animate</code> ) : Ext.Panel <div class="mdesc">\r
- <div class="short">Collapses the panel body so that it becomes hidden. Fires the beforecollapse event which will
-cancel the collapse ac...</div>\r
- <div class="long">\r
- Collapses the panel body so that it becomes hidden. Fires the <a ext:cls="Ext.Panel" ext:member="beforecollapse" href="output/Ext.Panel.html#beforecollapse">beforecollapse</a> event which will
-cancel the collapse action if it returns false. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>animate</code> : Boolean<div class="sub-desc">True to animate the transition, else false (defaults to the value of the
-<a ext:cls="Ext.Panel" ext:member="animCollapse" href="output/Ext.Panel.html#animCollapse">animCollapse</a> panel config)</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Panel</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#collapse" href="output/Ext.Panel.html#collapse">Panel</a></td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-collapseAll"></a>\r
- <b>collapseAll</b>() : void <div class="mdesc">\r
- <div class="short">Collapse all nodes</div>\r
- <div class="long">\r
- Collapse all nodes <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-destroy"></a>\r
- <b>destroy</b>() : void <div class="mdesc">\r
- <div class="short">Destroys this component by purging any event listeners, removing the component's element from the DOM,
-removing the c...</div>\r
- <div class="long">\r
- Destroys this component by purging any event listeners, removing the component's element from the DOM,
-removing the component from its <a ext:cls="Ext.Container" href="output/Ext.Container.html">Ext.Container</a> (if applicable) and unregistering it from
-<a ext:cls="Ext.ComponentMgr" href="output/Ext.ComponentMgr.html">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">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#destroy" href="output/Ext.Component.html#destroy">Component</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-expand"></a>\r
- <b>expand</b>( <code>Boolean animate</code> ) : Ext.Panel <div class="mdesc">\r
- <div class="short">Expands the panel body so that it becomes visible. Fires the beforeexpand event which will
-cancel the expand action ...</div>\r
- <div class="long">\r
- Expands the panel body so that it becomes visible. Fires the <a ext:cls="Ext.Panel" ext:member="beforeexpand" href="output/Ext.Panel.html#beforeexpand">beforeexpand</a> event which will
-cancel the expand action if it returns false. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>animate</code> : Boolean<div class="sub-desc">True to animate the transition, else false (defaults to the value of the
-<a ext:cls="Ext.Panel" ext:member="animCollapse" href="output/Ext.Panel.html#animCollapse">animCollapse</a> panel config)</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Panel</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#expand" href="output/Ext.Panel.html#expand">Panel</a></td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-expandAll"></a>\r
- <b>expandAll</b>() : void <div class="mdesc">\r
- <div class="short">Expand all nodes</div>\r
- <div class="long">\r
- Expand all nodes <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-expandPath"></a>\r
- <b>expandPath</b>( <code>String path</code>, <span class="optional" title="Optional">[<code>String attr</code>]</span>, <span class="optional" title="Optional">[<code>Function callback</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Expands a specified path in this TreePanel. A path can be retrieved from a node with <a ext:cls="Ext.data.Node" ext:member="getPath" href="output/Ext.data.Node.html#getPath">Ext.data.Node.getPath</a></div>\r
- <div class="long">\r
- Expands a specified path in this TreePanel. A path can be retrieved from a node with <a ext:cls="Ext.data.Node" ext:member="getPath" href="output/Ext.data.Node.html#getPath">Ext.data.Node.getPath</a> <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>path</code> : String<div class="sub-desc"></div></li><li><code>attr</code> : String<div class="sub-desc">(optional) The attribute used in the path (see <a ext:cls="Ext.data.Node" ext:member="getPath" href="output/Ext.data.Node.html#getPath">Ext.data.Node.getPath</a> for more info)</div></li><li><code>callback</code> : Function<div class="sub-desc">(optional) The callback to call when the expand is complete. The callback will be called with
-(bSuccess, oLastNode) where bSuccess is if the expand was successful and oLastNode is the last node that was expanded.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-findParentBy"></a>\r
- <b>findParentBy</b>( <code>Function fcn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : Ext.Container <div class="mdesc">\r
- <div class="short">Find a container above this component at any level by a custom function. If the passed function returns
-true, the con...</div>\r
- <div class="long">\r
- Find a container above this component at any level by a custom function. If the passed function returns
-true, the container will be returned. The passed function is called with the arguments (container, this component). <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>fcn</code> : Function<div class="sub-desc"></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional)</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Container</code><div class="sub-desc">The first Container for which the custom function returns true</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#findParentBy" href="output/Ext.Component.html#findParentBy">Component</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-findParentByType"></a>\r
- <b>findParentByType</b>( <code>String/Class xtype</code> ) : Ext.Container <div class="mdesc">\r
- <div class="short">Find a container above this component at any level by xtype or class</div>\r
- <div class="long">\r
- Find a container above this component at any level by xtype or class <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>xtype</code> : String/Class<div class="sub-desc">The xtype string for a component, or the class of the component directly</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Container</code><div class="sub-desc">The first Container which matches the given xtype or class</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#findParentByType" href="output/Ext.Component.html#findParentByType">Component</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-fireEvent"></a>\r
- <b>fireEvent</b>( <code>String eventName</code>, <code>Object... args</code> ) : Boolean <div class="mdesc">\r
- <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>\r
- <div class="long">\r
- Fires the specified event with the passed parameters (minus the event name). <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>eventName</code> : String<div class="sub-desc"></div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-focus"></a>\r
- <b>focus</b>( <span class="optional" title="Optional">[<code>Boolean selectText</code>]</span>, <span class="optional" title="Optional">[<code>Boolean/Number delay</code>]</span> ) : Ext.Component <div class="mdesc">\r
- <div class="short">Try to focus this component.</div>\r
- <div class="long">\r
- Try to focus this component. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>selectText</code> : Boolean<div class="sub-desc">(optional) If applicable, true to also select the text in this component</div></li><li><code>delay</code> : Boolean/Number<div class="sub-desc">(optional) Delay the focus this number of milliseconds (true for 10 milliseconds)</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Component</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#focus" href="output/Ext.Component.html#focus">Component</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-getBottomToolbar"></a>\r
- <b>getBottomToolbar</b>() : Ext.Toolbar <div class="mdesc">\r
- <div class="short">Returns the toolbar from the bottom (bbar) section of the panel.</div>\r
- <div class="long">\r
- Returns the toolbar from the bottom (bbar) section of the panel. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Toolbar</code><div class="sub-desc">The toolbar</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#getBottomToolbar" href="output/Ext.Panel.html#getBottomToolbar">Panel</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-getBox"></a>\r
- <b>getBox</b>( <span class="optional" title="Optional">[<code>Boolean local</code>]</span> ) : Object <div class="mdesc">\r
- <div class="short">Gets the current box measurements of the component's underlying element.</div>\r
- <div class="long">\r
- Gets the current box measurements of the component's underlying element. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <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>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Object</code><div class="sub-desc">box An object in the format {x, y, width, height}</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#getBox" href="output/Ext.BoxComponent.html#getBox">BoxComponent</a></td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-getChecked"></a>\r
- <b>getChecked</b>( <span class="optional" title="Optional">[<code>String attribute</code>]</span>, <span class="optional" title="Optional">[<code>TreeNode startNode</code>]</span> ) : Array <div class="mdesc">\r
- <div class="short">Retrieve an array of checked nodes, or an array of a specific attribute of checked nodes (e.g. "id")</div>\r
- <div class="long">\r
- Retrieve an array of checked nodes, or an array of a specific attribute of checked nodes (e.g. "id") <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <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>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Array</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-getEl"></a>\r
- <b>getEl</b>() : Element <div class="mdesc">\r
- <div class="short">Returns the container element for this TreePanel.</div>\r
- <div class="long">\r
- Returns the container element for this TreePanel. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Element</code><div class="sub-desc">The container element for this TreePanel.</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-getFrameHeight"></a>\r
- <b>getFrameHeight</b>() : Number <div class="mdesc">\r
- <div class="short">Returns the height in pixels of the framing elements of this panel (including any top and bottom bars and
-header and ...</div>\r
- <div class="long">\r
- Returns the height in pixels of the framing elements of this panel (including any top and bottom bars and
-header and footer elements, but not including the body height). To retrieve the body height see <a ext:cls="Ext.Panel" ext:member="getInnerHeight" href="output/Ext.Panel.html#getInnerHeight">getInnerHeight</a>. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Number</code><div class="sub-desc">The frame height</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#getFrameHeight" href="output/Ext.Panel.html#getFrameHeight">Panel</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-getFrameWidth"></a>\r
- <b>getFrameWidth</b>() : Number <div class="mdesc">\r
- <div class="short">Returns the width in pixels of the framing elements of this panel (not including the body width). To
-retrieve the bo...</div>\r
- <div class="long">\r
- Returns the width in pixels of the framing elements of this panel (not including the body width). To
-retrieve the body width see <a ext:cls="Ext.Panel" ext:member="getInnerWidth" href="output/Ext.Panel.html#getInnerWidth">getInnerWidth</a>. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Number</code><div class="sub-desc">The frame width</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#getFrameWidth" href="output/Ext.Panel.html#getFrameWidth">Panel</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-getId"></a>\r
- <b>getId</b>() : String <div class="mdesc">\r
- <div class="short">Returns the id of this component.</div>\r
- <div class="long">\r
- Returns the id of this component. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>String</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#getId" href="output/Ext.Component.html#getId">Component</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-getInnerHeight"></a>\r
- <b>getInnerHeight</b>() : Number <div class="mdesc">\r
- <div class="short">Returns the height in pixels of the body element (not including the height of any framing elements).
-For the frame he...</div>\r
- <div class="long">\r
- Returns the height in pixels of the body element (not including the height of any framing elements).
-For the frame height see <a ext:cls="Ext.Panel" ext:member="getFrameHeight" href="output/Ext.Panel.html#getFrameHeight">getFrameHeight</a>. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Number</code><div class="sub-desc">The body height</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#getInnerHeight" href="output/Ext.Panel.html#getInnerHeight">Panel</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-getInnerWidth"></a>\r
- <b>getInnerWidth</b>() : Number <div class="mdesc">\r
- <div class="short">Returns the width in pixels of the body element (not including the width of any framing elements).
-For the frame widt...</div>\r
- <div class="long">\r
- Returns the width in pixels of the body element (not including the width of any framing elements).
-For the frame width see <a ext:cls="Ext.Panel" ext:member="getFrameWidth" href="output/Ext.Panel.html#getFrameWidth">getFrameWidth</a>. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Number</code><div class="sub-desc">The body width</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#getInnerWidth" href="output/Ext.Panel.html#getInnerWidth">Panel</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-getItemId"></a>\r
- <b>getItemId</b>() : String <div class="mdesc">\r
- <div class="short">Returns the item id of this component.</div>\r
- <div class="long">\r
- Returns the item id of this component. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>String</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#getItemId" href="output/Ext.Component.html#getItemId">Component</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-getLayoutTarget"></a>\r
- <b>getLayoutTarget</b>() : Ext.Element <div class="mdesc">\r
- <div class="short">Returns the Element to be used to contain the child Components of this Container.
-An implementation is provided which...</div>\r
- <div class="long">\r
- <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 ext:cls="Ext.Container" ext:member="getEl" href="output/Ext.Container.html#getEl">Element</a>, but
+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.Component</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#bubble" ext:member="#bubble" 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-cloneConfig"></a><b><a href="source/Component.html#method-Ext.Component-cloneConfig">cloneConfig</a></b>( <code>Object overrides</code> )
+ :
+ 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> )
+ :
+ Ext.Panel<div class="mdesc"><div class="short">Collapses the panel body so that it becomes hidden. Fires the beforecollapse event which will
+cancel the collapse ac...</div><div class="long">Collapses the panel body so that it becomes hidden. Fires the <a href="output/Ext.Panel.html#Ext.Panel-beforecollapse" ext:member="beforecollapse" ext:cls="Ext.Panel">beforecollapse</a> event which will
+cancel the collapse action if it returns false.<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#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-collapseAll"></a><b><a href="source/TreePanel.html#method-Ext.tree.TreePanel-collapseAll">collapseAll</a></b>()
+ :
+ void<div class="mdesc"><div class="short">Collapse all nodes</div><div class="long">Collapse all nodes<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">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-destroy"></a><b><a href="source/Component.html#method-Ext.Component-destroy">destroy</a></b>()
+ :
+ void<div class="mdesc"><div class="short">Destroys this component by purging any event listeners, removing the component's element from the DOM,
+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>String/Array events</code> )
+ :
+ void<div class="mdesc"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
+this.getBubbleTarget() if present....</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling
+<code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>
+<p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href="output/Ext.Component.getBubbleTarget.html" ext:cls="Ext.Component.getBubbleTarget">Ext.Component.getBubbleTarget</a>. The default
+implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to
+access the required target more quickly.</p>
+<p>Example:</p><pre><code>Ext.override(Ext.form.Field, {
+ <i>// Add functionality to Field's initComponent to enable the change event to bubble</i>
+ initComponent : Ext.form.Field.prototype.initComponent.createSequence(<b>function</b>() {
+ this.enableBubble(<em>'change'</em>);
+ }),
+
+ <i>// We know that we want Field's events to bubble directly to the FormPanel.</i>
+ getBubbleTarget : <b>function</b>() {
+ <b>if</b> (!this.formPanel) {
+ this.formPanel = this.findParentByType(<em>'form'</em>);
+ }
+ <b>return</b> this.formPanel;
+ }
+});
+
+<b>var</b> myForm = <b>new</b> Ext.formPanel({
+ title: <em>'User Details'</em>,
+ items: [{
+ ...
+ }],
+ listeners: {
+ change: <b>function</b>() {
+ <i>// Title goes red <b>if</b> form has been modified.</i>
+ myForm.header.setStyle(<em>'color'</em>, <em>'red'</em>);
+ }
+ }
+});</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> )
+ :
+ Ext.Panel<div class="mdesc"><div class="short">Expands the panel body so that it becomes visible. Fires the beforeexpand event which will
+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
+cancel the expand action if it returns false.<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#expand" ext:member="#expand" 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-expandAll"></a><b><a href="source/TreePanel.html#method-Ext.tree.TreePanel-expandAll">expandAll</a></b>()
+ :
+ void<div class="mdesc"><div class="short">Expand all nodes</div><div class="long">Expand all nodes<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">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-expandPath"></a><b><a href="source/TreePanel.html#method-Ext.tree.TreePanel-expandPath">expandPath</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> )
+ :
+ void<div class="mdesc"><div class="short">Expands a specified path in this TreePanel. A path can be retrieved from a node with Ext.data.Node.getPath</div><div class="long">Expands a specified path in this TreePanel. 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 expand is complete. The callback will be called with
+(bSuccess, oLastNode) where bSuccess is if the expand was successful and oLastNode is the last node that was expanded.</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.Component-findParentBy"></a><b><a href="source/Component.html#method-Ext.Component-findParentBy">findParentBy</a></b>( <code>Function fn</code> )
+ :
+ Ext.Container<div class="mdesc"><div class="short">Find a container above this component at any level by a custom function. If the passed function returns
+true, the con...</div><div class="long">Find a container above this component at any level by a custom function. If the passed function returns
+true, the container will be returned.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>fn</code> : Function<div class="sub-desc">The custom function to call with the arguments (container, this component).</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Container</code><div class="sub-desc">The first Container for which the custom function returns true</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#findParentBy" ext:member="#findParentBy" 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-findParentByType"></a><b><a href="source/Component.html#method-Ext.Component-findParentByType">findParentByType</a></b>( <code>String/Ext.Component/Class xtype</code>, <span title="Optional" class="optional">[<code>Boolean shallow</code>]</span> )
+ :
+ Ext.Container<div class="mdesc"><div class="short">Find a container above this component at any level by xtype or class</div><div class="long">Find a container above this component at any level by xtype or class<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>xtype</code> : String/Ext.Component/Class<div class="sub-desc">The xtype to check for this Component. Note that the the component can either be an instance
+or a component class:</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>Ext.Container</code><div class="sub-desc">The first Container which matches the given xtype or class</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#findParentByType" ext:member="#findParentByType" 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-fireEvent"></a><b><a href="source/Observable.html#method-Ext.util.Observable-fireEvent">fireEvent</a></b>( <code>String eventName</code>, <code>Object... args</code> )
+ :
+ Boolean<div class="mdesc"><div class="short">Fires the specified event with the passed parameters (minus the event name).
+An event may be set to bubble up an Obse...</div><div class="long"><p>Fires the specified event with the passed parameters (minus the event name).</p>
+<p>An event may be set to bubble up an Observable parent hierarchy (See <a href="output/Ext.Component.html#Ext.Component-getBubbleTarget" ext:member="getBubbleTarget" ext:cls="Ext.Component">Ext.Component.getBubbleTarget</a>)
+by calling <a href="output/Ext.util.Observable.html#Ext.util.Observable-enableBubble" ext:member="enableBubble" ext:cls="Ext.util.Observable">enableBubble</a>.</p><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to fire.</div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers.</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#fireEvent" ext:member="#fireEvent" 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-focus"></a><b><a href="source/Component.html#method-Ext.Component-focus">focus</a></b>( <span title="Optional" class="optional">[<code>Boolean selectText</code>]</span>, <span title="Optional" class="optional">[<code>Boolean/Number delay</code>]</span> )
+ :
+ Ext.Component<div class="mdesc"><div class="short">Try to focus this component.</div><div class="long">Try to focus this component.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>selectText</code> : Boolean<div class="sub-desc">(optional) If applicable, true to also select the text in this component</div></li><li><code>delay</code> : Boolean/Number<div class="sub-desc">(optional) Delay the focus this number of milliseconds (true for 10 milliseconds)</div></li></ul><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#focus" ext:member="#focus" 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-get"></a><b><a href="source/Container.html#method-Ext.Container-get">get</a></b>( <code>String/Number key</code> )
+ :
+ Ext.Component<div class="mdesc"><div class="short">Get a component contained by this container (alias for items.get(key))</div><div class="long">Get a component contained by this container (alias for items.get(key))<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>key</code> : String/Number<div class="sub-desc">The index or id of the component</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Component</code><div class="sub-desc">Ext.Component</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Container.html#get" ext:member="#get" 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-getBottomToolbar"></a><b><a href="source/Panel.html#method-Ext.Panel-getBottomToolbar">getBottomToolbar</a></b>()
+ :
+ Ext.Toolbar<div class="mdesc"><div class="short">Returns the toolbar from the bottom (bbar) section of the panel.</div><div class="long">Returns the <a href="output/Ext.Toolbar.html" ext:cls="Ext.Toolbar">toolbar</a> from the bottom (<code><a href="output/Ext.Panel.html#Ext.Panel-bbar" ext:member="bbar" ext:cls="Ext.Panel">bbar</a></code>) section of the panel.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.Toolbar</code><div class="sub-desc">The toolbar</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Panel.html#getBottomToolbar" ext:member="#getBottomToolbar" 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.BoxComponent-getBox"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-getBox">getBox</a></b>( <span title="Optional" class="optional">[<code>Boolean local</code>]</span> )
+ :
+ Object<div class="mdesc"><div class="short">Gets the current box measurements of the component's underlying element.</div><div class="long">Gets the current box measurements 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>Object</code><div class="sub-desc">box An object in the format {x, y, width, height}</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#getBox" ext:member="#getBox" 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.Component-getBubbleTarget"></a><b><a href="source/Component.html#method-Ext.Component-getBubbleTarget">getBubbleTarget</a></b>()
+ :
+ 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> )
+ :
+ 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>()
+ :
+ Ext.Element<div class="mdesc"><div class="short">Returns the Ext.Element which encapsulates this Component.
+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-getFooterToolbar"></a><b><a href="source/Panel.html#method-Ext.Panel-getFooterToolbar">getFooterToolbar</a></b>()
+ :
+ Ext.Toolbar<div class="mdesc"><div class="short">Returns the toolbar from the footer (fbar) section of the panel.</div><div class="long">Returns the <a href="output/Ext.Toolbar.html" ext:cls="Ext.Toolbar">toolbar</a> from the footer (<code><a href="output/Ext.Panel.html#Ext.Panel-fbar" ext:member="fbar" ext:cls="Ext.Panel">fbar</a></code>) section of the panel.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.Toolbar</code><div class="sub-desc">The toolbar</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Panel.html#getFooterToolbar" ext:member="#getFooterToolbar" 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.Panel-getFrameHeight"></a><b><a href="source/Panel.html#method-Ext.Panel-getFrameHeight">getFrameHeight</a></b>()
+ :
+ 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
+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
+header and footer elements, but not including the body height). To retrieve the body height see <a href="output/Ext.Panel.html#Ext.Panel-getInnerHeight" ext:member="getInnerHeight" ext:cls="Ext.Panel">getInnerHeight</a>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">The frame height</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Panel.html#getFrameHeight" ext:member="#getFrameHeight" 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.Panel-getFrameWidth"></a><b><a href="source/Panel.html#method-Ext.Panel-getFrameWidth">getFrameWidth</a></b>()
+ :
+ Number<div class="mdesc"><div class="short">Returns the width in pixels of the framing elements of this panel (not including the body width). To
+retrieve the bo...</div><div class="long">Returns the width in pixels of the framing elements of this panel (not including the body width). To
+retrieve the body width see <a href="output/Ext.Panel.html#Ext.Panel-getInnerWidth" ext:member="getInnerWidth" ext:cls="Ext.Panel">getInnerWidth</a>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">The frame width</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Panel.html#getFrameWidth" ext:member="#getFrameWidth" 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.BoxComponent-getHeight"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-getHeight">getHeight</a></b>()
+ :
+ Number<div class="mdesc"><div class="short">Gets the current height of the component's underlying element.</div><div class="long">Gets the current height of the component's underlying element.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#getHeight" ext:member="#getHeight" 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.Component-getId"></a><b><a href="source/Component.html#method-Ext.Component-getId">getId</a></b>()
+ :
+ String<div class="mdesc"><div class="short">Returns the id of this component or automatically generates and
+returns an id if an id is not defined yet:'ext-comp-'...</div><div class="long">Returns the <code>id</code> of this component or automatically generates and
+returns an <code>id</code> if an <code>id</code> is not defined yet:<pre><code><em>'ext-comp-'</em> + (++Ext.Component.AUTO_ID)</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc">id</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#getId" ext:member="#getId" 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-getInnerHeight"></a><b><a href="source/Panel.html#method-Ext.Panel-getInnerHeight">getInnerHeight</a></b>()
+ :
+ Number<div class="mdesc"><div class="short">Returns the height in pixels of the body element (not including the height of any framing elements).
+For the frame he...</div><div class="long">Returns the height in pixels of the body element (not including the height of any framing elements).
+For the frame height see <a href="output/Ext.Panel.html#Ext.Panel-getFrameHeight" ext:member="getFrameHeight" ext:cls="Ext.Panel">getFrameHeight</a>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">The body height</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Panel.html#getInnerHeight" ext:member="#getInnerHeight" 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.Panel-getInnerWidth"></a><b><a href="source/Panel.html#method-Ext.Panel-getInnerWidth">getInnerWidth</a></b>()
+ :
+ Number<div class="mdesc"><div class="short">Returns the width in pixels of the body element (not including the width of any framing elements).
+For the frame widt...</div><div class="long">Returns the width in pixels of the body element (not including the width of any framing elements).
+For the frame width see <a href="output/Ext.Panel.html#Ext.Panel-getFrameWidth" ext:member="getFrameWidth" ext:cls="Ext.Panel">getFrameWidth</a>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">The body width</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Panel.html#getInnerWidth" ext:member="#getInnerWidth" 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-getItemId"></a><b><a href="source/Component.html#method-Ext.Component-getItemId">getItemId</a></b>()
+ :
+ String<div class="mdesc"><div class="short">Returns the itemId of this component. If an
+itemId was not assigned through configuration the
+id is returned using g...</div><div class="long">Returns the <code><a href="output/Ext.Component.html#Ext.Component-itemId" ext:member="itemId" ext:cls="Ext.Component">itemId</a></code> of this component. If an
+<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>()
+ :
+ Ext.Element<div class="mdesc"><div class="short">Returns the Element to be used to contain the child Components of this Container.
+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 ext:cls="Ext.Container" ext:member="layout" href="output/Ext.Container.html#layout">layout</a> renders child Components.</p> <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">The Element to render child Components into.</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Container" ext:member="#getLayoutTarget" href="output/Ext.Container.html#getLayoutTarget">Container</a></td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-getLoader"></a>\r
- <b>getLoader</b>() : Ext.tree.TreeLoader <div class="mdesc">\r
- <div class="short">Returns the default <a ext:cls="Ext.tree.TreeLoader" href="output/Ext.tree.TreeLoader.html">Ext.tree.TreeLoader</a> for this TreePanel.</div>\r
- <div class="long">\r
- Returns the default <a ext:cls="Ext.tree.TreeLoader" href="output/Ext.tree.TreeLoader.html">Ext.tree.TreeLoader</a> for this TreePanel. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.tree.TreeLoader</code><div class="sub-desc">The TreeLoader for this TreePanel.</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-getNodeById"></a>\r
- <b>getNodeById</b>( <code>String id</code> ) : Node <div class="mdesc">\r
- <div class="short">Gets a node in this tree by its id</div>\r
- <div class="long">\r
- Gets a node in this tree by its id <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>id</code> : String<div class="sub-desc"></div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Node</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-getPosition"></a>\r
- <b>getPosition</b>( <span class="optional" title="Optional">[<code>Boolean local</code>]</span> ) : Array <div class="mdesc">\r
- <div class="short">Gets the current XY position of the component's underlying element.</div>\r
- <div class="long">\r
- Gets the current XY position of the component's underlying element. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <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>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Array</code><div class="sub-desc">The XY position of the element (e.g., [100, 200])</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#getPosition" href="output/Ext.BoxComponent.html#getPosition">BoxComponent</a></td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-getRootNode"></a>\r
- <b>getRootNode</b>() : Node <div class="mdesc">\r
- <div class="short">Returns this root node for this tree</div>\r
- <div class="long">\r
- Returns this root node for this tree <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Node</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-getSelectionModel"></a>\r
- <b>getSelectionModel</b>() : TreeSelectionModel <div class="mdesc">\r
- <div class="short">Returns the selection model used by this TreePanel.</div>\r
- <div class="long">\r
- Returns the selection model used by this TreePanel. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>TreeSelectionModel</code><div class="sub-desc">The selection model used by this TreePanel</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-getSize"></a>\r
- <b>getSize</b>() : Object <div class="mdesc">\r
- <div class="short">Gets the current size of the component's underlying element.</div>\r
- <div class="long">\r
- Gets the current size of the component's underlying element. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Object</code><div class="sub-desc">An object containing the element's size {width: (element width), height: (element height)}</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#getSize" href="output/Ext.BoxComponent.html#getSize">BoxComponent</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-getTool"></a>\r
- <b>getTool</b>( <code>String id</code> ) : Object <div class="mdesc">\r
- <div class="short">Retrieve a tool by id.</div>\r
- <div class="long">\r
- Retrieve a tool by id. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>id</code> : String<div class="sub-desc"></div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Object</code><div class="sub-desc">tool</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#getTool" href="output/Ext.Panel.html#getTool">Panel</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-getTopToolbar"></a>\r
- <b>getTopToolbar</b>() : Ext.Toolbar <div class="mdesc">\r
- <div class="short">Returns the toolbar from the top (tbar) section of the panel.</div>\r
- <div class="long">\r
- Returns the toolbar from the top (tbar) section of the panel. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Toolbar</code><div class="sub-desc">The toolbar</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#getTopToolbar" href="output/Ext.Panel.html#getTopToolbar">Panel</a></td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-getTreeEl"></a>\r
- <b>getTreeEl</b>() : Ext.Element <div class="mdesc">\r
- <div class="short">Returns the underlying Element for this tree</div>\r
- <div class="long">\r
- Returns the underlying Element for this tree <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code><div class="sub-desc">The Element</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-getXType"></a>\r
- <b>getXType</b>() : String <div class="mdesc">\r
- <div class="short">Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
-available xtypes, see the Ex...</div>\r
- <div class="long">\r
- Gets the xtype for this component as registered with <a ext:cls="Ext.ComponentMgr" href="output/Ext.ComponentMgr.html">Ext.ComponentMgr</a>. For a list of all
-available xtypes, see the <a ext:cls="Ext.Component" href="output/Ext.Component.html">Ext.Component</a> header. Example usage:
-<pre><code>var t = <b>new</b> Ext.form.TextField();
-alert(t.getXType()); // alerts <em>'textfield'</em></code></pre> <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>String</code><div class="sub-desc">The xtype</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#getXType" href="output/Ext.Component.html#getXType">Component</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-getXTypes"></a>\r
- <b>getXTypes</b>() : String <div class="mdesc">\r
- <div class="short">Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all
-available xtypes, see the Ext...</div>\r
- <div class="long">\r
- <p>Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all
-available xtypes, see the <a ext:cls="Ext.Component" href="output/Ext.Component.html">Ext.Component</a> header.</p>
+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>()
+ :
+ 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> )
+ :
+ Node<div class="mdesc"><div class="short">Gets a node in this tree by its id</div><div class="long">Gets a node in this tree by its id<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>id</code> : String<div class="sub-desc"></div></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 inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-getOuterSize"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-getOuterSize">getOuterSize</a></b>()
+ :
+ Object<div class="mdesc"><div class="short">Gets the current size of the component's underlying element, including space taken by its margins.</div><div class="long">Gets the current size of the component's underlying element, including space taken by its margins.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Object</code><div class="sub-desc">An object containing the element's size {width: (element width + left/right margins), height: (element height + top/bottom margins)}</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#getOuterSize" ext:member="#getOuterSize" 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-getPosition"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-getPosition">getPosition</a></b>( <span title="Optional" class="optional">[<code>Boolean local</code>]</span> )
+ :
+ 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>()
+ :
+ Ext.Element<div class="mdesc"><div class="short">Returns the outermost Element of this Component which defines the Components overall size.
+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
+active Element.</p>
+<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><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>()
+ :
+ 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>()
+ :
+ TreeSelectionModel<div class="mdesc"><div class="short">Returns the selection model used by this TreePanel.</div><div class="long">Returns the selection model used by this TreePanel.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>TreeSelectionModel</code><div class="sub-desc">The selection model used by 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.BoxComponent-getSize"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-getSize">getSize</a></b>()
+ :
+ Object<div class="mdesc"><div class="short">Gets the current size of the component's underlying element.</div><div class="long">Gets the current size of the component's underlying element.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Object</code><div class="sub-desc">An object containing the element's size {width: (element width), height: (element height)}</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#getSize" ext:member="#getSize" 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.Panel-getTool"></a><b><a href="source/Panel.html#method-Ext.Panel-getTool">getTool</a></b>( <code>String id</code> )
+ :
+ Object<div class="mdesc"><div class="short">Retrieve a tool by id.</div><div class="long">Retrieve a tool by id.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>id</code> : String<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li><code>Object</code><div class="sub-desc">tool</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Panel.html#getTool" ext:member="#getTool" 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.Panel-getTopToolbar"></a><b><a href="source/Panel.html#method-Ext.Panel-getTopToolbar">getTopToolbar</a></b>()
+ :
+ Ext.Toolbar<div class="mdesc"><div class="short">Returns the toolbar from the top (tbar) section of the panel.</div><div class="long">Returns the <a href="output/Ext.Toolbar.html" ext:cls="Ext.Toolbar">toolbar</a> from the top (<code><a href="output/Ext.Panel.html#Ext.Panel-tbar" ext:member="tbar" ext:cls="Ext.Panel">tbar</a></code>) section of the panel.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.Toolbar</code><div class="sub-desc">The toolbar</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Panel.html#getTopToolbar" ext:member="#getTopToolbar" 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-getTreeEl"></a><b><a href="source/TreePanel.html#method-Ext.tree.TreePanel-getTreeEl">getTreeEl</a></b>()
+ :
+ Ext.Element<div class="mdesc"><div class="short">Returns the underlying Element for this tree</div><div class="long">Returns the underlying Element for this tree<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</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.BoxComponent-getWidth"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-getWidth">getWidth</a></b>()
+ :
+ Number<div class="mdesc"><div class="short">Gets the current width of the component's underlying element.</div><div class="long">Gets the current width of the component's underlying element.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#getWidth" ext:member="#getWidth" 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.Component-getXType"></a><b><a href="source/Component.html#method-Ext.Component-getXType">getXType</a></b>()
+ :
+ String<div class="mdesc"><div class="short">Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
+available xtypes, see the Ex...</div><div class="long">Gets the xtype for this component as registered with <a href="output/Ext.ComponentMgr.html" ext:cls="Ext.ComponentMgr">Ext.ComponentMgr</a>. For a list of all
+available xtypes, see the <a href="output/Ext.Component.html" ext:cls="Ext.Component">Ext.Component</a> header. Example usage:
+<pre><code><b>var</b> t = <b>new</b> Ext.form.TextField();
+alert(t.getXType()); <i>// alerts <em>'textfield'</em></i></code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc">The xtype</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#getXType" ext:member="#getXType" 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-getXTypes"></a><b><a href="source/Component.html#method-Ext.Component-getXTypes">getXTypes</a></b>()
+ :
+ String<div class="mdesc"><div class="short">Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all
+available xtypes, see the Ext...</div><div class="long"><p>Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all
+available xtypes, see the <a href="output/Ext.Component.html" ext:cls="Ext.Component">Ext.Component</a> header.</p>
<p><b>If using your own subclasses, be aware that a Component must register its own xtype
to participate in determination of inherited xtypes.</b></p>
<p>Example usage:</p>
-<pre><code>\r
-var t = new Ext.form.TextField();\r
-alert(t.getXTypes()); // alerts 'component/box/field/textfield'</pre></code> <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>String</code><div class="sub-desc">The xtype hierarchy string</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#getXTypes" href="output/Ext.Component.html#getXTypes">Component</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-hasListener"></a>\r
- <b>hasListener</b>( <code>String eventName</code> ) : Boolean <div class="mdesc">\r
- <div class="short">Checks to see if this object has any listeners for a specified event</div>\r
- <div class="long">\r
- Checks to see if this object has any listeners for a specified event <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-hide"></a>\r
- <b>hide</b>() : Ext.Component <div class="mdesc">\r
- <div class="short">Hide this component.</div>\r
- <div class="long">\r
- Hide this component. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Component</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#hide" href="output/Ext.Component.html#hide">Component</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-isVisible"></a>\r
- <b>isVisible</b>() : void <div class="mdesc">\r
- <div class="short">Returns true if this component is visible.</div>\r
- <div class="long">\r
- Returns true if this component is visible. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#isVisible" href="output/Ext.Component.html#isVisible">Component</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-isXType"></a>\r
- <b>isXType</b>( <code>String xtype</code>, <span class="optional" title="Optional">[<code>Boolean shallow</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended
-from th...</div>\r
- <div class="long">\r
- <p>Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended
+<pre><code><b>var</b> t = <b>new</b> Ext.form.TextField();
+alert(t.getXTypes()); <i>// alerts <em>'component/box/field/textfield'</em></i></code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc">The xtype hierarchy string</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#getXTypes" ext:member="#getXTypes" 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-hasListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-hasListener">hasListener</a></b>( <code>String eventName</code> )
+ :
+ Boolean<div class="mdesc"><div class="short">Checks to see if this object has any listeners for a specified event</div><div class="long">Checks to see if this object has any listeners for a specified event<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#hasListener" ext:member="#hasListener" 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-hide"></a><b><a href="source/Component.html#method-Ext.Component-hide">hide</a></b>()
+ :
+ Ext.Component<div class="mdesc"><div class="short">Hide this component. Listen to the 'beforehide' event and return
+false to cancel hiding the component. Fires the 'h...</div><div class="long">Hide this component. Listen to the '<a href="output/Ext.Component.html#Ext.Component-beforehide" ext:member="beforehide" ext:cls="Ext.Component">beforehide</a>' event and return
+<tt>false</tt> to cancel hiding the component. Fires the '<a href="output/Ext.Component.html#Ext.Component-hide" ext:member="hide" ext:cls="Ext.Component">hide</a>'
+event after hiding the component. Note this method is called internally if
+the component is configured to be <code><a href="output/Ext.Component.html#Ext.Component-hidden" ext:member="hidden" ext:cls="Ext.Component">hidden</a></code>.<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">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#hide" ext:member="#hide" 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-isVisible"></a><b><a href="source/Component.html#method-Ext.Component-isVisible">isVisible</a></b>()
+ :
+ Boolean<div class="mdesc"><div class="short">Returns true if this component is visible.</div><div class="long">Returns true if this component is visible.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True if this component is visible, false otherwise.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#isVisible" ext:member="#isVisible" 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-isXType"></a><b><a href="source/Component.html#method-Ext.Component-isXType">isXType</a></b>( <code>String/Ext.Component/Class xtype</code>, <span title="Optional" class="optional">[<code>Boolean shallow</code>]</span> )
+ :
+ Boolean<div class="mdesc"><div class="short">Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended
+from th...</div><div class="long"><p>Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended
from the xtype (default) or whether it is directly of the xtype specified (shallow = true).</p>
<p><b>If using your own subclasses, be aware that a Component must register its own xtype
to participate in determination of inherited xtypes.</b></p>
-<p>For a list of all available xtypes, see the <a ext:cls="Ext.Component" href="output/Ext.Component.html">Ext.Component</a> header.</p>
+<p>For a list of all available xtypes, see the <a href="output/Ext.Component.html" ext:cls="Ext.Component">Ext.Component</a> header.</p>
<p>Example usage:</p>
-<pre><code>var t = <b>new</b> Ext.form.TextField();
+<pre><code><b>var</b> t = <b>new</b> Ext.form.TextField();
<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); // false, not a direct BoxComponent instance</code></pre> <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <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>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#isXType" href="output/Ext.Component.html#isXType">Component</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-on"></a>\r
- <b>on</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Appends an event handler to this element (shorthand for addListener)</div>\r
- <div class="long">\r
- Appends an event handler to this element (shorthand for addListener) <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler
-function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-purgeListeners"></a>\r
- <b>purgeListeners</b>() : void <div class="mdesc">\r
- <div class="short">Removes all listeners for this object</div>\r
- <div class="long">\r
- Removes all listeners for this object <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-relayEvents"></a>\r
- <b>relayEvents</b>( <code>Object o</code>, <code>Array events</code> ) : void <div class="mdesc">\r
- <div class="short">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.</div>\r
- <div class="long">\r
- Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>o</code> : Object<div class="sub-desc">The Observable whose events this object is to relay.</div></li><li><code>events</code> : Array<div class="sub-desc">Array of event names to relay.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#relayEvents" href="output/Ext.util.Observable.html#relayEvents">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-removeAll"></a>\r
- <b>removeAll</b>( <span class="optional" title="Optional">[<code>Boolean autoDestroy</code>]</span> ) : Array <div class="mdesc">\r
- <div class="short">Removes all components from this container.</div>\r
- <div class="long">\r
- Removes all components from this container. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>autoDestroy</code> : Boolean<div class="sub-desc">(optional) True to automatically invoke the removed Component's <a ext:cls="Ext.Component" ext:member="destroy" href="output/Ext.Component.html#destroy">Ext.Component.destroy</a> function.
-Defaults to the value of this Container's <a ext:cls="Ext.Container" ext:member="autoDestroy" href="output/Ext.Container.html#autoDestroy">autoDestroy</a> config.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Array</code><div class="sub-desc">Array of the destroyed components</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Container" ext:member="#removeAll" href="output/Ext.Container.html#removeAll">Container</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-removeClass"></a>\r
- <b>removeClass</b>( <code>string cls</code> ) : void <div class="mdesc">\r
- <div class="short">Removes a CSS class from the component's underlying element.</div>\r
- <div class="long">\r
- Removes a CSS class from the component's underlying element. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>cls</code> : string<div class="sub-desc">The CSS class name to remove</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#removeClass" href="output/Ext.Component.html#removeClass">Component</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-removeListener"></a>\r
- <b>removeListener</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Removes a listener</div>\r
- <div class="long">\r
- Removes a listener <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-render"></a>\r
- <b>render</b>( <span class="optional" title="Optional">[<code>Element/HTMLElement/String container</code>]</span>, <span class="optional" title="Optional">[<code>String/Number position</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Render this Component into the passed HTML element.
-If you are using a Container object to house this Component, then...</div>\r
- <div class="long">\r
- <p>Render this Component into the passed HTML element.</p>
-<p><b>If you are using a <a ext:cls="Ext.Container" href="output/Ext.Container.html">Container</a> object to house this Component, then
+<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/Ext.Component/Class<div class="sub-desc">The xtype to check for this Component. Note that the the component can either be an instance
+or a component class:
+<pre><code><b>var</b> c = <b>new</b> Ext.Component();
+console.log(c.isXType(c));
+console.log(c.isXType(Ext.Component));</code></pre></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-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> )
+ :
+ void<div class="mdesc"><div class="short">Adds listeners to any Observable object (or Elements) which are automatically removed when this Component
+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> )
+ :
+ 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>()
+ :
+ 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> )
+ :
+ void<div class="mdesc"><div class="short">Appends an event handler to this object (shorthand for addListener.)</div><div class="long">Appends an event handler to this object (shorthand for <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a>.)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
+<b>If omitted, defaults to the object which fired the event.</b></div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration.</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#on" ext:member="#on" 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-previousSibling"></a><b><a href="source/Component.html#method-Ext.Component-previousSibling">previousSibling</a></b>()
+ :
+ Ext.Component<div class="mdesc"><div class="short">Returns the previous component in the owning container</div><div class="long">Returns the previous 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#previousSibling" ext:member="#previousSibling" 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-purgeListeners"></a><b><a href="source/Observable.html#method-Ext.util.Observable-purgeListeners">purgeListeners</a></b>()
+ :
+ void<div class="mdesc"><div class="short">Removes all listeners for this object</div><div class="long">Removes all listeners for this object<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#purgeListeners" ext:member="#purgeListeners" 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.util.Observable-relayEvents"></a><b><a href="source/Observable-more.html#method-Ext.util.Observable-relayEvents">relayEvents</a></b>( <code>Object o</code>, <code>Array events</code> )
+ :
+ void<div class="mdesc"><div class="short">Relays selected events from the specified Observable as if the events were fired by this.</div><div class="long">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>o</code> : Object<div class="sub-desc">The Observable whose events this object is to relay.</div></li><li><code>events</code> : Array<div class="sub-desc">Array of event names to relay.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#relayEvents" ext:member="#relayEvents" 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-removeClass"></a><b><a href="source/Component.html#method-Ext.Component-removeClass">removeClass</a></b>( <code>string cls</code> )
+ :
+ Ext.Component<div class="mdesc"><div class="short">Removes a CSS class from the component's underlying element.</div><div class="long">Removes a CSS class from 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 remove</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#removeClass" ext:member="#removeClass" 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-removeListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-removeListener">removeListener</a></b>( <code>String eventName</code>, <code>Function handler</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span> )
+ :
+ void<div class="mdesc"><div class="short">Removes an event handler.</div><div class="long">Removes an event handler.<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#removeListener" ext:member="#removeListener" 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-render"></a><b><a href="source/Component.html#method-Ext.Component-render">render</a></b>( <span title="Optional" class="optional">[<code>Element/HTMLElement/String container</code>]</span>, <span title="Optional" class="optional">[<code>String/Number position</code>]</span> )
+ :
+ void<div class="mdesc"><div class="short">Render this Component into the passed HTML element.
+If you are using a Container object to house this Component, then...</div><div class="long"><p>Render this Component into the passed HTML element.</p>
+<p><b>If you are using a <a href="output/Ext.Container.html" ext:cls="Ext.Container">Container</a> object to house this Component, then
do not use the render method.</b></p>
<p>A Container's child Components are rendered by that Container's
-<a ext:cls="Ext.Container" ext:member="layout" href="output/Ext.Container.html#layout">layout</a> manager when the Container is first rendered.</p>
+<a href="output/Ext.Container.html#Ext.Container-layout" ext:member="layout" ext:cls="Ext.Container">layout</a> manager when the Container is first rendered.</p>
<p>Certain layout managers allow dynamic addition of child components. Those that do
-include <a ext:cls="Ext.layout.CardLayout" href="output/Ext.layout.CardLayout.html">Ext.layout.CardLayout</a>, <a ext:cls="Ext.layout.AnchorLayout" href="output/Ext.layout.AnchorLayout.html">Ext.layout.AnchorLayout</a>,
-<a ext:cls="Ext.layout.FormLayout" href="output/Ext.layout.FormLayout.html">Ext.layout.FormLayout</a>, <a ext:cls="Ext.layout.TableLayout" href="output/Ext.layout.TableLayout.html">Ext.layout.TableLayout</a>.</p>
+include <a href="output/Ext.layout.CardLayout.html" ext:cls="Ext.layout.CardLayout">Ext.layout.CardLayout</a>, <a href="output/Ext.layout.AnchorLayout.html" ext:cls="Ext.layout.AnchorLayout">Ext.layout.AnchorLayout</a>,
+<a href="output/Ext.layout.FormLayout.html" ext:cls="Ext.layout.FormLayout">Ext.layout.FormLayout</a>, <a href="output/Ext.layout.TableLayout.html" ext:cls="Ext.layout.TableLayout">Ext.layout.TableLayout</a>.</p>
<p>If the Container is already rendered when a new child Component is added, you may need to call
-the Container's <a ext:cls="Ext.Container" ext:member="doLayout" href="output/Ext.Container.html#doLayout">doLayout</a> to refresh the view which causes any
+the Container's <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 add multiple
child components if needed while only refreshing the layout once.</p>
<p>When creating complex UIs, it is important to remember that sizing and positioning
-of child items is the responsibility of the Container's <a ext:cls="Ext.Container" ext:member="layout" href="output/Ext.Container.html#layout">layout</a> manager.
+of child items is the responsibility of the Container's <a href="output/Ext.Container.html#Ext.Container-layout" ext:member="layout" ext:cls="Ext.Container">layout</a> manager.
If you expect child items to be sized in response to user interactions, you must
configure the Container with a layout manager which creates and manages the type of layout you
have in mind.</p>
-<p><b>Omitting the Container's <a ext:cls="Ext.Container" ext:member="layout" href="output/Ext.Container.html#layout">layout</a> config means that a basic
+<p><b>Omitting the Container's <a href="output/Ext.Container.html#Ext.Container-layout" ext:member="layout" ext:cls="Ext.Container">layout</a> config means that a basic
layout manager is used which does nothing but render child components sequentially into the
-Container. No sizing or positioning will be performed in this situation.</b></p> <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>container</code> : Element/HTMLElement/String<div class="sub-desc">(optional) The element this Component should be
+Container. No sizing or positioning will be performed in this situation.</b></p><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>container</code> : Element/HTMLElement/String<div class="sub-desc">(optional) The element this Component should be
rendered into. If it is being created from existing markup, this should be omitted.</div></li><li><code>position</code> : String/Number<div class="sub-desc">(optional) The element ID or DOM node index within the container <b>before</b>
-which this component will be inserted (defaults to appending to the end of the container)</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#render" href="output/Ext.Component.html#render">Component</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-resumeEvents"></a>\r
- <b>resumeEvents</b>() : void <div class="mdesc">\r
- <div class="short">Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>)</div>\r
- <div class="long">\r
- Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>) <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-selectPath"></a>\r
- <b>selectPath</b>( <code>String path</code>, <span class="optional" title="Optional">[<code>String attr</code>]</span>, <span class="optional" title="Optional">[<code>Function callback</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Selects the node in this tree at the specified path. A path can be retrieved from a node with <a ext:cls="Ext.data.Node" ext:member="getPath" href="output/Ext.data.Node.html#getPath">Ext.data.Node.getPath</a></div>\r
- <div class="long">\r
- Selects the node in this tree at the specified path. A path can be retrieved from a node with <a ext:cls="Ext.data.Node" ext:member="getPath" href="output/Ext.data.Node.html#getPath">Ext.data.Node.getPath</a> <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>path</code> : String<div class="sub-desc"></div></li><li><code>attr</code> : String<div class="sub-desc">(optional) The attribute used in the path (see <a ext:cls="Ext.data.Node" ext:member="getPath" href="output/Ext.data.Node.html#getPath">Ext.data.Node.getPath</a> for more info)</div></li><li><code>callback</code> : Function<div class="sub-desc">(optional) The callback to call when the selection is complete. The callback will be called with
-(bSuccess, oSelNode) where bSuccess is if the selection was successful and oSelNode is the selected node.</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-setHeight"></a>\r
- <b>setHeight</b>( <code>Number height</code> ) : Ext.BoxComponent <div class="mdesc">\r
- <div class="short">Sets the height of the component. This method fires the <a ext:cls="Ext.BoxComponent" ext:member="resize" href="output/Ext.BoxComponent.html#resize">resize</a> event.</div>\r
- <div class="long">\r
- Sets the height of the component. This method fires the <a ext:cls="Ext.BoxComponent" ext:member="resize" href="output/Ext.BoxComponent.html#resize">resize</a> event. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>height</code> : Number<div class="sub-desc">The new height to set</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#setHeight" href="output/Ext.BoxComponent.html#setHeight">BoxComponent</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-setIconClass"></a>\r
- <b>setIconClass</b>( <code>String cls</code> ) : void <div class="mdesc">\r
- <div class="short">Sets the CSS class that provides the icon image for this panel. This method will replace any existing
-icon class if ...</div>\r
- <div class="long">\r
- Sets the CSS class that provides the icon image for this panel. This method will replace any existing
-icon class if one has already been set. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>cls</code> : String<div class="sub-desc">The new CSS class name</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#setIconClass" href="output/Ext.Panel.html#setIconClass">Panel</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-setPagePosition"></a>\r
- <b>setPagePosition</b>( <code>Number x</code>, <code>Number y</code> ) : Ext.BoxComponent <div class="mdesc">\r
- <div class="short">Sets the page XY position of the component. To set the left and top instead, use setPosition.
-This method fires the ...</div>\r
- <div class="long">\r
- Sets the page XY position of the component. To set the left and top instead, use <a ext:cls="Ext.BoxComponent" ext:member="setPosition" href="output/Ext.BoxComponent.html#setPosition">setPosition</a>.
-This method fires the <a ext:cls="Ext.BoxComponent" ext:member="move" href="output/Ext.BoxComponent.html#move">move</a> event. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>x</code> : Number<div class="sub-desc">The new x position</div></li><li><code>y</code> : Number<div class="sub-desc">The new y position</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#setPagePosition" href="output/Ext.BoxComponent.html#setPagePosition">BoxComponent</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-setPosition"></a>\r
- <b>setPosition</b>( <code>Number left</code>, <code>Number top</code> ) : Ext.BoxComponent <div class="mdesc">\r
- <div class="short">Sets the left and top of the component. To set the page XY position instead, use setPagePosition.
-This method fires ...</div>\r
- <div class="long">\r
- Sets the left and top of the component. To set the page XY position instead, use <a ext:cls="Ext.BoxComponent" ext:member="setPagePosition" href="output/Ext.BoxComponent.html#setPagePosition">setPagePosition</a>.
-This method fires the <a ext:cls="Ext.BoxComponent" ext:member="move" href="output/Ext.BoxComponent.html#move">move</a> event. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>left</code> : Number<div class="sub-desc">The new left</div></li><li><code>top</code> : Number<div class="sub-desc">The new top</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#setPosition" href="output/Ext.BoxComponent.html#setPosition">BoxComponent</a></td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-setRootNode"></a>\r
- <b>setRootNode</b>( <code>Node node</code> ) : Node <div class="mdesc">\r
- <div class="short">Sets the root node for this tree during initialization.</div>\r
- <div class="long">\r
- Sets the root node for this tree during initialization. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>node</code> : Node<div class="sub-desc"></div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Node</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-setSize"></a>\r
- <b>setSize</b>( <code>Number/Object width</code>, <code>Number height</code> ) : Ext.BoxComponent <div class="mdesc">\r
- <div class="short">Sets the width and height of the component. This method fires the resize event. This method can accept
-either width...</div>\r
- <div class="long">\r
- Sets the width and height of the component. This method fires the <a ext:cls="Ext.BoxComponent" ext:member="resize" href="output/Ext.BoxComponent.html#resize">resize</a> event. This method can accept
-either width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>width</code> : Number/Object<div class="sub-desc">The new width to set, or a size object in the format {width, height}</div></li><li><code>height</code> : Number<div class="sub-desc">The new height to set (not required if a size object is passed as the first arg)</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#setSize" href="output/Ext.BoxComponent.html#setSize">BoxComponent</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-setTitle"></a>\r
- <b>setTitle</b>( <code>String title</code>, <span class="optional" title="Optional">[<code>String iconCls</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Sets the title text for the panel and optionally the icon class.
-In order to be able to set the title, a header eleme...</div>\r
- <div class="long">\r
- <p>Sets the title text for the panel and optionally the icon class.</p>
+which this component will be inserted (defaults to appending to the end of the container)</div></li></ul><strong>Returns:</strong><ul><li>void</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.util.Observable-resumeEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-resumeEvents">resumeEvents</a></b>()
+ :
+ void<div class="mdesc"><div class="short">Resume firing events. (see suspendEvents)
+If events were suspended using the queueSuspended parameter, then all
+event...</div><div class="long">Resume firing events. (see <a href="output/Ext.util.Observable.html#Ext.util.Observable-suspendEvents" ext:member="suspendEvents" ext:cls="Ext.util.Observable">suspendEvents</a>)
+If events were suspended using the <tt><b>queueSuspended</b></tt> parameter, then all
+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> )
+ :
+ 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
+(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> )
+ :
+ 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>Mixed height</code> )
+ :
+ 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> : Mixed<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">defaultUnit</a>s (by default, pixels).</li>
+<li>A String used to set the CSS height style.</li>
+<li><i>undefined</i> to leave the height unchanged.</li>
+</ul></div></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#setHeight" ext:member="#setHeight" 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.Panel-setIconClass"></a><b><a href="source/Panel.html#method-Ext.Panel-setIconClass">setIconClass</a></b>( <code>String cls</code> )
+ :
+ void<div class="mdesc"><div class="short">Sets the CSS class that provides the icon image for this panel. This method will replace any existing
+icon class if ...</div><div class="long">Sets the CSS class that provides the icon image for this panel. This method will replace any existing
+icon class if one has already been set and fire the <a href="output/Ext.Panel.html#Ext.Panel-iconchange" ext:member="iconchange" ext:cls="Ext.Panel">iconchange</a> event after completion.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>cls</code> : String<div class="sub-desc">The new CSS class name</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Panel.html#setIconClass" ext:member="#setIconClass" 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.BoxComponent-setPagePosition"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-setPagePosition">setPagePosition</a></b>( <code>Number x</code>, <code>Number y</code> )
+ :
+ Ext.BoxComponent<div class="mdesc"><div class="short">Sets the page XY position of the component. To set the left and top instead, use setPosition.
+This method fires the ...</div><div class="long">Sets the page XY position of the component. To set the left and top instead, use <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-setPosition" ext:member="setPosition" ext:cls="Ext.BoxComponent">setPosition</a>.
+This method fires the <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-move" ext:member="move" ext:cls="Ext.BoxComponent">move</a> event.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>x</code> : Number<div class="sub-desc">The new x position</div></li><li><code>y</code> : Number<div class="sub-desc">The new y position</div></li></ul><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#setPagePosition" ext:member="#setPagePosition" 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-setPosition"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-setPosition">setPosition</a></b>( <code>Number left</code>, <code>Number top</code> )
+ :
+ Ext.BoxComponent<div class="mdesc"><div class="short">Sets the left and top of the component. To set the page XY position instead, use setPagePosition.
+This method fires ...</div><div class="long">Sets the left and top of the component. To set the page XY position instead, use <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-setPagePosition" ext:member="setPagePosition" ext:cls="Ext.BoxComponent">setPagePosition</a>.
+This method fires the <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-move" ext:member="move" ext:cls="Ext.BoxComponent">move</a> event.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>left</code> : Number<div class="sub-desc">The new left</div></li><li><code>top</code> : Number<div class="sub-desc">The new top</div></li></ul><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#setPosition" ext:member="#setPosition" 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-setRootNode"></a><b><a href="source/TreePanel.html#method-Ext.tree.TreePanel-setRootNode">setRootNode</a></b>( <code>Node node</code> )
+ :
+ Node<div class="mdesc"><div class="short">Sets the root node for this tree. If the TreePanel has already rendered a root node, the
+previous root node (and all ...</div><div class="long">Sets the root node for this tree. If the TreePanel has already rendered a root node, the
+previous root node (and all of its descendants) are destroyed before the new root node is rendered.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>node</code> : Node<div class="sub-desc"></div></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 inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-setSize"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-setSize">setSize</a></b>( <code>Mixed width</code>, <code>Mixed height</code> )
+ :
+ Ext.BoxComponent<div class="mdesc"><div class="short">Sets the width and height of this BoxComponent. This method fires the resize event. This method can accept
+either wid...</div><div class="long">Sets the width and height of this BoxComponent. This method fires the <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-resize" ext:member="resize" ext:cls="Ext.BoxComponent">resize</a> event. This method can accept
+either width and height as separate arguments, or you can pass a size object like <code>{width:10, height:20}</code>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>width</code> : Mixed<div class="sub-desc">The new width to set. This may be one of:<div class="mdetail-params"><ul>
+<li>A Number specifying the new width 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>
+<li>A String used to set the CSS width style.</li>
+<li>A size object in the format <code>{width: widthValue, height: heightValue}</code>.</li>
+<li><code>undefined</code> to leave the width unchanged.</li>
+</ul></div></div></li><li><code>height</code> : Mixed<div class="sub-desc">The new height to set (not required if a size object is passed as the first arg).
+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>
+<li>A String used to set the CSS height style. Animation may <b>not</b> be used.</li>
+<li><code>undefined</code> to leave the height unchanged.</li>
+</ul></div></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#setSize" ext:member="#setSize" 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.Panel-setTitle"></a><b><a href="source/Panel.html#method-Ext.Panel-setTitle">setTitle</a></b>( <code>String title</code>, <span title="Optional" class="optional">[<code>String iconCls</code>]</span> )
+ :
+ void<div class="mdesc"><div class="short">Sets the title text for the panel and optionally the icon class.
+In order to be able to set the title, a header eleme...</div><div class="long"><p>Sets the title text for the panel and optionally the <a href="output/Ext.Panel.html#Ext.Panel-iconCls" ext:member="iconCls" ext:cls="Ext.Panel">icon class</a>.</p>
<p>In order to be able to set the title, a header element must have been created
-for the Panel. This is triggered either by configuring the Panel with a non-blank title,
-or configuring it with <tt><b><a ext:cls="Ext.Panel" ext:member="header" href="output/Ext.Panel.html#header">header</a>: true</b></tt>.</p> <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>title</code> : String<div class="sub-desc">The title text to set</div></li><li><code>iconCls</code> : String<div class="sub-desc">(optional) iconCls A user-defined CSS class that provides the icon image for this panel</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#setTitle" href="output/Ext.Panel.html#setTitle">Panel</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-setVisible"></a>\r
- <b>setVisible</b>( <code>Boolean visible</code> ) : Ext.Component <div class="mdesc">\r
- <div class="short">Convenience function to hide or show this component by boolean.</div>\r
- <div class="long">\r
- Convenience function to hide or show this component by boolean. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>visible</code> : Boolean<div class="sub-desc">True to show, false to hide</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Component</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#setVisible" href="output/Ext.Component.html#setVisible">Component</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-setWidth"></a>\r
- <b>setWidth</b>( <code>Number width</code> ) : Ext.BoxComponent <div class="mdesc">\r
- <div class="short">Sets the width of the component. This method fires the <a ext:cls="Ext.BoxComponent" ext:member="resize" href="output/Ext.BoxComponent.html#resize">resize</a> event.</div>\r
- <div class="long">\r
- Sets the width of the component. This method fires the <a ext:cls="Ext.BoxComponent" ext:member="resize" href="output/Ext.BoxComponent.html#resize">resize</a> event. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>width</code> : Number<div class="sub-desc">The new width to set</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#setWidth" href="output/Ext.BoxComponent.html#setWidth">BoxComponent</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-show"></a>\r
- <b>show</b>() : Ext.Component <div class="mdesc">\r
- <div class="short">Show this component.</div>\r
- <div class="long">\r
- Show this component. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Component</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#show" href="output/Ext.Component.html#show">Component</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-suspendEvents"></a>\r
- <b>suspendEvents</b>() : void <div class="mdesc">\r
- <div class="short">Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>)</div>\r
- <div class="long">\r
- Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>) <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-syncSize"></a>\r
- <b>syncSize</b>() : Ext.BoxComponent <div class="mdesc">\r
- <div class="short">Force the component's size to recalculate based on the underlying element's current height and width.</div>\r
- <div class="long">\r
- Force the component's size to recalculate based on the underlying element's current height and width. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#syncSize" href="output/Ext.BoxComponent.html#syncSize">BoxComponent</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-toggleCollapse"></a>\r
- <b>toggleCollapse</b>( <code>Boolean animate</code> ) : Ext.Panel <div class="mdesc">\r
- <div class="short">Shortcut for performing an <a ext:cls="Ext.Panel" ext:member="expand" href="output/Ext.Panel.html#expand">expand</a> or <a ext:cls="Ext.Panel" ext:member="collapse" href="output/Ext.Panel.html#collapse">collapse</a> based on the current state of the panel.</div>\r
- <div class="long">\r
- Shortcut for performing an <a ext:cls="Ext.Panel" ext:member="expand" href="output/Ext.Panel.html#expand">expand</a> or <a ext:cls="Ext.Panel" ext:member="collapse" href="output/Ext.Panel.html#collapse">collapse</a> based on the current state of the panel. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>animate</code> : Boolean<div class="sub-desc">True to animate the transition, else false (defaults to the value of the
-<a ext:cls="Ext.Panel" ext:member="animCollapse" href="output/Ext.Panel.html#animCollapse">animCollapse</a> panel config)</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Panel</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#toggleCollapse" href="output/Ext.Panel.html#toggleCollapse">Panel</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-un"></a>\r
- <b>un</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Removes a listener (shorthand for removeListener)</div>\r
- <div class="long">\r
- Removes a listener (shorthand for removeListener) <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-updateBox"></a>\r
- <b>updateBox</b>( <code>Object box</code> ) : Ext.BoxComponent <div class="mdesc">\r
- <div class="short">Sets the current box measurements of the component's underlying element.</div>\r
- <div class="long">\r
- Sets the current box measurements of the component's underlying element. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>box</code> : Object<div class="sub-desc">An object in the format {x, y, width, height}</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#updateBox" href="output/Ext.BoxComponent.html#updateBox">BoxComponent</a></td>\r
- </tr>\r
- </table>
- <a id="Ext.tree.TreePanel-events"></a>
- <h2>Public Events</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Event</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="event-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-activate"></a>\r
- <b>activate</b> : ( <code>Ext.Panel p</code> ) <div class="mdesc">\r
- <div class="short">Fires after the Panel has been visually activated.
-Note that Panels do not directly support being activated, but some...</div>\r
- <div class="long">\r
- Fires after the Panel has been visually activated.
+for the Panel. This is triggered either by configuring the Panel with a non-blank <code><a href="output/Ext.Panel.html#Ext.Panel-title" ext:member="title" ext:cls="Ext.Panel">title</a></code>,
+or configuring it with <code><b><a href="output/Ext.Panel.html#Ext.Panel-header" ext:member="header" ext:cls="Ext.Panel">header</a>: true</b></code>.</p><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>title</code> : String<div class="sub-desc">The title text to set</div></li><li><code>iconCls</code> : String<div class="sub-desc">(optional) <a href="output/Ext.Panel.html#Ext.Panel-iconCls" ext:member="iconCls" ext:cls="Ext.Panel">iconCls</a> A user-defined CSS class that provides the icon image for this panel</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Panel.html#setTitle" ext:member="#setTitle" 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-setVisible"></a><b><a href="source/Component.html#method-Ext.Component-setVisible">setVisible</a></b>( <code>Boolean visible</code> )
+ :
+ Ext.Component<div class="mdesc"><div class="short">Convenience function to hide or show this component by boolean.</div><div class="long">Convenience function to hide or show this component by boolean.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>visible</code> : Boolean<div class="sub-desc">True to show, false to hide</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#setVisible" ext:member="#setVisible" 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-setWidth"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-setWidth">setWidth</a></b>( <code>Mixed width</code> )
+ :
+ Ext.BoxComponent<div class="mdesc"><div class="short">Sets the width of the component. This method fires the resize event.</div><div class="long">Sets the width 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>width</code> : Mixed<div class="sub-desc">The new width to set. This may be one of:<div class="mdetail-params"><ul>
+<li>A Number specifying the new width 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">defaultUnit</a>s (by default, pixels).</li>
+<li>A String used to set the CSS width style.</li>
+</ul></div></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#setWidth" ext:member="#setWidth" 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.Component-show"></a><b><a href="source/Component.html#method-Ext.Component-show">show</a></b>()
+ :
+ Ext.Component<div class="mdesc"><div class="short">Show this component. Listen to the 'beforeshow' event and return
+false to cancel showing the component. Fires the '...</div><div class="long">Show this component. Listen to the '<a href="output/Ext.Component.html#Ext.Component-beforeshow" ext:member="beforeshow" ext:cls="Ext.Component">beforeshow</a>' event and return
+<tt>false</tt> to cancel showing the component. Fires the '<a href="output/Ext.Component.html#Ext.Component-show" ext:member="show" ext:cls="Ext.Component">show</a>'
+event after showing the component.<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">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#show" ext:member="#show" 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-suspendEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-suspendEvents">suspendEvents</a></b>( <code>Boolean queueSuspended</code> )
+ :
+ void<div class="mdesc"><div class="short">Suspend the firing of all events. (see resumeEvents)</div><div class="long">Suspend the firing of all events. (see <a href="output/Ext.util.Observable.html#Ext.util.Observable-resumeEvents" ext:member="resumeEvents" ext:cls="Ext.util.Observable">resumeEvents</a>)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>queueSuspended</code> : Boolean<div class="sub-desc">Pass as true to queue up suspended events to be fired
+after the <a href="output/Ext.util.Observable.html#Ext.util.Observable-resumeEvents" ext:member="resumeEvents" ext:cls="Ext.util.Observable">resumeEvents</a> call instead of discarding all suspended events;</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#suspendEvents" ext:member="#suspendEvents" 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-syncSize"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-syncSize">syncSize</a></b>()
+ :
+ Ext.BoxComponent<div class="mdesc"><div class="short">Force the component's size to recalculate based on the underlying element's current height and width.</div><div class="long">Force the component's size to recalculate based on the underlying element's current height and width.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</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#syncSize" ext:member="#syncSize" 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.Panel-toggleCollapse"></a><b><a href="source/Panel.html#method-Ext.Panel-toggleCollapse">toggleCollapse</a></b>( <code>Boolean animate</code> )
+ :
+ 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> )
+ :
+ 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> )
+ :
+ 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> )
+ :
+ 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> :
+ ( <code>Ext.Panel p</code> )
+ <div class="mdesc"><div class="short">Fires after the Panel has been visually activated.
+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 ext:cls="Ext.Window" href="output/Ext.Window.html">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">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>p</code> : Ext.Panel<div class="sub-desc">The Panel that has been activated.</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#event-activate" href="output/Ext.Panel.html#event-activate">Panel</a></td>\r
- </tr>\r
- <tr class="event-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-add"></a>\r
- <b>add</b> : ( <code>Ext.Container this</code>, <code>Ext.Component component</code>, <code>Number index</code> ) <div class="mdesc">\r
- <div class="short">Fires after any <a ext:cls="Ext.Component" href="output/Ext.Component.html">Ext.Component</a> is added or inserted into the container.</div>\r
- <div class="long">\r
- Fires after any <a ext:cls="Ext.Component" href="output/Ext.Component.html">Ext.Component</a> is added or inserted into the container. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : Ext.Container<div class="sub-desc"></div></li><li><code>component</code> : Ext.Component<div class="sub-desc">The component that was added</div></li><li><code>index</code> : Number<div class="sub-desc">The index at which the component was added to the container's items collection</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Container" ext:member="#event-add" href="output/Ext.Container.html#event-add">Container</a></td>\r
- </tr>\r
- <tr class="event-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-afterlayout"></a>\r
- <b>afterlayout</b> : ( <code>Ext.Container this</code>, <code>ContainerLayout layout</code> ) <div class="mdesc">\r
- <div class="short">Fires when the components in this container are arranged by the associated layout manager.</div>\r
- <div class="long">\r
- Fires when the components in this container are arranged by the associated layout manager. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <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>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Container" ext:member="#event-afterlayout" href="output/Ext.Container.html#event-afterlayout">Container</a></td>\r
- </tr>\r
- <tr class="event-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-append"></a>\r
- <b>append</b> : ( <code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code>, <code>Number index</code> ) <div class="mdesc">\r
- <div class="short">Fires when a new child node is appended to a node in this tree.</div>\r
- <div class="long">\r
- Fires when a new child node is appended to a node in this tree. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>parent</code> : Node<div class="sub-desc">The parent node</div></li><li><code>node</code> : Node<div class="sub-desc">The newly appended node</div></li><li><code>index</code> : Number<div class="sub-desc">The index of the newly appended node</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="event-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-beforeadd"></a>\r
- <b>beforeadd</b> : ( <code>Ext.Container this</code>, <code>Ext.Component component</code>, <code>Number index</code> ) <div class="mdesc">\r
- <div class="short">Fires before any <a ext:cls="Ext.Component" href="output/Ext.Component.html">Ext.Component</a> is added or inserted into the container.
-A handler can return false to cancel the add.</div>\r
- <div class="long">\r
- Fires before any <a ext:cls="Ext.Component" href="output/Ext.Component.html">Ext.Component</a> is added or inserted into the container.
-A handler can return false to cancel the add. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : Ext.Container<div class="sub-desc"></div></li><li><code>component</code> : Ext.Component<div class="sub-desc">The component being added</div></li><li><code>index</code> : Number<div class="sub-desc">The index at which the component will be added to the container's items collection</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Container" ext:member="#event-beforeadd" href="output/Ext.Container.html#event-beforeadd">Container</a></td>\r
- </tr>\r
- <tr class="event-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-beforeappend"></a>\r
- <b>beforeappend</b> : ( <code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code> ) <div class="mdesc">\r
- <div class="short">Fires before a new child is appended to a node in this tree, return false to cancel the append.</div>\r
- <div class="long">\r
- Fires before a new child is appended to a node in this tree, return false to cancel the append. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>parent</code> : Node<div class="sub-desc">The parent node</div></li><li><code>node</code> : Node<div class="sub-desc">The child node to be appended</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="event-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-beforechildrenrendered"></a>\r
- <b>beforechildrenrendered</b> : ( <code>Node node</code> ) <div class="mdesc">\r
- <div class="short">Fires right before the child nodes for a node are rendered</div>\r
- <div class="long">\r
- Fires right before the child nodes for a node are rendered <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>node</code> : Node<div class="sub-desc">The node</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="event-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-beforeclick"></a>\r
- <b>beforeclick</b> : ( <code>Node node</code>, <code>Ext.EventObject e</code> ) <div class="mdesc">\r
- <div class="short">Fires before click processing on a node. Return false to cancel the default action.</div>\r
- <div class="long">\r
- Fires before click processing on a node. Return false to cancel the default action. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>node</code> : Node<div class="sub-desc">The node</div></li><li><code>e</code> : Ext.EventObject<div class="sub-desc">The event object</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="event-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-beforeclose"></a>\r
- <b>beforeclose</b> : ( <code>Ext.Panel p</code> ) <div class="mdesc">\r
- <div class="short">Fires before the Panel is closed. Note that Panels do not directly support being closed, but some
-Panel subclasses d...</div>\r
- <div class="long">\r
- Fires before the Panel is closed. Note that Panels do not directly support being closed, but some
-Panel subclasses do (like <a ext:cls="Ext.Window" href="output/Ext.Window.html">Ext.Window</a>). This event only applies to such subclasses.
-A handler can return false to cancel the close. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>p</code> : Ext.Panel<div class="sub-desc">The Panel being closed.</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#event-beforeclose" href="output/Ext.Panel.html#event-beforeclose">Panel</a></td>\r
- </tr>\r
- <tr class="event-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-beforecollapse"></a>\r
- <b>beforecollapse</b> : ( <code>Ext.Panel p</code>, <code>Boolean animate</code> ) <div class="mdesc">\r
- <div class="short">Fires before the Panel is collapsed. A handler can return false to cancel the collapse.</div>\r
- <div class="long">\r
- Fires before the Panel is collapsed. A handler can return false to cancel the collapse. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>p</code> : Ext.Panel<div class="sub-desc">the Panel being collapsed.</div></li><li><code>animate</code> : Boolean<div class="sub-desc">True if the collapse is animated, else false.</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#event-beforecollapse" href="output/Ext.Panel.html#event-beforecollapse">Panel</a></td>\r
- </tr>\r
- <tr class="event-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-beforecollapsenode"></a>\r
- <b>beforecollapsenode</b> : ( <code>Node node</code>, <code>Boolean deep</code>, <code>Boolean anim</code> ) <div class="mdesc">\r
- <div class="short">Fires before a node is collapsed, return false to cancel.</div>\r
- <div class="long">\r
- Fires before a node is collapsed, return false to cancel. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>node</code> : Node<div class="sub-desc">The node</div></li><li><code>deep</code> : Boolean<div class="sub-desc"></div></li><li><code>anim</code> : Boolean<div class="sub-desc"></div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="event-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-beforedestroy"></a>\r
- <b>beforedestroy</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">\r
- <div class="short">Fires before the component is destroyed. Return false to stop the destroy.</div>\r
- <div class="long">\r
- Fires before the component is destroyed. Return false to stop the destroy. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-beforedestroy" href="output/Ext.Component.html#event-beforedestroy">Component</a></td>\r
- </tr>\r
- <tr class="event-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-beforeexpand"></a>\r
- <b>beforeexpand</b> : ( <code>Ext.Panel p</code>, <code>Boolean animate</code> ) <div class="mdesc">\r
- <div class="short">Fires before the Panel is expanded. A handler can return false to cancel the expand.</div>\r
- <div class="long">\r
- Fires before the Panel is expanded. A handler can return false to cancel the expand. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>p</code> : Ext.Panel<div class="sub-desc">The Panel being expanded.</div></li><li><code>animate</code> : Boolean<div class="sub-desc">True if the expand is animated, else false.</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#event-beforeexpand" href="output/Ext.Panel.html#event-beforeexpand">Panel</a></td>\r
- </tr>\r
- <tr class="event-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-beforeexpandnode"></a>\r
- <b>beforeexpandnode</b> : ( <code>Node node</code>, <code>Boolean deep</code>, <code>Boolean anim</code> ) <div class="mdesc">\r
- <div class="short">Fires before a node is expanded, return false to cancel.</div>\r
- <div class="long">\r
- Fires before a node is expanded, return false to cancel. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>node</code> : Node<div class="sub-desc">The node</div></li><li><code>deep</code> : Boolean<div class="sub-desc"></div></li><li><code>anim</code> : Boolean<div class="sub-desc"></div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="event-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-beforehide"></a>\r
- <b>beforehide</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">\r
- <div class="short">Fires before the component is hidden. Return false to stop the hide.</div>\r
- <div class="long">\r
- Fires before the component is hidden. Return false to stop the hide. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-beforehide" href="output/Ext.Component.html#event-beforehide">Component</a></td>\r
- </tr>\r
- <tr class="event-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-beforeinsert"></a>\r
- <b>beforeinsert</b> : ( <code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code>, <code>Node refNode</code> ) <div class="mdesc">\r
- <div class="short">Fires before a new child is inserted in a node in this tree, return false to cancel the insert.</div>\r
- <div class="long">\r
- Fires before a new child is inserted in a node in this tree, return false to cancel the insert. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>parent</code> : Node<div class="sub-desc">The parent node</div></li><li><code>node</code> : Node<div class="sub-desc">The child node to be inserted</div></li><li><code>refNode</code> : Node<div class="sub-desc">The child node the node is being inserted before</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="event-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-beforeload"></a>\r
- <b>beforeload</b> : ( <code>Node node</code> ) <div class="mdesc">\r
- <div class="short">Fires before a node is loaded, return false to cancel</div>\r
- <div class="long">\r
- Fires before a node is loaded, return false to cancel <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>node</code> : Node<div class="sub-desc">The node being loaded</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="event-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-beforemovenode"></a>\r
- <b>beforemovenode</b> : ( <code>Tree tree</code>, <code>Node node</code>, <code>Node oldParent</code>, <code>Node newParent</code>, <code>Number index</code> ) <div class="mdesc">\r
- <div class="short">Fires before a node is moved to a new location in the tree. Return false to cancel the move.</div>\r
- <div class="long">\r
- Fires before a node is moved to a new location in the tree. Return false to cancel the move. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>node</code> : Node<div class="sub-desc">The node being moved</div></li><li><code>oldParent</code> : Node<div class="sub-desc">The parent of the node</div></li><li><code>newParent</code> : Node<div class="sub-desc">The new parent the node is moving to</div></li><li><code>index</code> : Number<div class="sub-desc">The index it is being moved to</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="event-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-beforenodedrop"></a>\r
- <b>beforenodedrop</b> : ( <code>Object dropEvent</code> ) <div class="mdesc">\r
- <div class="short">Fires when a DD object is dropped on a node in this tree for preprocessing. Return false to cancel the drop. The drop...</div>\r
- <div class="long">\r
- Fires when a DD object is dropped on a node in this tree for preprocessing. Return false to cancel the drop. The dropEvent
+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.Component-added"></a><b><a href="source/Component.html#event-Ext.Component-added">added</a></b> :
+ ( <code>Ext.Component this</code>, <code>Ext.Container ownerCt</code>, <code>number index</code> )
+ <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> :
+ ( <code>Ext.Container this</code>, <code>ContainerLayout layout</code> )
+ <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> :
+ ( <code>Ext.Component this</code> )
+ <div class="mdesc"><div class="short">Fires after the component rendering is finished.
+The afterrender event is fired after this Component has been rendere...</div><div class="long"><p>Fires after the component rendering is finished.</p>
+<p>The afterrender event is fired after this Component has been <a href="output/Ext.Component.html#Ext.Component-rendered" ext:member="rendered" ext:cls="Ext.Component">rendered</a>, been postprocesed
+by any afterRender method defined for the Component, and, if <a href="output/Ext.Component.html#Ext.Component-stateful" ext:member="stateful" ext:cls="Ext.Component">stateful</a>, after state
+has been restored.</p><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#afterrender" ext:member="#afterrender" 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-append"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-append">append</a></b> :
+ ( <code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code>, <code>Number index</code> )
+ <div class="mdesc"><div class="short">Fires when a new child node is appended to a node in this tree.</div><div class="long">Fires when a new child node is appended to 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 newly appended node</div></li><li><code>index</code> : Number<div class="sub-desc">The index of the newly appended 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-beforeappend"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-beforeappend">beforeappend</a></b> :
+ ( <code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code> )
+ <div class="mdesc"><div class="short">Fires before a new child is appended to a node in this tree, return false to cancel the append.</div><div class="long">Fires before a new child is appended to a node in this tree, return false to cancel the append.<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 appended</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-beforechildrenrendered"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-beforechildrenrendered">beforechildrenrendered</a></b> :
+ ( <code>Node node</code> )
+ <div class="mdesc"><div class="short">Fires right before the child nodes for a node are rendered</div><div class="long">Fires right before the child nodes for a node are rendered<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-beforeclick"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-beforeclick">beforeclick</a></b> :
+ ( <code>Node node</code>, <code>Ext.EventObject e</code> )
+ <div class="mdesc"><div class="short">Fires before click processing on a node. Return false to cancel the default action.</div><div class="long">Fires before click processing on a node. Return false to cancel the default action.<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><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 inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Panel-beforeclose"></a><b><a href="source/Panel.html#event-Ext.Panel-beforeclose">beforeclose</a></b> :
+ ( <code>Ext.Panel p</code> )
+ <div class="mdesc"><div class="short">Fires before the Panel is closed. Note that Panels do not directly support being closed, but some
+Panel subclasses d...</div><div class="long">Fires before the Panel is closed. Note that Panels do not directly support being closed, but some
+Panel subclasses do (like <a href="output/Ext.Window.html" ext:cls="Ext.Window">Ext.Window</a>) or a Panel within a Ext.TabPanel. This event only
+applies to such subclasses.
+A handler can return false to cancel the close.<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 being closed.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Panel.html#beforeclose" ext:member="#beforeclose" 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.Panel-beforecollapse"></a><b><a href="source/Panel.html#event-Ext.Panel-beforecollapse">beforecollapse</a></b> :
+ ( <code>Ext.Panel p</code>, <code>Boolean animate</code> )
+ <div class="mdesc"><div class="short">Fires before the Panel is collapsed. A handler can return false to cancel the collapse.</div><div class="long">Fires before the Panel is collapsed. A handler can return false to cancel the collapse.<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 being collapsed.</div></li><li><code>animate</code> : Boolean<div class="sub-desc">True if the collapse is animated, else false.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Panel.html#beforecollapse" ext:member="#beforecollapse" 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-beforecollapsenode"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-beforecollapsenode">beforecollapsenode</a></b> :
+ ( <code>Node node</code>, <code>Boolean deep</code>, <code>Boolean anim</code> )
+ <div class="mdesc"><div class="short">Fires before a node is collapsed, return false to cancel.</div><div class="long">Fires before a node is collapsed, return false to cancel.<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><li><code>deep</code> : Boolean<div class="sub-desc"></div></li><li><code>anim</code> : Boolean<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-beforedblclick"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-beforedblclick">beforedblclick</a></b> :
+ ( <code>Node node</code>, <code>Ext.EventObject e</code> )
+ <div class="mdesc"><div class="short">Fires before double click processing on a node. Return false to cancel the default action.</div><div class="long">Fires before double click processing on a node. Return false to cancel the default action.<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><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 inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-beforedestroy"></a><b><a href="source/Component.html#event-Ext.Component-beforedestroy">beforedestroy</a></b> :
+ ( <code>Ext.Component this</code> )
+ <div class="mdesc"><div class="short">Fires before the component is destroyed. Return false from an event handler to stop the destroy.</div><div class="long">Fires before the component is <a href="output/Ext.Component.html#Ext.Component-destroy" ext:member="destroy" ext:cls="Ext.Component">destroy</a>ed. Return false from an event handler to stop the <a href="output/Ext.Component.html#Ext.Component-destroy" ext:member="destroy" ext:cls="Ext.Component">destroy</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#beforedestroy" ext:member="#beforedestroy" 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-beforeexpand"></a><b><a href="source/Panel.html#event-Ext.Panel-beforeexpand">beforeexpand</a></b> :
+ ( <code>Ext.Panel p</code>, <code>Boolean animate</code> )
+ <div class="mdesc"><div class="short">Fires before the Panel is expanded. A handler can return false to cancel the expand.</div><div class="long">Fires before the Panel is expanded. A handler can return false to cancel the expand.<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 being expanded.</div></li><li><code>animate</code> : Boolean<div class="sub-desc">True if the expand is animated, else false.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Panel.html#beforeexpand" ext:member="#beforeexpand" 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-beforeexpandnode"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-beforeexpandnode">beforeexpandnode</a></b> :
+ ( <code>Node node</code>, <code>Boolean deep</code>, <code>Boolean anim</code> )
+ <div class="mdesc"><div class="short">Fires before a node is expanded, return false to cancel.</div><div class="long">Fires before a node is expanded, return false to cancel.<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><li><code>deep</code> : Boolean<div class="sub-desc"></div></li><li><code>anim</code> : Boolean<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-beforehide"></a><b><a href="source/Component.html#event-Ext.Component-beforehide">beforehide</a></b> :
+ ( <code>Ext.Component this</code> )
+ <div class="mdesc"><div class="short">Fires before the component is hidden by calling the hide method.
+Return false from an event handler to stop the hide.</div><div class="long">Fires before the component is hidden by calling the <a href="output/Ext.Component.html#Ext.Component-hide" ext:member="hide" ext:cls="Ext.Component">hide</a> method.
+Return false from an event handler to stop the hide.<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#beforehide" ext:member="#beforehide" 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-beforeinsert"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-beforeinsert">beforeinsert</a></b> :
+ ( <code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code>, <code>Node refNode</code> )
+ <div class="mdesc"><div class="short">Fires before a new child is inserted in a node in this tree, return false to cancel the insert.</div><div class="long">Fires before a new child is inserted in a node in this tree, return false to cancel the insert.<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 inserted</div></li><li><code>refNode</code> : Node<div class="sub-desc">The child node the node is being inserted before</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-beforeload"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-beforeload">beforeload</a></b> :
+ ( <code>Node node</code> )
+ <div class="mdesc"><div class="short">Fires before a node is loaded, return false to cancel</div><div class="long">Fires before a node is loaded, return false to cancel<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 being loaded</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-beforemovenode"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-beforemovenode">beforemovenode</a></b> :
+ ( <code>Tree tree</code>, <code>Node node</code>, <code>Node oldParent</code>, <code>Node newParent</code>, <code>Number index</code> )
+ <div class="mdesc"><div class="short">Fires before a node is moved to a new location in the tree. Return false to cancel the move.</div><div class="long">Fires before a node is moved to a new location in the tree. Return false to cancel the move.<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>node</code> : Node<div class="sub-desc">The node being moved</div></li><li><code>oldParent</code> : Node<div class="sub-desc">The parent of the node</div></li><li><code>newParent</code> : Node<div class="sub-desc">The new parent the node is moving to</div></li><li><code>index</code> : Number<div class="sub-desc">The index it is being moved to</div></li></ul></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-beforenodedrop"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-beforenodedrop">beforenodedrop</a></b> :
+ ( <code>Object dropEvent</code> )
+ <div class="mdesc"><div class="short">Fires when a DD object is dropped on a node in this tree for preprocessing. Return false to cancel the drop. The drop...</div><div class="long">Fires when a DD object is dropped on a node in this tree for preprocessing. Return false to cancel the drop. The dropEvent
passed to handlers has the following properties:<br />
<ul style="padding:5px;padding-left:16px;">
<li>tree - The TreePanel</li>
to be inserted by setting them on this object.</li>
<li>cancel - Set this to true to cancel the drop.</li>
<li>dropStatus - If the default drop action is cancelled but the drop is valid, setting this to true
-will prevent the animated "repair" from appearing.</li>
-</ul> <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>dropEvent</code> : Object<div class="sub-desc"></div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="event-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-beforeremove"></a>\r
- <b>beforeremove</b> : ( <code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code> ) <div class="mdesc">\r
- <div class="short">Fires before a child is removed from a node in this tree, return false to cancel the remove.</div>\r
- <div class="long">\r
- Fires before a child is removed from a node in this tree, return false to cancel the remove. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <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>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="event-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-beforerender"></a>\r
- <b>beforerender</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">\r
- <div class="short">Fires before the component is rendered. Return false to stop the render.</div>\r
- <div class="long">\r
- Fires before the component is rendered. Return false to stop the render. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-beforerender" href="output/Ext.Component.html#event-beforerender">Component</a></td>\r
- </tr>\r
- <tr class="event-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-beforeshow"></a>\r
- <b>beforeshow</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">\r
- <div class="short">Fires before the component is shown. Return false to stop the show.</div>\r
- <div class="long">\r
- Fires before the component is shown. Return false to stop the show. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-beforeshow" href="output/Ext.Component.html#event-beforeshow">Component</a></td>\r
- </tr>\r
- <tr class="event-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-beforestaterestore"></a>\r
- <b>beforestaterestore</b> : ( <code>Ext.Component this</code>, <code>Object state</code> ) <div class="mdesc">\r
- <div class="short">Fires before the state of the component is restored. Return false to stop the restore.</div>\r
- <div class="long">\r
- Fires before the state of the component is restored. Return false to stop the restore. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>state</code> : Object<div class="sub-desc">The hash of state values</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-beforestaterestore" href="output/Ext.Component.html#event-beforestaterestore">Component</a></td>\r
- </tr>\r
- <tr class="event-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-beforestatesave"></a>\r
- <b>beforestatesave</b> : ( <code>Ext.Component this</code>, <code>Object state</code> ) <div class="mdesc">\r
- <div class="short">Fires before the state of the component is saved to the configured state provider. Return false to stop the save.</div>\r
- <div class="long">\r
- Fires before the state of the component is saved to the configured state provider. Return false to stop the save. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>state</code> : Object<div class="sub-desc">The hash of state values</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-beforestatesave" href="output/Ext.Component.html#event-beforestatesave">Component</a></td>\r
- </tr>\r
- <tr class="event-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-bodyresize"></a>\r
- <b>bodyresize</b> : ( <code>Ext.Panel p</code>, <code>Number width</code>, <code>Number height</code> ) <div class="mdesc">\r
- <div class="short">Fires after the Panel has been resized.</div>\r
- <div class="long">\r
- Fires after the Panel has been resized. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>p</code> : Ext.Panel<div class="sub-desc">the Panel which has been resized.</div></li><li><code>width</code> : Number<div class="sub-desc">The Panel's new width.</div></li><li><code>height</code> : Number<div class="sub-desc">The Panel's new height.</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#event-bodyresize" href="output/Ext.Panel.html#event-bodyresize">Panel</a></td>\r
- </tr>\r
- <tr class="event-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-checkchange"></a>\r
- <b>checkchange</b> : ( <code>Node this</code>, <code>Boolean checked</code> ) <div class="mdesc">\r
- <div class="short">Fires when a node with a checkbox's checked property changes</div>\r
- <div class="long">\r
- Fires when a node with a checkbox's checked property changes <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : Node<div class="sub-desc">This node</div></li><li><code>checked</code> : Boolean<div class="sub-desc"></div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="event-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-click"></a>\r
- <b>click</b> : ( <code>Node node</code>, <code>Ext.EventObject e</code> ) <div class="mdesc">\r
- <div class="short">Fires when a node is clicked</div>\r
- <div class="long">\r
- Fires when a node is clicked <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>node</code> : Node<div class="sub-desc">The node</div></li><li><code>e</code> : Ext.EventObject<div class="sub-desc">The event object</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="event-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-close"></a>\r
- <b>close</b> : ( <code>Ext.Panel p</code> ) <div class="mdesc">\r
- <div class="short">Fires after the Panel is closed. Note that Panels do not directly support being closed, but some
-Panel subclasses do...</div>\r
- <div class="long">\r
- Fires after the Panel is closed. Note that Panels do not directly support being closed, but some
-Panel subclasses do (like <a ext:cls="Ext.Window" href="output/Ext.Window.html">Ext.Window</a>). <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>p</code> : Ext.Panel<div class="sub-desc">The Panel that has been closed.</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#event-close" href="output/Ext.Panel.html#event-close">Panel</a></td>\r
- </tr>\r
- <tr class="event-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-collapse"></a>\r
- <b>collapse</b> : ( <code>Ext.Panel p</code> ) <div class="mdesc">\r
- <div class="short">Fires after the Panel has been collapsed.</div>\r
- <div class="long">\r
- Fires after the Panel has been collapsed. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>p</code> : Ext.Panel<div class="sub-desc">the Panel that has been collapsed.</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#event-collapse" href="output/Ext.Panel.html#event-collapse">Panel</a></td>\r
- </tr>\r
- <tr class="event-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-collapsenode"></a>\r
- <b>collapsenode</b> : ( <code>Node node</code> ) <div class="mdesc">\r
- <div class="short">Fires when a node is collapsed</div>\r
- <div class="long">\r
- Fires when a node is collapsed <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>node</code> : Node<div class="sub-desc">The node</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="event-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-contextmenu"></a>\r
- <b>contextmenu</b> : ( <code>Node node</code>, <code>Ext.EventObject e</code> ) <div class="mdesc">\r
- <div class="short">Fires when a node is right clicked. To display a context menu in response to this
-event, first create a Menu object (...</div>\r
- <div class="long">\r
- Fires when a node is right clicked. To display a context menu in response to this
-event, first create a Menu object (see <a ext:cls="Ext.menu.Menu" href="output/Ext.menu.Menu.html">Ext.menu.Menu</a> for details), then add
-a handler for this event:<code><pre>new Ext.tree.TreePanel({\r
- title: 'My TreePanel',\r
- root: new Ext.tree.AsyncTreeNode({\r
- text: 'The Root',\r
- children: [\r
- { text: 'Child node 1', leaf: true },\r
- { text: 'Child node 2', leaf: true }\r
- ]\r
- }),\r
- contextMenu: new Ext.menu.Menu({\r
- items: [{\r
- id: 'delete-node',\r
- text: 'Delete Node'\r
- }],\r
- listeners: {\r
- itemclick: function(item) {\r
- switch (item.id) {\r
- case 'delete-node':\r
- var n = item.parentMenu.contextNode;\r
- if (n.parentNode) {\r
- n.remove();\r
- }\r
- break;\r
- }\r
- }\r
- }\r
- }),\r
- listeners: {\r
- contextmenu: function(node, e) {\r
-// Register the context node with the menu so that a Menu Item's handler function can access\r
-// it via its <a ext:cls="Ext.menu.BaseItem" ext:member="parentMenu" href="output/Ext.menu.BaseItem.html#parentMenu">parentMenu</a> property.\r
- node.select();\r
- var c = node.getOwnerTree().contextMenu;\r
- c.contextNode = node;\r
- c.showAt(e.getXY());\r
- }\r
- }\r
-});</pre></code> <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>node</code> : Node<div class="sub-desc">The node</div></li><li><code>e</code> : Ext.EventObject<div class="sub-desc">The event object</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="event-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-dblclick"></a>\r
- <b>dblclick</b> : ( <code>Node node</code>, <code>Ext.EventObject e</code> ) <div class="mdesc">\r
- <div class="short">Fires when a node is double clicked</div>\r
- <div class="long">\r
- Fires when a node is double clicked <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>node</code> : Node<div class="sub-desc">The node</div></li><li><code>e</code> : Ext.EventObject<div class="sub-desc">The event object</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="event-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-deactivate"></a>\r
- <b>deactivate</b> : ( <code>Ext.Panel p</code> ) <div class="mdesc">\r
- <div class="short">Fires after the Panel has been visually deactivated.
-Note that Panels do not directly support being deactivated, but ...</div>\r
- <div class="long">\r
- Fires after the Panel has been visually deactivated.
+will prevent the animated 'repair' from appearing.</li>
+</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> :
+ ( <code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code> )
+ <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> :
+ ( <code>Ext.Component this</code> )
+ <div class="mdesc"><div class="short">Fires before the component is rendered. Return false from an
+event handler to stop the render.</div><div class="long">Fires before the component is <a href="output/Ext.Component.html#Ext.Component-rendered" ext:member="rendered" ext:cls="Ext.Component">rendered</a>. Return false from an
+event handler to stop the <a href="output/Ext.Component.html#Ext.Component-render" ext:member="render" ext:cls="Ext.Component">render</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#beforerender" ext:member="#beforerender" 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-beforeshow"></a><b><a href="source/Component.html#event-Ext.Component-beforeshow">beforeshow</a></b> :
+ ( <code>Ext.Component this</code> )
+ <div class="mdesc"><div class="short">Fires before the component is shown by calling the show method.
+Return false from an event handler to stop the show.</div><div class="long">Fires before the component is shown by calling the <a href="output/Ext.Component.html#Ext.Component-show" ext:member="show" ext:cls="Ext.Component">show</a> method.
+Return false from an event handler to stop the show.<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#beforeshow" ext:member="#beforeshow" 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-beforestaterestore"></a><b><a href="source/Component.html#event-Ext.Component-beforestaterestore">beforestaterestore</a></b> :
+ ( <code>Ext.Component this</code>, <code>Object state</code> )
+ <div class="mdesc"><div class="short">Fires before the state of the component is restored. Return false from an event handler to stop the restore.</div><div class="long">Fires before the state of the component is restored. Return false from an event handler to stop the restore.<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>state</code> : Object<div class="sub-desc">The hash of state values returned from the StateProvider. If this
+event is not vetoed, then the state object is passed to <b><tt>applyState</tt></b>. By default,
+that simply copies property values into this Component. The method maybe overriden to
+provide custom state restoration.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#beforestaterestore" ext:member="#beforestaterestore" 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-beforestatesave"></a><b><a href="source/Component.html#event-Ext.Component-beforestatesave">beforestatesave</a></b> :
+ ( <code>Ext.Component this</code>, <code>Object state</code> )
+ <div class="mdesc"><div class="short">Fires before the state of the component is saved to the configured state provider. Return false to stop the save.</div><div class="long">Fires before the state of the component is saved to the configured state provider. Return false to stop the save.<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>state</code> : Object<div class="sub-desc">The hash of state values. This is determined by calling
+<b><tt>getState()</tt></b> on the Component. This method must be provided by the
+developer to return whetever representation of state is required, by default, Ext.Component
+has a null implementation.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#beforestatesave" ext:member="#beforestatesave" 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-bodyresize"></a><b><a href="source/Panel.html#event-Ext.Panel-bodyresize">bodyresize</a></b> :
+ ( <code>Ext.Panel p</code>, <code>Number width</code>, <code>Number height</code> )
+ <div class="mdesc"><div class="short">Fires after the Panel has been resized.</div><div class="long">Fires after the Panel has been resized.<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 which has been resized.</div></li><li><code>width</code> : Number<div class="sub-desc">The Panel body's new width.</div></li><li><code>height</code> : Number<div class="sub-desc">The Panel body's new height.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Panel.html#bodyresize" ext:member="#bodyresize" 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-checkchange"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-checkchange">checkchange</a></b> :
+ ( <code>Node this</code>, <code>Boolean checked</code> )
+ <div class="mdesc"><div class="short">Fires when a node with a checkbox's checked property changes</div><div class="long">Fires when a node with a checkbox's checked property changes<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Node<div class="sub-desc">This node</div></li><li><code>checked</code> : Boolean<div class="sub-desc"></div></li></ul></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-click"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-click">click</a></b> :
+ ( <code>Node node</code>, <code>Ext.EventObject e</code> )
+ <div class="mdesc"><div class="short">Fires when a node is clicked</div><div class="long">Fires when a node is clicked<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><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 inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Panel-close"></a><b><a href="source/Panel.html#event-Ext.Panel-close">close</a></b> :
+ ( <code>Ext.Panel p</code> )
+ <div class="mdesc"><div class="short">Fires after the Panel is closed. Note that Panels do not directly support being closed, but some
+Panel subclasses do...</div><div class="long">Fires after the Panel is closed. Note that Panels do not directly support being closed, but some
+Panel subclasses do (like <a href="output/Ext.Window.html" ext:cls="Ext.Window">Ext.Window</a>) or a Panel within a Ext.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 closed.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Panel.html#close" ext:member="#close" 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.Panel-collapse"></a><b><a href="source/Panel.html#event-Ext.Panel-collapse">collapse</a></b> :
+ ( <code>Ext.Panel p</code> )
+ <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> :
+ ( <code>Node node</code> )
+ <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> :
+ ( <code>Tree this</code>, <code>Ext.EventObject e</code> )
+ <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> :
+ ( <code>Tree this</code>, <code>Ext.EventObject e</code> )
+ <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> :
+ ( <code>Tree this</code>, <code>Ext.EventObject e</code> )
+ <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> :
+ ( <code>Node node</code>, <code>Ext.EventObject e</code> )
+ <div class="mdesc"><div class="short">Fires when a node is right clicked. To display a context menu in response to this
+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
+event, first create a Menu object (see <a href="output/Ext.menu.Menu.html" ext:cls="Ext.menu.Menu">Ext.menu.Menu</a> for details), then add
+a handler for this event:<pre><code><b>new</b> Ext.tree.TreePanel({
+ title: <em>'My TreePanel'</em>,
+ root: <b>new</b> Ext.tree.AsyncTreeNode({
+ text: <em>'The Root'</em>,
+ children: [
+ { text: <em>'Child node 1'</em>, leaf: true },
+ { text: <em>'Child node 2'</em>, leaf: true }
+ ]
+ }),
+ contextMenu: <b>new</b> Ext.menu.Menu({
+ items: [{
+ id: <em>'<b>delete</b>-node'</em>,
+ text: <em>'Delete Node'</em>
+ }],
+ listeners: {
+ itemclick: <b>function</b>(item) {
+ <b>switch</b> (item.id) {
+ <b>case</b> <em>'<b>delete</b>-node'</em>:
+ <b>var</b> n = item.parentMenu.contextNode;
+ <b>if</b> (n.parentNode) {
+ n.remove();
+ }
+ <b>break</b>;
+ }
+ }
+ }
+ }),
+ listeners: {
+ contextmenu: <b>function</b>(node, e) {
+<i>// Register the context node <b>with</b> the menu so that a Menu Item<em>'s handler <b>function</b> can access</i>
+<i>// it via its <a href="output/Ext.menu.BaseItem.html#Ext.menu.BaseItem-parentMenu" ext:member="parentMenu" ext:cls="Ext.menu.BaseItem">parentMenu</a> property.</i>
+ node.select();
+ <b>var</b> c = node.getOwnerTree().contextMenu;
+ c.contextNode = node;
+ c.showAt(e.getXY());
+ }
+ }
+});</code></pre><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><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-dblclick"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-dblclick">dblclick</a></b> :
+ ( <code>Node node</code>, <code>Ext.EventObject e</code> )
+ <div class="mdesc"><div class="short">Fires when a node is double clicked</div><div class="long">Fires when a node is double clicked<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><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 inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Panel-deactivate"></a><b><a href="source/Panel.html#event-Ext.Panel-deactivate">deactivate</a></b> :
+ ( <code>Ext.Panel p</code> )
+ <div class="mdesc"><div class="short">Fires after the Panel has been visually deactivated.
+Note that Panels do not directly support being deactivated, but ...</div><div class="long">Fires after the Panel has been visually deactivated.
Note that Panels do not directly support being deactivated, but some Panel subclasses
-do (like <a ext:cls="Ext.Window" href="output/Ext.Window.html">Ext.Window</a>). Panels which are child Components of a TabPanel fire the
-activate and deactivate events under the control of the TabPanel. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>p</code> : Ext.Panel<div class="sub-desc">The Panel that has been deactivated.</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#event-deactivate" href="output/Ext.Panel.html#event-deactivate">Panel</a></td>\r
- </tr>\r
- <tr class="event-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-destroy"></a>\r
- <b>destroy</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">\r
- <div class="short">Fires after the component is destroyed.</div>\r
- <div class="long">\r
- Fires after the component is destroyed. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-destroy" href="output/Ext.Component.html#event-destroy">Component</a></td>\r
- </tr>\r
- <tr class="event-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-disable"></a>\r
- <b>disable</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">\r
- <div class="short">Fires after the component is disabled.</div>\r
- <div class="long">\r
- Fires after the component is disabled. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-disable" href="output/Ext.Component.html#event-disable">Component</a></td>\r
- </tr>\r
- <tr class="event-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-disabledchange"></a>\r
- <b>disabledchange</b> : ( <code>Node node</code>, <code>Boolean disabled</code> ) <div class="mdesc">\r
- <div class="short">Fires when the disabled status of a node changes</div>\r
- <div class="long">\r
- Fires when the disabled status of a node changes <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>node</code> : Node<div class="sub-desc">The node</div></li><li><code>disabled</code> : Boolean<div class="sub-desc"></div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="event-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-dragdrop"></a>\r
- <b>dragdrop</b> : ( <code>Ext.tree.TreePanel this</code>, <code>Ext.tree.TreeNode node</code>, <code>DD dd</code>, <code>event e</code> ) <div class="mdesc">\r
- <div class="short">Fires when a dragged node is dropped on a valid DD target</div>\r
- <div class="long">\r
- Fires when a dragged node is dropped on a valid DD target <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : Ext.tree.TreePanel<div class="sub-desc"></div></li><li><code>node</code> : Ext.tree.TreeNode<div class="sub-desc"></div></li><li><code>dd</code> : DD<div class="sub-desc">The dd it was dropped on</div></li><li><code>e</code> : event<div class="sub-desc">The raw browser event</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="event-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-enable"></a>\r
- <b>enable</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">\r
- <div class="short">Fires after the component is enabled.</div>\r
- <div class="long">\r
- Fires after the component is enabled. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-enable" href="output/Ext.Component.html#event-enable">Component</a></td>\r
- </tr>\r
- <tr class="event-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-enddrag"></a>\r
- <b>enddrag</b> : ( <code>Ext.tree.TreePanel this</code>, <code>Ext.tree.TreeNode node</code>, <code>event e</code> ) <div class="mdesc">\r
- <div class="short">Fires when a drag operation is complete</div>\r
- <div class="long">\r
- Fires when a drag operation is complete <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : Ext.tree.TreePanel<div class="sub-desc"></div></li><li><code>node</code> : Ext.tree.TreeNode<div class="sub-desc"></div></li><li><code>e</code> : event<div class="sub-desc">The raw browser event</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="event-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-expand"></a>\r
- <b>expand</b> : ( <code>Ext.Panel p</code> ) <div class="mdesc">\r
- <div class="short">Fires after the Panel has been expanded.</div>\r
- <div class="long">\r
- Fires after the Panel has been expanded. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>p</code> : Ext.Panel<div class="sub-desc">The Panel that has been expanded.</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#event-expand" href="output/Ext.Panel.html#event-expand">Panel</a></td>\r
- </tr>\r
- <tr class="event-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-expandnode"></a>\r
- <b>expandnode</b> : ( <code>Node node</code> ) <div class="mdesc">\r
- <div class="short">Fires when a node is expanded</div>\r
- <div class="long">\r
- Fires when a node is expanded <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>node</code> : Node<div class="sub-desc">The node</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="event-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-hide"></a>\r
- <b>hide</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">\r
- <div class="short">Fires after the component is hidden.</div>\r
- <div class="long">\r
- Fires after the component is hidden. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-hide" href="output/Ext.Component.html#event-hide">Component</a></td>\r
- </tr>\r
- <tr class="event-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-iconchange"></a>\r
- <b>iconchange</b> : ( <code>Ext.Panel p</code>, <code>String The</code>, <code>String The</code> ) <div class="mdesc">\r
- <div class="short">Fires after the Panel icon class has been set or changed.</div>\r
- <div class="long">\r
- Fires after the Panel icon class has been set or changed. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>p</code> : Ext.Panel<div class="sub-desc">the Panel which has had its icon class changed.</div></li><li><code>The</code> : String<div class="sub-desc">new icon class.</div></li><li><code>The</code> : String<div class="sub-desc">old icon class.</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#event-iconchange" href="output/Ext.Panel.html#event-iconchange">Panel</a></td>\r
- </tr>\r
- <tr class="event-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-insert"></a>\r
- <b>insert</b> : ( <code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code>, <code>Node refNode</code> ) <div class="mdesc">\r
- <div class="short">Fires when a new child node is inserted in a node in this tree.</div>\r
- <div class="long">\r
- Fires when a new child node is inserted in a node in this tree. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>parent</code> : Node<div class="sub-desc">The parent node</div></li><li><code>node</code> : Node<div class="sub-desc">The child node inserted</div></li><li><code>refNode</code> : Node<div class="sub-desc">The child node the node was inserted before</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="event-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-load"></a>\r
- <b>load</b> : ( <code>Node node</code> ) <div class="mdesc">\r
- <div class="short">Fires when a node is loaded</div>\r
- <div class="long">\r
- Fires when a node is loaded <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>node</code> : Node<div class="sub-desc">The node that was loaded</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="event-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-move"></a>\r
- <b>move</b> : ( <code>Ext.Component this</code>, <code>Number x</code>, <code>Number y</code> ) <div class="mdesc">\r
- <div class="short">Fires after the component is moved.</div>\r
- <div class="long">\r
- Fires after the component is moved. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>x</code> : Number<div class="sub-desc">The new x position</div></li><li><code>y</code> : Number<div class="sub-desc">The new y position</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#event-move" href="output/Ext.BoxComponent.html#event-move">BoxComponent</a></td>\r
- </tr>\r
- <tr class="event-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-movenode"></a>\r
- <b>movenode</b> : ( <code>Tree tree</code>, <code>Node node</code>, <code>Node oldParent</code>, <code>Node newParent</code>, <code>Number index</code> ) <div class="mdesc">\r
- <div class="short">Fires when a node is moved to a new location in the tree</div>\r
- <div class="long">\r
- Fires when a node is moved to a new location in the tree <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>tree</code> : Tree<div class="sub-desc">The owner tree</div></li><li><code>node</code> : Node<div class="sub-desc">The node moved</div></li><li><code>oldParent</code> : Node<div class="sub-desc">The old parent of this node</div></li><li><code>newParent</code> : Node<div class="sub-desc">The new parent of this node</div></li><li><code>index</code> : Number<div class="sub-desc">The index it was moved to</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="event-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-nodedragover"></a>\r
- <b>nodedragover</b> : ( <code>Object dragOverEvent</code> ) <div class="mdesc">\r
- <div class="short">Fires when a tree node is being targeted for a drag drop, return false to signal drop not allowed. The dragOverEvent
-...</div>\r
- <div class="long">\r
- Fires when a tree node is being targeted for a drag drop, return false to signal drop not allowed. The dragOverEvent
+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 deactivated.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Panel.html#deactivate" ext:member="#deactivate" 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-destroy"></a><b><a href="source/Component.html#event-Ext.Component-destroy">destroy</a></b> :
+ ( <code>Ext.Component this</code> )
+ <div class="mdesc"><div class="short">Fires after the component is destroyed.</div><div class="long">Fires after the component is <a href="output/Ext.Component.html#Ext.Component-destroy" ext:member="destroy" ext:cls="Ext.Component">destroy</a>ed.<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#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.Component-disable"></a><b><a href="source/Component.html#event-Ext.Component-disable">disable</a></b> :
+ ( <code>Ext.Component this</code> )
+ <div class="mdesc"><div class="short">Fires after the component is disabled.</div><div class="long">Fires after the component is disabled.<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#disable" ext:member="#disable" 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-disabledchange"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-disabledchange">disabledchange</a></b> :
+ ( <code>Node node</code>, <code>Boolean disabled</code> )
+ <div class="mdesc"><div class="short">Fires when the disabled status of a node changes</div><div class="long">Fires when the disabled status of a node changes<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><li><code>disabled</code> : Boolean<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-dragdrop"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-dragdrop">dragdrop</a></b> :
+ ( <code>Ext.tree.TreePanel this</code>, <code>Ext.tree.TreeNode node</code>, <code>DD dd</code>, <code>event e</code> )
+ <div class="mdesc"><div class="short">Fires when a dragged node is dropped on a valid DD target</div><div class="long">Fires when a dragged node is dropped on a valid DD target<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.tree.TreePanel<div class="sub-desc"></div></li><li><code>node</code> : Ext.tree.TreeNode<div class="sub-desc"></div></li><li><code>dd</code> : DD<div class="sub-desc">The dd it was dropped on</div></li><li><code>e</code> : event<div class="sub-desc">The raw browser event</div></li></ul></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-enable"></a><b><a href="source/Component.html#event-Ext.Component-enable">enable</a></b> :
+ ( <code>Ext.Component this</code> )
+ <div class="mdesc"><div class="short">Fires after the component is enabled.</div><div class="long">Fires after the component is enabled.<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#enable" ext:member="#enable" 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-enddrag"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-enddrag">enddrag</a></b> :
+ ( <code>Ext.tree.TreePanel this</code>, <code>Ext.tree.TreeNode node</code>, <code>event e</code> )
+ <div class="mdesc"><div class="short">Fires when a drag operation is complete</div><div class="long">Fires when a drag operation is complete<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.tree.TreePanel<div class="sub-desc"></div></li><li><code>node</code> : Ext.tree.TreeNode<div class="sub-desc"></div></li><li><code>e</code> : event<div class="sub-desc">The raw browser event</div></li></ul></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-expand"></a><b><a href="source/Panel.html#event-Ext.Panel-expand">expand</a></b> :
+ ( <code>Ext.Panel p</code> )
+ <div class="mdesc"><div class="short">Fires after the Panel has been expanded.</div><div class="long">Fires after the Panel has been expanded.<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 expanded.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Panel.html#expand" ext:member="#expand" 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-expandnode"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-expandnode">expandnode</a></b> :
+ ( <code>Node node</code> )
+ <div class="mdesc"><div class="short">Fires when a node is expanded</div><div class="long">Fires when a node is expanded<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 inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-hide"></a><b><a href="source/Component.html#event-Ext.Component-hide">hide</a></b> :
+ ( <code>Ext.Component this</code> )
+ <div class="mdesc"><div class="short">Fires after the component is hidden.
+Fires after the component is hidden when calling the hide method.</div><div class="long">Fires after the component is hidden.
+Fires after the component is hidden when calling the <a href="output/Ext.Component.html#Ext.Component-hide" ext:member="hide" ext:cls="Ext.Component">hide</a> method.<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#hide" ext:member="#hide" 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-iconchange"></a><b><a href="source/Panel.html#event-Ext.Panel-iconchange">iconchange</a></b> :
+ ( <code>Ext.Panel p</code>, <code>String The</code>, <code>String The</code> )
+ <div class="mdesc"><div class="short">Fires after the Panel icon class has been set or changed.</div><div class="long">Fires after the Panel icon class has been <a href="output/Ext.Panel.html#Ext.Panel-iconCls" ext:member="iconCls" ext:cls="Ext.Panel">set</a> or <a href="output/Ext.Panel.html#Ext.Panel-setIconClass" ext:member="setIconClass" ext:cls="Ext.Panel">changed</a>.<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 which has had its <a href="output/Ext.Panel.html#Ext.Panel-iconCls" ext:member="iconCls" ext:cls="Ext.Panel">icon class</a> changed.</div></li><li><code>The</code> : String<div class="sub-desc">new icon class.</div></li><li><code>The</code> : String<div class="sub-desc">old icon class.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Panel.html#iconchange" ext:member="#iconchange" 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-insert"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-insert">insert</a></b> :
+ ( <code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code>, <code>Node refNode</code> )
+ <div class="mdesc"><div class="short">Fires when a new child node is inserted in a node in this tree.</div><div class="long">Fires when a new child node is inserted in 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 inserted</div></li><li><code>refNode</code> : Node<div class="sub-desc">The child node the node was inserted before</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-load"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-load">load</a></b> :
+ ( <code>Node node</code> )
+ <div class="mdesc"><div class="short">Fires when a node is loaded</div><div class="long">Fires when a node is loaded<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 that was loaded</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.BoxComponent-move"></a><b><a href="source/BoxComponent.html#event-Ext.BoxComponent-move">move</a></b> :
+ ( <code>Ext.Component this</code>, <code>Number x</code>, <code>Number y</code> )
+ <div class="mdesc"><div class="short">Fires after the component is moved.</div><div class="long">Fires after the component is moved.<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>x</code> : Number<div class="sub-desc">The new x position</div></li><li><code>y</code> : Number<div class="sub-desc">The new y position</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#move" ext:member="#move" 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-movenode"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-movenode">movenode</a></b> :
+ ( <code>Tree tree</code>, <code>Node node</code>, <code>Node oldParent</code>, <code>Node newParent</code>, <code>Number index</code> )
+ <div class="mdesc"><div class="short">Fires when a node is moved to a new location in the tree</div><div class="long">Fires when a node is moved to a new location in the 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>node</code> : Node<div class="sub-desc">The node moved</div></li><li><code>oldParent</code> : Node<div class="sub-desc">The old parent of this node</div></li><li><code>newParent</code> : Node<div class="sub-desc">The new parent of this node</div></li><li><code>index</code> : Number<div class="sub-desc">The index it was moved to</div></li></ul></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-nodedragover"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-nodedragover">nodedragover</a></b> :
+ ( <code>Object dragOverEvent</code> )
+ <div class="mdesc"><div class="short">Fires when a tree node is being targeted for a drag drop, return false to signal drop not allowed. The dragOverEvent
+...</div><div class="long">Fires when a tree node is being targeted for a drag drop, return false to signal drop not allowed. The dragOverEvent
passed to handlers has the following properties:<br />
<ul style="padding:5px;padding-left:16px;">
<li>tree - The TreePanel</li>
<li>rawEvent - Raw mouse event</li>
<li>dropNode - Drop node(s) provided by the source.</li>
<li>cancel - Set this to true to signal drop not allowed.</li>
-</ul> <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>dragOverEvent</code> : Object<div class="sub-desc"></div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="event-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-nodedrop"></a>\r
- <b>nodedrop</b> : ( <code>Object dropEvent</code> ) <div class="mdesc">\r
- <div class="short">Fires after a DD object is dropped on a node in this tree. The dropEvent
-passed to handlers has the following propert...</div>\r
- <div class="long">\r
- Fires after a DD object is dropped on a node in this tree. The dropEvent
+</ul><div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>dragOverEvent</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-nodedrop"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-nodedrop">nodedrop</a></b> :
+ ( <code>Object dropEvent</code> )
+ <div class="mdesc"><div class="short">Fires after a DD object is dropped on a node in this tree. The dropEvent
+passed to handlers has the following propert...</div><div class="long">Fires after a DD object is dropped on a node in this tree. The dropEvent
passed to handlers has the following properties:<br />
<ul style="padding:5px;padding-left:16px;">
<li>tree - The TreePanel</li>
<li>source - The drag source</li>
<li>rawEvent - Raw mouse event</li>
<li>dropNode - Dropped node(s).</li>
-</ul> <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>dropEvent</code> : Object<div class="sub-desc"></div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="event-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-remove"></a>\r
- <b>remove</b> : ( <code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code> ) <div class="mdesc">\r
- <div class="short">Fires when a child node is removed from a node in this tree.</div>\r
- <div class="long">\r
- Fires when a child node is removed from a node in this tree. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <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>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="event-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-render"></a>\r
- <b>render</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">\r
- <div class="short">Fires after the component is rendered.</div>\r
- <div class="long">\r
- Fires after the component is rendered. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-render" href="output/Ext.Component.html#event-render">Component</a></td>\r
- </tr>\r
- <tr class="event-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-resize"></a>\r
- <b>resize</b> : ( <code>Ext.Component this</code>, <code>Number adjWidth</code>, <code>Number adjHeight</code>, <code>Number rawWidth</code>, <code>Number rawHeight</code> ) <div class="mdesc">\r
- <div class="short">Fires after the component is resized.</div>\r
- <div class="long">\r
- Fires after the component is resized. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>adjWidth</code> : Number<div class="sub-desc">The box-adjusted width that was set</div></li><li><code>adjHeight</code> : Number<div class="sub-desc">The box-adjusted height that was set</div></li><li><code>rawWidth</code> : Number<div class="sub-desc">The width that was originally specified</div></li><li><code>rawHeight</code> : Number<div class="sub-desc">The height that was originally specified</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.BoxComponent" ext:member="#event-resize" href="output/Ext.BoxComponent.html#event-resize">BoxComponent</a></td>\r
- </tr>\r
- <tr class="event-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-show"></a>\r
- <b>show</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">\r
- <div class="short">Fires after the component is shown.</div>\r
- <div class="long">\r
- Fires after the component is shown. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-show" href="output/Ext.Component.html#event-show">Component</a></td>\r
- </tr>\r
- <tr class="event-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-startdrag"></a>\r
- <b>startdrag</b> : ( <code>Ext.tree.TreePanel this</code>, <code>Ext.tree.TreeNode node</code>, <code>event e</code> ) <div class="mdesc">\r
- <div class="short">Fires when a node starts being dragged</div>\r
- <div class="long">\r
- Fires when a node starts being dragged <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : Ext.tree.TreePanel<div class="sub-desc"></div></li><li><code>node</code> : Ext.tree.TreeNode<div class="sub-desc"></div></li><li><code>e</code> : event<div class="sub-desc">The raw browser event</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="event-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-staterestore"></a>\r
- <b>staterestore</b> : ( <code>Ext.Component this</code>, <code>Object state</code> ) <div class="mdesc">\r
- <div class="short">Fires after the state of the component is restored.</div>\r
- <div class="long">\r
- Fires after the state of the component is restored. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>state</code> : Object<div class="sub-desc">The hash of state values</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-staterestore" href="output/Ext.Component.html#event-staterestore">Component</a></td>\r
- </tr>\r
- <tr class="event-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-statesave"></a>\r
- <b>statesave</b> : ( <code>Ext.Component this</code>, <code>Object state</code> ) <div class="mdesc">\r
- <div class="short">Fires after the state of the component is saved to the configured state provider.</div>\r
- <div class="long">\r
- Fires after the state of the component is saved to the configured state provider. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>state</code> : Object<div class="sub-desc">The hash of state values</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-statesave" href="output/Ext.Component.html#event-statesave">Component</a></td>\r
- </tr>\r
- <tr class="event-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-textchange"></a>\r
- <b>textchange</b> : ( <code>Node node</code>, <code>String text</code>, <code>String oldText</code> ) <div class="mdesc">\r
- <div class="short">Fires when the text for a node is changed</div>\r
- <div class="long">\r
- Fires when the text for a node is changed <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>node</code> : Node<div class="sub-desc">The node</div></li><li><code>text</code> : String<div class="sub-desc">The new text</div></li><li><code>oldText</code> : String<div class="sub-desc">The old text</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">TreePanel</td>\r
- </tr>\r
- <tr class="event-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.tree.TreePanel-titlechange"></a>\r
- <b>titlechange</b> : ( <code>Ext.Panel p</code>, <code>String The</code> ) <div class="mdesc">\r
- <div class="short">Fires after the Panel title has been set or changed.</div>\r
- <div class="long">\r
- Fires after the Panel title has been set or changed. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>p</code> : Ext.Panel<div class="sub-desc">the Panel which has had its title changed.</div></li><li><code>The</code> : String<div class="sub-desc">new title.</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.Panel" ext:member="#event-titlechange" href="output/Ext.Panel.html#event-titlechange">Panel</a></td>\r
- </tr>\r
- </table>
-
- </div>
\ No newline at end of file
+</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> :
+ ( <code>Tree tree</code>, <code>Node parent</code>, <code>Node node</code> )
+ <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> :
+ ( <code>Ext.Component this</code>, <code>Ext.Container ownerCt</code> )
+ <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> :
+ ( <code>Ext.Component this</code> )
+ <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> :
+ ( <code>Ext.Component this</code>, <code>Number adjWidth</code>, <code>Number adjHeight</code>, <code>Number rawWidth</code>, <code>Number rawHeight</code> )
+ <div class="mdesc"><div class="short">Fires after the component is resized.</div><div class="long">Fires after the component is resized.<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>adjWidth</code> : Number<div class="sub-desc">The box-adjusted width that was set</div></li><li><code>adjHeight</code> : Number<div class="sub-desc">The box-adjusted height that was set</div></li><li><code>rawWidth</code> : Number<div class="sub-desc">The width that was originally specified</div></li><li><code>rawHeight</code> : Number<div class="sub-desc">The height that was originally specified</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#resize" ext:member="#resize" 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.Component-show"></a><b><a href="source/Component.html#event-Ext.Component-show">show</a></b> :
+ ( <code>Ext.Component this</code> )
+ <div class="mdesc"><div class="short">Fires after the component is shown when calling the show method.</div><div class="long">Fires after the component is shown when calling the <a href="output/Ext.Component.html#Ext.Component-show" ext:member="show" ext:cls="Ext.Component">show</a> method.<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#show" ext:member="#show" 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-startdrag"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-startdrag">startdrag</a></b> :
+ ( <code>Ext.tree.TreePanel this</code>, <code>Ext.tree.TreeNode node</code>, <code>event e</code> )
+ <div class="mdesc"><div class="short">Fires when a node starts being dragged</div><div class="long">Fires when a node starts being dragged<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.tree.TreePanel<div class="sub-desc"></div></li><li><code>node</code> : Ext.tree.TreeNode<div class="sub-desc"></div></li><li><code>e</code> : event<div class="sub-desc">The raw browser event</div></li></ul></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-staterestore"></a><b><a href="source/Component.html#event-Ext.Component-staterestore">staterestore</a></b> :
+ ( <code>Ext.Component this</code>, <code>Object state</code> )
+ <div class="mdesc"><div class="short">Fires after the state of the component is restored.</div><div class="long">Fires after the state of the component is restored.<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>state</code> : Object<div class="sub-desc">The hash of state values returned from the StateProvider. This is passed
+to <b><tt>applyState</tt></b>. By default, that simply copies property values into this
+Component. The method maybe overriden to provide custom state restoration.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#staterestore" ext:member="#staterestore" 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-statesave"></a><b><a href="source/Component.html#event-Ext.Component-statesave">statesave</a></b> :
+ ( <code>Ext.Component this</code>, <code>Object state</code> )
+ <div class="mdesc"><div class="short">Fires after the state of the component is saved to the configured state provider.</div><div class="long">Fires after the state of the component is saved to the configured state provider.<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>state</code> : Object<div class="sub-desc">The hash of state values. This is determined by calling
+<b><tt>getState()</tt></b> on the Component. This method must be provided by the
+developer to return whetever representation of state is required, by default, Ext.Component
+has a null implementation.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#statesave" ext:member="#statesave" 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-textchange"></a><b><a href="source/TreePanel.html#event-Ext.tree.TreePanel-textchange">textchange</a></b> :
+ ( <code>Node node</code>, <code>String text</code>, <code>String oldText</code> )
+ <div class="mdesc"><div class="short">Fires when the text for a node is changed</div><div class="long">Fires when the text for a node is changed<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><li><code>text</code> : String<div class="sub-desc">The new text</div></li><li><code>oldText</code> : String<div class="sub-desc">The old text</div></li></ul></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-titlechange"></a><b><a href="source/Panel.html#event-Ext.Panel-titlechange">titlechange</a></b> :
+ ( <code>Ext.Panel p</code>, <code>String The</code> )
+ <div class="mdesc"><div class="short">Fires after the Panel title has been set or changed.</div><div class="long">Fires after the Panel title has been <a href="output/Ext.Panel.html#Ext.Panel-title" ext:member="title" ext:cls="Ext.Panel">set</a> or <a href="output/Ext.Panel.html#Ext.Panel-setTitle" ext:member="setTitle" ext:cls="Ext.Panel">changed</a>.<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 which has had its title changed.</div></li><li><code>The</code> : String<div class="sub-desc">new title.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Panel.html#titlechange" ext:member="#titlechange" ext:cls="Ext.Panel">Panel</a></td></tr></tbody></table></div>
\ No newline at end of file
git.ithinksw.org / extjs.git / blobdiff