commit extjs-2.2.1
[extjs.git] / docs / output / Ext.Component.html
1         <div class="body-wrap">
2         <div class="top-tools">
3             <a class="inner-link" href="#Ext.Component-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
4             <a class="inner-link" href="#Ext.Component-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
5             <a class="inner-link" href="#Ext.Component-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
6                             <a class="inner-link" href="#Ext.Component-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
7                         <a class="bookmark" href="../docs/?class=Ext.Component"><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"/>Component</pre></div>
12                 <h1>Class Ext.Component</h1>
13         <table cellspacing="0">
14             <tr><td class="label">Package:</td><td class="hd-info">Ext</td></tr>
15             <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/Component.js" target="_blank">Component.js</a></td></tr>
16             <tr><td class="label">Class:</td><td class="hd-info">Component</td></tr>
17                         <tr><td class="label">Subclasses:</td><td class="hd-info"><a ext:cls="Ext.BoxComponent" href="output/Ext.BoxComponent.html">BoxComponent</a>, <a ext:cls="Ext.Button" href="output/Ext.Button.html">Button</a>, <a ext:cls="Ext.ColorPalette" href="output/Ext.ColorPalette.html">ColorPalette</a>, <a ext:cls="Ext.DatePicker" href="output/Ext.DatePicker.html">DatePicker</a>, <a ext:cls="Ext.Editor" href="output/Ext.Editor.html">Editor</a>, <a ext:cls="Ext.menu.BaseItem" href="output/Ext.menu.BaseItem.html">BaseItem</a></td></tr>
18                                     <tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a></td></tr>
19                     </table>
20         <div class="description">
21             *
22 <p>Base class for all Ext components.  All subclasses of Component can automatically participate in the standard
23 Ext component lifecycle of creation, rendering and destruction.  They also have automatic support for basic hide/show
24 and enable/disable behavior.  Component allows any subclass to be lazy-rendered into any <a ext:cls="Ext.Container" href="output/Ext.Container.html">Ext.Container</a> and
25 to be automatically registered with the <a ext:cls="Ext.ComponentMgr" href="output/Ext.ComponentMgr.html">Ext.ComponentMgr</a> so that it can be referenced at any time via
26 <a ext:cls="Ext" ext:member="getCmp" href="output/Ext.html#getCmp">Ext.getCmp</a>.  All visual widgets that require rendering into a layout should subclass Component (or
27 <a ext:cls="Ext.BoxComponent" href="output/Ext.BoxComponent.html">Ext.BoxComponent</a> if managed box model handling is required).</p>
28 <p>Every component has a specific xtype, which is its Ext-specific type name, along with methods for checking the
29 xtype like <a ext:cls="Ext.Component" ext:member="getXType" href="output/Ext.Component.html#getXType">getXType</a> and <a ext:cls="Ext.Component" ext:member="isXType" href="output/Ext.Component.html#isXType">isXType</a>. This is the list of all valid xtypes:</p>
30 <pre>xtype            Class\r
31 -------------    ------------------\r
32 box              Ext.BoxComponent\r
33 button           Ext.Button\r
34 colorpalette     Ext.ColorPalette\r
35 component        Ext.Component\r
36 container        Ext.Container\r
37 cycle            Ext.CycleButton\r
38 dataview         Ext.DataView\r
39 datepicker       Ext.DatePicker\r
40 editor           Ext.Editor\r
41 editorgrid       Ext.grid.EditorGridPanel\r
42 grid             Ext.grid.GridPanel\r
43 paging           Ext.PagingToolbar\r
44 panel            Ext.Panel\r
45 progress         Ext.ProgressBar\r
46 propertygrid     Ext.grid.PropertyGrid\r
47 slider           Ext.Slider\r
48 splitbutton      Ext.SplitButton\r
49 statusbar        Ext.StatusBar\r
50 tabpanel         Ext.TabPanel\r
51 treepanel        Ext.tree.TreePanel\r
52 viewport         Ext.Viewport\r
53 window           Ext.Window\r
54 \r
55 Toolbar components\r
56 ---------------------------------------\r
57 toolbar          Ext.Toolbar\r
58 tbbutton         Ext.Toolbar.Button\r
59 tbfill           Ext.Toolbar.Fill\r
60 tbitem           Ext.Toolbar.Item\r
61 tbseparator      Ext.Toolbar.Separator\r
62 tbspacer         Ext.Toolbar.Spacer\r
63 tbsplit          Ext.Toolbar.SplitButton\r
64 tbtext           Ext.Toolbar.TextItem\r
65 \r
66 Form components\r
67 ---------------------------------------\r
68 form             Ext.FormPanel\r
69 checkbox         Ext.form.Checkbox\r
70 combo            Ext.form.ComboBox\r
71 datefield        Ext.form.DateField\r
72 field            Ext.form.Field\r
73 fieldset         Ext.form.FieldSet\r
74 hidden           Ext.form.Hidden\r
75 htmleditor       Ext.form.HtmlEditor\r
76 label            Ext.form.Label\r
77 numberfield      Ext.form.NumberField\r
78 radio            Ext.form.Radio\r
79 textarea         Ext.form.TextArea\r
80 textfield        Ext.form.TextField\r
81 timefield        Ext.form.TimeField\r
82 trigger          Ext.form.TriggerField</pre>        </div>
83         
84         <div class="hr"></div>
85                 <a id="Ext.Component-configs"></a>
86         <h2>Config Options</h2>
87         <table cellspacing="0" class="member-table">
88             <tr>
89                 <th class="sig-header" colspan="2">Config Options</th>
90                 <th class="msource-header">Defined By</th>
91             </tr>
92                 <tr class="config-row">\r
93         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
94         <td class="sig">\r
95         <a id="Ext.Component-allowDomMove"></a>\r
96             <b>allowDomMove</b> : Boolean            <div class="mdesc">\r
97                             Whether the component can move the Dom node when rendering (defaults to true).                        </div>\r
98         </td>\r
99         <td class="msource">Component</td>\r
100     </tr>\r
101         <tr class="config-row alt expandable">\r
102         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
103         <td class="sig">\r
104         <a id="Ext.Component-applyTo"></a>\r
105             <b>applyTo</b> : Mixed            <div class="mdesc">\r
106                         <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
107             <div class="long">\r
108                 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
109                         </div>\r
110         </td>\r
111         <td class="msource">Component</td>\r
112     </tr>\r
113         <tr class="config-row expandable">\r
114         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
115         <td class="sig">\r
116         <a id="Ext.Component-autoEl"></a>\r
117             <b>autoEl</b> : String/Object            <div class="mdesc">\r
118                         <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
119             <div class="long">\r
120                 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>}
121 {xtype:<em>'box'</em>, autoEl: {tag:<em>'blockquote'</em>, html:<em>'autoEl is cool!'</em>}} // <b>with</b> DomHelper</code></pre>            </div>\r
122                         </div>\r
123         </td>\r
124         <td class="msource">Component</td>\r
125     </tr>\r
126         <tr class="config-row alt expandable">\r
127         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
128         <td class="sig">\r
129         <a id="Ext.Component-autoShow"></a>\r
130             <b>autoShow</b> : Boolean            <div class="mdesc">\r
131                         <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
132             <div class="long">\r
133                 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
134                         </div>\r
135         </td>\r
136         <td class="msource">Component</td>\r
137     </tr>\r
138         <tr class="config-row expandable">\r
139         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
140         <td class="sig">\r
141         <a id="Ext.Component-clearCls"></a>\r
142             <b>clearCls</b> : String            <div class="mdesc">\r
143                         <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
144             <div class="long">\r
145                 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
146                         </div>\r
147         </td>\r
148         <td class="msource">Component</td>\r
149     </tr>\r
150         <tr class="config-row alt expandable">\r
151         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
152         <td class="sig">\r
153         <a id="Ext.Component-cls"></a>\r
154             <b>cls</b> : String            <div class="mdesc">\r
155                         <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
156             <div class="long">\r
157                 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
158                         </div>\r
159         </td>\r
160         <td class="msource">Component</td>\r
161     </tr>\r
162         <tr class="config-row expandable">\r
163         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
164         <td class="sig">\r
165         <a id="Ext.Component-ctCls"></a>\r
166             <b>ctCls</b> : String            <div class="mdesc">\r
167                         <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
168             <div class="long">\r
169                 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
170                         </div>\r
171         </td>\r
172         <td class="msource">Component</td>\r
173     </tr>\r
174         <tr class="config-row alt">\r
175         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
176         <td class="sig">\r
177         <a id="Ext.Component-disabled"></a>\r
178             <b>disabled</b> : Boolean            <div class="mdesc">\r
179                             Render this component disabled (default is false).                        </div>\r
180         </td>\r
181         <td class="msource">Component</td>\r
182     </tr>\r
183         <tr class="config-row">\r
184         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
185         <td class="sig">\r
186         <a id="Ext.Component-disabledClass"></a>\r
187             <b>disabledClass</b> : String            <div class="mdesc">\r
188                             CSS class added to the component when it is disabled (defaults to "x-item-disabled").                        </div>\r
189         </td>\r
190         <td class="msource">Component</td>\r
191     </tr>\r
192         <tr class="config-row alt expandable">\r
193         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
194         <td class="sig">\r
195         <a id="Ext.Component-fieldLabel"></a>\r
196             <b>fieldLabel</b> : String            <div class="mdesc">\r
197                         <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
198             <div class="long">\r
199                 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({
200     height: 100,
201     renderTo: Ext.getBody(),
202     items: [{
203         xtype: <em>'textfield'</em>,
204         fieldLabel: <em>'Name'</em>
205     }]
206 });</code></pre>            </div>\r
207                         </div>\r
208         </td>\r
209         <td class="msource">Component</td>\r
210     </tr>\r
211         <tr class="config-row">\r
212         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
213         <td class="sig">\r
214         <a id="Ext.Component-hidden"></a>\r
215             <b>hidden</b> : Boolean            <div class="mdesc">\r
216                             Render this component hidden (default is false).                        </div>\r
217         </td>\r
218         <td class="msource">Component</td>\r
219     </tr>\r
220         <tr class="config-row alt expandable">\r
221         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
222         <td class="sig">\r
223         <a id="Ext.Component-hideLabel"></a>\r
224             <b>hideLabel</b> : Boolean            <div class="mdesc">\r
225                         <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
226             <div class="long">\r
227                 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({
228     height: 100,
229     renderTo: Ext.getBody(),
230     items: [{
231         xtype: <em>'textfield'</em>
232         hideLabel: true
233     }]
234 });</code></pre>            </div>\r
235                         </div>\r
236         </td>\r
237         <td class="msource">Component</td>\r
238     </tr>\r
239         <tr class="config-row expandable">\r
240         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
241         <td class="sig">\r
242         <a id="Ext.Component-hideMode"></a>\r
243             <b>hideMode</b> : String            <div class="mdesc">\r
244                         <div class="short">How this component should be hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset p...</div>\r
245             <div class="long">\r
246                 <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
247                         </div>\r
248         </td>\r
249         <td class="msource">Component</td>\r
250     </tr>\r
251         <tr class="config-row alt expandable">\r
252         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
253         <td class="sig">\r
254         <a id="Ext.Component-hideParent"></a>\r
255             <b>hideParent</b> : Boolean            <div class="mdesc">\r
256                         <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
257             <div class="long">\r
258                 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
259                         </div>\r
260         </td>\r
261         <td class="msource">Component</td>\r
262     </tr>\r
263         <tr class="config-row expandable">\r
264         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
265         <td class="sig">\r
266         <a id="Ext.Component-id"></a>\r
267             <b>id</b> : String            <div class="mdesc">\r
268                         <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
269             <div class="long">\r
270                 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
271                         </div>\r
272         </td>\r
273         <td class="msource">Component</td>\r
274     </tr>\r
275         <tr class="config-row alt expandable">\r
276         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
277         <td class="sig">\r
278         <a id="Ext.Component-itemCls"></a>\r
279             <b>itemCls</b> : String            <div class="mdesc">\r
280                         <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
281             <div class="long">\r
282                 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>
283 &lt;style>
284     .required .x-form-item-label {font-weight:bold;color:red;}
285 &lt;/style>
286
287 <b>new</b> Ext.FormPanel({
288     height: 100,
289     renderTo: Ext.getBody(),
290     items: [{
291         xtype: <em>'textfield'</em>,
292         fieldLabel: <em>'Name'</em>,
293         itemCls: <em>'required'</em> <i>//<b>this</b> label will be styled</i>
294     },{
295         xtype: <em>'textfield'</em>,
296         fieldLabel: <em>'Favorite Color'</em>
297     }]
298 });</code></pre>            </div>\r
299                         </div>\r
300         </td>\r
301         <td class="msource">Component</td>\r
302     </tr>\r
303         <tr class="config-row expandable">\r
304         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
305         <td class="sig">\r
306         <a id="Ext.Component-labelSeparator"></a>\r
307             <b>labelSeparator</b> : String            <div class="mdesc">\r
308                         <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
309             <div class="long">\r
310                 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({
311     height: 100,
312     renderTo: Ext.getBody(),
313     items: [{
314         xtype: <em>'textfield'</em>,
315         fieldLabel: <em>'Name'</em>,
316         labelSeparator: <em>'...'</em>
317     }]
318 });</code></pre>            </div>\r
319                         </div>\r
320         </td>\r
321         <td class="msource">Component</td>\r
322     </tr>\r
323         <tr class="config-row alt expandable">\r
324         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
325         <td class="sig">\r
326         <a id="Ext.Component-labelStyle"></a>\r
327             <b>labelStyle</b> : String            <div class="mdesc">\r
328                         <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
329             <div class="long">\r
330                 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({
331     height: 100,
332     renderTo: Ext.getBody(),
333     items: [{
334         xtype: <em>'textfield'</em>,
335         fieldLabel: <em>'Name'</em>,
336         labelStyle: <em>'font-weight:bold;'</em>
337     }]
338 });</code></pre>            </div>\r
339                         </div>\r
340         </td>\r
341         <td class="msource">Component</td>\r
342     </tr>\r
343         <tr class="config-row inherited expandable">\r
344         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
345         <td class="sig">\r
346         <a id="Ext.Component-listeners"></a>\r
347             <b>listeners</b> : Object            <div class="mdesc">\r
348                         <div class="short">(optional) A config object containing one or more event handlers to be added to this object during initialization. Th...</div>\r
349             <div class="long">\r
350                 (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
351                         </div>\r
352         </td>\r
353         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td>\r
354     </tr>\r
355         <tr class="config-row alt expandable">\r
356         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
357         <td class="sig">\r
358         <a id="Ext.Component-overCls"></a>\r
359             <b>overCls</b> : String            <div class="mdesc">\r
360                         <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
361             <div class="long">\r
362                 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
363                         </div>\r
364         </td>\r
365         <td class="msource">Component</td>\r
366     </tr>\r
367         <tr class="config-row expandable">\r
368         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
369         <td class="sig">\r
370         <a id="Ext.Component-plugins"></a>\r
371             <b>plugins</b> : Object/Array            <div class="mdesc">\r
372                         <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
373             <div class="long">\r
374                 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
375                         </div>\r
376         </td>\r
377         <td class="msource">Component</td>\r
378     </tr>\r
379         <tr class="config-row alt expandable">\r
380         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
381         <td class="sig">\r
382         <a id="Ext.Component-renderTo"></a>\r
383             <b>renderTo</b> : Mixed            <div class="mdesc">\r
384                         <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
385             <div class="long">\r
386                 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
387                         </div>\r
388         </td>\r
389         <td class="msource">Component</td>\r
390     </tr>\r
391         <tr class="config-row expandable">\r
392         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
393         <td class="sig">\r
394         <a id="Ext.Component-stateEvents"></a>\r
395             <b>stateEvents</b> : Array            <div class="mdesc">\r
396                         <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
397             <div class="long">\r
398                 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
399                         </div>\r
400         </td>\r
401         <td class="msource">Component</td>\r
402     </tr>\r
403         <tr class="config-row alt expandable">\r
404         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
405         <td class="sig">\r
406         <a id="Ext.Component-stateId"></a>\r
407             <b>stateId</b> : String            <div class="mdesc">\r
408                         <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
409             <div class="long">\r
410                 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
411                         </div>\r
412         </td>\r
413         <td class="msource">Component</td>\r
414     </tr>\r
415         <tr class="config-row expandable">\r
416         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
417         <td class="sig">\r
418         <a id="Ext.Component-stateful"></a>\r
419             <b>stateful</b> : Boolean            <div class="mdesc">\r
420                         <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
421             <div class="long">\r
422                 <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
423                         </div>\r
424         </td>\r
425         <td class="msource">Component</td>\r
426     </tr>\r
427         <tr class="config-row alt expandable">\r
428         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
429         <td class="sig">\r
430         <a id="Ext.Component-style"></a>\r
431             <b>style</b> : String            <div class="mdesc">\r
432                         <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
433             <div class="long">\r
434                 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
435                         </div>\r
436         </td>\r
437         <td class="msource">Component</td>\r
438     </tr>\r
439         <tr class="config-row expandable">\r
440         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
441         <td class="sig">\r
442         <a id="Ext.Component-xtype"></a>\r
443             <b>xtype</b> : String            <div class="mdesc">\r
444                         <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
445             <div class="long">\r
446                 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
447                         </div>\r
448         </td>\r
449         <td class="msource">Component</td>\r
450     </tr>\r
451             </table>
452                 <a id="Ext.Component-props"></a>
453         <h2>Public Properties</h2>
454                 <table cellspacing="0" class="member-table">
455             <tr>
456                 <th class="sig-header" colspan="2">Property</th>
457                 <th class="msource-header">Defined By</th>
458             </tr>
459                 <tr class="property-row">\r
460         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
461         <td class="sig">\r
462         <a id="Ext.Component-disabled"></a>\r
463             <b>disabled</b> : Boolean            <div class="mdesc">\r
464                             True if this component is disabled. Read-only.                        </div>\r
465         </td>\r
466         <td class="msource">Component</td>\r
467     </tr>\r
468         <tr class="property-row alt">\r
469         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
470         <td class="sig">\r
471         <a id="Ext.Component-hidden"></a>\r
472             <b>hidden</b> : Boolean            <div class="mdesc">\r
473                             
474 True if this component is hidden. Read-only.                        </div>\r
475         </td>\r
476         <td class="msource">Component</td>\r
477     </tr>\r
478         <tr class="property-row">\r
479         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
480         <td class="sig">\r
481         <a id="Ext.Component-initialConfig"></a>\r
482             <b>initialConfig</b> : Object            <div class="mdesc">\r
483                             This Component's initial configuration specification. Read-only.                        </div>\r
484         </td>\r
485         <td class="msource">Component</td>\r
486     </tr>\r
487         <tr class="property-row alt expandable">\r
488         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
489         <td class="sig">\r
490         <a id="Ext.Component-ownerCt"></a>\r
491             <b>ownerCt</b> : Ext.Container            <div class="mdesc">\r
492                         <div class="short">The component's owner Ext.Container (defaults to undefined, and is set automatically when
493 the component is added to a...</div>\r
494             <div class="long">\r
495                 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
496 the component is added to a container).  Read-only.            </div>\r
497                         </div>\r
498         </td>\r
499         <td class="msource">Component</td>\r
500     </tr>\r
501         <tr class="property-row">\r
502         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
503         <td class="sig">\r
504         <a id="Ext.Component-rendered"></a>\r
505             <b>rendered</b> : Boolean            <div class="mdesc">\r
506                             True if this component has been rendered. Read-only.                        </div>\r
507         </td>\r
508         <td class="msource">Component</td>\r
509     </tr>\r
510             </table>
511                 <a id="Ext.Component-methods"></a>
512         <h2>Public Methods</h2>
513                 <table cellspacing="0" class="member-table">
514             <tr>
515                 <th class="sig-header" colspan="2">Method</th>
516                 <th class="msource-header">Defined By</th>
517             </tr>
518                 <tr class="method-row expandable">\r
519         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
520         <td class="sig">\r
521         <a id="Ext.Component-Component"></a>\r
522             <b>Component</b>(&nbsp;<code>Ext.Element/String/Object config</code>&nbsp;)            <div class="mdesc">\r
523                         <div class="short"></div>\r
524             <div class="long">\r
525                     <div class="mdetail-params">\r
526         <strong>Parameters:</strong>\r
527         <ul><li><code>config</code> : Ext.Element/String/Object<div class="sub-desc">The configuration options. If an element is passed, it is set as the internal
528 element and its id used as the component id. If a string is passed, it is assumed to be the id of an existing element
529 and is used as the component id. Otherwise, it is assumed to be a standard config object and is applied to the component.</div></li>        </ul>\r
530         <strong>Returns:</strong>\r
531         <ul>\r
532             <li><code></code></li>\r
533         </ul>\r
534     </div>\r
535                 </div>\r
536                         </div>\r
537         </td>\r
538         <td class="msource">Component</td>\r
539     </tr>\r
540         <tr class="method-row alt expandable">\r
541         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
542         <td class="sig">\r
543         <a id="Ext.Component-addClass"></a>\r
544             <b>addClass</b>(&nbsp;<code>string cls</code>&nbsp;) : void            <div class="mdesc">\r
545                         <div class="short">Adds a CSS class to the component's underlying element.</div>\r
546             <div class="long">\r
547                 Adds a CSS class to the component's underlying element.    <div class="mdetail-params">\r
548         <strong>Parameters:</strong>\r
549         <ul><li><code>cls</code> : string<div class="sub-desc">The CSS class name to add</div></li>        </ul>\r
550         <strong>Returns:</strong>\r
551         <ul>\r
552             <li><code>void</code></li>\r
553         </ul>\r
554     </div>\r
555                 </div>\r
556                         </div>\r
557         </td>\r
558         <td class="msource">Component</td>\r
559     </tr>\r
560         <tr class="method-row inherited expandable">\r
561         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
562         <td class="sig">\r
563         <a id="Ext.Component-addEvents"></a>\r
564             <b>addEvents</b>(&nbsp;<code>Object object</code>&nbsp;) : void            <div class="mdesc">\r
565                         <div class="short">Used to define events on this Observable</div>\r
566             <div class="long">\r
567                 Used to define events on this Observable    <div class="mdetail-params">\r
568         <strong>Parameters:</strong>\r
569         <ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li>        </ul>\r
570         <strong>Returns:</strong>\r
571         <ul>\r
572             <li><code>void</code></li>\r
573         </ul>\r
574     </div>\r
575                 </div>\r
576                         </div>\r
577         </td>\r
578         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td>\r
579     </tr>\r
580         <tr class="method-row inherited alt expandable">\r
581         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
582         <td class="sig">\r
583         <a id="Ext.Component-addListener"></a>\r
584             <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
585                         <div class="short">Appends an event handler to this component</div>\r
586             <div class="long">\r
587                 Appends an event handler to this component    <div class="mdetail-params">\r
588         <strong>Parameters:</strong>\r
589         <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
590 function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration
591 properties. This may contain any of the following properties:<ul>
592 <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>
593 <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>
594 <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>
595 <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
596 by the specified number of milliseconds. If the event fires again within that time, the original
597 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</p></li>
598 </ul><br>
599 <p>
600 <b>Combining Options</b><br>
601 Using the options argument, it is possible to combine different types of listeners:<br>
602 <br>
603 A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
604 <pre><code>el.on(<em>'click'</em>, <b>this</b>.onClick, <b>this</b>, {
605     single: true,
606     delay: 100,
607     forumId: 4
608 });</code></pre>
609 <p>
610 <b>Attaching multiple handlers in 1 call</b><br>
611 The method also allows for a single argument to be passed which is a config object containing properties
612 which specify multiple handlers.
613 <p>
614 <pre><code>foo.on({
615     <em>'click'</em> : {
616         fn: <b>this</b>.onClick,
617         scope: <b>this</b>,
618         delay: 100
619     },
620     <em>'mouseover'</em> : {
621         fn: <b>this</b>.onMouseOver,
622         scope: <b>this</b>
623     },
624     <em>'mouseout'</em> : {
625         fn: <b>this</b>.onMouseOut,
626         scope: <b>this</b>
627     }
628 });</code></pre>
629 <p>
630 Or a shorthand syntax:<br>
631 <pre><code>foo.on({
632     <em>'click'</em> : <b>this</b>.onClick,
633     <em>'mouseover'</em> : <b>this</b>.onMouseOver,
634     <em>'mouseout'</em> : <b>this</b>.onMouseOut,
635      scope: <b>this</b>
636 });</code></pre></div></li>        </ul>\r
637         <strong>Returns:</strong>\r
638         <ul>\r
639             <li><code>void</code></li>\r
640         </ul>\r
641     </div>\r
642                 </div>\r
643                         </div>\r
644         </td>\r
645         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td>\r
646     </tr>\r
647         <tr class="method-row expandable">\r
648         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
649         <td class="sig">\r
650         <a id="Ext.Component-applyToMarkup"></a>\r
651             <b>applyToMarkup</b>(&nbsp;<code>String/HTMLElement el</code>&nbsp;) : void            <div class="mdesc">\r
652                         <div class="short">Apply this component to existing markup that is valid. With this function, no call to render() is required.</div>\r
653             <div class="long">\r
654                 Apply this component to existing markup that is valid. With this function, no call to render() is required.    <div class="mdetail-params">\r
655         <strong>Parameters:</strong>\r
656         <ul><li><code>el</code> : String/HTMLElement<div class="sub-desc"></div></li>        </ul>\r
657         <strong>Returns:</strong>\r
658         <ul>\r
659             <li><code>void</code></li>\r
660         </ul>\r
661     </div>\r
662                 </div>\r
663                         </div>\r
664         </td>\r
665         <td class="msource">Component</td>\r
666     </tr>\r
667         <tr class="method-row alt expandable">\r
668         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
669         <td class="sig">\r
670         <a id="Ext.Component-cloneConfig"></a>\r
671             <b>cloneConfig</b>(&nbsp;<code>Object overrides</code>&nbsp;) : Ext.Component            <div class="mdesc">\r
672                         <div class="short">Clone the current component using the original config values passed into this instance by default.</div>\r
673             <div class="long">\r
674                 Clone the current component using the original config values passed into this instance by default.    <div class="mdetail-params">\r
675         <strong>Parameters:</strong>\r
676         <ul><li><code>overrides</code> : Object<div class="sub-desc">A new config containing any properties to override in the cloned version.
677 An id property can be passed on this object, otherwise one will be generated to avoid duplicates.</div></li>        </ul>\r
678         <strong>Returns:</strong>\r
679         <ul>\r
680             <li><code>Ext.Component</code><div class="sub-desc">clone The cloned copy of this component</div></li>\r
681         </ul>\r
682     </div>\r
683                 </div>\r
684                         </div>\r
685         </td>\r
686         <td class="msource">Component</td>\r
687     </tr>\r
688         <tr class="method-row expandable">\r
689         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
690         <td class="sig">\r
691         <a id="Ext.Component-destroy"></a>\r
692             <b>destroy</b>() : void            <div class="mdesc">\r
693                         <div class="short">Destroys this component by purging any event listeners, removing the component's element from the DOM,
694 removing the c...</div>\r
695             <div class="long">\r
696                 Destroys this component by purging any event listeners, removing the component's element from the DOM,
697 removing the component from its <a ext:cls="Ext.Container" href="output/Ext.Container.html">Ext.Container</a> (if applicable) and unregistering it from
698 <a ext:cls="Ext.ComponentMgr" href="output/Ext.ComponentMgr.html">Ext.ComponentMgr</a>.  Destruction is generally handled automatically by the framework and this method
699 should usually not need to be called directly.    <div class="mdetail-params">\r
700         <strong>Parameters:</strong>\r
701         <ul><li>None.</li>        </ul>\r
702         <strong>Returns:</strong>\r
703         <ul>\r
704             <li><code>void</code></li>\r
705         </ul>\r
706     </div>\r
707                 </div>\r
708                         </div>\r
709         </td>\r
710         <td class="msource">Component</td>\r
711     </tr>\r
712         <tr class="method-row alt expandable">\r
713         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
714         <td class="sig">\r
715         <a id="Ext.Component-disable"></a>\r
716             <b>disable</b>() : Ext.Component            <div class="mdesc">\r
717                         <div class="short">Disable this component.</div>\r
718             <div class="long">\r
719                 Disable this component.    <div class="mdetail-params">\r
720         <strong>Parameters:</strong>\r
721         <ul><li>None.</li>        </ul>\r
722         <strong>Returns:</strong>\r
723         <ul>\r
724             <li><code>Ext.Component</code><div class="sub-desc">this</div></li>\r
725         </ul>\r
726     </div>\r
727                 </div>\r
728                         </div>\r
729         </td>\r
730         <td class="msource">Component</td>\r
731     </tr>\r
732         <tr class="method-row expandable">\r
733         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
734         <td class="sig">\r
735         <a id="Ext.Component-enable"></a>\r
736             <b>enable</b>() : Ext.Component            <div class="mdesc">\r
737                         <div class="short">Enable this component.</div>\r
738             <div class="long">\r
739                 Enable this component.    <div class="mdetail-params">\r
740         <strong>Parameters:</strong>\r
741         <ul><li>None.</li>        </ul>\r
742         <strong>Returns:</strong>\r
743         <ul>\r
744             <li><code>Ext.Component</code><div class="sub-desc">this</div></li>\r
745         </ul>\r
746     </div>\r
747                 </div>\r
748                         </div>\r
749         </td>\r
750         <td class="msource">Component</td>\r
751     </tr>\r
752         <tr class="method-row alt expandable">\r
753         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
754         <td class="sig">\r
755         <a id="Ext.Component-findParentBy"></a>\r
756             <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
757                         <div class="short">Find a container above this component at any level by a custom function. If the passed function returns
758 true, the con...</div>\r
759             <div class="long">\r
760                 Find a container above this component at any level by a custom function. If the passed function returns
761 true, the container will be returned. The passed function is called with the arguments (container, this component).    <div class="mdetail-params">\r
762         <strong>Parameters:</strong>\r
763         <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
764         <strong>Returns:</strong>\r
765         <ul>\r
766             <li><code>Ext.Container</code><div class="sub-desc">The first Container for which the custom function returns true</div></li>\r
767         </ul>\r
768     </div>\r
769                 </div>\r
770                         </div>\r
771         </td>\r
772         <td class="msource">Component</td>\r
773     </tr>\r
774         <tr class="method-row expandable">\r
775         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
776         <td class="sig">\r
777         <a id="Ext.Component-findParentByType"></a>\r
778             <b>findParentByType</b>(&nbsp;<code>String/Class xtype</code>&nbsp;) : Ext.Container            <div class="mdesc">\r
779                         <div class="short">Find a container above this component at any level by xtype or class</div>\r
780             <div class="long">\r
781                 Find a container above this component at any level by xtype or class    <div class="mdetail-params">\r
782         <strong>Parameters:</strong>\r
783         <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
784         <strong>Returns:</strong>\r
785         <ul>\r
786             <li><code>Ext.Container</code><div class="sub-desc">The first Container which matches the given xtype or class</div></li>\r
787         </ul>\r
788     </div>\r
789                 </div>\r
790                         </div>\r
791         </td>\r
792         <td class="msource">Component</td>\r
793     </tr>\r
794         <tr class="method-row inherited alt expandable">\r
795         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
796         <td class="sig">\r
797         <a id="Ext.Component-fireEvent"></a>\r
798             <b>fireEvent</b>(&nbsp;<code>String eventName</code>, <code>Object... args</code>&nbsp;) : Boolean            <div class="mdesc">\r
799                         <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>\r
800             <div class="long">\r
801                 Fires the specified event with the passed parameters (minus the event name).    <div class="mdetail-params">\r
802         <strong>Parameters:</strong>\r
803         <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
804         <strong>Returns:</strong>\r
805         <ul>\r
806             <li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li>\r
807         </ul>\r
808     </div>\r
809                 </div>\r
810                         </div>\r
811         </td>\r
812         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td>\r
813     </tr>\r
814         <tr class="method-row expandable">\r
815         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
816         <td class="sig">\r
817         <a id="Ext.Component-focus"></a>\r
818             <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
819                         <div class="short">Try to focus this component.</div>\r
820             <div class="long">\r
821                 Try to focus this component.    <div class="mdetail-params">\r
822         <strong>Parameters:</strong>\r
823         <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
824         <strong>Returns:</strong>\r
825         <ul>\r
826             <li><code>Ext.Component</code><div class="sub-desc">this</div></li>\r
827         </ul>\r
828     </div>\r
829                 </div>\r
830                         </div>\r
831         </td>\r
832         <td class="msource">Component</td>\r
833     </tr>\r
834         <tr class="method-row alt expandable">\r
835         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
836         <td class="sig">\r
837         <a id="Ext.Component-getEl"></a>\r
838             <b>getEl</b>() : Ext.Element            <div class="mdesc">\r
839                         <div class="short">Returns the underlying <a ext:cls="Ext.Element" href="output/Ext.Element.html">Ext.Element</a>.</div>\r
840             <div class="long">\r
841                 Returns the underlying <a ext:cls="Ext.Element" href="output/Ext.Element.html">Ext.Element</a>.    <div class="mdetail-params">\r
842         <strong>Parameters:</strong>\r
843         <ul><li>None.</li>        </ul>\r
844         <strong>Returns:</strong>\r
845         <ul>\r
846             <li><code>Ext.Element</code><div class="sub-desc">The element</div></li>\r
847         </ul>\r
848     </div>\r
849                 </div>\r
850                         </div>\r
851         </td>\r
852         <td class="msource">Component</td>\r
853     </tr>\r
854         <tr class="method-row expandable">\r
855         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
856         <td class="sig">\r
857         <a id="Ext.Component-getId"></a>\r
858             <b>getId</b>() : String            <div class="mdesc">\r
859                         <div class="short">Returns the id of this component.</div>\r
860             <div class="long">\r
861                 Returns the id of this component.    <div class="mdetail-params">\r
862         <strong>Parameters:</strong>\r
863         <ul><li>None.</li>        </ul>\r
864         <strong>Returns:</strong>\r
865         <ul>\r
866             <li><code>String</code></li>\r
867         </ul>\r
868     </div>\r
869                 </div>\r
870                         </div>\r
871         </td>\r
872         <td class="msource">Component</td>\r
873     </tr>\r
874         <tr class="method-row alt expandable">\r
875         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
876         <td class="sig">\r
877         <a id="Ext.Component-getItemId"></a>\r
878             <b>getItemId</b>() : String            <div class="mdesc">\r
879                         <div class="short">Returns the item id of this component.</div>\r
880             <div class="long">\r
881                 Returns the item id of this component.    <div class="mdetail-params">\r
882         <strong>Parameters:</strong>\r
883         <ul><li>None.</li>        </ul>\r
884         <strong>Returns:</strong>\r
885         <ul>\r
886             <li><code>String</code></li>\r
887         </ul>\r
888     </div>\r
889                 </div>\r
890                         </div>\r
891         </td>\r
892         <td class="msource">Component</td>\r
893     </tr>\r
894         <tr class="method-row expandable">\r
895         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
896         <td class="sig">\r
897         <a id="Ext.Component-getXType"></a>\r
898             <b>getXType</b>() : String            <div class="mdesc">\r
899                         <div class="short">Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
900 available xtypes, see the Ex...</div>\r
901             <div class="long">\r
902                 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
903 available xtypes, see the <a ext:cls="Ext.Component" href="output/Ext.Component.html">Ext.Component</a> header. Example usage:
904 <pre><code>var t = <b>new</b> Ext.form.TextField();
905 alert(t.getXType());  // alerts <em>'textfield'</em></code></pre>    <div class="mdetail-params">\r
906         <strong>Parameters:</strong>\r
907         <ul><li>None.</li>        </ul>\r
908         <strong>Returns:</strong>\r
909         <ul>\r
910             <li><code>String</code><div class="sub-desc">The xtype</div></li>\r
911         </ul>\r
912     </div>\r
913                 </div>\r
914                         </div>\r
915         </td>\r
916         <td class="msource">Component</td>\r
917     </tr>\r
918         <tr class="method-row alt expandable">\r
919         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
920         <td class="sig">\r
921         <a id="Ext.Component-getXTypes"></a>\r
922             <b>getXTypes</b>() : String            <div class="mdesc">\r
923                         <div class="short">Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all
924 available xtypes, see the Ext...</div>\r
925             <div class="long">\r
926                 <p>Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all
927 available xtypes, see the <a ext:cls="Ext.Component" href="output/Ext.Component.html">Ext.Component</a> header.</p>
928 <p><b>If using your own subclasses, be aware that a Component must register its own xtype
929 to participate in determination of inherited xtypes.</b></p>
930 <p>Example usage:</p>
931 <pre><code>\r
932 var t = new Ext.form.TextField();\r
933 alert(t.getXTypes());  // alerts 'component/box/field/textfield'</pre></code>    <div class="mdetail-params">\r
934         <strong>Parameters:</strong>\r
935         <ul><li>None.</li>        </ul>\r
936         <strong>Returns:</strong>\r
937         <ul>\r
938             <li><code>String</code><div class="sub-desc">The xtype hierarchy string</div></li>\r
939         </ul>\r
940     </div>\r
941                 </div>\r
942                         </div>\r
943         </td>\r
944         <td class="msource">Component</td>\r
945     </tr>\r
946         <tr class="method-row inherited expandable">\r
947         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
948         <td class="sig">\r
949         <a id="Ext.Component-hasListener"></a>\r
950             <b>hasListener</b>(&nbsp;<code>String eventName</code>&nbsp;) : Boolean            <div class="mdesc">\r
951                         <div class="short">Checks to see if this object has any listeners for a specified event</div>\r
952             <div class="long">\r
953                 Checks to see if this object has any listeners for a specified event    <div class="mdetail-params">\r
954         <strong>Parameters:</strong>\r
955         <ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li>        </ul>\r
956         <strong>Returns:</strong>\r
957         <ul>\r
958             <li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li>\r
959         </ul>\r
960     </div>\r
961                 </div>\r
962                         </div>\r
963         </td>\r
964         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td>\r
965     </tr>\r
966         <tr class="method-row alt expandable">\r
967         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
968         <td class="sig">\r
969         <a id="Ext.Component-hide"></a>\r
970             <b>hide</b>() : Ext.Component            <div class="mdesc">\r
971                         <div class="short">Hide this component.</div>\r
972             <div class="long">\r
973                 Hide this component.    <div class="mdetail-params">\r
974         <strong>Parameters:</strong>\r
975         <ul><li>None.</li>        </ul>\r
976         <strong>Returns:</strong>\r
977         <ul>\r
978             <li><code>Ext.Component</code><div class="sub-desc">this</div></li>\r
979         </ul>\r
980     </div>\r
981                 </div>\r
982                         </div>\r
983         </td>\r
984         <td class="msource">Component</td>\r
985     </tr>\r
986         <tr class="method-row expandable">\r
987         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
988         <td class="sig">\r
989         <a id="Ext.Component-isVisible"></a>\r
990             <b>isVisible</b>() : void            <div class="mdesc">\r
991                         <div class="short">Returns true if this component is visible.</div>\r
992             <div class="long">\r
993                 Returns true if this component is visible.    <div class="mdetail-params">\r
994         <strong>Parameters:</strong>\r
995         <ul><li>None.</li>        </ul>\r
996         <strong>Returns:</strong>\r
997         <ul>\r
998             <li><code>void</code></li>\r
999         </ul>\r
1000     </div>\r
1001                 </div>\r
1002                         </div>\r
1003         </td>\r
1004         <td class="msource">Component</td>\r
1005     </tr>\r
1006         <tr class="method-row alt expandable">\r
1007         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1008         <td class="sig">\r
1009         <a id="Ext.Component-isXType"></a>\r
1010             <b>isXType</b>(&nbsp;<code>String xtype</code>, <span class="optional" title="Optional">[<code>Boolean shallow</code>]</span>&nbsp;) : void            <div class="mdesc">\r
1011                         <div class="short">Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended
1012 from th...</div>\r
1013             <div class="long">\r
1014                 <p>Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended
1015 from the xtype (default) or whether it is directly of the xtype specified (shallow = true).</p>
1016 <p><b>If using your own subclasses, be aware that a Component must register its own xtype
1017 to participate in determination of inherited xtypes.</b></p>
1018 <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>
1019 <p>Example usage:</p>
1020 <pre><code>var t = <b>new</b> Ext.form.TextField();
1021 <b>var</b> isText = t.isXType(<em>'textfield'</em>);        <i>// true</i>
1022 <b>var</b> isBoxSubclass = t.isXType(<em>'box'</em>);       <i>// true, descended from BoxComponent</i>
1023 <b>var</b> isBoxInstance = t.isXType(<em>'box'</em>, true); // false, not a direct BoxComponent instance</code></pre>    <div class="mdetail-params">\r
1024         <strong>Parameters:</strong>\r
1025         <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
1026 the default), or true to check whether this Component is directly of the specified xtype.</div></li>        </ul>\r
1027         <strong>Returns:</strong>\r
1028         <ul>\r
1029             <li><code>void</code></li>\r
1030         </ul>\r
1031     </div>\r
1032                 </div>\r
1033                         </div>\r
1034         </td>\r
1035         <td class="msource">Component</td>\r
1036     </tr>\r
1037         <tr class="method-row inherited expandable">\r
1038         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1039         <td class="sig">\r
1040         <a id="Ext.Component-on"></a>\r
1041             <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
1042                         <div class="short">Appends an event handler to this element (shorthand for addListener)</div>\r
1043             <div class="long">\r
1044                 Appends an event handler to this element (shorthand for addListener)    <div class="mdetail-params">\r
1045         <strong>Parameters:</strong>\r
1046         <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
1047 function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li>        </ul>\r
1048         <strong>Returns:</strong>\r
1049         <ul>\r
1050             <li><code>void</code></li>\r
1051         </ul>\r
1052     </div>\r
1053                 </div>\r
1054                         </div>\r
1055         </td>\r
1056         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td>\r
1057     </tr>\r
1058         <tr class="method-row inherited alt expandable">\r
1059         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1060         <td class="sig">\r
1061         <a id="Ext.Component-purgeListeners"></a>\r
1062             <b>purgeListeners</b>() : void            <div class="mdesc">\r
1063                         <div class="short">Removes all listeners for this object</div>\r
1064             <div class="long">\r
1065                 Removes all listeners for this object    <div class="mdetail-params">\r
1066         <strong>Parameters:</strong>\r
1067         <ul><li>None.</li>        </ul>\r
1068         <strong>Returns:</strong>\r
1069         <ul>\r
1070             <li><code>void</code></li>\r
1071         </ul>\r
1072     </div>\r
1073                 </div>\r
1074                         </div>\r
1075         </td>\r
1076         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td>\r
1077     </tr>\r
1078         <tr class="method-row inherited expandable">\r
1079         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1080         <td class="sig">\r
1081         <a id="Ext.Component-relayEvents"></a>\r
1082             <b>relayEvents</b>(&nbsp;<code>Object o</code>, <code>Array events</code>&nbsp;) : void            <div class="mdesc">\r
1083                         <div class="short">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.</div>\r
1084             <div class="long">\r
1085                 Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.    <div class="mdetail-params">\r
1086         <strong>Parameters:</strong>\r
1087         <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
1088         <strong>Returns:</strong>\r
1089         <ul>\r
1090             <li><code>void</code></li>\r
1091         </ul>\r
1092     </div>\r
1093                 </div>\r
1094                         </div>\r
1095         </td>\r
1096         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#relayEvents" href="output/Ext.util.Observable.html#relayEvents">Observable</a></td>\r
1097     </tr>\r
1098         <tr class="method-row alt expandable">\r
1099         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1100         <td class="sig">\r
1101         <a id="Ext.Component-removeClass"></a>\r
1102             <b>removeClass</b>(&nbsp;<code>string cls</code>&nbsp;) : void            <div class="mdesc">\r
1103                         <div class="short">Removes a CSS class from the component's underlying element.</div>\r
1104             <div class="long">\r
1105                 Removes a CSS class from the component's underlying element.    <div class="mdetail-params">\r
1106         <strong>Parameters:</strong>\r
1107         <ul><li><code>cls</code> : string<div class="sub-desc">The CSS class name to remove</div></li>        </ul>\r
1108         <strong>Returns:</strong>\r
1109         <ul>\r
1110             <li><code>void</code></li>\r
1111         </ul>\r
1112     </div>\r
1113                 </div>\r
1114                         </div>\r
1115         </td>\r
1116         <td class="msource">Component</td>\r
1117     </tr>\r
1118         <tr class="method-row inherited expandable">\r
1119         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1120         <td class="sig">\r
1121         <a id="Ext.Component-removeListener"></a>\r
1122             <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
1123                         <div class="short">Removes a listener</div>\r
1124             <div class="long">\r
1125                 Removes a listener    <div class="mdetail-params">\r
1126         <strong>Parameters:</strong>\r
1127         <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
1128         <strong>Returns:</strong>\r
1129         <ul>\r
1130             <li><code>void</code></li>\r
1131         </ul>\r
1132     </div>\r
1133                 </div>\r
1134                         </div>\r
1135         </td>\r
1136         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td>\r
1137     </tr>\r
1138         <tr class="method-row alt expandable">\r
1139         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1140         <td class="sig">\r
1141         <a id="Ext.Component-render"></a>\r
1142             <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
1143                         <div class="short">Render this Component into the passed HTML element.
1144 If you are using a Container object to house this Component, then...</div>\r
1145             <div class="long">\r
1146                 <p>Render this Component into the passed HTML element.</p>
1147 <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
1148 do not use the render method.</b></p>
1149 <p>A Container's child Components are rendered by that Container's
1150 <a ext:cls="Ext.Container" ext:member="layout" href="output/Ext.Container.html#layout">layout</a> manager when the Container is first rendered.</p>
1151 <p>Certain layout managers allow dynamic addition of child components. Those that do
1152 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>,
1153 <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>
1154 <p>If the Container is already rendered when a new child Component is added, you may need to call
1155 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
1156 unrendered child Components to be rendered. This is required so that you can add multiple
1157 child components if needed while only refreshing the layout once.</p>
1158 <p>When creating complex UIs, it is important to remember that sizing and positioning
1159 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.
1160 If you expect child items to be sized in response to user interactions, you must
1161 configure the Container with a layout manager which creates and manages the type of layout you
1162 have in mind.</p>
1163 <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
1164 layout manager is used which does nothing but render child components sequentially into the
1165 Container. No sizing or positioning will be performed in this situation.</b></p>    <div class="mdetail-params">\r
1166         <strong>Parameters:</strong>\r
1167         <ul><li><code>container</code> : Element/HTMLElement/String<div class="sub-desc">(optional) The element this Component should be
1168 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>
1169 which this component will be inserted (defaults to appending to the end of the container)</div></li>        </ul>\r
1170         <strong>Returns:</strong>\r
1171         <ul>\r
1172             <li><code>void</code></li>\r
1173         </ul>\r
1174     </div>\r
1175                 </div>\r
1176                         </div>\r
1177         </td>\r
1178         <td class="msource">Component</td>\r
1179     </tr>\r
1180         <tr class="method-row inherited expandable">\r
1181         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1182         <td class="sig">\r
1183         <a id="Ext.Component-resumeEvents"></a>\r
1184             <b>resumeEvents</b>() : void            <div class="mdesc">\r
1185                         <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
1186             <div class="long">\r
1187                 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
1188         <strong>Parameters:</strong>\r
1189         <ul><li>None.</li>        </ul>\r
1190         <strong>Returns:</strong>\r
1191         <ul>\r
1192             <li><code>void</code></li>\r
1193         </ul>\r
1194     </div>\r
1195                 </div>\r
1196                         </div>\r
1197         </td>\r
1198         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td>\r
1199     </tr>\r
1200         <tr class="method-row alt expandable">\r
1201         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1202         <td class="sig">\r
1203         <a id="Ext.Component-setDisabled"></a>\r
1204             <b>setDisabled</b>(&nbsp;<code>Boolean disabled</code>&nbsp;) : void            <div class="mdesc">\r
1205                         <div class="short">Convenience function for setting disabled/enabled by boolean.</div>\r
1206             <div class="long">\r
1207                 Convenience function for setting disabled/enabled by boolean.    <div class="mdetail-params">\r
1208         <strong>Parameters:</strong>\r
1209         <ul><li><code>disabled</code> : Boolean<div class="sub-desc"></div></li>        </ul>\r
1210         <strong>Returns:</strong>\r
1211         <ul>\r
1212             <li><code>void</code></li>\r
1213         </ul>\r
1214     </div>\r
1215                 </div>\r
1216                         </div>\r
1217         </td>\r
1218         <td class="msource">Component</td>\r
1219     </tr>\r
1220         <tr class="method-row expandable">\r
1221         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1222         <td class="sig">\r
1223         <a id="Ext.Component-setVisible"></a>\r
1224             <b>setVisible</b>(&nbsp;<code>Boolean visible</code>&nbsp;) : Ext.Component            <div class="mdesc">\r
1225                         <div class="short">Convenience function to hide or show this component by boolean.</div>\r
1226             <div class="long">\r
1227                 Convenience function to hide or show this component by boolean.    <div class="mdetail-params">\r
1228         <strong>Parameters:</strong>\r
1229         <ul><li><code>visible</code> : Boolean<div class="sub-desc">True to show, false to hide</div></li>        </ul>\r
1230         <strong>Returns:</strong>\r
1231         <ul>\r
1232             <li><code>Ext.Component</code><div class="sub-desc">this</div></li>\r
1233         </ul>\r
1234     </div>\r
1235                 </div>\r
1236                         </div>\r
1237         </td>\r
1238         <td class="msource">Component</td>\r
1239     </tr>\r
1240         <tr class="method-row alt expandable">\r
1241         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1242         <td class="sig">\r
1243         <a id="Ext.Component-show"></a>\r
1244             <b>show</b>() : Ext.Component            <div class="mdesc">\r
1245                         <div class="short">Show this component.</div>\r
1246             <div class="long">\r
1247                 Show this component.    <div class="mdetail-params">\r
1248         <strong>Parameters:</strong>\r
1249         <ul><li>None.</li>        </ul>\r
1250         <strong>Returns:</strong>\r
1251         <ul>\r
1252             <li><code>Ext.Component</code><div class="sub-desc">this</div></li>\r
1253         </ul>\r
1254     </div>\r
1255                 </div>\r
1256                         </div>\r
1257         </td>\r
1258         <td class="msource">Component</td>\r
1259     </tr>\r
1260         <tr class="method-row inherited expandable">\r
1261         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1262         <td class="sig">\r
1263         <a id="Ext.Component-suspendEvents"></a>\r
1264             <b>suspendEvents</b>() : void            <div class="mdesc">\r
1265                         <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
1266             <div class="long">\r
1267                 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
1268         <strong>Parameters:</strong>\r
1269         <ul><li>None.</li>        </ul>\r
1270         <strong>Returns:</strong>\r
1271         <ul>\r
1272             <li><code>void</code></li>\r
1273         </ul>\r
1274     </div>\r
1275                 </div>\r
1276                         </div>\r
1277         </td>\r
1278         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td>\r
1279     </tr>\r
1280         <tr class="method-row inherited alt expandable">\r
1281         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1282         <td class="sig">\r
1283         <a id="Ext.Component-un"></a>\r
1284             <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
1285                         <div class="short">Removes a listener (shorthand for removeListener)</div>\r
1286             <div class="long">\r
1287                 Removes a listener (shorthand for removeListener)    <div class="mdetail-params">\r
1288         <strong>Parameters:</strong>\r
1289         <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
1290         <strong>Returns:</strong>\r
1291         <ul>\r
1292             <li><code>void</code></li>\r
1293         </ul>\r
1294     </div>\r
1295                 </div>\r
1296                         </div>\r
1297         </td>\r
1298         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td>\r
1299     </tr>\r
1300             </table>
1301                 <a id="Ext.Component-events"></a>
1302         <h2>Public Events</h2>
1303                 <table cellspacing="0" class="member-table">
1304             <tr>
1305                 <th class="sig-header" colspan="2">Event</th>
1306                 <th class="msource-header">Defined By</th>
1307             </tr>
1308                 <tr class="event-row expandable">\r
1309         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1310         <td class="sig">\r
1311         <a id="Ext.Component-beforedestroy"></a>\r
1312             <b>beforedestroy</b> : (&nbsp;<code>Ext.Component this</code>&nbsp;)            <div class="mdesc">\r
1313                         <div class="short">Fires before the component is destroyed. Return false to stop the destroy.</div>\r
1314             <div class="long">\r
1315                 Fires before the component is destroyed. Return false to stop the destroy.    <div class="mdetail-params">\r
1316         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
1317         <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li>        </ul>\r
1318     </div>\r
1319                 </div>\r
1320                         </div>\r
1321         </td>\r
1322         <td class="msource">Component</td>\r
1323     </tr>\r
1324         <tr class="event-row alt expandable">\r
1325         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1326         <td class="sig">\r
1327         <a id="Ext.Component-beforehide"></a>\r
1328             <b>beforehide</b> : (&nbsp;<code>Ext.Component this</code>&nbsp;)            <div class="mdesc">\r
1329                         <div class="short">Fires before the component is hidden. Return false to stop the hide.</div>\r
1330             <div class="long">\r
1331                 Fires before the component is hidden. Return false to stop the hide.    <div class="mdetail-params">\r
1332         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
1333         <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li>        </ul>\r
1334     </div>\r
1335                 </div>\r
1336                         </div>\r
1337         </td>\r
1338         <td class="msource">Component</td>\r
1339     </tr>\r
1340         <tr class="event-row expandable">\r
1341         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1342         <td class="sig">\r
1343         <a id="Ext.Component-beforerender"></a>\r
1344             <b>beforerender</b> : (&nbsp;<code>Ext.Component this</code>&nbsp;)            <div class="mdesc">\r
1345                         <div class="short">Fires before the component is rendered. Return false to stop the render.</div>\r
1346             <div class="long">\r
1347                 Fires before the component is rendered. Return false to stop the render.    <div class="mdetail-params">\r
1348         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
1349         <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li>        </ul>\r
1350     </div>\r
1351                 </div>\r
1352                         </div>\r
1353         </td>\r
1354         <td class="msource">Component</td>\r
1355     </tr>\r
1356         <tr class="event-row alt expandable">\r
1357         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1358         <td class="sig">\r
1359         <a id="Ext.Component-beforeshow"></a>\r
1360             <b>beforeshow</b> : (&nbsp;<code>Ext.Component this</code>&nbsp;)            <div class="mdesc">\r
1361                         <div class="short">Fires before the component is shown. Return false to stop the show.</div>\r
1362             <div class="long">\r
1363                 Fires before the component is shown. Return false to stop the show.    <div class="mdetail-params">\r
1364         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
1365         <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li>        </ul>\r
1366     </div>\r
1367                 </div>\r
1368                         </div>\r
1369         </td>\r
1370         <td class="msource">Component</td>\r
1371     </tr>\r
1372         <tr class="event-row expandable">\r
1373         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1374         <td class="sig">\r
1375         <a id="Ext.Component-beforestaterestore"></a>\r
1376             <b>beforestaterestore</b> : (&nbsp;<code>Ext.Component this</code>, <code>Object state</code>&nbsp;)            <div class="mdesc">\r
1377                         <div class="short">Fires before the state of the component is restored. Return false to stop the restore.</div>\r
1378             <div class="long">\r
1379                 Fires before the state of the component is restored. Return false to stop the restore.    <div class="mdetail-params">\r
1380         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
1381         <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
1382     </div>\r
1383                 </div>\r
1384                         </div>\r
1385         </td>\r
1386         <td class="msource">Component</td>\r
1387     </tr>\r
1388         <tr class="event-row alt expandable">\r
1389         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1390         <td class="sig">\r
1391         <a id="Ext.Component-beforestatesave"></a>\r
1392             <b>beforestatesave</b> : (&nbsp;<code>Ext.Component this</code>, <code>Object state</code>&nbsp;)            <div class="mdesc">\r
1393                         <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
1394             <div class="long">\r
1395                 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
1396         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
1397         <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
1398     </div>\r
1399                 </div>\r
1400                         </div>\r
1401         </td>\r
1402         <td class="msource">Component</td>\r
1403     </tr>\r
1404         <tr class="event-row expandable">\r
1405         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1406         <td class="sig">\r
1407         <a id="Ext.Component-destroy"></a>\r
1408             <b>destroy</b> : (&nbsp;<code>Ext.Component this</code>&nbsp;)            <div class="mdesc">\r
1409                         <div class="short">Fires after the component is destroyed.</div>\r
1410             <div class="long">\r
1411                 Fires after the component is destroyed.    <div class="mdetail-params">\r
1412         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
1413         <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li>        </ul>\r
1414     </div>\r
1415                 </div>\r
1416                         </div>\r
1417         </td>\r
1418         <td class="msource">Component</td>\r
1419     </tr>\r
1420         <tr class="event-row alt expandable">\r
1421         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1422         <td class="sig">\r
1423         <a id="Ext.Component-disable"></a>\r
1424             <b>disable</b> : (&nbsp;<code>Ext.Component this</code>&nbsp;)            <div class="mdesc">\r
1425                         <div class="short">Fires after the component is disabled.</div>\r
1426             <div class="long">\r
1427                 Fires after the component is disabled.    <div class="mdetail-params">\r
1428         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
1429         <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li>        </ul>\r
1430     </div>\r
1431                 </div>\r
1432                         </div>\r
1433         </td>\r
1434         <td class="msource">Component</td>\r
1435     </tr>\r
1436         <tr class="event-row expandable">\r
1437         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1438         <td class="sig">\r
1439         <a id="Ext.Component-enable"></a>\r
1440             <b>enable</b> : (&nbsp;<code>Ext.Component this</code>&nbsp;)            <div class="mdesc">\r
1441                         <div class="short">Fires after the component is enabled.</div>\r
1442             <div class="long">\r
1443                 Fires after the component is enabled.    <div class="mdetail-params">\r
1444         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
1445         <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li>        </ul>\r
1446     </div>\r
1447                 </div>\r
1448                         </div>\r
1449         </td>\r
1450         <td class="msource">Component</td>\r
1451     </tr>\r
1452         <tr class="event-row alt expandable">\r
1453         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1454         <td class="sig">\r
1455         <a id="Ext.Component-hide"></a>\r
1456             <b>hide</b> : (&nbsp;<code>Ext.Component this</code>&nbsp;)            <div class="mdesc">\r
1457                         <div class="short">Fires after the component is hidden.</div>\r
1458             <div class="long">\r
1459                 Fires after the component is hidden.    <div class="mdetail-params">\r
1460         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
1461         <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li>        </ul>\r
1462     </div>\r
1463                 </div>\r
1464                         </div>\r
1465         </td>\r
1466         <td class="msource">Component</td>\r
1467     </tr>\r
1468         <tr class="event-row expandable">\r
1469         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1470         <td class="sig">\r
1471         <a id="Ext.Component-render"></a>\r
1472             <b>render</b> : (&nbsp;<code>Ext.Component this</code>&nbsp;)            <div class="mdesc">\r
1473                         <div class="short">Fires after the component is rendered.</div>\r
1474             <div class="long">\r
1475                 Fires after the component is rendered.    <div class="mdetail-params">\r
1476         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
1477         <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li>        </ul>\r
1478     </div>\r
1479                 </div>\r
1480                         </div>\r
1481         </td>\r
1482         <td class="msource">Component</td>\r
1483     </tr>\r
1484         <tr class="event-row alt expandable">\r
1485         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1486         <td class="sig">\r
1487         <a id="Ext.Component-show"></a>\r
1488             <b>show</b> : (&nbsp;<code>Ext.Component this</code>&nbsp;)            <div class="mdesc">\r
1489                         <div class="short">Fires after the component is shown.</div>\r
1490             <div class="long">\r
1491                 Fires after the component is shown.    <div class="mdetail-params">\r
1492         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
1493         <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li>        </ul>\r
1494     </div>\r
1495                 </div>\r
1496                         </div>\r
1497         </td>\r
1498         <td class="msource">Component</td>\r
1499     </tr>\r
1500         <tr class="event-row expandable">\r
1501         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1502         <td class="sig">\r
1503         <a id="Ext.Component-staterestore"></a>\r
1504             <b>staterestore</b> : (&nbsp;<code>Ext.Component this</code>, <code>Object state</code>&nbsp;)            <div class="mdesc">\r
1505                         <div class="short">Fires after the state of the component is restored.</div>\r
1506             <div class="long">\r
1507                 Fires after the state of the component is restored.    <div class="mdetail-params">\r
1508         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
1509         <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
1510     </div>\r
1511                 </div>\r
1512                         </div>\r
1513         </td>\r
1514         <td class="msource">Component</td>\r
1515     </tr>\r
1516         <tr class="event-row alt expandable">\r
1517         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
1518         <td class="sig">\r
1519         <a id="Ext.Component-statesave"></a>\r
1520             <b>statesave</b> : (&nbsp;<code>Ext.Component this</code>, <code>Object state</code>&nbsp;)            <div class="mdesc">\r
1521                         <div class="short">Fires after the state of the component is saved to the configured state provider.</div>\r
1522             <div class="long">\r
1523                 Fires after the state of the component is saved to the configured state provider.    <div class="mdetail-params">\r
1524         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
1525         <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
1526     </div>\r
1527                 </div>\r
1528                         </div>\r
1529         </td>\r
1530         <td class="msource">Component</td>\r
1531     </tr>\r
1532             </table>
1533         
1534         </div>