docs/output/Ext.BoxComponent.html

   1         <div class="body-wrap">
   2         <div class="top-tools">
   3             <a class="inner-link" href="#Ext.BoxComponent-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
   4             <a class="inner-link" href="#Ext.BoxComponent-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
   5             <a class="inner-link" href="#Ext.BoxComponent-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
   6                             <a class="inner-link" href="#Ext.BoxComponent-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
   7                         <a class="bookmark" href="../docs/?class=Ext.BoxComponent"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
   8         </div>
   9                 <div class="inheritance res-block">
  10 <pre class="res-block-inner"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a>
  11   <img src="resources/elbow-end.gif"/><a ext:cls="Ext.Component" ext:member="" href="output/Ext.Component.html">Component</a>
  12     <img src="resources/elbow-end.gif"/>BoxComponent</pre></div>
  13                 <h1>Class Ext.BoxComponent</h1>
  14         <table cellspacing="0">
  15             <tr><td class="label">Package:</td><td class="hd-info">Ext</td></tr>
  16             <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/BoxComponent.js" target="_blank">BoxComponent.js</a></td></tr>
  17             <tr><td class="label">Class:</td><td class="hd-info">BoxComponent</td></tr>
  18                         <tr><td class="label">Subclasses:</td><td class="hd-info"><a ext:cls="Ext.Container" href="output/Ext.Container.html">Container</a>, <a ext:cls="Ext.DataView" href="output/Ext.DataView.html">DataView</a>, <a ext:cls="Ext.ProgressBar" href="output/Ext.ProgressBar.html">ProgressBar</a>, <a ext:cls="Ext.Slider" href="output/Ext.Slider.html">Slider</a>, <a ext:cls="Ext.Toolbar" href="output/Ext.Toolbar.html">Toolbar</a>, <a ext:cls="Ext.form.Field" href="output/Ext.form.Field.html">Field</a>, <a ext:cls="Ext.form.Label" href="output/Ext.form.Label.html">Label</a></td></tr>
  19                                     <tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.Component" ext:member="" href="output/Ext.Component.html">Component</a></td></tr>
  20                     </table>
  21         <div class="description">
  22             *
  23 <p>Base class for any visual <a ext:cls="Ext.Component" href="output/Ext.Component.html">Ext.Component</a> that uses a box container.  BoxComponent provides automatic box
  24 model adjustments for sizing and positioning and will work correctly withnin the Component rendering model.  All
  25 container classes should subclass BoxComponent so that they will work consistently when nested within other Ext
  26 layout containers.</p>
  27 <p>A BoxComponent may be created as a custom Component which encapsulates any HTML element, either a pre-existing
  28 element, or one that is created to your specifications at render time. Usually, to participate in layouts,
  29 a Component will need to be a <b>Box</b>Component in order to have its width and height managed.</p>
  30 <p>To use a pre-existing element as a BoxComponent, configure it so that you preset the <b>el</b> property to the
  31 element to reference:<pre><code>var pageHeader = <b>new</b> Ext.BoxComponent({
  32     el: <em>'my-header-div'</em>
  33 });</code></pre>
  34 This may then be <a ext:cls="Ext.Container" ext:member="add" href="output/Ext.Container.html#add">added</a> to a <a ext:cls="Ext.Container" href="output/Ext.Container.html">Container</a> as a child item.</p>
  35 <p>To create a BoxComponent based around a HTML element to be created at render time, use the
  36 <a ext:cls="Ext.Component" ext:member="autoEl" href="output/Ext.Component.html#autoEl">autoEl</a> config option which takes the form of a
  37 <a ext:cls="Ext.DomHelper" href="output/Ext.DomHelper.html">DomHelper</a> specification:<pre><code>var myImage = <b>new</b> Ext.BoxComponent({
  38     autoEl: {
  39         tag: <em>'img'</em>,
  40         src: <em>'/images/my-image.jpg'</em>
  41     }
  42 });</code></pre></p>        </div>
  43
  44         <div class="hr"></div>
  45                 <a id="Ext.BoxComponent-configs"></a>
  46         <h2>Config Options</h2>
  47         <table cellspacing="0" class="member-table">
  48             <tr>
  49                 <th class="sig-header" colspan="2">Config Options</th>
  50                 <th class="msource-header">Defined By</th>
  51             </tr>
  52                 <tr class="config-row inherited">\r
  53         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  54         <td class="sig">\r
  55         <a id="Ext.BoxComponent-allowDomMove"></a>\r
  56             <b>allowDomMove</b> : Boolean            <div class="mdesc">\r
  57                             Whether the component can move the Dom node when rendering (defaults to true).                        </div>\r
  58         </td>\r
  59         <td class="msource"><a ext:cls="Ext.Component" ext:member="#allowDomMove" href="output/Ext.Component.html#allowDomMove">Component</a></td>\r
  60     </tr>\r
  61         <tr class="config-row inherited alt expandable">\r
  62         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  63         <td class="sig">\r
  64         <a id="Ext.BoxComponent-applyTo"></a>\r
  65             <b>applyTo</b> : Mixed            <div class="mdesc">\r
  66                         <div class="short">The id of the node, a DOM node or an existing Element corresponding to a DIV that is already present in the document ...</div>\r
  67             <div class="long">\r
  68                 The id of the node, a DOM node or an existing Element corresponding to a DIV that is already present in the document that specifies some structural markup for this component. When applyTo is used, constituent parts of the component can also be specified by id or CSS class name within the main element, and the component being created may attempt to create its subcomponents from that markup if applicable. Using this config, a call to render() is not required. If applyTo is specified, any value passed for <a ext:cls="Ext.Component" ext:member="renderTo" href="output/Ext.Component.html#renderTo">renderTo</a> will be ignored and the target element's parent node will automatically be used as the component's container.            </div>\r
  69                         </div>\r
  70         </td>\r
  71         <td class="msource"><a ext:cls="Ext.Component" ext:member="#applyTo" href="output/Ext.Component.html#applyTo">Component</a></td>\r
  72     </tr>\r
  73         <tr class="config-row inherited expandable">\r
  74         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  75         <td class="sig">\r
  76         <a id="Ext.BoxComponent-autoEl"></a>\r
  77             <b>autoEl</b> : String/Object            <div class="mdesc">\r
  78                         <div class="short">A tag name or DomHelper spec to create an element with. This is intended to create shorthand utility components inlin...</div>\r
  79             <div class="long">\r
  80                 A tag name or DomHelper spec to create an element with. This is intended to create shorthand utility components inline via JSON. It should not be used for higher level components which already create their own elements. Example usage: <pre><code>{xtype:<em>'box'</em>, autoEl: <em>'div'</em>, cls:<em>'my-class'</em>}
  81 {xtype:<em>'box'</em>, autoEl: {tag:<em>'blockquote'</em>, html:<em>'autoEl is cool!'</em>}} // <b>with</b> DomHelper</code></pre>            </div>\r
  82                         </div>\r
  83         </td>\r
  84         <td class="msource"><a ext:cls="Ext.Component" ext:member="#autoEl" href="output/Ext.Component.html#autoEl">Component</a></td>\r
  85     </tr>\r
  86         <tr class="config-row alt expandable">\r
  87         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  88         <td class="sig">\r
  89         <a id="Ext.BoxComponent-autoHeight"></a>\r
  90             <b>autoHeight</b> : Boolean            <div class="mdesc">\r
  91                         <div class="short">True to use height:'auto', false to use fixed height (defaults to false). Note: Although many components inherit this...</div>\r
  92             <div class="long">\r
  93                 True to use height:'auto', false to use fixed height (defaults to false). <b>Note</b>: Although many components inherit this config option, not all will function as expected with a height of 'auto'. Setting autoHeight:true means that the browser will manage height based on the element's contents, and that Ext will not manage it at all.            </div>\r
  94                         </div>\r
  95         </td>\r
  96         <td class="msource">BoxComponent</td>\r
  97     </tr>\r
  98         <tr class="config-row inherited expandable">\r
  99         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 100         <td class="sig">\r
 101         <a id="Ext.BoxComponent-autoShow"></a>\r
 102             <b>autoShow</b> : Boolean            <div class="mdesc">\r
 103                         <div class="short">True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove them on render...</div>\r
 104             <div class="long">\r
 105                 True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove them on render (defaults to false).            </div>\r
 106                         </div>\r
 107         </td>\r
 108         <td class="msource"><a ext:cls="Ext.Component" ext:member="#autoShow" href="output/Ext.Component.html#autoShow">Component</a></td>\r
 109     </tr>\r
 110         <tr class="config-row alt expandable">\r
 111         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 112         <td class="sig">\r
 113         <a id="Ext.BoxComponent-autoWidth"></a>\r
 114             <b>autoWidth</b> : Boolean            <div class="mdesc">\r
 115                         <div class="short">True to use width:'auto', false to use fixed width (defaults to false). Note: Although many components inherit this c...</div>\r
 116             <div class="long">\r
 117                 True to use width:'auto', false to use fixed width (defaults to false). <b>Note</b>: Although many components inherit this config option, not all will function as expected with a width of 'auto'. Setting autoWidth:true means that the browser will manage width based on the element's contents, and that Ext will not manage it at all.            </div>\r
 118                         </div>\r
 119         </td>\r
 120         <td class="msource">BoxComponent</td>\r
 121     </tr>\r
 122         <tr class="config-row inherited expandable">\r
 123         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 124         <td class="sig">\r
 125         <a id="Ext.BoxComponent-clearCls"></a>\r
 126             <b>clearCls</b> : String            <div class="mdesc">\r
 127                         <div class="short">The CSS class used to provide field clearing (defaults to 'x-form-clear-left'). This config is only used when this Co...</div>\r
 128             <div class="long">\r
 129                 The CSS class used to provide field clearing (defaults to 'x-form-clear-left'). <p><b>This config is only used when this Component is rendered by a Container which has been configured to use the <a ext:cls="Ext.form.FormLayout" href="output/Ext.form.FormLayout.html">FormLayout</a> layout manager.</b></p>            </div>\r
 130                         </div>\r
 131         </td>\r
 132         <td class="msource"><a ext:cls="Ext.Component" ext:member="#clearCls" href="output/Ext.Component.html#clearCls">Component</a></td>\r
 133     </tr>\r
 134         <tr class="config-row inherited alt expandable">\r
 135         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 136         <td class="sig">\r
 137         <a id="Ext.BoxComponent-cls"></a>\r
 138             <b>cls</b> : String            <div class="mdesc">\r
 139                         <div class="short">An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be useful for a...</div>\r
 140             <div class="long">\r
 141                 An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be useful for adding customized styles to the component or any of its children using standard CSS rules.            </div>\r
 142                         </div>\r
 143         </td>\r
 144         <td class="msource"><a ext:cls="Ext.Component" ext:member="#cls" href="output/Ext.Component.html#cls">Component</a></td>\r
 145     </tr>\r
 146         <tr class="config-row inherited expandable">\r
 147         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 148         <td class="sig">\r
 149         <a id="Ext.BoxComponent-ctCls"></a>\r
 150             <b>ctCls</b> : String            <div class="mdesc">\r
 151                         <div class="short">An optional extra CSS class that will be added to this component's container (defaults to ''). This can be useful for...</div>\r
 152             <div class="long">\r
 153                 An optional extra CSS class that will be added to this component's container (defaults to ''). This can be useful for adding customized styles to the container or any of its children using standard CSS rules.            </div>\r
 154                         </div>\r
 155         </td>\r
 156         <td class="msource"><a ext:cls="Ext.Component" ext:member="#ctCls" href="output/Ext.Component.html#ctCls">Component</a></td>\r
 157     </tr>\r
 158         <tr class="config-row inherited alt">\r
 159         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 160         <td class="sig">\r
 161         <a id="Ext.BoxComponent-disabled"></a>\r
 162             <b>disabled</b> : Boolean            <div class="mdesc">\r
 163                             Render this component disabled (default is false).                        </div>\r
 164         </td>\r
 165         <td class="msource"><a ext:cls="Ext.Component" ext:member="#disabled" href="output/Ext.Component.html#disabled">Component</a></td>\r
 166     </tr>\r
 167         <tr class="config-row inherited">\r
 168         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 169         <td class="sig">\r
 170         <a id="Ext.BoxComponent-disabledClass"></a>\r
 171             <b>disabledClass</b> : String            <div class="mdesc">\r
 172                             CSS class added to the component when it is disabled (defaults to "x-item-disabled").                        </div>\r
 173         </td>\r
 174         <td class="msource"><a ext:cls="Ext.Component" ext:member="#disabledClass" href="output/Ext.Component.html#disabledClass">Component</a></td>\r
 175     </tr>\r
 176         <tr class="config-row inherited alt expandable">\r
 177         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 178         <td class="sig">\r
 179         <a id="Ext.BoxComponent-fieldLabel"></a>\r
 180             <b>fieldLabel</b> : String            <div class="mdesc">\r
 181                         <div class="short">The label text to display next to this Component (defaults to '') This config is only used when this Component is ren...</div>\r
 182             <div class="long">\r
 183                 The label text to display next to this Component (defaults to '') <p><b>This config is only used when this Component is rendered by a Container which has been configured to use the <a ext:cls="Ext.form.FormLayout" href="output/Ext.form.FormLayout.html">FormLayout</a> layout manager.</b></p> Example use:<pre><code>new Ext.FormPanel({
 184     height: 100,
 185     renderTo: Ext.getBody(),
 186     items: [{
 187         xtype: <em>'textfield'</em>,
 188         fieldLabel: <em>'Name'</em>
 189     }]
 190 });</code></pre>            </div>\r
 191                         </div>\r
 192         </td>\r
 193         <td class="msource"><a ext:cls="Ext.Component" ext:member="#fieldLabel" href="output/Ext.Component.html#fieldLabel">Component</a></td>\r
 194     </tr>\r
 195         <tr class="config-row">\r
 196         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 197         <td class="sig">\r
 198         <a id="Ext.BoxComponent-height"></a>\r
 199             <b>height</b> : Number            <div class="mdesc">\r
 200                             The height of this component in pixels (defaults to auto).                        </div>\r
 201         </td>\r
 202         <td class="msource">BoxComponent</td>\r
 203     </tr>\r
 204         <tr class="config-row inherited alt">\r
 205         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 206         <td class="sig">\r
 207         <a id="Ext.BoxComponent-hidden"></a>\r
 208             <b>hidden</b> : Boolean            <div class="mdesc">\r
 209                             Render this component hidden (default is false).                        </div>\r
 210         </td>\r
 211         <td class="msource"><a ext:cls="Ext.Component" ext:member="#hidden" href="output/Ext.Component.html#hidden">Component</a></td>\r
 212     </tr>\r
 213         <tr class="config-row inherited expandable">\r
 214         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 215         <td class="sig">\r
 216         <a id="Ext.BoxComponent-hideLabel"></a>\r
 217             <b>hideLabel</b> : Boolean            <div class="mdesc">\r
 218                         <div class="short">True to completely hide the label element (defaults to false). By default, even if you do not specify a fieldLabel th...</div>\r
 219             <div class="long">\r
 220                 True to completely hide the label element (defaults to false). By default, even if you do not specify a <a ext:cls="fieldLabel" href="output/fieldLabel.html">fieldLabel</a> the space will still be reserved so that the field will line up with other fields that do have labels. Setting this to true will cause the field to not reserve that space. <p><b>This config is only used when this Component is rendered by a Container which has been configured to use the <a ext:cls="Ext.form.FormLayout" href="output/Ext.form.FormLayout.html">FormLayout</a> layout manager.</b></p> Example use:<pre><code>new Ext.FormPanel({
 221     height: 100,
 222     renderTo: Ext.getBody(),
 223     items: [{
 224         xtype: <em>'textfield'</em>
 225         hideLabel: true
 226     }]
 227 });</code></pre>            </div>\r
 228                         </div>\r
 229         </td>\r
 230         <td class="msource"><a ext:cls="Ext.Component" ext:member="#hideLabel" href="output/Ext.Component.html#hideLabel">Component</a></td>\r
 231     </tr>\r
 232         <tr class="config-row inherited alt expandable">\r
 233         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 234         <td class="sig">\r
 235         <a id="Ext.BoxComponent-hideMode"></a>\r
 236             <b>hideMode</b> : String            <div class="mdesc">\r
 237                         <div class="short">How this component should be hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset p...</div>\r
 238             <div class="long">\r
 239                 <p>How this component should be hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset position) and "display" (css display) - defaults to "display".</p> <p>For Containers which may be hidden and shown as part of a <a ext:cls="Ext.layout.CardLayout" href="output/Ext.layout.CardLayout.html">card layout</a> Container such as a <a ext:cls="Ext.TabPanel" href="output/Ext.TabPanel.html">TabPanel</a>, it is recommended that hideMode is configured as "offsets". This ensures that hidden Components still have height and width so that layout managers can perform measurements when calculating layouts.</p>            </div>\r
 240                         </div>\r
 241         </td>\r
 242         <td class="msource"><a ext:cls="Ext.Component" ext:member="#hideMode" href="output/Ext.Component.html#hideMode">Component</a></td>\r
 243     </tr>\r
 244         <tr class="config-row inherited expandable">\r
 245         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 246         <td class="sig">\r
 247         <a id="Ext.BoxComponent-hideParent"></a>\r
 248             <b>hideParent</b> : Boolean            <div class="mdesc">\r
 249                         <div class="short">True to hide and show the component's container when hide/show is called on the component, false to hide and show the...</div>\r
 250             <div class="long">\r
 251                 True to hide and show the component's container when hide/show is called on the component, false to hide and show the component itself (defaults to false). For example, this can be used as a shortcut for a hide button on a window by setting hide:true on the button when adding it to its parent container.            </div>\r
 252                         </div>\r
 253         </td>\r
 254         <td class="msource"><a ext:cls="Ext.Component" ext:member="#hideParent" href="output/Ext.Component.html#hideParent">Component</a></td>\r
 255     </tr>\r
 256         <tr class="config-row inherited alt expandable">\r
 257         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 258         <td class="sig">\r
 259         <a id="Ext.BoxComponent-id"></a>\r
 260             <b>id</b> : String            <div class="mdesc">\r
 261                         <div class="short">The unique id of this component (defaults to an auto-assigned id). You should assign an id if you need to be able to ...</div>\r
 262             <div class="long">\r
 263                 The unique id of this component (defaults to an auto-assigned id). You should assign an id if you need to be able to access the component later and you do not have an object reference available (e.g., using <a ext:cls="Ext.ComponentMgr" ext:member="getCmp" href="output/Ext.ComponentMgr.html#getCmp">Ext.ComponentMgr.getCmp</a>). Note that this id will also be used as the element id for the containing HTML element that is rendered to the page for this component. This allows you to write id-based CSS rules to style the specific instance of this component uniquely, and also to select sub-elements using this component's id as the parent.            </div>\r
 264                         </div>\r
 265         </td>\r
 266         <td class="msource"><a ext:cls="Ext.Component" ext:member="#id" href="output/Ext.Component.html#id">Component</a></td>\r
 267     </tr>\r
 268         <tr class="config-row inherited expandable">\r
 269         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 270         <td class="sig">\r
 271         <a id="Ext.BoxComponent-itemCls"></a>\r
 272             <b>itemCls</b> : String            <div class="mdesc">\r
 273                         <div class="short">An additional CSS class to apply to the wrapper's form item element of this field (defaults to the container's itemCl...</div>\r
 274             <div class="long">\r
 275                 An additional CSS class to apply to the wrapper's form item element of this field (defaults to the container's itemCls value if set, or ''). Since it is applied to the item wrapper, it allows you to write standard CSS rules that can apply to the field, the label (if specified) or any other element within the markup for the field. <p><b>This config is only used when this Component is rendered by a Container which has been configured to use the <a ext:cls="Ext.form.FormLayout" href="output/Ext.form.FormLayout.html">FormLayout</a> layout manager.</b></p> Example use:<pre><code><i>// Apply a style to the field's label:</i>
 276 &lt;style>
 277     .required .x-form-item-label {font-weight:bold;color:red;}
 278 &lt;/style>
 279
 280 <b>new</b> Ext.FormPanel({
 281     height: 100,
 282     renderTo: Ext.getBody(),
 283     items: [{
 284         xtype: <em>'textfield'</em>,
 285         fieldLabel: <em>'Name'</em>,
 286         itemCls: <em>'required'</em> <i>//<b>this</b> label will be styled</i>
 287     },{
 288         xtype: <em>'textfield'</em>,
 289         fieldLabel: <em>'Favorite Color'</em>
 290     }]
 291 });</code></pre>            </div>\r
 292                         </div>\r
 293         </td>\r
 294         <td class="msource"><a ext:cls="Ext.Component" ext:member="#itemCls" href="output/Ext.Component.html#itemCls">Component</a></td>\r
 295     </tr>\r
 296         <tr class="config-row inherited alt expandable">\r
 297         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 298         <td class="sig">\r
 299         <a id="Ext.BoxComponent-labelSeparator"></a>\r
 300             <b>labelSeparator</b> : String            <div class="mdesc">\r
 301                         <div class="short">The standard separator to display after the text of each form label (defaults to the value of Ext.layout.FormLayout.l...</div>\r
 302             <div class="long">\r
 303                 The standard separator to display after the text of each form label (defaults to the value of <a ext:cls="Ext.layout.FormLayout" ext:member="labelSeparator" href="output/Ext.layout.FormLayout.html#labelSeparator">Ext.layout.FormLayout.labelSeparator</a>, which is a colon ':' by default). To display no separator for this field's label specify empty string ''. <p><b>This config is only used when this Component is rendered by a Container which has been configured to use the <a ext:cls="Ext.form.FormLayout" href="output/Ext.form.FormLayout.html">FormLayout</a> layout manager.</b></p> Example use:<pre><code>new Ext.FormPanel({
 304     height: 100,
 305     renderTo: Ext.getBody(),
 306     items: [{
 307         xtype: <em>'textfield'</em>,
 308         fieldLabel: <em>'Name'</em>,
 309         labelSeparator: <em>'...'</em>
 310     }]
 311 });</code></pre>            </div>\r
 312                         </div>\r
 313         </td>\r
 314         <td class="msource"><a ext:cls="Ext.Component" ext:member="#labelSeparator" href="output/Ext.Component.html#labelSeparator">Component</a></td>\r
 315     </tr>\r
 316         <tr class="config-row inherited expandable">\r
 317         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 318         <td class="sig">\r
 319         <a id="Ext.BoxComponent-labelStyle"></a>\r
 320             <b>labelStyle</b> : String            <div class="mdesc">\r
 321                         <div class="short">A CSS style specification to apply directly to this field's label (defaults to the container's labelStyle value if se...</div>\r
 322             <div class="long">\r
 323                 A CSS style specification to apply directly to this field's label (defaults to the container's labelStyle value if set, or '').<code></code>. <p><b>This config is only used when this Component is rendered by a Container which has been configured to use the <a ext:cls="Ext.form.FormLayout" href="output/Ext.form.FormLayout.html">FormLayout</a> layout manager.</b></p> Example use:<pre><code>new Ext.FormPanel({
 324     height: 100,
 325     renderTo: Ext.getBody(),
 326     items: [{
 327         xtype: <em>'textfield'</em>,
 328         fieldLabel: <em>'Name'</em>,
 329         labelStyle: <em>'font-weight:bold;'</em>
 330     }]
 331 });</code></pre>            </div>\r
 332                         </div>\r
 333         </td>\r
 334         <td class="msource"><a ext:cls="Ext.Component" ext:member="#labelStyle" href="output/Ext.Component.html#labelStyle">Component</a></td>\r
 335     </tr>\r
 336         <tr class="config-row inherited alt expandable">\r
 337         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 338         <td class="sig">\r
 339         <a id="Ext.BoxComponent-listeners"></a>\r
 340             <b>listeners</b> : Object            <div class="mdesc">\r
 341                         <div class="short">(optional) A config object containing one or more event handlers to be added to this object during initialization. Th...</div>\r
 342             <div class="long">\r
 343                 (optional) A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the <a ext:cls="Ext.util.Observable" ext:member="addListener" href="output/Ext.util.Observable.html#addListener">addListener</a> example for attaching multiple handlers at once.            </div>\r
 344                         </div>\r
 345         </td>\r
 346         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td>\r
 347     </tr>\r
 348         <tr class="config-row inherited expandable">\r
 349         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 350         <td class="sig">\r
 351         <a id="Ext.BoxComponent-overCls"></a>\r
 352             <b>overCls</b> : String            <div class="mdesc">\r
 353                         <div class="short">An optional extra CSS class that will be added to this component's Element when the mouse moves over the Element, and...</div>\r
 354             <div class="long">\r
 355                 An optional extra CSS class that will be added to this component's Element when the mouse moves over the Element, and removed when the mouse moves out. (defaults to ''). This can be useful for adding customized "active" or "hover" styles to the component or any of its children using standard CSS rules.            </div>\r
 356                         </div>\r
 357         </td>\r
 358         <td class="msource"><a ext:cls="Ext.Component" ext:member="#overCls" href="output/Ext.Component.html#overCls">Component</a></td>\r
 359     </tr>\r
 360         <tr class="config-row alt">\r
 361         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 362         <td class="sig">\r
 363         <a id="Ext.BoxComponent-pageX"></a>\r
 364             <b>pageX</b> : Number            <div class="mdesc">\r
 365                             The page level x coordinate for this component if contained within a positioning container.                        </div>\r
 366         </td>\r
 367         <td class="msource">BoxComponent</td>\r
 368     </tr>\r
 369         <tr class="config-row">\r
 370         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 371         <td class="sig">\r
 372         <a id="Ext.BoxComponent-pageY"></a>\r
 373             <b>pageY</b> : Number            <div class="mdesc">\r
 374                             The page level y coordinate for this component if contained within a positioning container.                        </div>\r
 375         </td>\r
 376         <td class="msource">BoxComponent</td>\r
 377     </tr>\r
 378         <tr class="config-row inherited alt expandable">\r
 379         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 380         <td class="sig">\r
 381         <a id="Ext.BoxComponent-plugins"></a>\r
 382             <b>plugins</b> : Object/Array            <div class="mdesc">\r
 383                         <div class="short">An object or array of objects that will provide custom functionality for this component. The only requirement for a v...</div>\r
 384             <div class="long">\r
 385                 An object or array of objects that will provide custom functionality for this component. The only requirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.Component. When a component is created, if any plugins are available, the component will call the init method on each plugin, passing a reference to itself. Each plugin can then call methods or respond to events on the component as needed to provide its functionality.            </div>\r
 386                         </div>\r
 387         </td>\r
 388         <td class="msource"><a ext:cls="Ext.Component" ext:member="#plugins" href="output/Ext.Component.html#plugins">Component</a></td>\r
 389     </tr>\r
 390         <tr class="config-row inherited expandable">\r
 391         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 392         <td class="sig">\r
 393         <a id="Ext.BoxComponent-renderTo"></a>\r
 394             <b>renderTo</b> : Mixed            <div class="mdesc">\r
 395                         <div class="short">The id of the node, a DOM node or an existing Element that will be the container to render this component into. Using...</div>\r
 396             <div class="long">\r
 397                 The id of the node, a DOM node or an existing Element that will be the container to render this component into. Using this config, a call to render() is not required.            </div>\r
 398                         </div>\r
 399         </td>\r
 400         <td class="msource"><a ext:cls="Ext.Component" ext:member="#renderTo" href="output/Ext.Component.html#renderTo">Component</a></td>\r
 401     </tr>\r
 402         <tr class="config-row inherited alt expandable">\r
 403         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 404         <td class="sig">\r
 405         <a id="Ext.BoxComponent-stateEvents"></a>\r
 406             <b>stateEvents</b> : Array            <div class="mdesc">\r
 407                         <div class="short">An array of events that, when fired, should trigger this component to save its state (defaults to none). These can be...</div>\r
 408             <div class="long">\r
 409                 An array of events that, when fired, should trigger this component to save its state (defaults to none). These can be any types of events supported by this component, including browser or custom events (e.g., ['click', 'customerchange']). <p>See <a ext:cls="Ext.Component" ext:member="stateful" href="output/Ext.Component.html#stateful">stateful</a> for an explanation of saving and restoring Component state.</p>            </div>\r
 410                         </div>\r
 411         </td>\r
 412         <td class="msource"><a ext:cls="Ext.Component" ext:member="#stateEvents" href="output/Ext.Component.html#stateEvents">Component</a></td>\r
 413     </tr>\r
 414         <tr class="config-row inherited expandable">\r
 415         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 416         <td class="sig">\r
 417         <a id="Ext.BoxComponent-stateId"></a>\r
 418             <b>stateId</b> : String            <div class="mdesc">\r
 419                         <div class="short">The unique id for this component to use for state management purposes (defaults to the component id if one was set, o...</div>\r
 420             <div class="long">\r
 421                 The unique id for this component to use for state management purposes (defaults to the component id if one was set, otherwise null if the component is using a generated id). <p>See <a ext:cls="Ext.Component" ext:member="stateful" href="output/Ext.Component.html#stateful">stateful</a> for an explanation of saving and restoring Component state.</p>            </div>\r
 422                         </div>\r
 423         </td>\r
 424         <td class="msource"><a ext:cls="Ext.Component" ext:member="#stateId" href="output/Ext.Component.html#stateId">Component</a></td>\r
 425     </tr>\r
 426         <tr class="config-row inherited alt expandable">\r
 427         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 428         <td class="sig">\r
 429         <a id="Ext.BoxComponent-stateful"></a>\r
 430             <b>stateful</b> : Boolean            <div class="mdesc">\r
 431                         <div class="short">A flag which causes the Component to attempt to restore the state of internal properties from a saved state on startu...</div>\r
 432             <div class="long">\r
 433                 <p>A flag which causes the Component to attempt to restore the state of internal properties from a saved state on startup. The component must have either a <a ext:cls="Ext.Component" ext:member="stateId" href="output/Ext.Component.html#stateId">stateId</a> or <a ext:cls="Ext.Component" ext:member="id" href="output/Ext.Component.html#id">id</a> assigned for state to be managed. Auto-generated ids are not guaranteed to be stable across page loads and cannot be relied upon to save and restore the same state for a component.<p> For state saving to work, the state manager's provider must have been set to an implementation of <a ext:cls="Ext.state.Provider" href="output/Ext.state.Provider.html">Ext.state.Provider</a> which overrides the <a ext:cls="Ext.state.Provider" ext:member="set" href="output/Ext.state.Provider.html#set">set</a> and <a ext:cls="Ext.state.Provider" ext:member="get" href="output/Ext.state.Provider.html#get">get</a> methods to save and recall name/value pairs. A built-in implementation, <a ext:cls="Ext.state.CookieProvider" href="output/Ext.state.CookieProvider.html">Ext.state.CookieProvider</a> is available.</p> <p>To set the state provider for the current page:</p> <pre><code>Ext.state.Manager.setProvider(<b>new</b> Ext.state.CookieProvider());</code></pre> <p>Components attempt to save state when one of the events listed in the <a ext:cls="Ext.Component" ext:member="stateEvents" href="output/Ext.Component.html#stateEvents">stateEvents</a> configuration fires.</p> <p>You can perform extra processing on state save and restore by attaching handlers to the <a ext:cls="Ext.Component" ext:member="beforestaterestore" href="output/Ext.Component.html#beforestaterestore">beforestaterestore</a>, <a ext:cls="Ext.Component" ext:member="staterestore" href="output/Ext.Component.html#staterestore">staterestore</a>, <a ext:cls="Ext.Component" ext:member="beforestatesave" href="output/Ext.Component.html#beforestatesave">beforestatesave</a> and <a ext:cls="Ext.Component" ext:member="statesave" href="output/Ext.Component.html#statesave">statesave</a> events</p>            </div>\r
 434                         </div>\r
 435         </td>\r
 436         <td class="msource"><a ext:cls="Ext.Component" ext:member="#stateful" href="output/Ext.Component.html#stateful">Component</a></td>\r
 437     </tr>\r
 438         <tr class="config-row inherited expandable">\r
 439         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 440         <td class="sig">\r
 441         <a id="Ext.BoxComponent-style"></a>\r
 442             <b>style</b> : String            <div class="mdesc">\r
 443                         <div class="short">A custom style specification to be applied to this component's Element. Should be a valid argument to Ext.Element.app...</div>\r
 444             <div class="long">\r
 445                 A custom style specification to be applied to this component's Element. Should be a valid argument to <a ext:cls="Ext.Element" ext:member="applyStyles" href="output/Ext.Element.html#applyStyles">Ext.Element.applyStyles</a>.            </div>\r
 446                         </div>\r
 447         </td>\r
 448         <td class="msource"><a ext:cls="Ext.Component" ext:member="#style" href="output/Ext.Component.html#style">Component</a></td>\r
 449     </tr>\r
 450         <tr class="config-row alt">\r
 451         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 452         <td class="sig">\r
 453         <a id="Ext.BoxComponent-width"></a>\r
 454             <b>width</b> : Number            <div class="mdesc">\r
 455                             The width of this component in pixels (defaults to auto).                        </div>\r
 456         </td>\r
 457         <td class="msource">BoxComponent</td>\r
 458     </tr>\r
 459         <tr class="config-row">\r
 460         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 461         <td class="sig">\r
 462         <a id="Ext.BoxComponent-x"></a>\r
 463             <b>x</b> : Number            <div class="mdesc">\r
 464                             The local x (left) coordinate for this component if contained within a positioning container.                        </div>\r
 465         </td>\r
 466         <td class="msource">BoxComponent</td>\r
 467     </tr>\r
 468         <tr class="config-row inherited alt expandable">\r
 469         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 470         <td class="sig">\r
 471         <a id="Ext.BoxComponent-xtype"></a>\r
 472             <b>xtype</b> : String            <div class="mdesc">\r
 473                         <div class="short">The registered xtype to create. This config option is not used when passing a config object into a constructor. This ...</div>\r
 474             <div class="long">\r
 475                 The registered xtype to create. This config option is not used when passing a config object into a constructor. This config option is used only when lazy instantiation is being used, and a child item of a Container is being specified not as a fully instantiated Component, but as a <i>Component config object</i>. The xtype will be looked up at render time up to determine what type of child Component to create.<br><br> The predefined xtypes are listed <a ext:cls="Ext.Component" href="output/Ext.Component.html">here</a>. <br><br> If you subclass Components to create your own Components, you may register them using <a ext:cls="Ext.ComponentMgr" ext:member="registerType" href="output/Ext.ComponentMgr.html#registerType">Ext.ComponentMgr.registerType</a> in order to be able to take advantage of lazy instantiation and rendering.            </div>\r
 476                         </div>\r
 477         </td>\r
 478         <td class="msource"><a ext:cls="Ext.Component" ext:member="#xtype" href="output/Ext.Component.html#xtype">Component</a></td>\r
 479     </tr>\r
 480         <tr class="config-row">\r
 481         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 482         <td class="sig">\r
 483         <a id="Ext.BoxComponent-y"></a>\r
 484             <b>y</b> : Number            <div class="mdesc">\r
 485                             The local y (top) coordinate for this component if contained within a positioning container.                        </div>\r
 486         </td>\r
 487         <td class="msource">BoxComponent</td>\r
 488     </tr>\r
 489             </table>
 490                 <a id="Ext.BoxComponent-props"></a>
 491         <h2>Public Properties</h2>
 492                 <table cellspacing="0" class="member-table">
 493             <tr>
 494                 <th class="sig-header" colspan="2">Property</th>
 495                 <th class="msource-header">Defined By</th>
 496             </tr>
 497                 <tr class="property-row inherited">\r
 498         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 499         <td class="sig">\r
 500         <a id="Ext.BoxComponent-disabled"></a>\r
 501             <b>disabled</b> : Boolean            <div class="mdesc">\r
 502                             True if this component is disabled. Read-only.                        </div>\r
 503         </td>\r
 504         <td class="msource"><a ext:cls="Ext.Component" ext:member="#disabled" href="output/Ext.Component.html#disabled">Component</a></td>\r
 505     </tr>\r
 506         <tr class="property-row inherited alt">\r
 507         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 508         <td class="sig">\r
 509         <a id="Ext.BoxComponent-hidden"></a>\r
 510             <b>hidden</b> : Boolean            <div class="mdesc">\r
 511
 512 True if this component is hidden. Read-only.                        </div>\r
 513         </td>\r
 514         <td class="msource"><a ext:cls="Ext.Component" ext:member="#hidden" href="output/Ext.Component.html#hidden">Component</a></td>\r
 515     </tr>\r
 516         <tr class="property-row inherited">\r
 517         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 518         <td class="sig">\r
 519         <a id="Ext.BoxComponent-initialConfig"></a>\r
 520             <b>initialConfig</b> : Object            <div class="mdesc">\r
 521                             This Component's initial configuration specification. Read-only.                        </div>\r
 522         </td>\r
 523         <td class="msource"><a ext:cls="Ext.Component" ext:member="#initialConfig" href="output/Ext.Component.html#initialConfig">Component</a></td>\r
 524     </tr>\r
 525         <tr class="property-row inherited alt expandable">\r
 526         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 527         <td class="sig">\r
 528         <a id="Ext.BoxComponent-ownerCt"></a>\r
 529             <b>ownerCt</b> : Ext.Container            <div class="mdesc">\r
 530                         <div class="short">The component's owner Ext.Container (defaults to undefined, and is set automatically when
 531 the component is added to a...</div>\r
 532             <div class="long">\r
 533                 The component's owner <a ext:cls="Ext.Container" href="output/Ext.Container.html">Ext.Container</a> (defaults to undefined, and is set automatically when
 534 the component is added to a container).  Read-only.            </div>\r
 535                         </div>\r
 536         </td>\r
 537         <td class="msource"><a ext:cls="Ext.Component" ext:member="#ownerCt" href="output/Ext.Component.html#ownerCt">Component</a></td>\r
 538     </tr>\r
 539         <tr class="property-row inherited">\r
 540         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 541         <td class="sig">\r
 542         <a id="Ext.BoxComponent-rendered"></a>\r
 543             <b>rendered</b> : Boolean            <div class="mdesc">\r
 544                             True if this component has been rendered. Read-only.                        </div>\r
 545         </td>\r
 546         <td class="msource"><a ext:cls="Ext.Component" ext:member="#rendered" href="output/Ext.Component.html#rendered">Component</a></td>\r
 547     </tr>\r
 548             </table>
 549                 <a id="Ext.BoxComponent-methods"></a>
 550         <h2>Public Methods</h2>
 551                 <table cellspacing="0" class="member-table">
 552             <tr>
 553                 <th class="sig-header" colspan="2">Method</th>
 554                 <th class="msource-header">Defined By</th>
 555             </tr>
 556                 <tr class="method-row expandable">\r
 557         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 558         <td class="sig">\r
 559         <a id="Ext.BoxComponent-BoxComponent"></a>\r
 560             <b>BoxComponent</b>(&nbsp;<code>Ext.Element/String/Object config</code>&nbsp;)            <div class="mdesc">\r
 561                         <div class="short"></div>\r
 562             <div class="long">\r
 563                     <div class="mdetail-params">\r
 564         <strong>Parameters:</strong>\r
 565         <ul><li><code>config</code> : Ext.Element/String/Object<div class="sub-desc">The configuration options.</div></li>        </ul>\r
 566         <strong>Returns:</strong>\r
 567         <ul>\r
 568             <li><code></code></li>\r
 569         </ul>\r
 570     </div>\r
 571                 </div>\r
 572                         </div>\r
 573         </td>\r
 574         <td class="msource">BoxComponent</td>\r
 575     </tr>\r
 576         <tr class="method-row inherited alt expandable">\r
 577         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 578         <td class="sig">\r
 579         <a id="Ext.BoxComponent-addClass"></a>\r
 580             <b>addClass</b>(&nbsp;<code>string cls</code>&nbsp;) : void            <div class="mdesc">\r
 581                         <div class="short">Adds a CSS class to the component's underlying element.</div>\r
 582             <div class="long">\r
 583                 Adds a CSS class to the component's underlying element.    <div class="mdetail-params">\r
 584         <strong>Parameters:</strong>\r
 585         <ul><li><code>cls</code> : string<div class="sub-desc">The CSS class name to add</div></li>        </ul>\r
 586         <strong>Returns:</strong>\r
 587         <ul>\r
 588             <li><code>void</code></li>\r
 589         </ul>\r
 590     </div>\r
 591                 </div>\r
 592                         </div>\r
 593         </td>\r
 594         <td class="msource"><a ext:cls="Ext.Component" ext:member="#addClass" href="output/Ext.Component.html#addClass">Component</a></td>\r
 595     </tr>\r
 596         <tr class="method-row inherited expandable">\r
 597         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 598         <td class="sig">\r
 599         <a id="Ext.BoxComponent-addEvents"></a>\r
 600             <b>addEvents</b>(&nbsp;<code>Object object</code>&nbsp;) : void            <div class="mdesc">\r
 601                         <div class="short">Used to define events on this Observable</div>\r
 602             <div class="long">\r
 603                 Used to define events on this Observable    <div class="mdetail-params">\r
 604         <strong>Parameters:</strong>\r
 605         <ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li>        </ul>\r
 606         <strong>Returns:</strong>\r
 607         <ul>\r
 608             <li><code>void</code></li>\r
 609         </ul>\r
 610     </div>\r
 611                 </div>\r
 612                         </div>\r
 613         </td>\r
 614         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td>\r
 615     </tr>\r
 616         <tr class="method-row inherited alt expandable">\r
 617         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 618         <td class="sig">\r
 619         <a id="Ext.BoxComponent-addListener"></a>\r
 620             <b>addListener</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span>&nbsp;) : void            <div class="mdesc">\r
 621                         <div class="short">Appends an event handler to this component</div>\r
 622             <div class="long">\r
 623                 Appends an event handler to this component    <div class="mdetail-params">\r
 624         <strong>Parameters:</strong>\r
 625         <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler
 626 function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration
 627 properties. This may contain any of the following properties:<ul>
 628 <li><b>scope</b> : Object<p class="sub-desc">The scope in which to execute the handler function. The handler function's "this" context.</p></li>
 629 <li><b>delay</b> : Number<p class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</p></li>
 630 <li><b>single</b> : Boolean<p class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</p></li>
 631 <li><b>buffer</b> : Number<p class="sub-desc">Causes the handler to be scheduled to run in an <a ext:cls="Ext.util.DelayedTask" href="output/Ext.util.DelayedTask.html">Ext.util.DelayedTask</a> delayed
 632 by the specified number of milliseconds. If the event fires again within that time, the original
 633 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</p></li>
 634 </ul><br>
 635 <p>
 636 <b>Combining Options</b><br>
 637 Using the options argument, it is possible to combine different types of listeners:<br>
 638 <br>
 639 A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
 640 <pre><code>el.on(<em>'click'</em>, <b>this</b>.onClick, <b>this</b>, {
 641     single: true,
 642     delay: 100,
 643     forumId: 4
 644 });</code></pre>
 645 <p>
 646 <b>Attaching multiple handlers in 1 call</b><br>
 647 The method also allows for a single argument to be passed which is a config object containing properties
 648 which specify multiple handlers.
 649 <p>
 650 <pre><code>foo.on({
 651     <em>'click'</em> : {
 652         fn: <b>this</b>.onClick,
 653         scope: <b>this</b>,
 654         delay: 100
 655     },
 656     <em>'mouseover'</em> : {
 657         fn: <b>this</b>.onMouseOver,
 658         scope: <b>this</b>
 659     },
 660     <em>'mouseout'</em> : {
 661         fn: <b>this</b>.onMouseOut,
 662         scope: <b>this</b>
 663     }
 664 });</code></pre>
 665 <p>
 666 Or a shorthand syntax:<br>
 667 <pre><code>foo.on({
 668     <em>'click'</em> : <b>this</b>.onClick,
 669     <em>'mouseover'</em> : <b>this</b>.onMouseOver,
 670     <em>'mouseout'</em> : <b>this</b>.onMouseOut,
 671      scope: <b>this</b>
 672 });</code></pre></div></li>        </ul>\r
 673         <strong>Returns:</strong>\r
 674         <ul>\r
 675             <li><code>void</code></li>\r
 676         </ul>\r
 677     </div>\r
 678                 </div>\r
 679                         </div>\r
 680         </td>\r
 681         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td>\r
 682     </tr>\r
 683         <tr class="method-row inherited expandable">\r
 684         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 685         <td class="sig">\r
 686         <a id="Ext.BoxComponent-applyToMarkup"></a>\r
 687             <b>applyToMarkup</b>(&nbsp;<code>String/HTMLElement el</code>&nbsp;) : void            <div class="mdesc">\r
 688                         <div class="short">Apply this component to existing markup that is valid. With this function, no call to render() is required.</div>\r
 689             <div class="long">\r
 690                 Apply this component to existing markup that is valid. With this function, no call to render() is required.    <div class="mdetail-params">\r
 691         <strong>Parameters:</strong>\r
 692         <ul><li><code>el</code> : String/HTMLElement<div class="sub-desc"></div></li>        </ul>\r
 693         <strong>Returns:</strong>\r
 694         <ul>\r
 695             <li><code>void</code></li>\r
 696         </ul>\r
 697     </div>\r
 698                 </div>\r
 699                         </div>\r
 700         </td>\r
 701         <td class="msource"><a ext:cls="Ext.Component" ext:member="#applyToMarkup" href="output/Ext.Component.html#applyToMarkup">Component</a></td>\r
 702     </tr>\r
 703         <tr class="method-row inherited alt expandable">\r
 704         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 705         <td class="sig">\r
 706         <a id="Ext.BoxComponent-cloneConfig"></a>\r
 707             <b>cloneConfig</b>(&nbsp;<code>Object overrides</code>&nbsp;) : Ext.Component            <div class="mdesc">\r
 708                         <div class="short">Clone the current component using the original config values passed into this instance by default.</div>\r
 709             <div class="long">\r
 710                 Clone the current component using the original config values passed into this instance by default.    <div class="mdetail-params">\r
 711         <strong>Parameters:</strong>\r
 712         <ul><li><code>overrides</code> : Object<div class="sub-desc">A new config containing any properties to override in the cloned version.
 713 An id property can be passed on this object, otherwise one will be generated to avoid duplicates.</div></li>        </ul>\r
 714         <strong>Returns:</strong>\r
 715         <ul>\r
 716             <li><code>Ext.Component</code><div class="sub-desc">clone The cloned copy of this component</div></li>\r
 717         </ul>\r
 718     </div>\r
 719                 </div>\r
 720                         </div>\r
 721         </td>\r
 722         <td class="msource"><a ext:cls="Ext.Component" ext:member="#cloneConfig" href="output/Ext.Component.html#cloneConfig">Component</a></td>\r
 723     </tr>\r
 724         <tr class="method-row inherited expandable">\r
 725         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 726         <td class="sig">\r
 727         <a id="Ext.BoxComponent-destroy"></a>\r
 728             <b>destroy</b>() : void            <div class="mdesc">\r
 729                         <div class="short">Destroys this component by purging any event listeners, removing the component's element from the DOM,
 730 removing the c...</div>\r
 731             <div class="long">\r
 732                 Destroys this component by purging any event listeners, removing the component's element from the DOM,
 733 removing the component from its <a ext:cls="Ext.Container" href="output/Ext.Container.html">Ext.Container</a> (if applicable) and unregistering it from
 734 <a ext:cls="Ext.ComponentMgr" href="output/Ext.ComponentMgr.html">Ext.ComponentMgr</a>.  Destruction is generally handled automatically by the framework and this method
 735 should usually not need to be called directly.    <div class="mdetail-params">\r
 736         <strong>Parameters:</strong>\r
 737         <ul><li>None.</li>        </ul>\r
 738         <strong>Returns:</strong>\r
 739         <ul>\r
 740             <li><code>void</code></li>\r
 741         </ul>\r
 742     </div>\r
 743                 </div>\r
 744                         </div>\r
 745         </td>\r
 746         <td class="msource"><a ext:cls="Ext.Component" ext:member="#destroy" href="output/Ext.Component.html#destroy">Component</a></td>\r
 747     </tr>\r
 748         <tr class="method-row inherited alt expandable">\r
 749         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 750         <td class="sig">\r
 751         <a id="Ext.BoxComponent-disable"></a>\r
 752             <b>disable</b>() : Ext.Component            <div class="mdesc">\r
 753                         <div class="short">Disable this component.</div>\r
 754             <div class="long">\r
 755                 Disable this component.    <div class="mdetail-params">\r
 756         <strong>Parameters:</strong>\r
 757         <ul><li>None.</li>        </ul>\r
 758         <strong>Returns:</strong>\r
 759         <ul>\r
 760             <li><code>Ext.Component</code><div class="sub-desc">this</div></li>\r
 761         </ul>\r
 762     </div>\r
 763                 </div>\r
 764                         </div>\r
 765         </td>\r
 766         <td class="msource"><a ext:cls="Ext.Component" ext:member="#disable" href="output/Ext.Component.html#disable">Component</a></td>\r
 767     </tr>\r
 768         <tr class="method-row inherited expandable">\r
 769         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 770         <td class="sig">\r
 771         <a id="Ext.BoxComponent-enable"></a>\r
 772             <b>enable</b>() : Ext.Component            <div class="mdesc">\r
 773                         <div class="short">Enable this component.</div>\r
 774             <div class="long">\r
 775                 Enable this component.    <div class="mdetail-params">\r
 776         <strong>Parameters:</strong>\r
 777         <ul><li>None.</li>        </ul>\r
 778         <strong>Returns:</strong>\r
 779         <ul>\r
 780             <li><code>Ext.Component</code><div class="sub-desc">this</div></li>\r
 781         </ul>\r
 782     </div>\r
 783                 </div>\r
 784                         </div>\r
 785         </td>\r
 786         <td class="msource"><a ext:cls="Ext.Component" ext:member="#enable" href="output/Ext.Component.html#enable">Component</a></td>\r
 787     </tr>\r
 788         <tr class="method-row inherited alt expandable">\r
 789         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 790         <td class="sig">\r
 791         <a id="Ext.BoxComponent-findParentBy"></a>\r
 792             <b>findParentBy</b>(&nbsp;<code>Function fcn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : Ext.Container            <div class="mdesc">\r
 793                         <div class="short">Find a container above this component at any level by a custom function. If the passed function returns
 794 true, the con...</div>\r
 795             <div class="long">\r
 796                 Find a container above this component at any level by a custom function. If the passed function returns
 797 true, the container will be returned. The passed function is called with the arguments (container, this component).    <div class="mdetail-params">\r
 798         <strong>Parameters:</strong>\r
 799         <ul><li><code>fcn</code> : Function<div class="sub-desc"></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional)</div></li>        </ul>\r
 800         <strong>Returns:</strong>\r
 801         <ul>\r
 802             <li><code>Ext.Container</code><div class="sub-desc">The first Container for which the custom function returns true</div></li>\r
 803         </ul>\r
 804     </div>\r
 805                 </div>\r
 806                         </div>\r
 807         </td>\r
 808         <td class="msource"><a ext:cls="Ext.Component" ext:member="#findParentBy" href="output/Ext.Component.html#findParentBy">Component</a></td>\r
 809     </tr>\r
 810         <tr class="method-row inherited expandable">\r
 811         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 812         <td class="sig">\r
 813         <a id="Ext.BoxComponent-findParentByType"></a>\r
 814             <b>findParentByType</b>(&nbsp;<code>String/Class xtype</code>&nbsp;) : Ext.Container            <div class="mdesc">\r
 815                         <div class="short">Find a container above this component at any level by xtype or class</div>\r
 816             <div class="long">\r
 817                 Find a container above this component at any level by xtype or class    <div class="mdetail-params">\r
 818         <strong>Parameters:</strong>\r
 819         <ul><li><code>xtype</code> : String/Class<div class="sub-desc">The xtype string for a component, or the class of the component directly</div></li>        </ul>\r
 820         <strong>Returns:</strong>\r
 821         <ul>\r
 822             <li><code>Ext.Container</code><div class="sub-desc">The first Container which matches the given xtype or class</div></li>\r
 823         </ul>\r
 824     </div>\r
 825                 </div>\r
 826                         </div>\r
 827         </td>\r
 828         <td class="msource"><a ext:cls="Ext.Component" ext:member="#findParentByType" href="output/Ext.Component.html#findParentByType">Component</a></td>\r
 829     </tr>\r
 830         <tr class="method-row inherited alt expandable">\r
 831         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 832         <td class="sig">\r
 833         <a id="Ext.BoxComponent-fireEvent"></a>\r
 834             <b>fireEvent</b>(&nbsp;<code>String eventName</code>, <code>Object... args</code>&nbsp;) : Boolean            <div class="mdesc">\r
 835                         <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>\r
 836             <div class="long">\r
 837                 Fires the specified event with the passed parameters (minus the event name).    <div class="mdetail-params">\r
 838         <strong>Parameters:</strong>\r
 839         <ul><li><code>eventName</code> : String<div class="sub-desc"></div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers</div></li>        </ul>\r
 840         <strong>Returns:</strong>\r
 841         <ul>\r
 842             <li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li>\r
 843         </ul>\r
 844     </div>\r
 845                 </div>\r
 846                         </div>\r
 847         </td>\r
 848         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td>\r
 849     </tr>\r
 850         <tr class="method-row inherited expandable">\r
 851         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 852         <td class="sig">\r
 853         <a id="Ext.BoxComponent-focus"></a>\r
 854             <b>focus</b>(&nbsp;<span class="optional" title="Optional">[<code>Boolean selectText</code>]</span>, <span class="optional" title="Optional">[<code>Boolean/Number delay</code>]</span>&nbsp;) : Ext.Component            <div class="mdesc">\r
 855                         <div class="short">Try to focus this component.</div>\r
 856             <div class="long">\r
 857                 Try to focus this component.    <div class="mdetail-params">\r
 858         <strong>Parameters:</strong>\r
 859         <ul><li><code>selectText</code> : Boolean<div class="sub-desc">(optional) If applicable, true to also select the text in this component</div></li><li><code>delay</code> : Boolean/Number<div class="sub-desc">(optional) Delay the focus this number of milliseconds (true for 10 milliseconds)</div></li>        </ul>\r
 860         <strong>Returns:</strong>\r
 861         <ul>\r
 862             <li><code>Ext.Component</code><div class="sub-desc">this</div></li>\r
 863         </ul>\r
 864     </div>\r
 865                 </div>\r
 866                         </div>\r
 867         </td>\r
 868         <td class="msource"><a ext:cls="Ext.Component" ext:member="#focus" href="output/Ext.Component.html#focus">Component</a></td>\r
 869     </tr>\r
 870         <tr class="method-row alt expandable">\r
 871         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 872         <td class="sig">\r
 873         <a id="Ext.BoxComponent-getBox"></a>\r
 874             <b>getBox</b>(&nbsp;<span class="optional" title="Optional">[<code>Boolean local</code>]</span>&nbsp;) : Object            <div class="mdesc">\r
 875                         <div class="short">Gets the current box measurements of the component's underlying element.</div>\r
 876             <div class="long">\r
 877                 Gets the current box measurements of the component's underlying element.    <div class="mdetail-params">\r
 878         <strong>Parameters:</strong>\r
 879         <ul><li><code>local</code> : Boolean<div class="sub-desc">(optional) If true the element's left and top are returned instead of page XY (defaults to false)</div></li>        </ul>\r
 880         <strong>Returns:</strong>\r
 881         <ul>\r
 882             <li><code>Object</code><div class="sub-desc">box An object in the format {x, y, width, height}</div></li>\r
 883         </ul>\r
 884     </div>\r
 885                 </div>\r
 886                         </div>\r
 887         </td>\r
 888         <td class="msource">BoxComponent</td>\r
 889     </tr>\r
 890         <tr class="method-row inherited expandable">\r
 891         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 892         <td class="sig">\r
 893         <a id="Ext.BoxComponent-getEl"></a>\r
 894             <b>getEl</b>() : Ext.Element            <div class="mdesc">\r
 895                         <div class="short">Returns the underlying <a ext:cls="Ext.Element" href="output/Ext.Element.html">Ext.Element</a>.</div>\r
 896             <div class="long">\r
 897                 Returns the underlying <a ext:cls="Ext.Element" href="output/Ext.Element.html">Ext.Element</a>.    <div class="mdetail-params">\r
 898         <strong>Parameters:</strong>\r
 899         <ul><li>None.</li>        </ul>\r
 900         <strong>Returns:</strong>\r
 901         <ul>\r
 902             <li><code>Ext.Element</code><div class="sub-desc">The element</div></li>\r
 903         </ul>\r
 904     </div>\r
 905                 </div>\r
 906                         </div>\r
 907         </td>\r
 908         <td class="msource"><a ext:cls="Ext.Component" ext:member="#getEl" href="output/Ext.Component.html#getEl">Component</a></td>\r
 909     </tr>\r
 910         <tr class="method-row inherited alt expandable">\r
 911         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 912         <td class="sig">\r
 913         <a id="Ext.BoxComponent-getId"></a>\r
 914             <b>getId</b>() : String            <div class="mdesc">\r
 915                         <div class="short">Returns the id of this component.</div>\r
 916             <div class="long">\r
 917                 Returns the id of this component.    <div class="mdetail-params">\r
 918         <strong>Parameters:</strong>\r
 919         <ul><li>None.</li>        </ul>\r
 920         <strong>Returns:</strong>\r
 921         <ul>\r
 922             <li><code>String</code></li>\r
 923         </ul>\r
 924     </div>\r
 925                 </div>\r
 926                         </div>\r
 927         </td>\r
 928         <td class="msource"><a ext:cls="Ext.Component" ext:member="#getId" href="output/Ext.Component.html#getId">Component</a></td>\r
 929     </tr>\r
 930         <tr class="method-row inherited expandable">\r
 931         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 932         <td class="sig">\r
 933         <a id="Ext.BoxComponent-getItemId"></a>\r
 934             <b>getItemId</b>() : String            <div class="mdesc">\r
 935                         <div class="short">Returns the item id of this component.</div>\r
 936             <div class="long">\r
 937                 Returns the item id of this component.    <div class="mdetail-params">\r
 938         <strong>Parameters:</strong>\r
 939         <ul><li>None.</li>        </ul>\r
 940         <strong>Returns:</strong>\r
 941         <ul>\r
 942             <li><code>String</code></li>\r
 943         </ul>\r
 944     </div>\r
 945                 </div>\r
 946                         </div>\r
 947         </td>\r
 948         <td class="msource"><a ext:cls="Ext.Component" ext:member="#getItemId" href="output/Ext.Component.html#getItemId">Component</a></td>\r
 949     </tr>\r
 950         <tr class="method-row alt expandable">\r
 951         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 952         <td class="sig">\r
 953         <a id="Ext.BoxComponent-getPosition"></a>\r
 954             <b>getPosition</b>(&nbsp;<span class="optional" title="Optional">[<code>Boolean local</code>]</span>&nbsp;) : Array            <div class="mdesc">\r
 955                         <div class="short">Gets the current XY position of the component's underlying element.</div>\r
 956             <div class="long">\r
 957                 Gets the current XY position of the component's underlying element.    <div class="mdetail-params">\r
 958         <strong>Parameters:</strong>\r
 959         <ul><li><code>local</code> : Boolean<div class="sub-desc">(optional) If true the element's left and top are returned instead of page XY (defaults to false)</div></li>        </ul>\r
 960         <strong>Returns:</strong>\r
 961         <ul>\r
 962             <li><code>Array</code><div class="sub-desc">The XY position of the element (e.g., [100, 200])</div></li>\r
 963         </ul>\r
 964     </div>\r
 965                 </div>\r
 966                         </div>\r
 967         </td>\r
 968         <td class="msource">BoxComponent</td>\r
 969     </tr>\r
 970         <tr class="method-row expandable">\r
 971         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 972         <td class="sig">\r
 973         <a id="Ext.BoxComponent-getSize"></a>\r
 974             <b>getSize</b>() : Object            <div class="mdesc">\r
 975                         <div class="short">Gets the current size of the component's underlying element.</div>\r
 976             <div class="long">\r
 977                 Gets the current size of the component's underlying element.    <div class="mdetail-params">\r
 978         <strong>Parameters:</strong>\r
 979         <ul><li>None.</li>        </ul>\r
 980         <strong>Returns:</strong>\r
 981         <ul>\r
 982             <li><code>Object</code><div class="sub-desc">An object containing the element's size {width: (element width), height: (element height)}</div></li>\r
 983         </ul>\r
 984     </div>\r
 985                 </div>\r
 986                         </div>\r
 987         </td>\r
 988         <td class="msource">BoxComponent</td>\r
 989     </tr>\r
 990         <tr class="method-row inherited alt expandable">\r
 991         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 992         <td class="sig">\r
 993         <a id="Ext.BoxComponent-getXType"></a>\r
 994             <b>getXType</b>() : String            <div class="mdesc">\r
 995                         <div class="short">Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
 996 available xtypes, see the Ex...</div>\r
 997             <div class="long">\r
 998                 Gets the xtype for this component as registered with <a ext:cls="Ext.ComponentMgr" href="output/Ext.ComponentMgr.html">Ext.ComponentMgr</a>. For a list of all
 999 available xtypes, see the <a ext:cls="Ext.Component" href="output/Ext.Component.html">Ext.Component</a> header. Example usage:
