Upgrade to ExtJS 3.0.3 - Released 10/11/2009
[extjs.git] / docs / output / Ext.Container.html
1 <div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.Container-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.Container-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.Container-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="inner-link" href="#Ext.Container-configs"><img src="resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>&#13;<a class="bookmark" href="../docs/?class=Ext.Container"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</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>&#13;&nbsp;&nbsp;<img src="resources/elbow-end.gif"><a href="output/Ext.Component.html" ext:member="" ext:cls="Ext.Component">Component</a>&#13;&nbsp;&nbsp;&nbsp;&nbsp;<img src="resources/elbow-end.gif"><a href="output/Ext.BoxComponent.html" ext:member="" ext:cls="Ext.BoxComponent">BoxComponent</a>&#13;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<img src="resources/elbow-end.gif">Container</pre></div><h1>Class <a href="source/Container.html#cls-Ext.Container">Ext.Container</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext</td></tr><tr><td class="label">Defined In:</td><td class="hd-info">Container.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/Container.html#cls-Ext.Container">Container</a></td></tr><tr><td class="label">Subclasses:</td><td class="hd-info"><a href="output/Ext.Panel.html" ext:cls="Ext.Panel">Panel</a>,&#13;<a href="output/Ext.Toolbar.html" ext:cls="Ext.Toolbar">Toolbar</a>,&#13;<a href="output/Ext.Viewport.html" ext:cls="Ext.Viewport">Viewport</a>,&#13;<a href="output/Ext.menu.Menu.html" ext:cls="Ext.menu.Menu">Menu</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.BoxComponent.html" ext:cls="Ext.BoxComponent" ext:member="">BoxComponent</a></td></tr><tr><td class="hd-info"></td></tr><tr><td class="label">xtype:</td><td class="hd-info">container</td></tr></table><div class="description"><p>Base class for any <a href="output/Ext.BoxComponent.html" ext:cls="Ext.BoxComponent">Ext.BoxComponent</a> that may contain other Components. Containers handle the\r
2 basic behavior of containing items, namely adding, inserting and removing items.</p>\r
3 <p>The most commonly used Container classes are <a href="output/Ext.Panel.html" ext:cls="Ext.Panel">Ext.Panel</a>, <a href="output/Ext.Window.html" ext:cls="Ext.Window">Ext.Window</a> and <a href="output/Ext.TabPanel.html" ext:cls="Ext.TabPanel">Ext.TabPanel</a>.\r
4 If you do not need the capabilities offered by the aforementioned classes you can create a lightweight\r
5 Container to be encapsulated by an HTML element to your specifications by using the\r
6 <tt><b><a href="output/Ext.Component.html#Ext.Component-autoEl" ext:member="autoEl" ext:cls="Ext.Component">autoEl</a></b></tt> config option. This is a useful technique when creating\r
7 embedded <a href="output/Ext.layout.ColumnLayout.html" ext:cls="Ext.layout.ColumnLayout">column</a> layouts inside <a href="output/Ext.form.FormPanel.html" ext:cls="Ext.form.FormPanel">FormPanels</a>\r
8 for example.</p>\r
9 <p>The code below illustrates both how to explicitly create a Container, and how to implicitly\r
10 create one using the <b><tt>'container'</tt></b> xtype:<pre><code><i>// explicitly create a Container\r</i>
11 <b>var</b> embeddedColumns = <b>new</b> Ext.Container({\r
12     autoEl: <em>'div'</em>,  <i>// This is the <b>default</b>\r</i>
13     layout: <em>'column'</em>,\r
14     defaults: {\r
15         <i>// implicitly create Container by specifying xtype\r</i>
16         xtype: <em>'container'</em>,\r
17         autoEl: <em>'div'</em>, <i>// This is the <b>default</b>.\r</i>
18         layout: <em>'form'</em>,\r
19         columnWidth: 0.5,\r
20         style: {\r
21             padding: <em>'10px'</em>\r
22         }\r
23     },\r
24 <i>//  The two items below will be Ext.Containers, each encapsulated by a &lt;DIV> element.\r</i>
25     items: [{\r
26         items: {\r
27             xtype: <em>'datefield'</em>,\r
28             name: <em>'startDate'</em>,\r
29             fieldLabel: <em>'Start date'</em>\r
30         }\r
31     }, {\r
32         items: {\r
33             xtype: <em>'datefield'</em>,\r
34             name: <em>'endDate'</em>,\r
35             fieldLabel: <em>'End date'</em>\r
36         }\r
37     }]\r
38 });</code></pre></p>\r
39 <p><u><b>Layout</b></u></p>\r
40 <p>Container classes delegate the rendering of child Components to a layout\r
41 manager class which must be configured into the Container using the\r
42 <code><b><a href="output/Ext.Container.html#Ext.Container-layout" ext:member="layout" ext:cls="Ext.Container">layout</a></b></code> configuration property.</p>\r
43 <p>When either specifying child <code><a href="output/Ext.Container.html#Ext.Container-items" ext:member="items" ext:cls="Ext.Container">items</a></code> of a Container,\r
44 or dynamically <a href="output/Ext.Container.html#Ext.Container-add" ext:member="add" ext:cls="Ext.Container">adding</a> Components to a Container, remember to\r
45 consider how you wish the Container to arrange those child elements, and\r
46 whether those child elements need to be sized using one of Ext's built-in\r
47 <b><code><a href="output/Ext.Container.html#Ext.Container-layout" ext:member="layout" ext:cls="Ext.Container">layout</a></code></b> schemes. By default, Containers use the\r
48 <a href="output/Ext.layout.ContainerLayout.html" ext:cls="Ext.layout.ContainerLayout">ContainerLayout</a> scheme which only\r
49 renders child components, appending them one after the other inside the\r
50 Container, and <b>does not apply any sizing</b> at all.</p>\r
51 <p>A common mistake is when a developer neglects to specify a\r
52 <b><code><a href="output/Ext.Container.html#Ext.Container-layout" ext:member="layout" ext:cls="Ext.Container">layout</a></code></b> (e.g. widgets like GridPanels or\r
53 TreePanels are added to Containers for which no <tt><b><a href="output/Ext.Container.html#Ext.Container-layout" ext:member="layout" ext:cls="Ext.Container">layout</a></b></tt>\r
54 has been specified). If a Container is left to use the default\r
55 <a href="output/Ext.layout.ContainerLayout.html" ext:cls="Ext.layout.ContainerLayout">ContainerLayout</a> scheme, none of its\r
56 child components will be resized, or changed in any way when the Container\r
57 is resized.</p>\r
58 <p>Certain layout managers allow dynamic addition of child components.\r
59 Those that do include <a href="output/Ext.layout.CardLayout.html" ext:cls="Ext.layout.CardLayout">Ext.layout.CardLayout</a>,\r
60 <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>, and\r
61 <a href="output/Ext.layout.TableLayout.html" ext:cls="Ext.layout.TableLayout">Ext.layout.TableLayout</a>. For example:<pre><code><i>//  Create the GridPanel.\r</i>
62 <b>var</b> myNewGrid = <b>new</b> Ext.grid.GridPanel({\r
63     store: myStore,\r
64     columns: myColumnModel,\r
65     title: <em>'Results'</em>, <i>// the title becomes the title of the tab\r</i>
66 });\r
67 \r
68 myTabPanel.add(myNewGrid); <i>// <a href="output/Ext.TabPanel.html" ext:cls="Ext.TabPanel">Ext.TabPanel</a> implicitly uses <a href="output/Ext.layout.CardLayout.html" ext:cls="Ext.layout.CardLayout">CardLayout</a>\r</i>
69 myTabPanel.<a href="output/Ext.TabPanel.html#Ext.TabPanel-setActiveTab" ext:member="setActiveTab" ext:cls="Ext.TabPanel">setActiveTab</a>(myNewGrid);</code></pre></p>\r
70 <p>The example above adds a newly created GridPanel to a TabPanel. Note that\r
71 a TabPanel uses <a href="output/Ext.layout.CardLayout.html" ext:cls="Ext.layout.CardLayout">Ext.layout.CardLayout</a> as its layout manager which\r
72 means all its child items are sized to <a href="output/Ext.layout.FitLayout.html" ext:cls="Ext.layout.FitLayout">fit</a>\r
73 exactly into its client area.\r
74 <p><b><u>Overnesting is a common problem</u></b>.\r
75 An example of overnesting occurs when a GridPanel is added to a TabPanel\r
76 by wrapping the GridPanel <i>inside</i> a wrapping Panel (that has no\r
77 <tt><b><a href="output/Ext.Container.html#Ext.Container-layout" ext:member="layout" ext:cls="Ext.Container">layout</a></b></tt> specified) and then add that wrapping Panel\r
78 to the TabPanel. The point to realize is that a GridPanel <b>is</b> a\r
79 Component which can be added directly to a Container. If the wrapping Panel\r
80 has no <tt><b><a href="output/Ext.Container.html#Ext.Container-layout" ext:member="layout" ext:cls="Ext.Container">layout</a></b></tt> configuration, then the overnested\r
81 GridPanel will not be sized as expected.<p>\r
82 <p><u><b>Adding via remote configuration</b></u></p>\r
83 <p>A server side script can be used to add Components which are generated dynamically on the server.\r
84 An example of adding a GridPanel to a TabPanel where the GridPanel is generated by the server\r
85 based on certain parameters:\r
86 </p><pre><code><i>// execute an Ajax request to invoke server side script:\r</i>
87 Ext.Ajax.request({\r
88     url: <em>'gen-invoice-grid.php'</em>,\r
89     <i>// send additional parameters to instruct server script\r</i>
90     params: {\r
91         startDate: Ext.getCmp(<em>'start-date'</em>).getValue(),\r
92         endDate: Ext.getCmp(<em>'end-date'</em>).getValue()\r
93     },\r
94     <i>// process the response object to add it to the TabPanel:\r</i>
95     success: <b>function</b>(xhr) {\r
96         <b>var</b> newComponent = eval(xhr.responseText); <i>// see discussion below\r</i>
97         myTabPanel.add(newComponent); <i>// add the component to the TabPanel\r</i>
98         myTabPanel.setActiveTab(newComponent);\r
99     },\r
100     failure: <b>function</b>() {\r
101         Ext.Msg.alert(<em>"Grid create failed"</em>, <em>"Server communication failure"</em>);\r
102     }\r
103 });</code></pre>\r
104 <p>The server script needs to return an executable Javascript statement which, when processed\r
105 using <tt>eval()</tt>, will return either a config object with an <a href="output/Ext.Component.html#Ext.Component-xtype" ext:member="xtype" ext:cls="Ext.Component">xtype</a>,\r
106 or an instantiated Component. The server might return this for example:</p><pre><code>(<b>function</b>() {\r
107     <b>function</b> formatDate(value){\r
108         <b>return</b> value ? value.dateFormat(<em>'M d, Y'</em>) : <em>''</em>;\r
109     };\r
110 \r
111     <b>var</b> store = <b>new</b> Ext.data.Store({\r
112         url: <em>'get-invoice-data.php'</em>,\r
113         baseParams: {\r
114             startDate: <em>'01/01/2008'</em>,\r
115             endDate: <em>'01/31/2008'</em>\r
116         },\r
117         reader: <b>new</b> Ext.data.JsonReader({\r
118             record: <em>'transaction'</em>,\r
119             idProperty: <em>'id'</em>,\r
120             totalRecords: <em>'total'</em>\r
121         }, [\r
122            <em>'customer'</em>,\r
123            <em>'invNo'</em>,\r
124            {name: <em>'date'</em>, type: <em>'date'</em>, dateFormat: <em>'m/d/Y'</em>},\r
125            {name: <em>'value'</em>, type: <em>'float'</em>}\r
126         ])\r
127     });\r
128 \r
129     <b>var</b> grid = <b>new</b> Ext.grid.GridPanel({\r
130         title: <em>'Invoice Report'</em>,\r
131         bbar: <b>new</b> Ext.PagingToolbar(store),\r
132         store: store,\r
133         columns: [\r
134             {header: <em>"Customer"</em>, width: 250, dataIndex: <em>'customer'</em>, sortable: true},\r
135             {header: <em>"Invoice Number"</em>, width: 120, dataIndex: <em>'invNo'</em>, sortable: true},\r
136             {header: <em>"Invoice Date"</em>, width: 100, dataIndex: <em>'date'</em>, renderer: formatDate, sortable: true},\r
137             {header: <em>"Value"</em>, width: 120, dataIndex: <em>'value'</em>, renderer: <em>'usMoney'</em>, sortable: true}\r
138         ],\r
139     });\r
140     store.load();\r
141     <b>return</b> grid;  <i>// <b>return</b> instantiated component\r</i>
142 })();</code></pre>\r
143 <p>When the above code fragment is passed through the <tt>eval</tt> function in the success handler\r
144 of the Ajax request, the code is executed by the Javascript processor, and the anonymous function\r
145 runs, and returns the instantiated grid component.</p>\r
146 <p>Note: since the code above is <i>generated</i> by a server script, the <tt>baseParams</tt> for\r
147 the Store, the metadata to allow generation of the Record layout, and the ColumnModel\r
148 can all be generated into the code since these are all known on the server.</p></div><div class="hr"></div><a id="Ext.Container-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 "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Container-activeItem"></a><b><a href="source/Container.html#cfg-Ext.Container-activeItem">activeItem</a></b> : String/Number<div class="mdesc"><div class="short">A string component id or the numeric index of the component that should be initially activated within the&#13;\r
149 container'...</div><div class="long">A string component id or the numeric index of the component that should be initially activated within the\r
150 container's layout on render.  For example, activeItem: 'item-1' or activeItem: 0 (index 0 = the first\r
151 item in the container's collection).  activeItem only applies to layout styles that can display\r
152 items one at a time (like <a href="output/Ext.layout.AccordionLayout.html" ext:cls="Ext.layout.AccordionLayout">Ext.layout.AccordionLayout</a>, <a href="output/Ext.layout.CardLayout.html" ext:cls="Ext.layout.CardLayout">Ext.layout.CardLayout</a> and\r
153 <a href="output/Ext.layout.FitLayout.html" ext:cls="Ext.layout.FitLayout">Ext.layout.FitLayout</a>).  Related to <a href="output/Ext.layout.ContainerLayout.html#Ext.layout.ContainerLayout-activeItem" ext:member="activeItem" ext:cls="Ext.layout.ContainerLayout">Ext.layout.ContainerLayout.activeItem</a>.</div></div></td><td class="msource">Container</td></tr><tr class="config-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-allowDomMove"></a><b><a href="source/Component.html#cfg-Ext.Component-allowDomMove">allowDomMove</a></b> : Boolean<div class="mdesc">Whether the component can move the Dom node when rendering (defaults to true).</div></td><td class="msource"><a href="output/Ext.Component.html#allowDomMove" ext:member="#allowDomMove" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-anchor"></a><b><a href="source/Component.html#cfg-Ext.Component-anchor">anchor</a></b> : String<div class="mdesc"><div class="short">Note: this config is only used when this Component is rendered\r
154 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
155 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></b>
156 based layout manager, for example:<div class="mdetail-params"><ul>
157 <li><a href="output/Ext.form.FormPanel.html" ext:cls="Ext.form.FormPanel">Ext.form.FormPanel</a></li>
158 <li>specifying <code>layout: <em>'anchor'</em> <i>// or <em>'form'</em>, or <em>'absolute'</em></i></code></li>
159 </ul></div></p>
160 <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.Component.html#anchor" ext:member="#anchor" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-applyTo"></a><b><a href="source/Component.html#cfg-Ext.Component-applyTo">applyTo</a></b> : Mixed<div class="mdesc"><div class="short">Specify the id of the element, a DOM element or an existing Element corresponding to a DIV\r
161 that is already present in...</div><div class="long"><p>Specify the id of the element, a DOM element or an existing Element corresponding to a DIV
162 that is already present in the document that specifies some structural markup for this
163 component.</p><div><ul>
164 <li><b>Description</b> : <ul>
165 <div class="sub-desc">When <tt>applyTo</tt> is used, constituent parts of the component can also be specified
166 by id or CSS class name within the main element, and the component being created may attempt
167 to create its subcomponents from that markup if applicable.</div>
168 </ul></li>
169 <li><b>Notes</b> : <ul>
170 <div class="sub-desc">When using this config, a call to render() is not required.</div>
171 <div class="sub-desc">If applyTo is specified, any value passed for <a href="output/Ext.Component.html#Ext.Component-renderTo" ext:member="renderTo" ext:cls="Ext.Component">renderTo</a> will be ignored and the target
172 element's parent node will automatically be used as the component's container.</div>
173 </ul></li>
174 </ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#applyTo" ext:member="#applyTo" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Container-autoDestroy"></a><b><a href="source/Container.html#cfg-Ext.Container-autoDestroy">autoDestroy</a></b> : Boolean<div class="mdesc"><div class="short">If true the container will automatically destroy any contained component that is removed from it, else&#13;\r
175 destruction m...</div><div class="long">If true the container will automatically destroy any contained component that is removed from it, else\r
176 destruction must be handled manually (defaults to true).</div></div></td><td class="msource">Container</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-autoEl"></a><b><a href="source/Component.html#cfg-Ext.Component-autoEl">autoEl</a></b> : Mixed<div class="mdesc"><div class="short">A tag name or DomHelper spec used to create the Element which will\r
177 encapsulate this Component.\r
178 You do not normally ne...</div><div class="long"><p>A tag name or <a href="output/Ext.DomHelper.html" ext:cls="Ext.DomHelper">DomHelper</a> spec used to create the <a href="output/Ext.Component.html#Ext.Component-getEl" ext:member="getEl" ext:cls="Ext.Component">Element</a> which will
179 encapsulate this Component.</p>
180 <p>You do not normally need to specify this. For the base classes <a href="output/Ext.Component.html" ext:cls="Ext.Component">Ext.Component</a>, <a href="output/Ext.BoxComponent.html" ext:cls="Ext.BoxComponent">Ext.BoxComponent</a>,
181 and <a href="output/Ext.Container.html" ext:cls="Ext.Container">Ext.Container</a>, this defaults to <b><tt>'div'</tt></b>. The more complex Ext classes use a more complex
182 DOM structure created by their own onRender methods.</p>
183 <p>This is intended to allow the developer to create application-specific utility Components encapsulated by
184 different DOM elements. Example usage:</p><pre><code>{
185     xtype: <em>'box'</em>,
186     autoEl: {
187         tag: <em>'img'</em>,
188         src: <em>'http:<i>//www.example.com/example.jpg'</em></i>
189     }
190 }, {
191     xtype: <em>'box'</em>,
192     autoEl: {
193         tag: <em>'blockquote'</em>,
194         html: <em>'autoEl is cool!'</em>
195     }
196 }, {
197     xtype: <em>'container'</em>,
198     autoEl: <em>'ul'</em>,
199     cls: <em>'ux-unordered-list'</em>,
200     items: {
201         xtype: <em>'box'</em>,
202         autoEl: <em>'li'</em>,
203         html: <em>'First list item'</em>
204     }
205 }</code></pre></div></div></td><td class="msource"><a href="output/Ext.Component.html#autoEl" ext:member="#autoEl" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-autoHeight"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-autoHeight">autoHeight</a></b> : Boolean<div class="mdesc"><div class="short">True to use height:'auto', false to use fixed height (or allow it to be managed by its parent\r
206 Container's layout mana...</div><div class="long"><p>True to use height:'auto', false to use fixed height (or allow it to be managed by its parent
207 Container's <a href="output/Ext.Container.html#Ext.Container-layout" ext:member="layout" ext:cls="Ext.Container">layout manager</a>. Defaults to false.</p>
208 <p><b>Note</b>: Although many components inherit this config option, not all will
209 function as expected with a height of 'auto'. Setting autoHeight:true means that the
210 browser will manage height based on the element's contents, and that Ext will not manage it at all.</p>
211 <p>If the <i>browser</i> is managing the height, be aware that resizes performed by the browser in response
212 to changes within the structure of the Component cannot be detected. Therefore changes to the height might
213 result in elements needing to be synchronized with the new height. Example:</p><pre><code><b>var</b> w = <b>new</b> Ext.Window({
214     title: <em>'Window'</em>,
215     width: 600,
216     autoHeight: true,
217     items: {
218         title: <em>'Collapse Me'</em>,
219         height: 400,
220         collapsible: true,
221         border: false,
222         listeners: {
223             beforecollapse: <b>function</b>() {
224                 w.el.shadow.hide();
225             },
226             beforeexpand: <b>function</b>() {
227                 w.el.shadow.hide();
228             },
229             collapse: <b>function</b>() {
230                 w.syncShadow();
231             },
232             expand: <b>function</b>() {
233                 w.syncShadow();
234             }
235         }
236     }
237 }).show();</code></pre></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#autoHeight" ext:member="#autoHeight" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-autoShow"></a><b><a href="source/Component.html#cfg-Ext.Component-autoShow">autoShow</a></b> : Boolean<div class="mdesc"><div class="short">True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove\r
238 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
239 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">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-autoWidth"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-autoWidth">autoWidth</a></b> : Boolean<div class="mdesc"><div class="short">True to use width:'auto', false to use fixed width (or allow it to be managed by its parent\r
240 Container's layout manage...</div><div class="long"><p>True to use width:'auto', false to use fixed width (or allow it to be managed by its parent
241 Container's <a href="output/Ext.Container.html#Ext.Container-layout" ext:member="layout" ext:cls="Ext.Container">layout manager</a>. Defaults to false.</p>
242 <p><b>Note</b>: Although many components  inherit this config option, not all will
243 function as expected with a width of 'auto'. Setting autoWidth:true means that the
244 browser will manage width based on the element's contents, and that Ext will not manage it at all.</p>
245 <p>If the <i>browser</i> is managing the width, be aware that resizes performed by the browser in response
246 to changes within the structure of the Component cannot be detected. Therefore changes to the width might
247 result in elements needing to be synchronized with the new width. For example, where the target element is:</p><pre><code>&lt;div id=<em>'grid-container'</em> style=<em>'margin-left:25%;width:50%'</em>>&lt;/div></code></pre>
248 A Panel rendered into that target element must listen for browser window resize in order to relay its
249 child items when the browser changes its width:<pre><code><b>var</b> myPanel = <b>new</b> Ext.Panel({
250     renderTo: <em>'grid-container'</em>,
251     monitorResize: true, <i>// relay on browser resize</i>
252     title: <em>'Panel'</em>,
253     height: 400,
254     autoWidth: true,
255     layout: <em>'hbox'</em>,
256     layoutConfig: {
257         align: <em>'stretch'</em>
258     },
259     defaults: {
260         flex: 1
261     },
262     items: [{
263         title: <em>'Box 1'</em>,
264     }, {
265         title: <em>'Box 2'</em>
266     }, {
267         title: <em>'Box 3'</em>
268     }],
269 });</code></pre></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#autoWidth" ext:member="#autoWidth" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Container-bubbleEvents"></a><b><a href="source/Container.html#cfg-Ext.Container-bubbleEvents">bubbleEvents</a></b> : Array<div class="mdesc"><p>An array of events that, when fired, should be bubbled to any parent container.\r
270 Defaults to <tt>['add', 'remove']</tt>.</div></td><td class="msource">Container</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Container-bufferResize"></a><b><a href="source/Container.html#cfg-Ext.Container-bufferResize">bufferResize</a></b> : Boolean/Number<div class="mdesc"><div class="short">When set to true (50 milliseconds) or a number of milliseconds, the layout assigned for this container will buffer&#13;\r
271 t...</div><div class="long">When set to true (50 milliseconds) or a number of milliseconds, the layout assigned for this container will buffer\r
272 the frequency it calculates and does a re-layout of components. This is useful for heavy containers or containers\r
273 with a large quantity of sub-components for which frequent layout calls would be expensive. Defaults to <tt>50</tt>.</div></div></td><td class="msource">Container</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</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\r
274 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
275 directly after each form field wrapper to provide field clearing (defaults to
276 <tt>'x-form-clear-left'</tt>).</p>
277 <br><p><b>Note</b>: this config is only used when this Component is rendered by a Container
278 which has been configured to use the <b><a href="output/Ext.layout.FormLayout.html" ext:cls="Ext.layout.FormLayout">FormLayout</a></b> layout
279 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
280 <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>
281 <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">&nbsp;</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\r
282 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
283 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">&nbsp;</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\r
284 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
285 adding customized styles to the container or any of its children using standard CSS rules.  See
286 <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>
287 <p><b>Note</b>: <tt>ctCls</tt> defaults to <tt>''</tt> except for the following class
288 which assigns a value by default:
289 <div class="mdetail-params"><ul>
290 <li><a href="output/Ext.layout.Box.html" ext:cls="Ext.layout.Box">Box Layout</a> : <tt>'x-box-layout-ct'</tt></li>
291 </ul></div>
292 To configure the above Class with an extra CSS class append to the default.  For example,
293 for BoxLayout (Hbox and Vbox):<pre><code>ctCls: <em>'x-box-layout-ct custom-class'</em></code></pre>
294 </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 expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Container-defaultType"></a><b><a href="source/Container.html#cfg-Ext.Container-defaultType">defaultType</a></b> : String<div class="mdesc"><div class="short">The default xtype of child Components to create in this Container when&#13;\r
295 a child item is specified as a raw configurat...</div><div class="long"><p>The default <a href="output/Ext.Component.html" ext:cls="Ext.Component">xtype</a> of child Components to create in this Container when\r
296 a child item is specified as a raw configuration object, rather than as an instantiated Component.</p>\r
297 <p>Defaults to <tt>'panel'</tt>, except <a href="output/Ext.menu.Menu.html" ext:cls="Ext.menu.Menu">Ext.menu.Menu</a> which defaults to <tt>'menuitem'</tt>,\r
298 and <a href="output/Ext.Toolbar.html" ext:cls="Ext.Toolbar">Ext.Toolbar</a> and <a href="output/Ext.ButtonGroup.html" ext:cls="Ext.ButtonGroup">Ext.ButtonGroup</a> which default to <tt>'button'</tt>.</p></div></div></td><td class="msource">Container</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Container-defaults"></a><b><a href="source/Container.html#cfg-Ext.Container-defaults">defaults</a></b> : Object<div class="mdesc"><div class="short">A config object that will be applied to all components added to this container either via the items&#13;\r
299 config or via th...</div><div class="long"><p>A config object that will be applied to all components added to this container either via the <a href="output/Ext.Container.html#Ext.Container-items" ext:member="items" ext:cls="Ext.Container">items</a>\r
300 config or via the <a href="output/Ext.Container.html#Ext.Container-add" ext:member="add" ext:cls="Ext.Container">add</a> or <a href="output/Ext.Container.html#Ext.Container-insert" ext:member="insert" ext:cls="Ext.Container">insert</a> methods.  The <tt>defaults</tt> config can contain any\r
301 number of name/value property pairs to be added to each item, and should be valid for the types of items\r
302 being added to the container.  For example, to automatically apply padding to the body of each of a set of\r
303 contained <a href="output/Ext.Panel.html" ext:cls="Ext.Panel">Ext.Panel</a> items, you could pass: <tt>defaults: {bodyStyle:'padding:15px'}</tt>.</p><br/>\r
304 <p><b>Note</b>: <tt>defaults</tt> will not be applied to config objects if the option is already specified.\r
305 For example:</p><pre><code>defaults: {               <i>// defaults are applied to items, not the container\r</i>
306     autoScroll:true\r
307 },\r
308 items: [\r
309     {\r
310         xtype: <em>'panel'</em>,   <i>// defaults <b><b>do</b> not</b> have precedence over\r</i>
311         id: <em>'panel1'</em>,     <i>// options <b>in</b> config objects, so the defaults\r</i>
312         autoScroll: false <i>// will not be applied here, panel1 will be autoScroll:false\r</i>
313     },\r
314     <b>new</b> Ext.Panel({       <i>// defaults <b><b>do</b></b> have precedence over options\r</i>
315         id: <em>'panel2'</em>,     <i>// options <b>in</b> components, so the defaults\r</i>
316         autoScroll: false <i>// will be applied here, panel2 will be autoScroll:true.\r</i>
317     })\r
318 ]</code></pre></div></div></td><td class="msource">Container</td></tr><tr class="config-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-disabled"></a><b><a href="source/Component.html#cfg-Ext.Component-disabled">disabled</a></b> : Boolean<div class="mdesc">Render this component disabled (default is false).</div></td><td class="msource"><a href="output/Ext.Component.html#disabled" ext:member="#disabled" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-disabledClass"></a><b><a href="source/Component.html#cfg-Ext.Component-disabledClass">disabledClass</a></b> : String<div class="mdesc">CSS class added to the component when it is disabled (defaults to 'x-item-disabled').</div></td><td class="msource"><a href="output/Ext.Component.html#disabledClass" ext:member="#disabledClass" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</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 '').\r
319 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>
320 <br><p><b>Note</b>: this config is only used when this Component is rendered by a Container which
321 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.
322 <a href="output/Ext.form.FormPanel.html" ext:cls="Ext.form.FormPanel">Ext.form.FormPanel</a> or specifying <tt>layout:'form'</tt>).</p><br>
323 <p>Also see <tt><a href="output/Ext.Component.html#Ext.Component-hideLabel" ext:member="hideLabel" ext:cls="Ext.Component">hideLabel</a></tt> and
324 <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>
325 Example use:<pre><code><b>new</b> Ext.FormPanel({
326     height: 100,
327     renderTo: Ext.getBody(),
328     items: [{
329         xtype: <em>'textfield'</em>,
330         fieldLabel: <em>'Name'</em>
331     }]
332 });</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 "><td class="micon"><a href="#expand" class="exi">&nbsp;</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&#13;\r
333 is useful for forcing f...</div><div class="long">If true the container will force a layout initially even if hidden or collapsed. This option\r
334 is useful for forcing forms to render in collapsed or hidden containers. (defaults to false).</div></div></td><td class="msource">Container</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</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).\r
335 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).
336 <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">&nbsp;</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
337 <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 expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Container-hideBorders"></a><b><a href="source/Container.html#cfg-Ext.Container-hideBorders">hideBorders</a></b> : Boolean<div class="mdesc"><div class="short">True to hide the borders of each contained component, false to defer to the component's existing&#13;\r
338 border settings (de...</div><div class="long">True to hide the borders of each contained component, false to defer to the component's existing\r
339 border settings (defaults to false).</div></div></td><td class="msource">Container</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</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\r
340 (label and separator). Defaults to false.\r
341 By default, even if you do not sp...</div><div class="long"><p><tt>true</tt> to completely hide the label element
342 (<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>.
343 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
344 reserved so that the field will line up with other fields that do have labels.
345 Setting this to <tt>true</tt> will cause the field to not reserve that space.</p>
346 <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>
347 Example use:<pre><code><b>new</b> Ext.FormPanel({
348     height: 100,
349     renderTo: Ext.getBody(),
350     items: [{
351         xtype: <em>'textfield'</em>
352         hideLabel: true
353     }]
354 });</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">&nbsp;</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'\r
355 (css visibility), 'offsets' (negative offset p...</div><div class="long"><p>How this component should be hidden. Supported values are <tt>'visibility'</tt>
356 (css visibility), <tt>'offsets'</tt> (negative offset position) and <tt>'display'</tt>
357 (css display).</p>
358 <br><p><b>Note</b>: the default of <tt>'display'</tt> is generally preferred
359 since items are automatically laid out when they are first shown (no sizing
360 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">&nbsp;</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\r
361 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
362 and show the component itself (defaults to false).  For example, this can be used as a shortcut for a hide
363 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 expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</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).\r
364 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>).
365 You should assign an id if you need to be able to access the component later and you do
366 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>
367 <p>Note that this id will also be used as the element id for the containing HTML element
368 that is rendered to the page for this component. This allows you to write id-based CSS
369 rules to style the specific instance of this component uniquely, and also to select
370 sub-elements using this component's id as the parent.</p>
371 <p><b>Note</b>: to avoid complications imposed by a unique <tt>id</tt> also see
372 <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>
373 <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">&nbsp;</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\r
374 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
375 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.
376 <a href="output/Ext.form.FormPanel.html" ext:cls="Ext.form.FormPanel">Ext.form.FormPanel</a> or specifying <tt>layout:'form'</tt>).</p><br>
377 <p>An additional CSS class to apply to the div wrapping the form item
378 element of this field.  If supplied, <tt>itemCls</tt> at the <b>field</b> level will override
379 the default <tt>itemCls</tt> supplied at the <b>container</b> level. The value specified for
380 <tt>itemCls</tt> will be added to the default class (<tt>'x-form-item'</tt>).</p>
381 <p>Since it is applied to the item wrapper (see
382 <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
383 you to write standard CSS rules that can apply to the field, the label (if specified), or
384 any other element within the markup for the field.</p>
385 <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>
386 Example use:<pre><code><i>// Apply a style to the field&#39;s <b>label</b>:</i>
387 &lt;style>
388     .required .x-form-item-<b>label</b> {font-weight:bold;color:red;}
389 &lt;/style>
390
391 <b>new</b> Ext.FormPanel({
392     height: 100,
393     renderTo: Ext.getBody(),
394     items: [{
395         xtype: <em>'textfield'</em>,
396         fieldLabel: <em>'Name'</em>,
397         itemCls: <em>'required'</em> <i>//this <b>label</b> will be styled</i>
398     },{
399         xtype: <em>'textfield'</em>,
400         fieldLabel: <em>'Favorite Color'</em>
401     }]
402 });</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">&nbsp;</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\r
403 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
404 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
405 <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
406 <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
407 <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
408 container's internal MixedCollection, the <code>itemId</code> is scoped locally to the container --
409 avoiding potential conflicts with <a href="output/Ext.ComponentMgr.html" ext:cls="Ext.ComponentMgr">Ext.ComponentMgr</a> which requires a <b>unique</b>
410 <code><a href="output/Ext.Component.html#Ext.Component-id" ext:member="id" ext:cls="Ext.Component">id</a></code>.</p>
411 <pre><code><b>var</b> c = <b>new</b> Ext.Panel({ <i>//</i>
412     <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-height" ext:member="height" ext:cls="Ext.BoxComponent">height</a>: 300,
413     <a href="output/Ext.Component.html#Ext.Component-renderTo" ext:member="renderTo" ext:cls="Ext.Component">renderTo</a>: document.body,
414     <a href="output/Ext.Container.html#Ext.Container-layout" ext:member="layout" ext:cls="Ext.Container">layout</a>: <em>'auto'</em>,
415     <a href="output/Ext.Container.html#Ext.Container-items" ext:member="items" ext:cls="Ext.Container">items</a>: [
416         {
417             itemId: <em>'p1'</em>,
418             <a href="output/Ext.Panel.html#Ext.Panel-title" ext:member="title" ext:cls="Ext.Panel">title</a>: <em>'Panel 1'</em>,
419             <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-height" ext:member="height" ext:cls="Ext.BoxComponent">height</a>: 150
420         },
421         {
422             itemId: <em>'p2'</em>,
423             <a href="output/Ext.Panel.html#Ext.Panel-title" ext:member="title" ext:cls="Ext.Panel">title</a>: <em>'Panel 2'</em>,
424             <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-height" ext:member="height" ext:cls="Ext.BoxComponent">height</a>: 150
425         }
426     ]
427 })
428 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>
429 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>
430 <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>
431 <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 "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Container-items"></a><b><a href="source/Container.html#cfg-Ext.Container-items">items</a></b> : Object/Array<div class="mdesc"><div class="short">** IMPORTANT: be sure to specify a layout if needed ! **&#13;\r
432 A single item, or an array of child Components to be added ...</div><div class="long"><pre><b>** IMPORTANT</b>: be sure to <b><a href="output/Ext.Container.html#Ext.Container-layout" ext:member="layout" ext:cls="Ext.Container">specify a <code>layout</code></a> if needed ! **</b></pre>\r
433 <p>A single item, or an array of child Components to be added to this container,\r
434 for example:</p>\r
435 <pre><code><i>// specifying a single item\r</i>
436 items: {...},\r
437 layout: <em>'fit'</em>,    <i>// specify a layout!\r</i>
438 \r
439 <i>// specifying multiple items\r</i>
440 items: [{...}, {...}],\r
441 layout: <em>'anchor'</em>, <i>// specify a layout!</i></code></pre>\r
442 <p>Each item may be:</p>\r
443 <div><ul class="mdetail-params">\r
444 <li>any type of object based on <a href="output/Ext.Component.html" ext:cls="Ext.Component">Ext.Component</a></li>\r
445 <li>a fully instanciated object or</li>\r
446 <li>an object literal that:</li>\r
447 <div><ul class="mdetail-params">\r
448 <li>has a specified <code><a href="output/Ext.Component.html#Ext.Component-xtype" ext:member="xtype" ext:cls="Ext.Component">xtype</a></code></li>\r
449 <li>the <a href="output/Ext.Component.html#Ext.Component-xtype" ext:member="xtype" ext:cls="Ext.Component">Ext.Component.xtype</a> specified is associated with the Component\r
450 desired and should be chosen from one of the available xtypes as listed\r
451 in <a href="output/Ext.Component.html" ext:cls="Ext.Component">Ext.Component</a>.</li>\r
452 <li>If an <code><a href="output/Ext.Component.html#Ext.Component-xtype" ext:member="xtype" ext:cls="Ext.Component">xtype</a></code> is not explicitly\r
453 specified, the <a href="output/Ext.Container.html#Ext.Container-defaultType" ext:member="defaultType" ext:cls="Ext.Container">defaultType</a> for that Container is used.</li>\r
454 <li>will be "lazily instanciated", avoiding the overhead of constructing a fully\r
455 instanciated Component object</li>\r
456 </ul></div></ul></div>\r
457 <p><b>Notes</b>:</p>\r
458 <div><ul class="mdetail-params">\r
459 <li>Ext uses lazy rendering. Child Components will only be rendered\r
460 should it become necessary. Items are automatically laid out when they are first\r
461 shown (no sizing is done while hidden), or in response to a <a href="output/Ext.Container.html#Ext.Container-doLayout" ext:member="doLayout" ext:cls="Ext.Container">doLayout</a> call.</li>\r
462 <li>Do not specify <code><a href="output/Ext.Panel.html#Ext.Panel-contentEl" ext:member="contentEl" ext:cls="Ext.Panel">contentEl</a></code>/\r
463 <code><a href="output/Ext.Panel.html#Ext.Panel-html" ext:member="html" ext:cls="Ext.Panel">html</a></code> with <code>items</code>.</li>\r
464 </ul></div></div></div></td><td class="msource">Container</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</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\r
465 fieldLabel.  This property may be configured at various levels.\r
466 The o...</div><div class="long"><p>The separator to display after the text of each
467 <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.
468 The order of precedence is:
469 <div class="mdetail-params"><ul>
470 <li>field / component level</li>
471 <li>container level</li>
472 <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>
473 </ul></div>
474 To display no separator for this field's label specify empty string ''.</p>
475 <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>
476 <p>Also see <tt><a href="output/Ext.Component.html#Ext.Component-hideLabel" ext:member="hideLabel" ext:cls="Ext.Component">hideLabel</a></tt> and
477 <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>
478 Example use:<pre><code><b>new</b> Ext.FormPanel({
479     height: 100,
480     renderTo: Ext.getBody(),
481     layoutConfig: {
482         labelSeparator: <em>'~'</em>   <i>// layout config has lowest priority (defaults to <em>':'</em>)</i>
483     },
484     <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>
485     items: [{
486         xtype: <em>'textfield'</em>,
487         fieldLabel: <em>'Field 1'</em>,
488         labelSeparator: <em>'...'</em> <i>// field/component level config supersedes others</i>
489     },{
490         xtype: <em>'textfield'</em>,
491         fieldLabel: <em>'Field 2'</em> <i>// labelSeparator will be <em>'='</em></i>
492     }]
493 });</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">&nbsp;</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\r
494 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
495 label.  Defaults to the container's labelStyle value if set (e.g.,
496 <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>
497 <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>
498 <p>Also see <code><a href="output/Ext.Component.html#Ext.Component-hideLabel" ext:member="hideLabel" ext:cls="Ext.Component">hideLabel</a></code> and
499 <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>
500 Example use:<pre><code><b>new</b> Ext.FormPanel({
501     height: 100,
502     renderTo: Ext.getBody(),
503     items: [{
504         xtype: <em>'textfield'</em>,
505         fieldLabel: <em>'Name'</em>,
506         labelStyle: <em>'font-weight:bold;'</em>
507     }]
508 });</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 expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Container-layout"></a><b><a href="source/Container.html#cfg-Ext.Container-layout">layout</a></b> : String/Object<div class="mdesc"><div class="short">*Important: In order for child items to be correctly sized and&#13;\r
509 positioned, typically a layout manager must be specif...</div><div class="long"><p><b>*Important</b>: In order for child items to be correctly sized and\r
510 positioned, typically a layout manager <b>must</b> be specified through\r
511 the <code>layout</code> configuration option.</p>\r
512 <br><p>The sizing and positioning of child <a href="output/items.html" ext:cls="items">items</a> is the responsibility of\r
513 the Container's layout manager which creates and manages the type of layout\r
514 you have in mind.  For example:</p><pre><code><b>new</b> Ext.Window({\r
515     width:300, height: 300,\r
516     layout: <em>'fit'</em>, <i>// explicitly set layout manager: override the <b>default</b> (layout:<em>'auto'</em>)\r</i>
517     items: [{\r
518         title: <em>'Panel inside a Window'</em>\r
519     }]\r
520 }).show();</code></pre>\r
521 <p>If the <a href="output/Ext.Container.html#Ext.Container-layout" ext:member="layout" ext:cls="Ext.Container">layout</a> configuration is not explicitly specified for\r
522 a general purpose container (e.g. Container or Panel) the\r
523 <a href="output/Ext.layout.ContainerLayout.html" ext:cls="Ext.layout.ContainerLayout">default layout manager</a> will be used\r
524 which does nothing but render child components sequentially into the\r
525 Container (no sizing or positioning will be performed in this situation).\r
526 Some container classes implicitly specify a default layout\r
527 (e.g. FormPanel specifies <code>layout:<em>'form'</em></code>). Other specific\r
528 purpose classes internally specify/manage their internal layout (e.g.\r
529 GridPanel, TabPanel, TreePanel, Toolbar, Menu, etc.).</p>\r
530 <br><p><b><code>layout</code></b> may be specified as either as an Object or\r
531 as a String:</p><div><ul class="mdetail-params">\r
532 <li><u>Specify as an Object</u></li>\r
533 <div><ul class="mdetail-params">\r
534 <li>Example usage:</li>\r
535 <pre><code>layout: {\r
536     type: <em>'vbox'</em>,\r
537     padding: <em>'5'</em>,\r
538     align: <em>'left'</em>\r
539 }</code></pre>\r
540 <li><tt><b>type</b></tt></li>\r
541 <br/><p>The layout type to be used for this container.  If not specified,\r
542 a default <a href="output/Ext.layout.ContainerLayout.html" ext:cls="Ext.layout.ContainerLayout">Ext.layout.ContainerLayout</a> will be created and used.</p>\r
543 <br/><p>Valid layout <tt>type</tt> values are:</p>\r
544 <div class="sub-desc"><ul class="mdetail-params">\r
545 <li><tt><b><a href="output/Ext.layout.AbsoluteLayout.html" ext:cls="Ext.layout.AbsoluteLayout">absolute</a></b></tt></li>\r
546 <li><tt><b><a href="output/Ext.layout.AccordionLayout.html" ext:cls="Ext.layout.AccordionLayout">accordion</a></b></tt></li>\r
547 <li><tt><b><a href="output/Ext.layout.AnchorLayout.html" ext:cls="Ext.layout.AnchorLayout">anchor</a></b></tt></li>\r
548 <li><tt><b><a href="output/Ext.layout.ContainerLayout.html" ext:cls="Ext.layout.ContainerLayout">auto</a></b></tt> &nbsp;&nbsp;&nbsp; <b>Default</b></li>\r
549 <li><tt><b><a href="output/Ext.layout.BorderLayout.html" ext:cls="Ext.layout.BorderLayout">border</a></b></tt></li>\r
550 <li><tt><b><a href="output/Ext.layout.CardLayout.html" ext:cls="Ext.layout.CardLayout">card</a></b></tt></li>\r
551 <li><tt><b><a href="output/Ext.layout.ColumnLayout.html" ext:cls="Ext.layout.ColumnLayout">column</a></b></tt></li>\r
552 <li><tt><b><a href="output/Ext.layout.FitLayout.html" ext:cls="Ext.layout.FitLayout">fit</a></b></tt></li>\r
553 <li><tt><b><a href="output/Ext.layout.FormLayout.html" ext:cls="Ext.layout.FormLayout">form</a></b></tt></li>\r
554 <li><tt><b><a href="output/Ext.layout.HBoxLayout.html" ext:cls="Ext.layout.HBoxLayout">hbox</a></b></tt></li>\r
555 <li><tt><b><a href="output/Ext.layout.MenuLayout.html" ext:cls="Ext.layout.MenuLayout">menu</a></b></tt></li>\r
556 <li><tt><b><a href="output/Ext.layout.TableLayout.html" ext:cls="Ext.layout.TableLayout">table</a></b></tt></li>\r
557 <li><tt><b><a href="output/Ext.layout.ToolbarLayout.html" ext:cls="Ext.layout.ToolbarLayout">toolbar</a></b></tt></li>\r
558 <li><tt><b><a href="output/Ext.layout.VBoxLayout.html" ext:cls="Ext.layout.VBoxLayout">vbox</a></b></tt></li>\r
559 </ul></div>\r
560 <li>Layout specific configuration properties</li>\r
561 <br/><p>Additional layout specific configuration properties may also be\r
562 specified. For complete details regarding the valid config options for\r
563 each layout type, see the layout class corresponding to the <tt>type</tt>\r
564 specified.</p>\r
565 </ul></div>\r
566 <li><u>Specify as a String</u></li>\r
567 <div><ul class="mdetail-params">\r
568 <li>Example usage:</li>\r
569 <pre><code>layout: <em>'vbox'</em>,\r
570 layoutConfig: {\r
571     padding: <em>'5'</em>,\r
572     align: <em>'left'</em>\r
573 }</code></pre>\r
574 <li><tt><b>layout</b></tt></li>\r
575 <br/><p>The layout <tt>type</tt> to be used for this container (see list\r
576 of valid layout type values above).</p><br/>\r
577 <li><tt><b><a href="output/Ext.Container.html#Ext.Container-layoutConfig" ext:member="layoutConfig" ext:cls="Ext.Container">layoutConfig</a></b></tt></li>\r
578 <br/><p>Additional layout specific configuration properties. For complete\r
579 details regarding the valid config options for each layout type, see the\r
580 layout class corresponding to the <tt>layout</tt> specified.</p>\r
581 </ul></div></ul></div></div></div></td><td class="msource">Container</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Container-layoutConfig"></a><b><a href="source/Container.html#cfg-Ext.Container-layoutConfig">layoutConfig</a></b> : Object<div class="mdesc"><div class="short">This is a config object containing properties specific to the chosen&#13;\r
582 layout if layout&#13;\r
583 has been specified as a strin...</div><div class="long">This is a config object containing properties specific to the chosen\r
584 <b><code><a href="output/Ext.Container.html#Ext.Container-layout" ext:member="layout" ext:cls="Ext.Container">layout</a></code></b> if <b><code><a href="output/Ext.Container.html#Ext.Container-layout" ext:member="layout" ext:cls="Ext.Container">layout</a></code></b>\r
585 has been specified as a <i>string</i>.</p></div></div></td><td class="msource">Container</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</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\r
586 object during initialization.  This should ...</div><div class="long"><p>A config object containing one or more event handlers to be added to this
587 object during initialization.  This should be a valid listeners config object as specified in the
588 <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>
589 <br><p><b><u>DOM events from ExtJs <a href="output/Ext.Component.html" ext:cls="Ext.Component">Components</a></u></b></p>
590 <br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
591 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
592 <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
593 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
594 has been rendered. A plugin can simplify this step:<pre><code><i>// Plugin is configured <b>with</b> a listeners config object.</i>
595 <i>// The Component is appended to the argument list of all handler functions.</i>
596 Ext.DomObserver = Ext.extend(Object, {
597     constructor: <b>function</b>(config) {
598         this.listeners = config.listeners ? config.listeners : config;
599     },
600
601     <i>// Component passes itself into plugin&#39;s init method</i>
602     init: <b>function</b>(c) {
603         <b>var</b> p, l = this.listeners;
604         <b>for</b> (p <b>in</b> l) {
605             <b>if</b> (Ext.isFunction(l[p])) {
606                 l[p] = this.createHandler(l[p], c);
607             } <b>else</b> {
608                 l[p].fn = this.createHandler(l[p].fn, c);
609             }
610         }
611
612         <i>// Add the listeners to the Element immediately following the render call</i>
613         c.render = c.render.<a href="output/Function.html#Function-createSequence" ext:member="createSequence" ext:cls="Function">createSequence</a>(<b>function</b>() {
614             <b>var</b> e = c.getEl();
615             <b>if</b> (e) {
616                 e.on(l);
617             }
618         });
619     },
620
621     createHandler: <b>function</b>(fn, c) {
622         <b>return</b> <b>function</b>(e) {
623             fn.call(this, e, c);
624         };
625     }
626 });
627
628 <b>var</b> combo = <b>new</b> Ext.form.ComboBox({
629
630     <i>// Collapse combo when its element is clicked on</i>
631     plugins: [ <b>new</b> Ext.DomObserver({
632         click: <b>function</b>(evt, comp) {
633             comp.collapse();
634         }
635     })],
636     store: myStore,
637     typeAhead: true,
638     mode: <em>'local'</em>,
639     triggerAction: <em>'all'</em>
640 });</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 expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</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\r
641 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
642 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>
643 or one of the two <b><a href="output/Ext.layout.BoxLayout.html" ext:cls="Ext.layout.BoxLayout">BoxLayout</a> subclasses.</b></p>
644 <p>An object containing margins to apply to this BoxComponent in the
645 format:</p><pre><code>{
646     top: (top margin),
647     right: (right margin),
648     bottom: (bottom margin),
649     left: (left margin)
650 }</code></pre>
651 <p>May also be a string containing space-separated, numeric margin values. The order of the
652 sides associated with each value matches the way CSS processes margin values:</p>
653 <p><div class="mdetail-params"><ul>
654 <li>If there is only one value, it applies to all sides.</li>
655 <li>If there are two values, the top and bottom borders are set to the first value and the
656 right and left are set to the second.</li>
657 <li>If there are three values, the top is set to the first value, the left and right are set
658 to the second, and the bottom is set to the third.</li>
659 <li>If there are four values, they apply to the top, right, bottom, and left, respectively.</li>
660 </ul></div></p>
661 <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 "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Container-monitorResize"></a><b><a href="source/Container.html#cfg-Ext.Container-monitorResize">monitorResize</a></b> : Boolean<div class="mdesc"><div class="short">True to automatically monitor window resize events to handle anything that is sensitive to the current size&#13;\r
662 of the v...</div><div class="long">True to automatically monitor window resize events to handle anything that is sensitive to the current size\r
663 of the viewport.  This value is typically managed by the chosen <code><a href="output/Ext.Container.html#Ext.Container-layout" ext:member="layout" ext:cls="Ext.Container">layout</a></code> and should not need\r
664 to be set manually.</div></div></td><td class="msource">Container</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-overCls"></a><b><a href="source/Component.html#cfg-Ext.Component-overCls">overCls</a></b> : String<div class="mdesc"><div class="short">An optional extra CSS class that will be added to this component's Element when the mouse moves\r
665 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
666 over the Element, and removed when the mouse moves out. (defaults to '').  This can be
667 useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules.</div></div></td><td class="msource"><a href="output/Ext.Component.html#overCls" ext:member="#overCls" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</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">&nbsp;</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 expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-plugins"></a><b><a href="source/Component.html#cfg-Ext.Component-plugins">plugins</a></b> : Object/Array<div class="mdesc"><div class="short">An object or array of objects that will provide custom functionality for this component.  The only\r
668 requirement for a ...</div><div class="long">An object or array of objects that will provide custom functionality for this component.  The only
669 requirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.Component.
670 When a component is created, if any plugins are available, the component will call the init method on each
671 plugin, passing a reference to itself.  Each plugin can then call methods or respond to events on the
672 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">&nbsp;</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\r
673 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
674 a config object into a constructor. This config option is used only when
675 lazy instantiation is being used, and a Plugin is being
676 specified not as a fully instantiated Component, but as a <i>Component config
677 object</i>. The <tt>ptype</tt> will be looked up at render time up to determine what
678 type of Plugin to create.<br><br>
679 If you create your own Plugins, you may register them using
680 <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
681 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">&nbsp;</a></td><td class="sig"><a id="Ext.Component-ref"></a><b><a href="source/Component.html#cfg-Ext.Component-ref">ref</a></b> : String<div class="mdesc"><div class="short">A path specification, relative to the Component's ownerCt specifying into which\r
682 ancestor Container to place a named r...</div><div class="long"><p>A path specification, relative to the Component's <a href="output/Ext.Component.html#Ext.Component-ownerCt" ext:member="ownerCt" ext:cls="Ext.Component">ownerCt</a> specifying into which
683 ancestor Container to place a named reference to this Component.</p>
684 <p>The ancestor axis can be traversed by using '/' characters in the path.
685 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({
686     title: <em>'My EditorGridPanel'</em>,
687     store: myStore,
688     colModel: myColModel,
689     tbar: [{
690         text: <em>'Save'</em>,
691         handler: saveChanges,
692         disabled: true,
693         ref: <em>'../saveButton'</em>
694     }],
695     listeners: {
696         afteredit: <b>function</b>() {
697 <i>//          The button reference is <b>in</b> the GridPanel</i>
698             myGrid.saveButton.enable();
699         }
700     }
701 });</code></pre>
702 <p>In the code above, if the ref had been <code><em>'saveButton'</em></code> the reference would
703 have been placed into the Toolbar. Each '/' in the ref moves up one level from the
704 Component's <a href="output/Ext.Component.html#Ext.Component-ownerCt" ext:member="ownerCt" ext:cls="Ext.Component">ownerCt</a>.</p></div></div></td><td class="msource"><a href="output/Ext.Component.html#ref" ext:member="#ref" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-region"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-region">region</a></b> : String<div class="mdesc"><div class="short">Note: this config is only used when this BoxComponent is rendered\r
705 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
706 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>
707 layout manager (e.g. specifying <tt>layout:'border'</tt>).</p><br>
708 <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">&nbsp;</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\r
709 will be rendered into.\r
710 Notes ...</div><div class="long"><p>Specify the id of the element, a DOM element or an existing Element that this component
711 will be rendered into.</p><div><ul>
712 <li><b>Notes</b> : <ul>
713 <div class="sub-desc">Do <u>not</u> use this option if the Component is to be a child item of
714 a <a href="output/Ext.Container.html" ext:cls="Ext.Container">Container</a>. It is the responsibility of the
715 <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>
716 to render and manage its child items.</div>
717 <div class="sub-desc">When using this config, a call to render() is not required.</div>
718 </ul></li>
719 </ul></div>
720 <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">&nbsp;</a></td><td class="sig"><a id="Ext.Container-resizeEvent"></a><b><a href="source/Container.html#cfg-Ext.Container-resizeEvent">resizeEvent</a></b> : String<div class="mdesc">The event to listen to for resizing in layouts. Defaults to <tt>'resize'</tt>.</div></td><td class="msource">Container</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</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\r
721 save its state (defaults to none). stateEvents ...</div><div class="long"><p>An array of events that, when fired, should trigger this component to
722 save its state (defaults to none). <code>stateEvents</code> may be any type
723 of event supported by this component, including browser or custom events
724 (e.g., <tt>['click', 'customerchange']</tt>).</p>
725 <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
726 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">&nbsp;</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\r
727 (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
728 (defaults to the component id if one was set, otherwise null if the
729 component is using a generated id).
730 <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
731 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">&nbsp;</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\r
732 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
733 internal properties from a saved state on startup. The component must have
734 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
735 for state to be managed. Auto-generated ids are not guaranteed to be stable
736 across page loads and cannot be relied upon to save and restore the same
737 state for a component.<p>
738 <p>For state saving to work, the state manager's provider must have been
739 set to an implementation of <a href="output/Ext.state.Provider.html" ext:cls="Ext.state.Provider">Ext.state.Provider</a> which overrides the
740 <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>
741 methods to save and recall name/value pairs. A built-in implementation,
742 <a href="output/Ext.state.CookieProvider.html" ext:cls="Ext.state.CookieProvider">Ext.state.CookieProvider</a> is available.</p>
743 <p>To set the state provider for the current page:</p>
744 <pre><code>Ext.state.Manager.setProvider(<b>new</b> Ext.state.CookieProvider({
745     expires: <b>new</b> Date(<b>new</b> Date().getTime()+(1000*60*60*24*7)), <i>//7 days from now</i>
746 }));</code></pre>
747 <p>A stateful Component attempts to save state when one of the events
748 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>
749 <p>To save state, a stateful Component first serializes its state by
750 calling <b><code>getState</code></b>. By default, this function does
751 nothing. The developer must provide an implementation which returns an
752 object hash which represents the Component's restorable state.</p>
753 <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>
754 which uses the configured <a href="output/Ext.state.Provider.html" ext:cls="Ext.state.Provider">Ext.state.Provider</a> to save the object
755 keyed by the Component's <code><a href="output/stateId.html" ext:cls="stateId">stateId</a></code>, or, if that is not
756 specified, its <code><a href="output/Ext.Component.html#Ext.Component-id" ext:member="id" ext:cls="Ext.Component">id</a></code>.</p>
757 <p>During construction, a stateful Component attempts to <i>restore</i>
758 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
759 <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
760 <code><a href="output/Ext.Component.html#Ext.Component-id" ext:member="id" ext:cls="Ext.Component">id</a></code>.</p>
761 <p>The resulting object is passed to <b><code>applyState</code></b>.
762 The default implementation of <code>applyState</code> simply copies
763 properties into the object, but a developer may override this to support
764 more behaviour.</p>
765 <p>You can perform extra processing on state save and restore by attaching
766 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>,
767 <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">&nbsp;</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\r
768 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
769 <a href="output/Ext.Element.html#Ext.Element-applyStyles" ext:member="applyStyles" ext:cls="Ext.Element">Ext.Element.applyStyles</a>.
770 <pre><code><b>new</b> Ext.Panel({
771     title: <em>'Some Title'</em>,
772     renderTo: Ext.getBody(),
773     width: 400, height: 300,
774     layout: <em>'form'</em>,
775     items: [{
776         xtype: <em>'textarea'</em>,
777         style: {
778             width: <em>'95%'</em>,
779             marginBottom: <em>'10px'</em>
780         }
781     },
782         <b>new</b> Ext.Button({
783             text: <em>'Send'</em>,
784             minWidth: <em>'100'</em>,
785             style: {
786                 marginBottom: <em>'10px'</em>
787             }
788         })
789     ]
790 });</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">&nbsp;</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.\r
791 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>
792 A string to be used as innerHTML (html tags are accepted) to show in a tooltip when mousing over
793 the associated tab selector element. <a href="output/Ext.QuickTips.html" ext:cls="Ext.QuickTips">Ext.QuickTips</a>.init()
794 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">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-width"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-width">width</a></b> : Number<div class="mdesc"><div class="short">The width of this component in pixels (defaults to auto).\r
795 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).
796 <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">&nbsp;</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">&nbsp;</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\r
797 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
798 a config object into a constructor. This config option is used only when
799 lazy instantiation is being used, and a child item of a Container is being
800 specified not as a fully instantiated Component, but as a <i>Component config
801 object</i>. The <tt>xtype</tt> will be looked up at render time up to determine what
802 type of child Component to create.<br><br>
803 The predefined xtypes are listed <a href="output/Ext.Component.html" ext:cls="Ext.Component">here</a>.
804 <br><br>
805 If you subclass Components to create your own Components, you may register
806 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
807 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">&nbsp;</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.Container-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  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-disabled"></a><b><a href="source/Component.html#prop-Ext.Component-disabled">disabled</a></b> : Boolean<div class="mdesc">True if this component is disabled. Read-only.</div></td><td class="msource"><a href="output/Ext.Component.html#disabled" ext:member="#disabled" ext:cls="Ext.Component">Component</a></td></tr><tr class="property-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</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.\r
808 This will usually be a &amp;lt;DIV&gt; 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>
809 <p>This will <i>usually</i> be a &lt;DIV> element created by the class's onRender method, but
810 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>
811 <br><p><b>Note</b>: this element will not be available until this Component has been rendered.</p><br>
812 <p>To add listeners for <b>DOM events</b> to this Component (as opposed to listeners
813 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>
814 config for a suggestion, or use a render listener directly:</p><pre><code><b>new</b> Ext.Panel({
815     title: <em>'The Clickable Panel'</em>,
816     listeners: {
817         render: <b>function</b>(p) {
818             <i>// Append the Panel to the click handler&#39;s argument list.</i>
819             p.getEl().on(<em>'click'</em>, handlePanelClick.createDelegate(null, [p], true));
820         },
821         single: true  <i>// Remove the listener after first invocation</i>
822     }
823 });</code></pre>
824 <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  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</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">&nbsp;</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  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Container-items"></a><b><a href="source/Container.html#prop-Ext.Container-items">items</a></b> : MixedCollection<div class="mdesc">The collection of components in this container as a <a href="output/Ext.util.MixedCollection.html" ext:cls="Ext.util.MixedCollection">Ext.util.MixedCollection</a></div></td><td class="msource">Container</td></tr><tr class="property-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-ownerCt"></a><b><a href="source/Component.html#prop-Ext.Component-ownerCt">ownerCt</a></b> : Ext.Container<div class="mdesc"><div class="short">This Component's owner Container (defaults to undefined, and is set automatically when\r
825 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
826 this Component is added to a Container).  Read-only.
827 <p><b>Note</b>: to access items within the Container see <tt><a href="output/Ext.Component.html#Ext.Component-itemId" ext:member="itemId" ext:cls="Ext.Component">itemId</a></tt>.</p></div></div></td><td class="msource"><a href="output/Ext.Component.html#ownerCt" ext:member="#ownerCt" ext:cls="Ext.Component">Component</a></td></tr><tr class="property-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</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></tbody></table><a id="Ext.Container-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">&nbsp;</a></td><td class="sig"><a id="Ext.Container-add"></a><b><a href="source/Container.html#method-Ext.Container-add">add</a></b>(&nbsp;<code>Object/Array&nbsp;component</code>,&nbsp;<code>Object&nbsp;(Optional)</code>,&nbsp;<code>Object&nbsp;(Optional)</code>&nbsp;)\r
828     :\r
829                                         Ext.Component<div class="mdesc"><div class="short">Adds Component(s) to this Container.&#13;\r
830 Description :&#13;\r
831 &lt;ul class="mdetail-params"&gt;&#13;\r
832 Fires the beforeadd event before ad...</div><div class="long"><p>Adds <a href="output/Ext.Component.html" ext:cls="Ext.Component">Component</a>(s) to this Container.</p>\r
833 <br><p><b>Description</b></u> :\r
834 <div><ul class="mdetail-params">\r
835 <li>Fires the <a href="output/Ext.Container.html#Ext.Container-beforeadd" ext:member="beforeadd" ext:cls="Ext.Container">beforeadd</a> event before adding</li>\r
836 <li>The Container's <a href="output/Ext.Container.html#Ext.Container-defaults" ext:member="defaults" ext:cls="Ext.Container">default config values</a> will be applied\r
837 accordingly (see <code><a href="output/Ext.Container.html#Ext.Container-defaults" ext:member="defaults" ext:cls="Ext.Container">defaults</a></code> for details).</li>\r
838 <li>Fires the <a href="output/Ext.Container.html#Ext.Container-add" ext:member="add" ext:cls="Ext.Container">add</a> event after the component has been added.</li>\r
839 </ul></div>\r
840 <br><p><b>Notes</b></u> :\r
841 <div><ul class="mdetail-params">\r
842 <li>If the Container is <i>already rendered</i> when <tt>add</tt>\r
843 is called, you may need to call <a href="output/Ext.Container.html#Ext.Container-doLayout" ext:member="doLayout" ext:cls="Ext.Container">doLayout</a> to refresh the view which causes\r
844 any unrendered child Components to be rendered. This is required so that you can\r
845 <tt>add</tt> multiple child components if needed while only refreshing the layout\r
846 once. For example:<pre><code><b>var</b> tb = <b>new</b> <a href="output/Ext.Toolbar.html" ext:cls="Ext.Toolbar">Ext.Toolbar</a>();\r
847 tb.render(document.body);  <i>// toolbar is rendered\r</i>
848 tb.add({text:<em>'Button 1'</em>}); <i>// add multiple items (<a href="output/Ext.Container.html#Ext.Container-defaultType" ext:member="defaultType" ext:cls="Ext.Container">defaultType</a> <b>for</b> <a href="output/Ext.Toolbar.html" ext:cls="Ext.Toolbar">Toolbar</a> is <em>'button'</em>)\r</i>
849 tb.add({text:<em>'Button 2'</em>});\r
850 tb.<a href="output/Ext.Container.html#Ext.Container-doLayout" ext:member="doLayout" ext:cls="Ext.Container">doLayout</a>();             <i>// refresh the layout</i></code></pre></li>\r
851 <li><i>Warning:</i> Containers directly managed by the BorderLayout layout manager\r
852 may not be removed or added.  See the Notes for <a href="output/Ext.layout.BorderLayout.html" ext:cls="Ext.layout.BorderLayout">BorderLayout</a>\r
853 for more details.</li>\r
854 </ul></div><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>component</code> : Object/Array<div class="sub-desc"><p>Either a single component or an Array of components to add.  See\r
855 <code><a href="output/Ext.Container.html#Ext.Container-items" ext:member="items" ext:cls="Ext.Container">items</a></code> for additional information.</p></div></li><li><code>(Optional)</code> : Object<div class="sub-desc">component_2</div></li><li><code>(Optional)</code> : Object<div class="sub-desc">component_n</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Component</code><div class="sub-desc">component The Component (or config object) that was added.</div></li></ul></div></div></div></td><td class="msource">Container</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-addClass"></a><b><a href="source/Component.html#method-Ext.Component-addClass">addClass</a></b>(&nbsp;<code>string&nbsp;cls</code>&nbsp;)\r
856     :\r
857                                         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">&nbsp;</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>(&nbsp;<code>Object|String&nbsp;o</code>,&nbsp;<code>string&nbsp;Optional.</code>&nbsp;)\r
858     :\r
859                                         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>
860 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.
861 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">&nbsp;</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>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Function&nbsp;handler</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;options</code>]</span>&nbsp;)\r
862     :\r
863                                         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.
864 <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.
865 properties. This may contain any of the following properties:<ul>
866 <li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
867 <b>If omitted, defaults to the object which fired the event.</b></div></li>
868 <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>
869 <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>
870 <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
871 by the specified number of milliseconds. If the event fires again within that time, the original
872 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
873 <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>
874 if the event was bubbled up from a child Observable.</div></li>
875 </ul><br>
876 <p>
877 <b>Combining Options</b><br>
878 Using the options argument, it is possible to combine different types of listeners:<br>
879 <br>
880 A delayed, one-time listener.
881 <pre><code>myDataView.on(<em>'click'</em>, this.onClick, this, {
882 single: true,
883 delay: 100
884 });</code></pre>
885 <p>
886 <b>Attaching multiple handlers in 1 call</b><br>
887 The method also allows for a single argument to be passed which is a config object containing properties
888 which specify multiple handlers.
889 <p>
890 <pre><code>myGridPanel.on({
891 <em>'click'</em> : {
892     fn: this.onClick,
893     scope: this,
894     delay: 100
895 },
896 <em>'mouseover'</em> : {
897     fn: this.onMouseOver,
898     scope: this
899 },
900 <em>'mouseout'</em> : {
901     fn: this.onMouseOut,
902     scope: this
903 }
904 });</code></pre>
905 <p>
906 Or a shorthand syntax:<br>
907 <pre><code>myGridPanel.on({
908 <em>'click'</em> : this.onClick,
909 <em>'mouseover'</em> : this.onMouseOver,
910 <em>'mouseout'</em> : this.onMouseOut,
911  scope: this
912 });</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">&nbsp;</a></td><td class="sig"><a id="Ext.Component-applyToMarkup"></a><b><a href="source/Component.html#method-Ext.Component-applyToMarkup">applyToMarkup</a></b>(&nbsp;<code>String/HTMLElement&nbsp;el</code>&nbsp;)\r
913     :\r
914                                         void<div class="mdesc"><div class="short">Apply this component to existing markup that is valid. With this function, no call to render() is required.</div><div class="long">Apply this component to existing markup that is valid. With this function, no call to render() is required.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>el</code> : String/HTMLElement<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#applyToMarkup" ext:member="#applyToMarkup" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Container-bubble"></a><b><a href="source/Container.html#method-Ext.Container-bubble">bubble</a></b>(&nbsp;<code>Function&nbsp;fn</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Array&nbsp;args</code>]</span>&nbsp;)\r
915     :\r
916                                         Ext.Container<div class="mdesc"><div class="short">Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of...</div><div class="long">Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (<i>this</i>) of\r
917 function call will be the scope provided or the current component. The arguments to the function\r
918 will be the args provided or the current component. If the function returns false at any point,\r
919 the bubble is stopped.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>fn</code> : Function<div class="sub-desc">The function to call</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope of the function (defaults to current node)</div></li><li><code>args</code> : Array<div class="sub-desc">(optional) The args to call the function with (default to passing the current component)</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Container</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource">Container</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Container-cascade"></a><b><a href="source/Container.html#method-Ext.Container-cascade">cascade</a></b>(&nbsp;<code>Function&nbsp;fn</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Array&nbsp;args</code>]</span>&nbsp;)\r
920     :\r
921                                         Ext.Container<div class="mdesc"><div class="short">Cascades down the component/container heirarchy from this component (called first), calling the specified function wi...</div><div class="long">Cascades down the component/container heirarchy from this component (called first), calling the specified function with\r
922 each component. The scope (<i>this</i>) of\r
923 function call will be the scope provided or the current component. The arguments to the function\r
924 will be the args provided or the current component. If the function returns false at any point,\r
925 the cascade is stopped on that branch.<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 component)</div></li><li><code>args</code> : Array<div class="sub-desc">(optional) The args to call the function with (defaults to passing the current component)</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Container</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource">Container</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-cloneConfig"></a><b><a href="source/Component.html#method-Ext.Component-cloneConfig">cloneConfig</a></b>(&nbsp;<code>Object&nbsp;overrides</code>&nbsp;)\r
926     :\r
927                                         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.
928 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">&nbsp;</a></td><td class="sig"><a id="Ext.Component-destroy"></a><b><a href="source/Component.html#method-Ext.Component-destroy">destroy</a></b>()\r
929     :\r
930                                         void<div class="mdesc"><div class="short">Destroys this component by purging any event listeners, removing the component's element from the DOM,\r
931 removing the c...</div><div class="long">Destroys this component by purging any event listeners, removing the component's element from the DOM,
932 removing the component from its <a href="output/Ext.Container.html" ext:cls="Ext.Container">Ext.Container</a> (if applicable) and unregistering it from
933 <a href="output/Ext.ComponentMgr.html" ext:cls="Ext.ComponentMgr">Ext.ComponentMgr</a>.  Destruction is generally handled automatically by the framework and this method
934 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">&nbsp;</a></td><td class="sig"><a id="Ext.Component-disable"></a><b><a href="source/Component.html#method-Ext.Component-disable">disable</a></b>()\r
935     :\r
936                                         Ext.Component<div class="mdesc"><div class="short">Disable this component and fire the 'disable' event.</div><div class="long">Disable this component and fire the 'disable' event.<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#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">&nbsp;</a></td><td class="sig"><a id="Ext.Container-doLayout"></a><b><a href="source/Container.html#method-Ext.Container-doLayout">doLayout</a></b>(&nbsp;<span title="Optional" class="optional">[<code>Boolean&nbsp;shallow</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Boolean&nbsp;force</code>]</span>&nbsp;)\r
937     :\r
938                                         Ext.Container<div class="mdesc"><div class="short">Force this container's layout to be recalculated. A call to this function is required after adding a new component&#13;\r
939 t...</div><div class="long">Force this container's layout to be recalculated. A call to this function is required after adding a new component\r
940 to an already rendered container, or possibly after changing sizing/position properties of child components.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>shallow</code> : Boolean<div class="sub-desc">(optional) True to only calc the layout of this component, and let child components auto\r
941 calc layouts as required (defaults to false, which calls doLayout recursively for each subcontainer)</div></li><li><code>force</code> : Boolean<div class="sub-desc">(optional) True to force a layout to occur, even if the item is hidden.</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Container</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource">Container</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-enable"></a><b><a href="source/Component.html#method-Ext.Component-enable">enable</a></b>()\r
942     :\r
943                                         Ext.Component<div class="mdesc"><div class="short">Enable this component and fire the 'enable' event.</div><div class="long">Enable this component and fire the 'enable' event.<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#enable" ext:member="#enable" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</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>(&nbsp;<code>Object&nbsp;events</code>&nbsp;)\r
944     :\r
945                                         void<div class="mdesc"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling&#13;\r
946 this.getBubbleTarget() if present...</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling\r
947 <code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>\r
948 <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\r
949 implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to\r
950 access the required target more quickly.</p>\r
951 <p>Example:</p><pre><code>Ext.override(Ext.form.Field, {\r
952 <i>//  Add functionality to Field<em>'s initComponent to enable the change event to bubble\r</i>
953     initComponent: Ext.form.Field.prototype.initComponent.createSequence(<b>function</b>() {\r
954         this.enableBubble('</em>change<em>');\r
955     }),\r
956 \r
957 <i>//  We know that we want Field'</em>s events to bubble directly to the FormPanel.\r</i>
958     getBubbleTarget: <b>function</b>() {\r
959         <b>if</b> (!this.formPanel) {\r
960             this.formPanel = this.findParentByType(<em>'form'</em>);\r
961         }\r
962         <b>return</b> this.formPanel;\r
963     }\r
964 });\r
965 \r
966 <b>var</b> myForm = <b>new</b> Ext.formPanel({\r
967     title: <em>'User Details'</em>,\r
968     items: [{\r
969         ...\r
970     }],\r
971     listeners: {\r
972         change: <b>function</b>() {\r
973 <i>//          Title goes red <b>if</b> form has been modified.\r</i>
974             myForm.header.setStyle(<em>"color"</em>, <em>"red"</em>);\r
975         }\r
976     }\r
977 });</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>events</code> : Object<div class="sub-desc">The event name to bubble, or an Array of event names.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#enableBubble" ext:member="#enableBubble" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Container-find"></a><b><a href="source/Container.html#method-Ext.Container-find">find</a></b>(&nbsp;<code>String&nbsp;prop</code>,&nbsp;<code>String&nbsp;value</code>&nbsp;)\r
978     :\r
979                                         Array<div class="mdesc"><div class="short">Find a component under this container at any level by property</div><div class="long">Find a component under this container at any level by property<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>prop</code> : String<div class="sub-desc"></div></li><li><code>value</code> : String<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li><code>Array</code><div class="sub-desc">Array of Ext.Components</div></li></ul></div></div></div></td><td class="msource">Container</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Container-findBy"></a><b><a href="source/Container.html#method-Ext.Container-findBy">findBy</a></b>(&nbsp;<code>Function&nbsp;fn</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>&nbsp;)\r
980     :\r
981                                         Array<div class="mdesc"><div class="short">Find a component under this container at any level by a custom function. If the passed function returns&#13;\r
982 true, the co...</div><div class="long">Find a component under this container at any level by a custom function. If the passed function returns\r
983 true, the component will be included in the results. The passed function is called with the arguments (component, this container).<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)</div></li></ul><strong>Returns:</strong><ul><li><code>Array</code><div class="sub-desc">Array of Ext.Components</div></li></ul></div></div></div></td><td class="msource">Container</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Container-findById"></a><b><a href="source/Container.html#method-Ext.Container-findById">findById</a></b>(&nbsp;<code>String&nbsp;id</code>&nbsp;)\r
984     :\r
985                                         Ext.Component<div class="mdesc"><div class="short">Find a component under this container at any level by id</div><div class="long">Find a component under this container at any level 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>Ext.Component</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">Container</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Container-findByType"></a><b><a href="source/Container.html#method-Ext.Container-findByType">findByType</a></b>(&nbsp;<code>String/Class&nbsp;xtype</code>,&nbsp;<span title="Optional" class="optional">[<code>Boolean&nbsp;shallow</code>]</span>&nbsp;)\r
986     :\r
987                                         Array<div class="mdesc"><div class="short">Find a component under this container at any level by xtype or class</div><div class="long">Find a component under this container at any level by xtype or class<div class="mdetail-params"><strong>Parameters:</strong><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><li><code>shallow</code> : Boolean<div class="sub-desc">(optional) False to check whether this Component is descended from the xtype (this is\r
988 the default), or true to check whether this Component is directly of the specified xtype.</div></li></ul><strong>Returns:</strong><ul><li><code>Array</code><div class="sub-desc">Array of Ext.Components</div></li></ul></div></div></div></td><td class="msource">Container</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-findParentBy"></a><b><a href="source/Component.html#method-Ext.Component-findParentBy">findParentBy</a></b>(&nbsp;<code>Function&nbsp;fn</code>&nbsp;)\r
989     :\r
990                                         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\r
991 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
992 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">&nbsp;</a></td><td class="sig"><a id="Ext.Component-findParentByType"></a><b><a href="source/Component.html#method-Ext.Component-findParentByType">findParentByType</a></b>(&nbsp;<code>String/Class&nbsp;xtype</code>&nbsp;)\r
993     :\r
994                                         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/Class<div class="sub-desc">The xtype string for a component, or the class of the component directly</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">&nbsp;</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>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Object...&nbsp;args</code>&nbsp;)\r
995     :\r
996                                         Boolean<div class="mdesc"><div class="short">Fires the specified event with the passed parameters (minus the event name).\r
997 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>
998 <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>)
999 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">&nbsp;</a></td><td class="sig"><a id="Ext.Component-focus"></a><b><a href="source/Component.html#method-Ext.Component-focus">focus</a></b>(&nbsp;<span title="Optional" class="optional">[<code>Boolean&nbsp;selectText</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Boolean/Number&nbsp;delay</code>]</span>&nbsp;)\r
1000     :\r
1001                                         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 "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Container-get"></a><b><a href="source/Container.html#method-Ext.Container-get">get</a></b>(&nbsp;<code>String/Number&nbsp;key</code>&nbsp;)\r
1002     :\r
1003                                         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">Container</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-getBox"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-getBox">getBox</a></b>(&nbsp;<span title="Optional" class="optional">[<code>Boolean&nbsp;local</code>]</span>&nbsp;)\r
1004     :\r
1005                                         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">&nbsp;</a></td><td class="sig"><a id="Ext.Component-getBubbleTarget"></a><b><a href="source/Component.html#method-Ext.Component-getBubbleTarget">getBubbleTarget</a></b>()\r
1006     :\r
1007                                         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">&nbsp;</a></td><td class="sig"><a id="Ext.Container-getComponent"></a><b><a href="source/Container.html#method-Ext.Container-getComponent">getComponent</a></b>(&nbsp;<code>String/Number&nbsp;comp</code>&nbsp;)\r
1008     :\r
1009                                         Ext.Component<div class="mdesc"><div class="short">Examines this container's items property&#13;\r
1010 and gets a direct child component of this container.</div><div class="long">Examines this container's <code><a href="output/Ext.Container.html#Ext.Container-items" ext:member="items" ext:cls="Ext.Container">items</a></code> <b>property</b>\r
1011 and gets a direct child component of this container.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>comp</code> : String/Number<div class="sub-desc">This parameter may be any of the following:\r
1012 <div><ul class="mdetail-params">\r
1013 <li>a <b><tt>String</tt></b> : representing the <code><a href="output/Ext.Component.html#Ext.Component-itemId" ext:member="itemId" ext:cls="Ext.Component">itemId</a></code>\r
1014 or <code><a href="output/Ext.Component.html#Ext.Component-id" ext:member="id" ext:cls="Ext.Component">id</a></code> of the child component </li>\r
1015 <li>a <b><tt>Number</tt></b> : representing the position of the child component\r
1016 within the <code><a href="output/Ext.Container.html#Ext.Container-items" ext:member="items" ext:cls="Ext.Container">items</a></code> <b>property</b></li>\r
1017 </ul></div>\r
1018 <p>For additional information see <a href="output/Ext.util.MixedCollection.html#Ext.util.MixedCollection-get" ext:member="get" ext:cls="Ext.util.MixedCollection">Ext.util.MixedCollection.get</a>.</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Component</code><div class="sub-desc">The component (if found).</div></li></ul></div></div></div></td><td class="msource">Container</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-getEl"></a><b><a href="source/Component.html#method-Ext.Component-getEl">getEl</a></b>()\r
1019     :\r
1020                                         Ext.Element<div class="mdesc"><div class="short">Returns the Ext.Element which encapsulates this Component.\r
1021 This will usually be a &amp;lt;DIV&gt; 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>
1022 <p>This will <i>usually</i> be a &lt;DIV> element created by the class's onRender method, but
1023 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>
1024 <br><p><b>Note</b>: this element will not be available until this Component has been rendered.</p><br>
1025 <p>To add listeners for <b>DOM events</b> to this Component (as opposed to listeners
1026 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,
1027 or use a render listener directly:</p><pre><code><b>new</b> Ext.Panel({
1028     title: <em>'The Clickable Panel'</em>,
1029     listeners: {
1030         render: <b>function</b>(p) {
1031             <i>// Append the Panel to the click handler&#39;s argument list.</i>
1032             p.getEl().on(<em>'click'</em>, handlePanelClick.createDelegate(null, [p], true));
1033         },
1034         single: true  <i>// Remove the listener after first invocation</i>
1035     }
1036 });</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">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-getHeight"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-getHeight">getHeight</a></b>()\r
1037     :\r
1038                                         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">&nbsp;</a></td><td class="sig"><a id="Ext.Component-getId"></a><b><a href="source/Component.html#method-Ext.Component-getId">getId</a></b>()\r
1039     :\r
1040                                         String<div class="mdesc"><div class="short">Returns the id of this component or automatically generates and\r
1041 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
1042 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">&nbsp;</a></td><td class="sig"><a id="Ext.Component-getItemId"></a><b><a href="source/Component.html#method-Ext.Component-getItemId">getItemId</a></b>()\r
1043     :\r
1044                                         String<div class="mdesc"><div class="short">Returns the itemId of this component.  If an\r
1045 itemId was not assigned through configuration the\r
1046 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
1047 <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
1048 <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 "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Container-getLayout"></a><b><a href="source/Container.html#method-Ext.Container-getLayout">getLayout</a></b>()\r
1049     :\r
1050                                         ContainerLayout<div class="mdesc"><div class="short">Returns the layout currently in use by the container.  If the container does not currently have a layout&#13;\r
1051 set, a defa...</div><div class="long">Returns the layout currently in use by the container.  If the container does not currently have a layout\r
1052 set, a default <a href="output/Ext.layout.ContainerLayout.html" ext:cls="Ext.layout.ContainerLayout">Ext.layout.ContainerLayout</a> will be created and set as the container's layout.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>ContainerLayout</code><div class="sub-desc">layout The container's layout</div></li></ul></div></div></div></td><td class="msource">Container</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Container-getLayoutTarget"></a><b><a href="source/Container.html#method-Ext.Container-getLayoutTarget">getLayoutTarget</a></b>()\r
1053     :\r
1054                                         Ext.Element<div class="mdesc"><div class="short">Returns the Element to be used to contain the child Components of this Container.&#13;\r
1055 An implementation is provided whic...</div><div class="long"><p>Returns the Element to be used to contain the child Components of this Container.</p>\r
1056 <p>An implementation is provided which returns the Container's <a href="output/Ext.Container.html#Ext.Container-getEl" ext:member="getEl" ext:cls="Ext.Container">Element</a>, but\r
1057 if there is a more complex structure to a Container, this may be overridden to return\r
1058 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">Container</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-getOuterSize"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-getOuterSize">getOuterSize</a></b>()\r
1059     :\r
1060                                         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">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-getPosition"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-getPosition">getPosition</a></b>(&nbsp;<span title="Optional" class="optional">[<code>Boolean&nbsp;local</code>]</span>&nbsp;)\r
1061     :\r
1062                                         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">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-getResizeEl"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-getResizeEl">getResizeEl</a></b>()\r
1063     :\r
1064                                         void<div class="mdesc"><div class="short">Returns the outermost Element of this Component which defines the Components overall size.\r
1065 Usually this will return t...</div><div class="long"><p>Returns the outermost Element of this Component which defines the Components overall size.</p>
1066 <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>,
1067 but in some cases, a Component may have some more wrapping Elements around its main
1068 active Element.</p>
1069 <p>An example is a ComboBox. It is encased in a <i>wrapping</i> Element which
1070 contains both the <code>&lt;input></code> Element (which is what would be returned
1071 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.
1072 This Element is returned as the <code>resizeEl</code>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#getResizeEl" ext:member="#getResizeEl" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-getSize"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-getSize">getSize</a></b>()\r
1073     :\r
1074                                         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">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-getWidth"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-getWidth">getWidth</a></b>()\r
1075     :\r
1076                                         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">&nbsp;</a></td><td class="sig"><a id="Ext.Component-getXType"></a><b><a href="source/Component.html#method-Ext.Component-getXType">getXType</a></b>()\r
1077     :\r
1078                                         String<div class="mdesc"><div class="short">Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all\r
1079 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
1080 available xtypes, see the <a href="output/Ext.Component.html" ext:cls="Ext.Component">Ext.Component</a> header. Example usage:
1081 <pre><code><b>var</b> t = <b>new</b> Ext.form.TextField();
1082 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">&nbsp;</a></td><td class="sig"><a id="Ext.Component-getXTypes"></a><b><a href="source/Component.html#method-Ext.Component-getXTypes">getXTypes</a></b>()\r
1083     :\r
1084                                         String<div class="mdesc"><div class="short">Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all\r
1085 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
1086 available xtypes, see the <a href="output/Ext.Component.html" ext:cls="Ext.Component">Ext.Component</a> header.</p>
1087 <p><b>If using your own subclasses, be aware that a Component must register its own xtype
1088 to participate in determination of inherited xtypes.</b></p>
1089 <p>Example usage:</p>
1090 <pre><code><b>var</b> t = <b>new</b> Ext.form.TextField();
1091 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">&nbsp;</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>(&nbsp;<code>String&nbsp;eventName</code>&nbsp;)\r
1092     :\r
1093                                         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">&nbsp;</a></td><td class="sig"><a id="Ext.Component-hide"></a><b><a href="source/Component.html#method-Ext.Component-hide">hide</a></b>()\r
1094     :\r
1095                                         Ext.Component<div class="mdesc"><div class="short">Hide this component.  Listen to the 'beforehide' event and return\r
1096 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
1097 <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>'
1098 event after hiding the component. Note this method is called internally if
1099 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 "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Container-insert"></a><b><a href="source/Container.html#method-Ext.Container-insert">insert</a></b>(&nbsp;<code>Number&nbsp;index</code>,&nbsp;<code>Ext.Component&nbsp;component</code>&nbsp;)\r
1100     :\r
1101                                         Ext.Component<div class="mdesc"><div class="short">Inserts a Component into this Container at a specified index. Fires the&#13;\r
1102 beforeadd event before inserting, then fires...</div><div class="long">Inserts a Component into this Container at a specified index. Fires the\r
1103 <a href="output/Ext.Container.html#Ext.Container-beforeadd" ext:member="beforeadd" ext:cls="Ext.Container">beforeadd</a> event before inserting, then fires the <a href="output/Ext.Container.html#Ext.Container-add" ext:member="add" ext:cls="Ext.Container">add</a> event after the\r
1104 Component has been inserted.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>index</code> : Number<div class="sub-desc">The index at which the Component will be inserted\r
1105 into the Container's items collection</div></li><li><code>component</code> : Ext.Component<div class="sub-desc">The child Component to insert.<br><br>\r
1106 Ext uses lazy rendering, and will only render the inserted Component should\r
1107 it become necessary.<br><br>\r
1108 A Component config object may be passed in order to avoid the overhead of\r
1109 constructing a real Component object if lazy rendering might mean that the\r
1110 inserted Component will not be rendered immediately. To take advantage of\r
1111 this 'lazy instantiation', set the <a href="output/Ext.Component.html#Ext.Component-xtype" ext:member="xtype" ext:cls="Ext.Component">Ext.Component.xtype</a> config\r
1112 property to the registered type of the Component wanted.<br><br>\r
1113 For a list of all available xtypes, see <a href="output/Ext.Component.html" ext:cls="Ext.Component">Ext.Component</a>.</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Component</code><div class="sub-desc">component The Component (or config object) that was&#13;\r
1114 inserted with the Container's default config values applied.</div></li></ul></div></div></div></td><td class="msource">Container</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-isVisible"></a><b><a href="source/Component.html#method-Ext.Component-isVisible">isVisible</a></b>()\r
1115     :\r
1116                                         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">&nbsp;</a></td><td class="sig"><a id="Ext.Component-isXType"></a><b><a href="source/Component.html#method-Ext.Component-isXType">isXType</a></b>(&nbsp;<code>String&nbsp;xtype</code>,&nbsp;<span title="Optional" class="optional">[<code>Boolean&nbsp;shallow</code>]</span>&nbsp;)\r
1117     :\r
1118                                         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\r
1119 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
1120 from the xtype (default) or whether it is directly of the xtype specified (shallow = true).</p>
1121 <p><b>If using your own subclasses, be aware that a Component must register its own xtype
1122 to participate in determination of inherited xtypes.</b></p>
1123 <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>
1124 <p>Example usage:</p>
1125 <pre><code><b>var</b> t = <b>new</b> Ext.form.TextField();
1126 <b>var</b> isText = t.isXType(<em>'textfield'</em>);        <i>// true</i>
1127 <b>var</b> isBoxSubclass = t.isXType(<em>'box'</em>);       <i>// true, descended from BoxComponent</i>
1128 <b>var</b> isBoxInstance = t.isXType(<em>'box'</em>, true); <i>// false, not a direct BoxComponent instance</i></code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>xtype</code> : String<div class="sub-desc">The xtype to check for this Component</div></li><li><code>shallow</code> : Boolean<div class="sub-desc">(optional) False to check whether this Component is descended from the xtype (this is
1129 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">&nbsp;</a></td><td class="sig"><a id="Ext.Component-nextSibling"></a><b><a href="source/Component.html#method-Ext.Component-nextSibling">nextSibling</a></b>()\r
1130     :\r
1131                                         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">&nbsp;</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>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Function&nbsp;handler</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;options</code>]</span>&nbsp;)\r
1132     :\r
1133                                         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.
1134 <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">&nbsp;</a></td><td class="sig"><a id="Ext.Component-previousSibling"></a><b><a href="source/Component.html#method-Ext.Component-previousSibling">previousSibling</a></b>()\r
1135     :\r
1136                                         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">&nbsp;</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>()\r
1137     :\r
1138                                         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">&nbsp;</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>(&nbsp;<code>Object&nbsp;o</code>,&nbsp;<code>Array&nbsp;events</code>&nbsp;)\r
1139     :\r
1140                                         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 "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Container-remove"></a><b><a href="source/Container.html#method-Ext.Container-remove">remove</a></b>(&nbsp;<code>Component/String&nbsp;component</code>,&nbsp;<span title="Optional" class="optional">[<code>Boolean&nbsp;autoDestroy</code>]</span>&nbsp;)\r
1141     :\r
1142                                         Ext.Component<div class="mdesc"><div class="short">Removes a component from this container.  Fires the beforeremove event before removing, then fires&#13;\r
1143 the remove event ...</div><div class="long">Removes a component from this container.  Fires the <a href="output/Ext.Container.html#Ext.Container-beforeremove" ext:member="beforeremove" ext:cls="Ext.Container">beforeremove</a> event before removing, then fires\r
1144 the <a href="output/Ext.Container.html#Ext.Container-remove" ext:member="remove" ext:cls="Ext.Container">remove</a> event after the component has been removed.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>component</code> : Component/String<div class="sub-desc">The component reference or id to remove.</div></li><li><code>autoDestroy</code> : Boolean<div class="sub-desc">(optional) True to automatically invoke the removed Component's <a href="output/Ext.Component.html#Ext.Component-destroy" ext:member="destroy" ext:cls="Ext.Component">Ext.Component.destroy</a> function.\r
1145 Defaults to the value of this Container's <a href="output/Ext.Container.html#Ext.Container-autoDestroy" ext:member="autoDestroy" ext:cls="Ext.Container">autoDestroy</a> config.</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Component</code><div class="sub-desc">component The Component that was removed.</div></li></ul></div></div></div></td><td class="msource">Container</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Container-removeAll"></a><b><a href="source/Container.html#method-Ext.Container-removeAll">removeAll</a></b>(&nbsp;<span title="Optional" class="optional">[<code>Boolean&nbsp;autoDestroy</code>]</span>&nbsp;)\r
1146     :\r
1147                                         Array<div class="mdesc"><div class="short">Removes all components from this container.</div><div class="long">Removes all components from this container.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>autoDestroy</code> : Boolean<div class="sub-desc">(optional) True to automatically invoke the removed Component's <a href="output/Ext.Component.html#Ext.Component-destroy" ext:member="destroy" ext:cls="Ext.Component">Ext.Component.destroy</a> function.\r
1148 Defaults to the value of this Container's <a href="output/Ext.Container.html#Ext.Container-autoDestroy" ext:member="autoDestroy" ext:cls="Ext.Container">autoDestroy</a> config.</div></li></ul><strong>Returns:</strong><ul><li><code>Array</code><div class="sub-desc">Array of the destroyed components</div></li></ul></div></div></div></td><td class="msource">Container</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-removeClass"></a><b><a href="source/Component.html#method-Ext.Component-removeClass">removeClass</a></b>(&nbsp;<code>string&nbsp;cls</code>&nbsp;)\r
1149     :\r
1150                                         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">&nbsp;</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>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Function&nbsp;handler</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>&nbsp;)\r
1151     :\r
1152                                         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">&nbsp;</a></td><td class="sig"><a id="Ext.Component-render"></a><b><a href="source/Component.html#method-Ext.Component-render">render</a></b>(&nbsp;<span title="Optional" class="optional">[<code>Element/HTMLElement/String&nbsp;container</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>String/Number&nbsp;position</code>]</span>&nbsp;)\r
1153     :\r
1154                                         void<div class="mdesc"><div class="short">Render this Component into the passed HTML element.\r
1155 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>
1156 <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
1157 do not use the render method.</b></p>
1158 <p>A Container's child Components are rendered by that Container's
1159 <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>
1160 <p>Certain layout managers allow dynamic addition of child components. Those that do
1161 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>,
1162 <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>
1163 <p>If the Container is already rendered when a new child Component is added, you may need to call
1164 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
1165 unrendered child Components to be rendered. This is required so that you can add multiple
1166 child components if needed while only refreshing the layout once.</p>
1167 <p>When creating complex UIs, it is important to remember that sizing and positioning
1168 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.
1169 If you expect child items to be sized in response to user interactions, you must
1170 configure the Container with a layout manager which creates and manages the type of layout you
1171 have in mind.</p>
1172 <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
1173 layout manager is used which does nothing but render child components sequentially into the
1174 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
1175 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>
1176 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">&nbsp;</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>()\r
1177     :\r
1178                                         void<div class="mdesc"><div class="short">Resume firing events. (see suspendEvents)\r
1179 If events were suspended using the queueSuspended parameter, then all\r
1180 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>)
1181 If events were suspended using the <tt><b>queueSuspended</b></tt> parameter, then all
1182 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 inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-setDisabled"></a><b><a href="source/Component.html#method-Ext.Component-setDisabled">setDisabled</a></b>(&nbsp;<code>Boolean&nbsp;disabled</code>&nbsp;)\r
1183     :\r
1184                                         Ext.Component<div class="mdesc"><div class="short">Convenience function for setting disabled/enabled by boolean.</div><div class="long">Convenience function for setting disabled/enabled by boolean.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>disabled</code> : Boolean<div class="sub-desc"></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#setDisabled" ext:member="#setDisabled" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-setHeight"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-setHeight">setHeight</a></b>(&nbsp;<code>Number&nbsp;height</code>&nbsp;)\r
1185     :\r
1186                                         Ext.BoxComponent<div class="mdesc"><div class="short">Sets the height of the component.  This method fires the resize event.</div><div class="long">Sets the height of the component.  This method fires the <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-resize" ext:member="resize" ext:cls="Ext.BoxComponent">resize</a> event.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>height</code> : Number<div class="sub-desc">The new height to set. This may be one of:<div class="mdetail-params"><ul>
1187 <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>
1188 <li>A String used to set the CSS height style.</li>
1189 <li><i>undefined</i> to leave the height unchanged.</li>
1190 </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">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-setPagePosition"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-setPagePosition">setPagePosition</a></b>(&nbsp;<code>Number&nbsp;x</code>,&nbsp;<code>Number&nbsp;y</code>&nbsp;)\r
1191     :\r
1192                                         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.\r
1193 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>.
1194 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">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-setPosition"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-setPosition">setPosition</a></b>(&nbsp;<code>Number&nbsp;left</code>,&nbsp;<code>Number&nbsp;top</code>&nbsp;)\r
1195     :\r
1196                                         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.\r
1197 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>.
1198 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 inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-setSize"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-setSize">setSize</a></b>(&nbsp;<code>Mixed&nbsp;width</code>,&nbsp;<code>Mixed&nbsp;height</code>&nbsp;)\r
1199     :\r
1200                                         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\r
1201 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
1202 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>
1203 <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>
1204 <li>A String used to set the CSS width style.</li>
1205 <li>A size object in the format <code>{width: widthValue, height: heightValue}</code>.</li>
1206 <li><code>undefined</code> to leave the width unchanged.</li>
1207 </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).
1208 This may be one of:<div class="mdetail-params"><ul>
1209 <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>
1210 <li>A String used to set the CSS height style. Animation may <b>not</b> be used.</li>
1211 <li><code>undefined</code> to leave the height unchanged.</li>
1212 </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">&nbsp;</a></td><td class="sig"><a id="Ext.Component-setVisible"></a><b><a href="source/Component.html#method-Ext.Component-setVisible">setVisible</a></b>(&nbsp;<code>Boolean&nbsp;visible</code>&nbsp;)\r
1213     :\r
1214                                         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">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-setWidth"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-setWidth">setWidth</a></b>(&nbsp;<code>Number&nbsp;width</code>&nbsp;)\r
1215     :\r
1216                                         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> : Number<div class="sub-desc">The new width to setThis may be one of:<div class="mdetail-params"><ul>
1217 <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>
1218 <li>A String used to set the CSS width style.</li>
1219 </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">&nbsp;</a></td><td class="sig"><a id="Ext.Component-show"></a><b><a href="source/Component.html#method-Ext.Component-show">show</a></b>()\r
1220     :\r
1221                                         Ext.Component<div class="mdesc"><div class="short">Show this component.  Listen to the 'beforeshow' event and return\r
1222 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
1223 <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>'
1224 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">&nbsp;</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>(&nbsp;<code>Boolean&nbsp;queueSuspended</code>&nbsp;)\r
1225     :\r
1226                                         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
1227 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">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-syncSize"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-syncSize">syncSize</a></b>()\r
1228     :\r
1229                                         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">&nbsp;</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>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Function&nbsp;handler</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>&nbsp;)\r
1230     :\r
1231                                         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">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-updateBox"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-updateBox">updateBox</a></b>(&nbsp;<code>Object&nbsp;box</code>&nbsp;)\r
1232     :\r
1233                                         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.Container-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 "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Container-add"></a><b><a href="source/Container.html#event-Ext.Container-add">add</a></b> :\r
1234                                       (&nbsp;<code>Ext.Container&nbsp;this</code>,&nbsp;<code>Ext.Component&nbsp;component</code>,&nbsp;<code>Number&nbsp;index</code>&nbsp;)\r
1235     <div class="mdesc"><div class="short"></div><div class="long"><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>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></div></div></div></td><td class="msource">Container</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Container-afterlayout"></a><b><a href="source/Container.html#event-Ext.Container-afterlayout">afterlayout</a></b> :\r
1236                                       (&nbsp;<code>Ext.Container&nbsp;this</code>,&nbsp;<code>ContainerLayout&nbsp;layout</code>&nbsp;)\r
1237     <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">Container</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-afterrender"></a><b><a href="source/Component.html#event-Ext.Component-afterrender">afterrender</a></b> :\r
1238                                       (&nbsp;<code>Ext.Component&nbsp;this</code>&nbsp;)\r
1239     <div class="mdesc"><div class="short">Fires after the component rendering is finished.\r
1240 The afterrender event is fired after this Component has been rendere...</div><div class="long"><p>Fires after the component rendering is finished.</p>
1241 <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
1242 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
1243 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">&nbsp;</a></td><td class="sig"><a id="Ext.Container-beforeadd"></a><b><a href="source/Container.html#event-Ext.Container-beforeadd">beforeadd</a></b> :\r
1244                                       (&nbsp;<code>Ext.Container&nbsp;this</code>,&nbsp;<code>Ext.Component&nbsp;component</code>,&nbsp;<code>Number&nbsp;index</code>&nbsp;)\r
1245     <div class="mdesc"><div class="short">Fires before any Ext.Component is added or inserted into the container.&#13;\r
1246 A handler can return false to cancel the add...</div><div class="long">Fires before any <a href="output/Ext.Component.html" ext:cls="Ext.Component">Ext.Component</a> is added or inserted into the container.\r
1247 A handler can return false to cancel the add.<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>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></div></div></div></td><td class="msource">Container</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-beforedestroy"></a><b><a href="source/Component.html#event-Ext.Component-beforedestroy">beforedestroy</a></b> :\r
1248                                       (&nbsp;<code>Ext.Component&nbsp;this</code>&nbsp;)\r
1249     <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">&nbsp;</a></td><td class="sig"><a id="Ext.Component-beforehide"></a><b><a href="source/Component.html#event-Ext.Component-beforehide">beforehide</a></b> :\r
1250                                       (&nbsp;<code>Ext.Component&nbsp;this</code>&nbsp;)\r
1251     <div class="mdesc"><div class="short">Fires before the component is hidden by calling the hide method.\r
1252 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.
1253 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">&nbsp;</a></td><td class="sig"><a id="Ext.Container-beforeremove"></a><b><a href="source/Container.html#event-Ext.Container-beforeremove">beforeremove</a></b> :\r
1254                                       (&nbsp;<code>Ext.Container&nbsp;this</code>,&nbsp;<code>Ext.Component&nbsp;component</code>&nbsp;)\r
1255     <div class="mdesc"><div class="short">Fires before any Ext.Component is removed from the container.  A handler can return&#13;\r
1256 false to cancel the remove.</div><div class="long">Fires before any <a href="output/Ext.Component.html" ext:cls="Ext.Component">Ext.Component</a> is removed from the container.  A handler can return\r
1257 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>this</code> : Ext.Container<div class="sub-desc"></div></li><li><code>component</code> : Ext.Component<div class="sub-desc">The component being removed</div></li></ul></div></div></div></td><td class="msource">Container</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-beforerender"></a><b><a href="source/Component.html#event-Ext.Component-beforerender">beforerender</a></b> :\r
1258                                       (&nbsp;<code>Ext.Component&nbsp;this</code>&nbsp;)\r
1259     <div class="mdesc"><div class="short">Fires before the component is rendered. Return false from an\r
1260 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
1261 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">&nbsp;</a></td><td class="sig"><a id="Ext.Component-beforeshow"></a><b><a href="source/Component.html#event-Ext.Component-beforeshow">beforeshow</a></b> :\r
1262                                       (&nbsp;<code>Ext.Component&nbsp;this</code>&nbsp;)\r
1263     <div class="mdesc"><div class="short">Fires before the component is shown by calling the show method.\r
1264 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.
1265 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">&nbsp;</a></td><td class="sig"><a id="Ext.Component-beforestaterestore"></a><b><a href="source/Component.html#event-Ext.Component-beforestaterestore">beforestaterestore</a></b> :\r
1266                                       (&nbsp;<code>Ext.Component&nbsp;this</code>,&nbsp;<code>Object&nbsp;state</code>&nbsp;)\r
1267     <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
1268 event is not vetoed, then the state object is passed to <b><tt>applyState</tt></b>. By default,
1269 that simply copies property values into this Component. The method maybe overriden to
1270 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">&nbsp;</a></td><td class="sig"><a id="Ext.Component-beforestatesave"></a><b><a href="source/Component.html#event-Ext.Component-beforestatesave">beforestatesave</a></b> :\r
1271                                       (&nbsp;<code>Ext.Component&nbsp;this</code>,&nbsp;<code>Object&nbsp;state</code>&nbsp;)\r
1272     <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
1273 <b><tt>getState()</tt></b> on the Component. This method must be provided by the
1274 developer to return whetever representation of state is required, by default, Ext.Component
1275 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">&nbsp;</a></td><td class="sig"><a id="Ext.Component-destroy"></a><b><a href="source/Component.html#event-Ext.Component-destroy">destroy</a></b> :\r
1276                                       (&nbsp;<code>Ext.Component&nbsp;this</code>&nbsp;)\r
1277     <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">&nbsp;</a></td><td class="sig"><a id="Ext.Component-disable"></a><b><a href="source/Component.html#event-Ext.Component-disable">disable</a></b> :\r
1278                                       (&nbsp;<code>Ext.Component&nbsp;this</code>&nbsp;)\r
1279     <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 inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-enable"></a><b><a href="source/Component.html#event-Ext.Component-enable">enable</a></b> :\r
1280                                       (&nbsp;<code>Ext.Component&nbsp;this</code>&nbsp;)\r
1281     <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 inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-hide"></a><b><a href="source/Component.html#event-Ext.Component-hide">hide</a></b> :\r
1282                                       (&nbsp;<code>Ext.Component&nbsp;this</code>&nbsp;)\r
1283     <div class="mdesc"><div class="short">Fires after the component is hidden.\r
1284 Fires after the component is hidden when calling the hide method.</div><div class="long">Fires after the component is hidden.
1285 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">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-move"></a><b><a href="source/BoxComponent.html#event-Ext.BoxComponent-move">move</a></b> :\r
1286                                       (&nbsp;<code>Ext.Component&nbsp;this</code>,&nbsp;<code>Number&nbsp;x</code>,&nbsp;<code>Number&nbsp;y</code>&nbsp;)\r
1287     <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">&nbsp;</a></td><td class="sig"><a id="Ext.Container-remove"></a><b><a href="source/Container.html#event-Ext.Container-remove">remove</a></b> :\r
1288                                       (&nbsp;<code>Ext.Container&nbsp;this</code>,&nbsp;<code>Ext.Component&nbsp;component</code>&nbsp;)\r
1289     <div class="mdesc"><div class="short"></div><div class="long"><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>component</code> : Ext.Component<div class="sub-desc">The component that was removed</div></li></ul></div></div></div></td><td class="msource">Container</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-render"></a><b><a href="source/Component.html#event-Ext.Component-render">render</a></b> :\r
1290                                       (&nbsp;<code>Ext.Component&nbsp;this</code>&nbsp;)\r
1291     <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">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-resize"></a><b><a href="source/BoxComponent.html#event-Ext.BoxComponent-resize">resize</a></b> :\r
1292                                       (&nbsp;<code>Ext.Component&nbsp;this</code>,&nbsp;<code>Number&nbsp;adjWidth</code>,&nbsp;<code>Number&nbsp;adjHeight</code>,&nbsp;<code>Number&nbsp;rawWidth</code>,&nbsp;<code>Number&nbsp;rawHeight</code>&nbsp;)\r
1293     <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">&nbsp;</a></td><td class="sig"><a id="Ext.Component-show"></a><b><a href="source/Component.html#event-Ext.Component-show">show</a></b> :\r
1294                                       (&nbsp;<code>Ext.Component&nbsp;this</code>&nbsp;)\r
1295     <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 inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-staterestore"></a><b><a href="source/Component.html#event-Ext.Component-staterestore">staterestore</a></b> :\r
1296                                       (&nbsp;<code>Ext.Component&nbsp;this</code>,&nbsp;<code>Object&nbsp;state</code>&nbsp;)\r
1297     <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
1298 to <b><tt>applyState</tt></b>. By default, that simply copies property values into this
1299 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">&nbsp;</a></td><td class="sig"><a id="Ext.Component-statesave"></a><b><a href="source/Component.html#event-Ext.Component-statesave">statesave</a></b> :\r
1300                                       (&nbsp;<code>Ext.Component&nbsp;this</code>,&nbsp;<code>Object&nbsp;state</code>&nbsp;)\r
1301     <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
1302 <b><tt>getState()</tt></b> on the Component. This method must be provided by the
1303 developer to return whetever representation of state is required, by default, Ext.Component
1304 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></tbody></table></div>