1000 <pre><code>var t = <b>new</b> Ext.form.TextField();
1001 alert(t.getXType());  // alerts <em>'textfield'</em></code></pre>    <div class="mdetail-params">\r
1002         <strong>Parameters:</strong>\r
1003         <ul><li>None.</li>        </ul>\r
1004         <strong>Returns:</strong>\r
1005         <ul>\r
1006             <li><code>String</code><div class="sub-desc">The xtype</div></li>\r
1007         </ul>\r
1008     </div>\r
1009                 </div>\r
1010                         </div>\r
1011         </td>\r
1012         <td class="msource"><a ext:cls="Ext.Component" ext:member="#getXType" href="output/Ext.Component.html#getXType">Component</a></td>\r
1013     </tr>\r
1014         <tr class="method-row inherited expandable">\r
1015         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1016         <td class="sig">\r
1017         <a id="Ext.BoxComponent-getXTypes"></a>\r
1018             <b>getXTypes</b>() : String            <div class="mdesc">\r
1019                         <div class="short">Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all
1020 available xtypes, see the Ext...</div>\r
1021             <div class="long">\r
1022                 <p>Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all
1023 available xtypes, see the <a ext:cls="Ext.Component" href="output/Ext.Component.html">Ext.Component</a> header.</p>
1024 <p><b>If using your own subclasses, be aware that a Component must register its own xtype
1025 to participate in determination of inherited xtypes.</b></p>
1026 <p>Example usage:</p>
1027 <pre><code>\r
1028 var t = new Ext.form.TextField();\r
1029 alert(t.getXTypes());  // alerts 'component/box/field/textfield'</pre></code>    <div class="mdetail-params">\r
1030         <strong>Parameters:</strong>\r
1031         <ul><li>None.</li>        </ul>\r
1032         <strong>Returns:</strong>\r
1033         <ul>\r
1034             <li><code>String</code><div class="sub-desc">The xtype hierarchy string</div></li>\r
1035         </ul>\r
1036     </div>\r
1037                 </div>\r
1038                         </div>\r
1039         </td>\r
1040         <td class="msource"><a ext:cls="Ext.Component" ext:member="#getXTypes" href="output/Ext.Component.html#getXTypes">Component</a></td>\r
1041     </tr>\r
1042         <tr class="method-row inherited alt expandable">\r
1043         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1044         <td class="sig">\r
1045         <a id="Ext.BoxComponent-hasListener"></a>\r
1046             <b>hasListener</b>(&nbsp;<code>String eventName</code>&nbsp;) : Boolean            <div class="mdesc">\r
1047                         <div class="short">Checks to see if this object has any listeners for a specified event</div>\r
1048             <div class="long">\r
1049                 Checks to see if this object has any listeners for a specified event    <div class="mdetail-params">\r
1050         <strong>Parameters:</strong>\r
1051         <ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li>        </ul>\r
1052         <strong>Returns:</strong>\r
1053         <ul>\r
1054             <li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li>\r
1055         </ul>\r
1056     </div>\r
1057                 </div>\r
1058                         </div>\r
1059         </td>\r
1060         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td>\r
1061     </tr>\r
1062         <tr class="method-row inherited expandable">\r
1063         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1064         <td class="sig">\r
1065         <a id="Ext.BoxComponent-hide"></a>\r
1066             <b>hide</b>() : Ext.Component            <div class="mdesc">\r
1067                         <div class="short">Hide this component.</div>\r
1068             <div class="long">\r
1069                 Hide this component.    <div class="mdetail-params">\r
1070         <strong>Parameters:</strong>\r
1071         <ul><li>None.</li>        </ul>\r
1072         <strong>Returns:</strong>\r
1073         <ul>\r
1074             <li><code>Ext.Component</code><div class="sub-desc">this</div></li>\r
1075         </ul>\r
1076     </div>\r
1077                 </div>\r
1078                         </div>\r
1079         </td>\r
1080         <td class="msource"><a ext:cls="Ext.Component" ext:member="#hide" href="output/Ext.Component.html#hide">Component</a></td>\r
1081     </tr>\r
1082         <tr class="method-row inherited alt expandable">\r
1083         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1084         <td class="sig">\r
1085         <a id="Ext.BoxComponent-isVisible"></a>\r
1086             <b>isVisible</b>() : void            <div class="mdesc">\r
1087                         <div class="short">Returns true if this component is visible.</div>\r
1088             <div class="long">\r
1089                 Returns true if this component is visible.    <div class="mdetail-params">\r
1090         <strong>Parameters:</strong>\r
1091         <ul><li>None.</li>        </ul>\r
1092         <strong>Returns:</strong>\r
1093         <ul>\r
1094             <li><code>void</code></li>\r
1095         </ul>\r
1096     </div>\r
1097                 </div>\r
1098                         </div>\r
1099         </td>\r
1100         <td class="msource"><a ext:cls="Ext.Component" ext:member="#isVisible" href="output/Ext.Component.html#isVisible">Component</a></td>\r
1101     </tr>\r
1102         <tr class="method-row inherited expandable">\r
1103         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1104         <td class="sig">\r
1105         <a id="Ext.BoxComponent-isXType"></a>\r
1106             <b>isXType</b>(&nbsp;<code>String xtype</code>, <span class="optional" title="Optional">[<code>Boolean shallow</code>]</span>&nbsp;) : void            <div class="mdesc">\r
1107                         <div class="short">Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended
1108 from th...</div>\r
1109             <div class="long">\r
1110                 <p>Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended
1111 from the xtype (default) or whether it is directly of the xtype specified (shallow = true).</p>
1112 <p><b>If using your own subclasses, be aware that a Component must register its own xtype
1113 to participate in determination of inherited xtypes.</b></p>
1114 <p>For a list of all available xtypes, see the <a ext:cls="Ext.Component" href="output/Ext.Component.html">Ext.Component</a> header.</p>
1115 <p>Example usage:</p>
1116 <pre><code>var t = <b>new</b> Ext.form.TextField();
1117 <b>var</b> isText = t.isXType(<em>'textfield'</em>);        <i>// true</i>
1118 <b>var</b> isBoxSubclass = t.isXType(<em>'box'</em>);       <i>// true, descended from BoxComponent</i>
1119 <b>var</b> isBoxInstance = t.isXType(<em>'box'</em>, true); // false, not a direct BoxComponent instance</code></pre>    <div class="mdetail-params">\r
1120         <strong>Parameters:</strong>\r
1121         <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
1122 the default), or true to check whether this Component is directly of the specified xtype.</div></li>        </ul>\r
1123         <strong>Returns:</strong>\r
1124         <ul>\r
1125             <li><code>void</code></li>\r
1126         </ul>\r
1127     </div>\r
1128                 </div>\r
1129                         </div>\r
1130         </td>\r
1131         <td class="msource"><a ext:cls="Ext.Component" ext:member="#isXType" href="output/Ext.Component.html#isXType">Component</a></td>\r
1132     </tr>\r
1133         <tr class="method-row inherited alt expandable">\r
1134         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1135         <td class="sig">\r
1136         <a id="Ext.BoxComponent-on"></a>\r
1137             <b>on</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span>&nbsp;) : void            <div class="mdesc">\r
1138                         <div class="short">Appends an event handler to this element (shorthand for addListener)</div>\r
1139             <div class="long">\r
1140                 Appends an event handler to this element (shorthand for addListener)    <div class="mdetail-params">\r
1141         <strong>Parameters:</strong>\r
1142         <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler
1143 function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li>        </ul>\r
1144         <strong>Returns:</strong>\r
1145         <ul>\r
1146             <li><code>void</code></li>\r
1147         </ul>\r
1148     </div>\r
1149                 </div>\r
1150                         </div>\r
1151         </td>\r
1152         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td>\r
1153     </tr>\r
1154         <tr class="method-row inherited expandable">\r
1155         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1156         <td class="sig">\r
1157         <a id="Ext.BoxComponent-purgeListeners"></a>\r
1158             <b>purgeListeners</b>() : void            <div class="mdesc">\r
1159                         <div class="short">Removes all listeners for this object</div>\r
1160             <div class="long">\r
1161                 Removes all listeners for this object    <div class="mdetail-params">\r
1162         <strong>Parameters:</strong>\r
1163         <ul><li>None.</li>        </ul>\r
1164         <strong>Returns:</strong>\r
1165         <ul>\r
1166             <li><code>void</code></li>\r
1167         </ul>\r
1168     </div>\r
1169                 </div>\r
1170                         </div>\r
1171         </td>\r
1172         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td>\r
1173     </tr>\r
1174         <tr class="method-row inherited alt expandable">\r
1175         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1176         <td class="sig">\r
1177         <a id="Ext.BoxComponent-relayEvents"></a>\r
1178             <b>relayEvents</b>(&nbsp;<code>Object o</code>, <code>Array events</code>&nbsp;) : void            <div class="mdesc">\r
1179                         <div class="short">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.</div>\r
1180             <div class="long">\r
1181                 Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.    <div class="mdetail-params">\r
1182         <strong>Parameters:</strong>\r
1183         <ul><li><code>o</code> : Object<div class="sub-desc">The Observable whose events this object is to relay.</div></li><li><code>events</code> : Array<div class="sub-desc">Array of event names to relay.</div></li>        </ul>\r
1184         <strong>Returns:</strong>\r
1185         <ul>\r
1186             <li><code>void</code></li>\r
1187         </ul>\r
1188     </div>\r
1189                 </div>\r
1190                         </div>\r
1191         </td>\r
1192         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#relayEvents" href="output/Ext.util.Observable.html#relayEvents">Observable</a></td>\r
1193     </tr>\r
1194         <tr class="method-row inherited expandable">\r
1195         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1196         <td class="sig">\r
1197         <a id="Ext.BoxComponent-removeClass"></a>\r
1198             <b>removeClass</b>(&nbsp;<code>string cls</code>&nbsp;) : void            <div class="mdesc">\r
1199                         <div class="short">Removes a CSS class from the component's underlying element.</div>\r
1200             <div class="long">\r
1201                 Removes a CSS class from the component's underlying element.    <div class="mdetail-params">\r
1202         <strong>Parameters:</strong>\r
1203         <ul><li><code>cls</code> : string<div class="sub-desc">The CSS class name to remove</div></li>        </ul>\r
1204         <strong>Returns:</strong>\r
1205         <ul>\r
1206             <li><code>void</code></li>\r
1207         </ul>\r
1208     </div>\r
1209                 </div>\r
1210                         </div>\r
1211         </td>\r
1212         <td class="msource"><a ext:cls="Ext.Component" ext:member="#removeClass" href="output/Ext.Component.html#removeClass">Component</a></td>\r
1213     </tr>\r
1214         <tr class="method-row inherited alt expandable">\r
1215         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1216         <td class="sig">\r
1217         <a id="Ext.BoxComponent-removeListener"></a>\r
1218             <b>removeListener</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : void            <div class="mdesc">\r
1219                         <div class="short">Removes a listener</div>\r
1220             <div class="long">\r
1221                 Removes a listener    <div class="mdetail-params">\r
1222         <strong>Parameters:</strong>\r
1223         <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li>        </ul>\r
1224         <strong>Returns:</strong>\r
1225         <ul>\r
1226             <li><code>void</code></li>\r
1227         </ul>\r
1228     </div>\r
1229                 </div>\r
1230                         </div>\r
1231         </td>\r
1232         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td>\r
1233     </tr>\r
1234         <tr class="method-row inherited expandable">\r
1235         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1236         <td class="sig">\r
1237         <a id="Ext.BoxComponent-render"></a>\r
1238             <b>render</b>(&nbsp;<span class="optional" title="Optional">[<code>Element/HTMLElement/String container</code>]</span>, <span class="optional" title="Optional">[<code>String/Number position</code>]</span>&nbsp;) : void            <div class="mdesc">\r
1239                         <div class="short">Render this Component into the passed HTML element.
1240 If you are using a Container object to house this Component, then...</div>\r
1241             <div class="long">\r
1242                 <p>Render this Component into the passed HTML element.</p>
1243 <p><b>If you are using a <a ext:cls="Ext.Container" href="output/Ext.Container.html">Container</a> object to house this Component, then
1244 do not use the render method.</b></p>
1245 <p>A Container's child Components are rendered by that Container's
1246 <a ext:cls="Ext.Container" ext:member="layout" href="output/Ext.Container.html#layout">layout</a> manager when the Container is first rendered.</p>
1247 <p>Certain layout managers allow dynamic addition of child components. Those that do
1248 include <a ext:cls="Ext.layout.CardLayout" href="output/Ext.layout.CardLayout.html">Ext.layout.CardLayout</a>, <a ext:cls="Ext.layout.AnchorLayout" href="output/Ext.layout.AnchorLayout.html">Ext.layout.AnchorLayout</a>,
1249 <a ext:cls="Ext.layout.FormLayout" href="output/Ext.layout.FormLayout.html">Ext.layout.FormLayout</a>, <a ext:cls="Ext.layout.TableLayout" href="output/Ext.layout.TableLayout.html">Ext.layout.TableLayout</a>.</p>
1250 <p>If the Container is already rendered when a new child Component is added, you may need to call
1251 the Container's <a ext:cls="Ext.Container" ext:member="doLayout" href="output/Ext.Container.html#doLayout">doLayout</a> to refresh the view which causes any
1252 unrendered child Components to be rendered. This is required so that you can add multiple
1253 child components if needed while only refreshing the layout once.</p>
1254 <p>When creating complex UIs, it is important to remember that sizing and positioning
1255 of child items is the responsibility of the Container's <a ext:cls="Ext.Container" ext:member="layout" href="output/Ext.Container.html#layout">layout</a> manager.
1256 If you expect child items to be sized in response to user interactions, you must
1257 configure the Container with a layout manager which creates and manages the type of layout you
1258 have in mind.</p>
1259 <p><b>Omitting the Container's <a ext:cls="Ext.Container" ext:member="layout" href="output/Ext.Container.html#layout">layout</a> config means that a basic
1260 layout manager is used which does nothing but render child components sequentially into the
1261 Container. No sizing or positioning will be performed in this situation.</b></p>    <div class="mdetail-params">\r
1262         <strong>Parameters:</strong>\r
1263         <ul><li><code>container</code> : Element/HTMLElement/String<div class="sub-desc">(optional) The element this Component should be
1264 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>
1265 which this component will be inserted (defaults to appending to the end of the container)</div></li>        </ul>\r
1266         <strong>Returns:</strong>\r
1267         <ul>\r
1268             <li><code>void</code></li>\r
1269         </ul>\r
1270     </div>\r
1271                 </div>\r
1272                         </div>\r
1273         </td>\r
1274         <td class="msource"><a ext:cls="Ext.Component" ext:member="#render" href="output/Ext.Component.html#render">Component</a></td>\r
1275     </tr>\r
1276         <tr class="method-row inherited alt expandable">\r
1277         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1278         <td class="sig">\r
1279         <a id="Ext.BoxComponent-resumeEvents"></a>\r
1280             <b>resumeEvents</b>() : void            <div class="mdesc">\r
1281                         <div class="short">Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>)</div>\r
1282             <div class="long">\r
1283                 Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>)    <div class="mdetail-params">\r
1284         <strong>Parameters:</strong>\r
1285         <ul><li>None.</li>        </ul>\r
1286         <strong>Returns:</strong>\r
1287         <ul>\r
1288             <li><code>void</code></li>\r
1289         </ul>\r
1290     </div>\r
1291                 </div>\r
1292                         </div>\r
1293         </td>\r
1294         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td>\r
1295     </tr>\r
1296         <tr class="method-row inherited expandable">\r
1297         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1298         <td class="sig">\r
1299         <a id="Ext.BoxComponent-setDisabled"></a>\r
1300             <b>setDisabled</b>(&nbsp;<code>Boolean disabled</code>&nbsp;) : void            <div class="mdesc">\r
1301                         <div class="short">Convenience function for setting disabled/enabled by boolean.</div>\r
1302             <div class="long">\r
1303                 Convenience function for setting disabled/enabled by boolean.    <div class="mdetail-params">\r
1304         <strong>Parameters:</strong>\r
1305         <ul><li><code>disabled</code> : Boolean<div class="sub-desc"></div></li>        </ul>\r
1306         <strong>Returns:</strong>\r
1307         <ul>\r
1308             <li><code>void</code></li>\r
1309         </ul>\r
1310     </div>\r
1311                 </div>\r
1312                         </div>\r
1313         </td>\r
1314         <td class="msource"><a ext:cls="Ext.Component" ext:member="#setDisabled" href="output/Ext.Component.html#setDisabled">Component</a></td>\r
1315     </tr>\r
1316         <tr class="method-row alt expandable">\r
1317         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1318         <td class="sig">\r
1319         <a id="Ext.BoxComponent-setHeight"></a>\r
1320             <b>setHeight</b>(&nbsp;<code>Number height</code>&nbsp;) : Ext.BoxComponent            <div class="mdesc">\r
1321                         <div class="short">Sets the height of the component.  This method fires the <a ext:cls="Ext.BoxComponent" ext:member="resize" href="output/Ext.BoxComponent.html#resize">resize</a> event.</div>\r
1322             <div class="long">\r
1323                 Sets the height of the component.  This method fires the <a ext:cls="Ext.BoxComponent" ext:member="resize" href="output/Ext.BoxComponent.html#resize">resize</a> event.    <div class="mdetail-params">\r
1324         <strong>Parameters:</strong>\r
1325         <ul><li><code>height</code> : Number<div class="sub-desc">The new height to set</div></li>        </ul>\r
1326         <strong>Returns:</strong>\r
1327         <ul>\r
1328             <li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li>\r
1329         </ul>\r
1330     </div>\r
1331                 </div>\r
1332                         </div>\r
1333         </td>\r
1334         <td class="msource">BoxComponent</td>\r
1335     </tr>\r
1336         <tr class="method-row expandable">\r
1337         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1338         <td class="sig">\r
1339         <a id="Ext.BoxComponent-setPagePosition"></a>\r
1340             <b>setPagePosition</b>(&nbsp;<code>Number x</code>, <code>Number y</code>&nbsp;) : Ext.BoxComponent            <div class="mdesc">\r
1341                         <div class="short">Sets the page XY position of the component.  To set the left and top instead, use setPosition.
1342 This method fires the ...</div>\r
1343             <div class="long">\r
1344                 Sets the page XY position of the component.  To set the left and top instead, use <a ext:cls="Ext.BoxComponent" ext:member="setPosition" href="output/Ext.BoxComponent.html#setPosition">setPosition</a>.
1345 This method fires the <a ext:cls="Ext.BoxComponent" ext:member="move" href="output/Ext.BoxComponent.html#move">move</a> event.    <div class="mdetail-params">\r
1346         <strong>Parameters:</strong>\r
1347         <ul><li><code>x</code> : Number<div class="sub-desc">The new x position</div></li><li><code>y</code> : Number<div class="sub-desc">The new y position</div></li>        </ul>\r
1348         <strong>Returns:</strong>\r
1349         <ul>\r
1350             <li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li>\r
1351         </ul>\r
1352     </div>\r
1353                 </div>\r
1354                         </div>\r
1355         </td>\r
1356         <td class="msource">BoxComponent</td>\r
1357     </tr>\r
1358         <tr class="method-row alt expandable">\r
1359         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1360         <td class="sig">\r
1361         <a id="Ext.BoxComponent-setPosition"></a>\r
1362             <b>setPosition</b>(&nbsp;<code>Number left</code>, <code>Number top</code>&nbsp;) : Ext.BoxComponent            <div class="mdesc">\r
1363                         <div class="short">Sets the left and top of the component.  To set the page XY position instead, use setPagePosition.
1364 This method fires ...</div>\r
1365             <div class="long">\r
1366                 Sets the left and top of the component.  To set the page XY position instead, use <a ext:cls="Ext.BoxComponent" ext:member="setPagePosition" href="output/Ext.BoxComponent.html#setPagePosition">setPagePosition</a>.
1367 This method fires the <a ext:cls="Ext.BoxComponent" ext:member="move" href="output/Ext.BoxComponent.html#move">move</a> event.    <div class="mdetail-params">\r
1368         <strong>Parameters:</strong>\r
1369         <ul><li><code>left</code> : Number<div class="sub-desc">The new left</div></li><li><code>top</code> : Number<div class="sub-desc">The new top</div></li>        </ul>\r
1370         <strong>Returns:</strong>\r
1371         <ul>\r
1372             <li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li>\r
1373         </ul>\r
1374     </div>\r
1375                 </div>\r
1376                         </div>\r
1377         </td>\r
1378         <td class="msource">BoxComponent</td>\r
1379     </tr>\r
1380         <tr class="method-row expandable">\r
1381         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1382         <td class="sig">\r
1383         <a id="Ext.BoxComponent-setSize"></a>\r
1384             <b>setSize</b>(&nbsp;<code>Number/Object width</code>, <code>Number height</code>&nbsp;) : Ext.BoxComponent            <div class="mdesc">\r
1385                         <div class="short">Sets the width and height of the component.  This method fires the resize event.  This method can accept
1386 either width...</div>\r
1387             <div class="long">\r
1388                 Sets the width and height of the component.  This method fires the <a ext:cls="Ext.BoxComponent" ext:member="resize" href="output/Ext.BoxComponent.html#resize">resize</a> event.  This method can accept
1389 either width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.    <div class="mdetail-params">\r
1390         <strong>Parameters:</strong>\r
1391         <ul><li><code>width</code> : Number/Object<div class="sub-desc">The new width to set, or a size object in the format {width, height}</div></li><li><code>height</code> : Number<div class="sub-desc">The new height to set (not required if a size object is passed as the first arg)</div></li>        </ul>\r
1392         <strong>Returns:</strong>\r
1393         <ul>\r
1394             <li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li>\r
1395         </ul>\r
1396     </div>\r
1397                 </div>\r
1398                         </div>\r
1399         </td>\r
1400         <td class="msource">BoxComponent</td>\r
1401     </tr>\r
1402         <tr class="method-row inherited alt expandable">\r
1403         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1404         <td class="sig">\r
1405         <a id="Ext.BoxComponent-setVisible"></a>\r
1406             <b>setVisible</b>(&nbsp;<code>Boolean visible</code>&nbsp;) : Ext.Component            <div class="mdesc">\r
1407                         <div class="short">Convenience function to hide or show this component by boolean.</div>\r
1408             <div class="long">\r
1409                 Convenience function to hide or show this component by boolean.    <div class="mdetail-params">\r
1410         <strong>Parameters:</strong>\r
1411         <ul><li><code>visible</code> : Boolean<div class="sub-desc">True to show, false to hide</div></li>        </ul>\r
1412         <strong>Returns:</strong>\r
1413         <ul>\r
1414             <li><code>Ext.Component</code><div class="sub-desc">this</div></li>\r
1415         </ul>\r
1416     </div>\r
1417                 </div>\r
1418                         </div>\r
1419         </td>\r
1420         <td class="msource"><a ext:cls="Ext.Component" ext:member="#setVisible" href="output/Ext.Component.html#setVisible">Component</a></td>\r
1421     </tr>\r
1422         <tr class="method-row expandable">\r
1423         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1424         <td class="sig">\r
1425         <a id="Ext.BoxComponent-setWidth"></a>\r
1426             <b>setWidth</b>(&nbsp;<code>Number width</code>&nbsp;) : Ext.BoxComponent            <div class="mdesc">\r
1427                         <div class="short">Sets the width of the component.  This method fires the <a ext:cls="Ext.BoxComponent" ext:member="resize" href="output/Ext.BoxComponent.html#resize">resize</a> event.</div>\r
1428             <div class="long">\r
1429                 Sets the width of the component.  This method fires the <a ext:cls="Ext.BoxComponent" ext:member="resize" href="output/Ext.BoxComponent.html#resize">resize</a> event.    <div class="mdetail-params">\r
1430         <strong>Parameters:</strong>\r
1431         <ul><li><code>width</code> : Number<div class="sub-desc">The new width to set</div></li>        </ul>\r
1432         <strong>Returns:</strong>\r
1433         <ul>\r
1434             <li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li>\r
1435         </ul>\r
1436     </div>\r
1437                 </div>\r
1438                         </div>\r
1439         </td>\r
1440         <td class="msource">BoxComponent</td>\r
1441     </tr>\r
1442         <tr class="method-row inherited alt expandable">\r
1443         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1444         <td class="sig">\r
1445         <a id="Ext.BoxComponent-show"></a>\r
1446             <b>show</b>() : Ext.Component            <div class="mdesc">\r
1447                         <div class="short">Show this component.</div>\r
1448             <div class="long">\r
1449                 Show this component.    <div class="mdetail-params">\r
1450         <strong>Parameters:</strong>\r
1451         <ul><li>None.</li>        </ul>\r
1452         <strong>Returns:</strong>\r
1453         <ul>\r
1454             <li><code>Ext.Component</code><div class="sub-desc">this</div></li>\r
1455         </ul>\r
1456     </div>\r
1457                 </div>\r
1458                         </div>\r
1459         </td>\r
1460         <td class="msource"><a ext:cls="Ext.Component" ext:member="#show" href="output/Ext.Component.html#show">Component</a></td>\r
1461     </tr>\r
1462         <tr class="method-row inherited expandable">\r
1463         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1464         <td class="sig">\r
1465         <a id="Ext.BoxComponent-suspendEvents"></a>\r
1466             <b>suspendEvents</b>() : void            <div class="mdesc">\r
1467                         <div class="short">Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>)</div>\r
1468             <div class="long">\r
1469                 Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>)    <div class="mdetail-params">\r
1470         <strong>Parameters:</strong>\r
1471         <ul><li>None.</li>        </ul>\r
1472         <strong>Returns:</strong>\r
1473         <ul>\r
1474             <li><code>void</code></li>\r
1475         </ul>\r
1476     </div>\r
1477                 </div>\r
1478                         </div>\r
1479         </td>\r
1480         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td>\r
1481     </tr>\r
1482         <tr class="method-row alt expandable">\r
1483         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1484         <td class="sig">\r
1485         <a id="Ext.BoxComponent-syncSize"></a>\r
1486             <b>syncSize</b>() : Ext.BoxComponent            <div class="mdesc">\r
1487                         <div class="short">Force the component's size to recalculate based on the underlying element's current height and width.</div>\r
1488             <div class="long">\r
1489                 Force the component's size to recalculate based on the underlying element's current height and width.    <div class="mdetail-params">\r
1490         <strong>Parameters:</strong>\r
1491         <ul><li>None.</li>        </ul>\r
1492         <strong>Returns:</strong>\r
1493         <ul>\r
1494             <li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li>\r
1495         </ul>\r
1496     </div>\r
1497                 </div>\r
1498                         </div>\r
1499         </td>\r
1500         <td class="msource">BoxComponent</td>\r
1501     </tr>\r
1502         <tr class="method-row inherited expandable">\r
1503         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1504         <td class="sig">\r
1505         <a id="Ext.BoxComponent-un"></a>\r
1506             <b>un</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : void            <div class="mdesc">\r
1507                         <div class="short">Removes a listener (shorthand for removeListener)</div>\r
1508             <div class="long">\r
1509                 Removes a listener (shorthand for removeListener)    <div class="mdetail-params">\r
1510         <strong>Parameters:</strong>\r
1511         <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li>        </ul>\r
1512         <strong>Returns:</strong>\r
1513         <ul>\r
1514             <li><code>void</code></li>\r
1515         </ul>\r
1516     </div>\r
1517                 </div>\r
1518                         </div>\r
1519         </td>\r
1520         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td>\r
1521     </tr>\r
1522         <tr class="method-row alt expandable">\r
1523         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1524         <td class="sig">\r
1525         <a id="Ext.BoxComponent-updateBox"></a>\r
1526             <b>updateBox</b>(&nbsp;<code>Object box</code>&nbsp;) : Ext.BoxComponent            <div class="mdesc">\r
1527                         <div class="short">Sets the current box measurements of the component's underlying element.</div>\r
1528             <div class="long">\r
1529                 Sets the current box measurements of the component's underlying element.    <div class="mdetail-params">\r
1530         <strong>Parameters:</strong>\r
1531         <ul><li><code>box</code> : Object<div class="sub-desc">An object in the format {x, y, width, height}</div></li>        </ul>\r
1532         <strong>Returns:</strong>\r
1533         <ul>\r
1534             <li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li>\r
1535         </ul>\r
1536     </div>\r
1537                 </div>\r
1538                         </div>\r
1539         </td>\r
1540         <td class="msource">BoxComponent</td>\r
1541     </tr>\r
1542             </table>
1543                 <a id="Ext.BoxComponent-events"></a>
1544         <h2>Public Events</h2>
1545                 <table cellspacing="0" class="member-table">
1546             <tr>
1547                 <th class="sig-header" colspan="2">Event</th>
1548                 <th class="msource-header">Defined By</th>
1549             </tr>
1550                 <tr class="event-row inherited expandable">\r
1551         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1552         <td class="sig">\r
1553         <a id="Ext.BoxComponent-beforedestroy"></a>\r
1554             <b>beforedestroy</b> : (&nbsp;<code>Ext.Component this</code>&nbsp;)            <div class="mdesc">\r
1555                         <div class="short">Fires before the component is destroyed. Return false to stop the destroy.</div>\r
1556             <div class="long">\r
1557                 Fires before the component is destroyed. Return false to stop the destroy.    <div class="mdetail-params">\r
1558         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
1559         <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li>        </ul>\r
1560     </div>\r
1561                 </div>\r
1562                         </div>\r
1563         </td>\r
1564         <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-beforedestroy" href="output/Ext.Component.html#event-beforedestroy">Component</a></td>\r
1565     </tr>\r
1566         <tr class="event-row inherited alt expandable">\r
1567         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1568         <td class="sig">\r
1569         <a id="Ext.BoxComponent-beforehide"></a>\r
1570             <b>beforehide</b> : (&nbsp;<code>Ext.Component this</code>&nbsp;)            <div class="mdesc">\r
1571                         <div class="short">Fires before the component is hidden. Return false to stop the hide.</div>\r
1572             <div class="long">\r
1573                 Fires before the component is hidden. Return false to stop the hide.    <div class="mdetail-params">\r
1574         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
1575         <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li>        </ul>\r
1576     </div>\r
1577                 </div>\r
1578                         </div>\r
1579         </td>\r
1580         <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-beforehide" href="output/Ext.Component.html#event-beforehide">Component</a></td>\r
1581     </tr>\r
1582         <tr class="event-row inherited expandable">\r
1583         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1584         <td class="sig">\r
1585         <a id="Ext.BoxComponent-beforerender"></a>\r
1586             <b>beforerender</b> : (&nbsp;<code>Ext.Component this</code>&nbsp;)            <div class="mdesc">\r
1587                         <div class="short">Fires before the component is rendered. Return false to stop the render.</div>\r
1588             <div class="long">\r
1589                 Fires before the component is rendered. Return false to stop the render.    <div class="mdetail-params">\r
1590         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
1591         <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li>        </ul>\r
1592     </div>\r
1593                 </div>\r
1594                         </div>\r
1595         </td>\r
1596         <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-beforerender" href="output/Ext.Component.html#event-beforerender">Component</a></td>\r
1597     </tr>\r
1598         <tr class="event-row inherited alt expandable">\r
1599         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1600         <td class="sig">\r
1601         <a id="Ext.BoxComponent-beforeshow"></a>\r
1602             <b>beforeshow</b> : (&nbsp;<code>Ext.Component this</code>&nbsp;)            <div class="mdesc">\r
1603                         <div class="short">Fires before the component is shown. Return false to stop the show.</div>\r
1604             <div class="long">\r
1605                 Fires before the component is shown. Return false to stop the show.    <div class="mdetail-params">\r
1606         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
1607         <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li>        </ul>\r
1608     </div>\r
1609                 </div>\r
1610                         </div>\r
1611         </td>\r
1612         <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-beforeshow" href="output/Ext.Component.html#event-beforeshow">Component</a></td>\r
1613     </tr>\r
1614         <tr class="event-row inherited expandable">\r
1615         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1616         <td class="sig">\r
1617         <a id="Ext.BoxComponent-beforestaterestore"></a>\r
1618             <b>beforestaterestore</b> : (&nbsp;<code>Ext.Component this</code>, <code>Object state</code>&nbsp;)            <div class="mdesc">\r
1619                         <div class="short">Fires before the state of the component is restored. Return false to stop the restore.</div>\r
1620             <div class="long">\r
1621                 Fires before the state of the component is restored. Return false to stop the restore.    <div class="mdetail-params">\r
1622         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
1623         <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>state</code> : Object<div class="sub-desc">The hash of state values</div></li>        </ul>\r
1624     </div>\r
1625                 </div>\r
1626                         </div>\r
1627         </td>\r
1628         <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-beforestaterestore" href="output/Ext.Component.html#event-beforestaterestore">Component</a></td>\r
1629     </tr>\r
1630         <tr class="event-row inherited alt expandable">\r
1631         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1632         <td class="sig">\r
1633         <a id="Ext.BoxComponent-beforestatesave"></a>\r
1634             <b>beforestatesave</b> : (&nbsp;<code>Ext.Component this</code>, <code>Object state</code>&nbsp;)            <div class="mdesc">\r
1635                         <div class="short">Fires before the state of the component is saved to the configured state provider. Return false to stop the save.</div>\r
1636             <div class="long">\r
1637                 Fires before the state of the component is saved to the configured state provider. Return false to stop the save.    <div class="mdetail-params">\r
1638         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
1639         <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>state</code> : Object<div class="sub-desc">The hash of state values</div></li>        </ul>\r
1640     </div>\r
1641                 </div>\r
1642                         </div>\r
1643         </td>\r
1644         <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-beforestatesave" href="output/Ext.Component.html#event-beforestatesave">Component</a></td>\r
1645     </tr>\r
1646         <tr class="event-row inherited expandable">\r
1647         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1648         <td class="sig">\r
1649         <a id="Ext.BoxComponent-destroy"></a>\r
1650             <b>destroy</b> : (&nbsp;<code>Ext.Component this</code>&nbsp;)            <div class="mdesc">\r
1651                         <div class="short">Fires after the component is destroyed.</div>\r
1652             <div class="long">\r
1653                 Fires after the component is destroyed.    <div class="mdetail-params">\r
1654         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
1655         <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li>        </ul>\r
1656     </div>\r
1657                 </div>\r
1658                         </div>\r
1659         </td>\r
1660         <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-destroy" href="output/Ext.Component.html#event-destroy">Component</a></td>\r
1661     </tr>\r
1662         <tr class="event-row inherited alt expandable">\r
1663         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1664         <td class="sig">\r
1665         <a id="Ext.BoxComponent-disable"></a>\r
1666             <b>disable</b> : (&nbsp;<code>Ext.Component this</code>&nbsp;)            <div class="mdesc">\r
1667                         <div class="short">Fires after the component is disabled.</div>\r
1668             <div class="long">\r
1669                 Fires after the component is disabled.    <div class="mdetail-params">\r
1670         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
1671         <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li>        </ul>\r
1672     </div>\r
1673                 </div>\r
1674                         </div>\r
1675         </td>\r
1676         <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-disable" href="output/Ext.Component.html#event-disable">Component</a></td>\r
1677     </tr>\r
1678         <tr class="event-row inherited expandable">\r
1679         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1680         <td class="sig">\r
1681         <a id="Ext.BoxComponent-enable"></a>\r
1682             <b>enable</b> : (&nbsp;<code>Ext.Component this</code>&nbsp;)            <div class="mdesc">\r
1683                         <div class="short">Fires after the component is enabled.</div>\r
1684             <div class="long">\r
1685                 Fires after the component is enabled.    <div class="mdetail-params">\r
1686         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
1687         <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li>        </ul>\r
1688     </div>\r
1689                 </div>\r
1690                         </div>\r
1691         </td>\r
1692         <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-enable" href="output/Ext.Component.html#event-enable">Component</a></td>\r
1693     </tr>\r
1694         <tr class="event-row inherited alt expandable">\r
1695         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1696         <td class="sig">\r
1697         <a id="Ext.BoxComponent-hide"></a>\r
1698             <b>hide</b> : (&nbsp;<code>Ext.Component this</code>&nbsp;)            <div class="mdesc">\r
1699                         <div class="short">Fires after the component is hidden.</div>\r
1700             <div class="long">\r
1701                 Fires after the component is hidden.    <div class="mdetail-params">\r
1702         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
1703         <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li>        </ul>\r
1704     </div>\r
1705                 </div>\r
1706                         </div>\r
1707         </td>\r
1708         <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-hide" href="output/Ext.Component.html#event-hide">Component</a></td>\r
1709     </tr>\r
1710         <tr class="event-row expandable">\r
1711         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1712         <td class="sig">\r
1713         <a id="Ext.BoxComponent-move"></a>\r
1714             <b>move</b> : (&nbsp;<code>Ext.Component this</code>, <code>Number x</code>, <code>Number y</code>&nbsp;)            <div class="mdesc">\r
1715                         <div class="short">Fires after the component is moved.</div>\r
1716             <div class="long">\r
1717                 Fires after the component is moved.    <div class="mdetail-params">\r
1718         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
1719         <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>x</code> : Number<div class="sub-desc">The new x position</div></li><li><code>y</code> : Number<div class="sub-desc">The new y position</div></li>        </ul>\r
1720     </div>\r
1721                 </div>\r
1722                         </div>\r
1723         </td>\r
1724         <td class="msource">BoxComponent</td>\r
1725     </tr>\r
1726         <tr class="event-row inherited alt expandable">\r
1727         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1728         <td class="sig">\r
1729         <a id="Ext.BoxComponent-render"></a>\r
1730             <b>render</b> : (&nbsp;<code>Ext.Component this</code>&nbsp;)            <div class="mdesc">\r
1731                         <div class="short">Fires after the component is rendered.</div>\r
1732             <div class="long">\r
1733                 Fires after the component is rendered.    <div class="mdetail-params">\r
1734         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
1735         <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li>        </ul>\r
1736     </div>\r
1737                 </div>\r
1738                         </div>\r
1739         </td>\r
1740         <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-render" href="output/Ext.Component.html#event-render">Component</a></td>\r
1741     </tr>\r
1742         <tr class="event-row expandable">\r
1743         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1744         <td class="sig">\r
1745         <a id="Ext.BoxComponent-resize"></a>\r
1746             <b>resize</b> : (&nbsp;<code>Ext.Component this</code>, <code>Number adjWidth</code>, <code>Number adjHeight</code>, <code>Number rawWidth</code>, <code>Number rawHeight</code>&nbsp;)            <div class="mdesc">\r
1747                         <div class="short">Fires after the component is resized.</div>\r
1748             <div class="long">\r
1749                 Fires after the component is resized.    <div class="mdetail-params">\r
1750         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
1751         <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>adjWidth</code> : Number<div class="sub-desc">The box-adjusted width that was set</div></li><li><code>adjHeight</code> : Number<div class="sub-desc">The box-adjusted height that was set</div></li><li><code>rawWidth</code> : Number<div class="sub-desc">The width that was originally specified</div></li><li><code>rawHeight</code> : Number<div class="sub-desc">The height that was originally specified</div></li>        </ul>\r
1752     </div>\r
1753                 </div>\r
1754                         </div>\r
1755         </td>\r
1756         <td class="msource">BoxComponent</td>\r
1757     </tr>\r
1758         <tr class="event-row inherited alt expandable">\r
1759         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1760         <td class="sig">\r
1761         <a id="Ext.BoxComponent-show"></a>\r
1762             <b>show</b> : (&nbsp;<code>Ext.Component this</code>&nbsp;)            <div class="mdesc">\r
1763                         <div class="short">Fires after the component is shown.</div>\r
1764             <div class="long">\r
1765                 Fires after the component is shown.    <div class="mdetail-params">\r
1766         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
1767         <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li>        </ul>\r
1768     </div>\r
1769                 </div>\r
1770                         </div>\r
1771         </td>\r
1772         <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-show" href="output/Ext.Component.html#event-show">Component</a></td>\r
1773     </tr>\r
1774         <tr class="event-row inherited expandable">\r
1775         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1776         <td class="sig">\r
1777         <a id="Ext.BoxComponent-staterestore"></a>\r
1778             <b>staterestore</b> : (&nbsp;<code>Ext.Component this</code>, <code>Object state</code>&nbsp;)            <div class="mdesc">\r
1779                         <div class="short">Fires after the state of the component is restored.</div>\r
1780             <div class="long">\r
1781                 Fires after the state of the component is restored.    <div class="mdetail-params">\r
1782         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
1783         <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>state</code> : Object<div class="sub-desc">The hash of state values</div></li>        </ul>\r
1784     </div>\r
1785                 </div>\r
1786                         </div>\r
1787         </td>\r
1788         <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-staterestore" href="output/Ext.Component.html#event-staterestore">Component</a></td>\r
1789     </tr>\r
1790         <tr class="event-row inherited alt expandable">\r
1791         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1792         <td class="sig">\r
1793         <a id="Ext.BoxComponent-statesave"></a>\r
1794             <b>statesave</b> : (&nbsp;<code>Ext.Component this</code>, <code>Object state</code>&nbsp;)            <div class="mdesc">\r
1795                         <div class="short">Fires after the state of the component is saved to the configured state provider.</div>\r
1796             <div class="long">\r
1797                 Fires after the state of the component is saved to the configured state provider.    <div class="mdetail-params">\r
1798         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
1799         <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>state</code> : Object<div class="sub-desc">The hash of state values</div></li>        </ul>\r
1800     </div>\r
1801                 </div>\r
1802                         </div>\r
1803         </td>\r
1804         <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-statesave" href="output/Ext.Component.html#event-statesave">Component</a></td>\r
1805     </tr>\r
1806             </table>
1807
1808         </div>