1 <div class="body-wrap">
2 <div class="top-tools">
3 <a class="inner-link" href="#Ext.Button-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
4 <a class="inner-link" href="#Ext.Button-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
5 <a class="inner-link" href="#Ext.Button-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
6 <a class="inner-link" href="#Ext.Button-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
7 <a class="bookmark" href="../docs/?class=Ext.Button"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
9 <div class="inheritance res-block">
10 <pre class="res-block-inner"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a>
11 <img src="resources/elbow-end.gif"/><a ext:cls="Ext.Component" ext:member="" href="output/Ext.Component.html">Component</a>
12 <img src="resources/elbow-end.gif"/>Button</pre></div>
13 <h1>Class Ext.Button</h1>
14 <table cellspacing="0">
15 <tr><td class="label">Package:</td><td class="hd-info">Ext</td></tr>
16 <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/Button.js" target="_blank">Button.js</a></td></tr>
17 <tr><td class="label">Class:</td><td class="hd-info">Button</td></tr>
18 <tr><td class="label">Subclasses:</td><td class="hd-info"><a ext:cls="Ext.SplitButton" href="output/Ext.SplitButton.html">SplitButton</a>, <a ext:cls="Ext.Toolbar.Button" href="output/Ext.Toolbar.Button.html">Toolbar.Button</a></td></tr>
19 <tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.Component" ext:member="" href="output/Ext.Component.html">Component</a></td></tr>
21 <div class="description">
23 Simple Button class </div>
25 <div class="hr"></div>
26 <a id="Ext.Button-configs"></a>
27 <h2>Config Options</h2>
28 <table cellspacing="0" class="member-table">
30 <th class="sig-header" colspan="2">Config Options</th>
31 <th class="msource-header">Defined By</th>
33 <tr class="config-row">
\r
34 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
36 <a id="Ext.Button-allowDepress"></a>
\r
37 <b>allowDepress</b> : Boolean <div class="mdesc">
\r
38 False to not allow a pressed Button to be depressed (defaults to undefined). Only valid when <a ext:cls="Ext.Button" ext:member="enableToggle" href="output/Ext.Button.html#enableToggle">enableToggle</a> is true. </div>
\r
40 <td class="msource">Button</td>
\r
42 <tr class="config-row inherited alt">
\r
43 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
45 <a id="Ext.Button-allowDomMove"></a>
\r
46 <b>allowDomMove</b> : Boolean <div class="mdesc">
\r
47 Whether the component can move the Dom node when rendering (defaults to true). </div>
\r
49 <td class="msource"><a ext:cls="Ext.Component" ext:member="#allowDomMove" href="output/Ext.Component.html#allowDomMove">Component</a></td>
\r
51 <tr class="config-row inherited expandable">
\r
52 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
54 <a id="Ext.Button-applyTo"></a>
\r
55 <b>applyTo</b> : Mixed <div class="mdesc">
\r
56 <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
58 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
61 <td class="msource"><a ext:cls="Ext.Component" ext:member="#applyTo" href="output/Ext.Component.html#applyTo">Component</a></td>
\r
63 <tr class="config-row inherited alt expandable">
\r
64 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
66 <a id="Ext.Button-autoShow"></a>
\r
67 <b>autoShow</b> : Boolean <div class="mdesc">
\r
68 <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
70 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
73 <td class="msource"><a ext:cls="Ext.Component" ext:member="#autoShow" href="output/Ext.Component.html#autoShow">Component</a></td>
\r
75 <tr class="config-row expandable">
\r
76 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
78 <a id="Ext.Button-buttonSelector"></a>
\r
79 <b>buttonSelector</b> : String <div class="mdesc">
\r
80 <div class="short">(Optional) A DomQuery selector which is used to extract the active, clickable element from the DOM structure created....</div>
\r
82 <p>(Optional) A <a ext:cls="Ext.DomQuery" href="output/Ext.DomQuery.html">DomQuery</a> selector which is used to extract the active, clickable element from the DOM structure created.</p> <p>When a custom <a ext:cls="Ext.Button" ext:member="template" href="output/Ext.Button.html#template">template</a> is used, you must ensure that this selector results in the selection of a focussable element.</p> <p>Defaults to <b><tt>"button:first-child"</tt></b>.</p> </div>
\r
85 <td class="msource">Button</td>
\r
87 <tr class="config-row inherited alt expandable">
\r
88 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
90 <a id="Ext.Button-clearCls"></a>
\r
91 <b>clearCls</b> : String <div class="mdesc">
\r
92 <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
94 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
97 <td class="msource"><a ext:cls="Ext.Component" ext:member="#clearCls" href="output/Ext.Component.html#clearCls">Component</a></td>
\r
99 <tr class="config-row">
\r
100 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
102 <a id="Ext.Button-clickEvent"></a>
\r
103 <b>clickEvent</b> : String <div class="mdesc">
\r
104 The type of event to map to the button's event handler (defaults to 'click') </div>
\r
106 <td class="msource">Button</td>
\r
108 <tr class="config-row inherited alt expandable">
\r
109 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
111 <a id="Ext.Button-cls"></a>
\r
112 <b>cls</b> : String <div class="mdesc">
\r
113 <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
115 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
118 <td class="msource"><a ext:cls="Ext.Component" ext:member="#cls" href="output/Ext.Component.html#cls">Component</a></td>
\r
120 <tr class="config-row inherited expandable">
\r
121 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
123 <a id="Ext.Button-ctCls"></a>
\r
124 <b>ctCls</b> : String <div class="mdesc">
\r
125 <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
127 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
130 <td class="msource"><a ext:cls="Ext.Component" ext:member="#ctCls" href="output/Ext.Component.html#ctCls">Component</a></td>
\r
132 <tr class="config-row alt">
\r
133 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
135 <a id="Ext.Button-disabled"></a>
\r
136 <b>disabled</b> : Boolean <div class="mdesc">
\r
137 True to start disabled (defaults to false) </div>
\r
139 <td class="msource">Button</td>
\r
141 <tr class="config-row inherited">
\r
142 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
144 <a id="Ext.Button-disabledClass"></a>
\r
145 <b>disabledClass</b> : String <div class="mdesc">
\r
146 CSS class added to the component when it is disabled (defaults to "x-item-disabled"). </div>
\r
148 <td class="msource"><a ext:cls="Ext.Component" ext:member="#disabledClass" href="output/Ext.Component.html#disabledClass">Component</a></td>
\r
150 <tr class="config-row alt">
\r
151 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
153 <a id="Ext.Button-enableToggle"></a>
\r
154 <b>enableToggle</b> : Boolean <div class="mdesc">
\r
155 True to enable pressed/not pressed toggling (defaults to false) </div>
\r
157 <td class="msource">Button</td>
\r
159 <tr class="config-row inherited expandable">
\r
160 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
162 <a id="Ext.Button-fieldLabel"></a>
\r
163 <b>fieldLabel</b> : String <div class="mdesc">
\r
164 <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
166 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({
168 renderTo: Ext.getBody(),
170 xtype: <em>'textfield'</em>,
171 fieldLabel: <em>'Name'</em>
173 });</code></pre> </div>
\r
176 <td class="msource"><a ext:cls="Ext.Component" ext:member="#fieldLabel" href="output/Ext.Component.html#fieldLabel">Component</a></td>
\r
178 <tr class="config-row alt">
\r
179 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
181 <a id="Ext.Button-handleMouseEvents"></a>
\r
182 <b>handleMouseEvents</b> : Boolean <div class="mdesc">
\r
183 False to disable visual cues on mouseover, mouseout and mousedown (defaults to true) </div>
\r
185 <td class="msource">Button</td>
\r
187 <tr class="config-row">
\r
188 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
190 <a id="Ext.Button-handler"></a>
\r
191 <b>handler</b> : Function <div class="mdesc">
\r
192 A function called when the button is clicked (can be used instead of click event) </div>
\r
194 <td class="msource">Button</td>
\r
196 <tr class="config-row alt">
\r
197 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
199 <a id="Ext.Button-hidden"></a>
\r
200 <b>hidden</b> : Boolean <div class="mdesc">
\r
201 True to start hidden (defaults to false) </div>
\r
203 <td class="msource">Button</td>
\r
205 <tr class="config-row inherited expandable">
\r
206 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
208 <a id="Ext.Button-hideLabel"></a>
\r
209 <b>hideLabel</b> : Boolean <div class="mdesc">
\r
210 <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
212 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({
214 renderTo: Ext.getBody(),
216 xtype: <em>'textfield'</em>
219 });</code></pre> </div>
\r
222 <td class="msource"><a ext:cls="Ext.Component" ext:member="#hideLabel" href="output/Ext.Component.html#hideLabel">Component</a></td>
\r
224 <tr class="config-row inherited alt expandable">
\r
225 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
227 <a id="Ext.Button-hideMode"></a>
\r
228 <b>hideMode</b> : String <div class="mdesc">
\r
229 <div class="short">How this component should be hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset p...</div>
\r
231 <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
234 <td class="msource"><a ext:cls="Ext.Component" ext:member="#hideMode" href="output/Ext.Component.html#hideMode">Component</a></td>
\r
236 <tr class="config-row inherited expandable">
\r
237 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
239 <a id="Ext.Button-hideParent"></a>
\r
240 <b>hideParent</b> : Boolean <div class="mdesc">
\r
241 <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
243 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
246 <td class="msource"><a ext:cls="Ext.Component" ext:member="#hideParent" href="output/Ext.Component.html#hideParent">Component</a></td>
\r
248 <tr class="config-row alt expandable">
\r
249 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
251 <a id="Ext.Button-icon"></a>
\r
252 <b>icon</b> : String <div class="mdesc">
\r
253 <div class="short">The path to an image to display in the button (the image will be set as the background-image CSS property of the butt...</div>
\r
255 The path to an image to display in the button (the image will be set as the background-image CSS property of the button by default, so if you want a mixed icon/text button, set cls:"x-btn-text-icon") </div>
\r
258 <td class="msource">Button</td>
\r
260 <tr class="config-row">
\r
261 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
263 <a id="Ext.Button-iconCls"></a>
\r
264 <b>iconCls</b> : String <div class="mdesc">
\r
265 A css class which sets a background image to be used as the icon for this button </div>
\r
267 <td class="msource">Button</td>
\r
269 <tr class="config-row inherited alt expandable">
\r
270 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
272 <a id="Ext.Button-id"></a>
\r
273 <b>id</b> : String <div class="mdesc">
\r
274 <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
276 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
279 <td class="msource"><a ext:cls="Ext.Component" ext:member="#id" href="output/Ext.Component.html#id">Component</a></td>
\r
281 <tr class="config-row inherited expandable">
\r
282 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
284 <a id="Ext.Button-itemCls"></a>
\r
285 <b>itemCls</b> : String <div class="mdesc">
\r
286 <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
288 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>
290 .required .x-form-item-label {font-weight:bold;color:red;}
293 <b>new</b> Ext.FormPanel({
295 renderTo: Ext.getBody(),
297 xtype: <em>'textfield'</em>,
298 fieldLabel: <em>'Name'</em>,
299 itemCls: <em>'required'</em> <i>//<b>this</b> label will be styled</i>
301 xtype: <em>'textfield'</em>,
302 fieldLabel: <em>'Favorite Color'</em>
304 });</code></pre> </div>
\r
307 <td class="msource"><a ext:cls="Ext.Component" ext:member="#itemCls" href="output/Ext.Component.html#itemCls">Component</a></td>
\r
309 <tr class="config-row inherited alt expandable">
\r
310 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
312 <a id="Ext.Button-labelSeparator"></a>
\r
313 <b>labelSeparator</b> : String <div class="mdesc">
\r
314 <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
316 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({
318 renderTo: Ext.getBody(),
320 xtype: <em>'textfield'</em>,
321 fieldLabel: <em>'Name'</em>,
322 labelSeparator: <em>'...'</em>
324 });</code></pre> </div>
\r
327 <td class="msource"><a ext:cls="Ext.Component" ext:member="#labelSeparator" href="output/Ext.Component.html#labelSeparator">Component</a></td>
\r
329 <tr class="config-row inherited expandable">
\r
330 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
332 <a id="Ext.Button-labelStyle"></a>
\r
333 <b>labelStyle</b> : String <div class="mdesc">
\r
334 <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
336 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({
338 renderTo: Ext.getBody(),
340 xtype: <em>'textfield'</em>,
341 fieldLabel: <em>'Name'</em>,
342 labelStyle: <em>'font-weight:bold;'</em>
344 });</code></pre> </div>
\r
347 <td class="msource"><a ext:cls="Ext.Component" ext:member="#labelStyle" href="output/Ext.Component.html#labelStyle">Component</a></td>
\r
349 <tr class="config-row inherited alt expandable">
\r
350 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
352 <a id="Ext.Button-listeners"></a>
\r
353 <b>listeners</b> : Object <div class="mdesc">
\r
354 <div class="short">(optional) A config object containing one or more event handlers to be added to this object during initialization. Th...</div>
\r
356 (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
359 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td>
\r
361 <tr class="config-row expandable">
\r
362 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
364 <a id="Ext.Button-menu"></a>
\r
365 <b>menu</b> : Mixed <div class="mdesc">
\r
366 <div class="short">Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to unde...</div>
\r
368 Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined). </div>
\r
371 <td class="msource">Button</td>
\r
373 <tr class="config-row alt">
\r
374 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
376 <a id="Ext.Button-menuAlign"></a>
\r
377 <b>menuAlign</b> : String <div class="mdesc">
\r
378 The position to align the menu to (see <a ext:cls="Ext.Element" ext:member="alignTo" href="output/Ext.Element.html#alignTo">Ext.Element.alignTo</a> for more details, defaults to 'tl-bl?'). </div>
\r
380 <td class="msource">Button</td>
\r
382 <tr class="config-row">
\r
383 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
385 <a id="Ext.Button-minWidth"></a>
\r
386 <b>minWidth</b> : Number <div class="mdesc">
\r
387 The minimum width for this button (used to give a set of buttons a common width) </div>
\r
389 <td class="msource">Button</td>
\r
391 <tr class="config-row inherited alt expandable">
\r
392 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
394 <a id="Ext.Button-overCls"></a>
\r
395 <b>overCls</b> : String <div class="mdesc">
\r
396 <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
398 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
401 <td class="msource"><a ext:cls="Ext.Component" ext:member="#overCls" href="output/Ext.Component.html#overCls">Component</a></td>
\r
403 <tr class="config-row inherited expandable">
\r
404 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
406 <a id="Ext.Button-plugins"></a>
\r
407 <b>plugins</b> : Object/Array <div class="mdesc">
\r
408 <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
410 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
413 <td class="msource"><a ext:cls="Ext.Component" ext:member="#plugins" href="output/Ext.Component.html#plugins">Component</a></td>
\r
415 <tr class="config-row alt">
\r
416 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
418 <a id="Ext.Button-pressed"></a>
\r
419 <b>pressed</b> : Boolean <div class="mdesc">
\r
420 True to start pressed (only if enableToggle = true) </div>
\r
422 <td class="msource">Button</td>
\r
424 <tr class="config-row inherited expandable">
\r
425 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
427 <a id="Ext.Button-renderTo"></a>
\r
428 <b>renderTo</b> : Mixed <div class="mdesc">
\r
429 <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
431 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
434 <td class="msource"><a ext:cls="Ext.Component" ext:member="#renderTo" href="output/Ext.Component.html#renderTo">Component</a></td>
\r
436 <tr class="config-row alt expandable">
\r
437 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
439 <a id="Ext.Button-repeat"></a>
\r
440 <b>repeat</b> : Boolean/Object <div class="mdesc">
\r
441 <div class="short">True to repeat fire the click event while the mouse is down. This can also be an Ext.util.ClickRepeater config object...</div>
\r
443 True to repeat fire the click event while the mouse is down. This can also be an <a ext:cls="Ext.util.ClickRepeater" href="output/Ext.util.ClickRepeater.html">Ext.util.ClickRepeater</a> config object (defaults to false). </div>
\r
446 <td class="msource">Button</td>
\r
448 <tr class="config-row">
\r
449 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
451 <a id="Ext.Button-scope"></a>
\r
452 <b>scope</b> : Object <div class="mdesc">
\r
453 The scope of the handler </div>
\r
455 <td class="msource">Button</td>
\r
457 <tr class="config-row inherited alt expandable">
\r
458 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
460 <a id="Ext.Button-stateEvents"></a>
\r
461 <b>stateEvents</b> : Array <div class="mdesc">
\r
462 <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
464 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
467 <td class="msource"><a ext:cls="Ext.Component" ext:member="#stateEvents" href="output/Ext.Component.html#stateEvents">Component</a></td>
\r
469 <tr class="config-row inherited expandable">
\r
470 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
472 <a id="Ext.Button-stateId"></a>
\r
473 <b>stateId</b> : String <div class="mdesc">
\r
474 <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
476 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
479 <td class="msource"><a ext:cls="Ext.Component" ext:member="#stateId" href="output/Ext.Component.html#stateId">Component</a></td>
\r
481 <tr class="config-row inherited alt expandable">
\r
482 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
484 <a id="Ext.Button-stateful"></a>
\r
485 <b>stateful</b> : Boolean <div class="mdesc">
\r
486 <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
488 <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
491 <td class="msource"><a ext:cls="Ext.Component" ext:member="#stateful" href="output/Ext.Component.html#stateful">Component</a></td>
\r
493 <tr class="config-row inherited expandable">
\r
494 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
496 <a id="Ext.Button-style"></a>
\r
497 <b>style</b> : String <div class="mdesc">
\r
498 <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
500 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
503 <td class="msource"><a ext:cls="Ext.Component" ext:member="#style" href="output/Ext.Component.html#style">Component</a></td>
\r
505 <tr class="config-row alt">
\r
506 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
508 <a id="Ext.Button-tabIndex"></a>
\r
509 <b>tabIndex</b> : Number <div class="mdesc">
\r
510 Set a DOM tabIndex for this button (defaults to undefined) </div>
\r
512 <td class="msource">Button</td>
\r
514 <tr class="config-row expandable">
\r
515 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
517 <a id="Ext.Button-template"></a>
\r
518 <b>template</b> : Ext.Template <div class="mdesc">
\r
519 <div class="short">(Optional) An Ext.Template with which to create the Button's main element. This Template must contain numeric substit...</div>
\r
521 (Optional) An <a ext:cls="Ext.Template" href="output/Ext.Template.html">Ext.Template</a> with which to create the Button's main element. This Template must contain numeric substitution parameter 0 if it is to display the text property. Changing the template could require code modifications if required elements (e.g. a button) aren't present. </div>
\r
524 <td class="msource">Button</td>
\r
526 <tr class="config-row alt">
\r
527 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
529 <a id="Ext.Button-text"></a>
\r
530 <b>text</b> : String <div class="mdesc">
\r
531 The button text </div>
\r
533 <td class="msource">Button</td>
\r
535 <tr class="config-row">
\r
536 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
538 <a id="Ext.Button-toggleGroup"></a>
\r
539 <b>toggleGroup</b> : String <div class="mdesc">
\r
540 The group this toggle button is a member of (only 1 per group can be pressed) </div>
\r
542 <td class="msource">Button</td>
\r
544 <tr class="config-row alt expandable">
\r
545 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
547 <a id="Ext.Button-toggleHandler"></a>
\r
548 <b>toggleHandler</b> : Function <div class="mdesc">
\r
549 <div class="short">Function called when a Button with enableToggle set to true is clicked. Two arguments are passed: button : Ext.Button...</div>
\r
551 Function called when a Button with <a ext:cls="Ext.Button" ext:member="enableToggle" href="output/Ext.Button.html#enableToggle">enableToggle</a> set to true is clicked. Two arguments are passed:<ul class="mdetail-params"> <li><b>button</b> : Ext.Button<div class="sub-desc">this Button object</div></li> <li><b>state</b> : Boolean<div class="sub-desc">The next state if the Button, true means pressed.</div></li> </ul> </div>
\r
554 <td class="msource">Button</td>
\r
556 <tr class="config-row">
\r
557 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
559 <a id="Ext.Button-tooltip"></a>
\r
560 <b>tooltip</b> : String/Object <div class="mdesc">
\r
561 The tooltip for the button - can be a string or QuickTips config object </div>
\r
563 <td class="msource">Button</td>
\r
565 <tr class="config-row alt">
\r
566 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
568 <a id="Ext.Button-tooltipType"></a>
\r
569 <b>tooltipType</b> : String <div class="mdesc">
\r
570 The type of tooltip to use. Either "qtip" (default) for QuickTips or "title" for title attribute. </div>
\r
572 <td class="msource">Button</td>
\r
574 <tr class="config-row">
\r
575 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
577 <a id="Ext.Button-type"></a>
\r
578 <b>type</b> : String <div class="mdesc">
\r
579 submit, reset or button - defaults to 'button' </div>
\r
581 <td class="msource">Button</td>
\r
583 <tr class="config-row inherited alt expandable">
\r
584 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
586 <a id="Ext.Button-xtype"></a>
\r
587 <b>xtype</b> : String <div class="mdesc">
\r
588 <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
590 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
593 <td class="msource"><a ext:cls="Ext.Component" ext:member="#xtype" href="output/Ext.Component.html#xtype">Component</a></td>
\r
596 <a id="Ext.Button-props"></a>
597 <h2>Public Properties</h2>
598 <table cellspacing="0" class="member-table">
600 <th class="sig-header" colspan="2">Property</th>
601 <th class="msource-header">Defined By</th>
603 <tr class="property-row">
\r
604 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
606 <a id="Ext.Button-disabled"></a>
\r
607 <b>disabled</b> : Boolean <div class="mdesc">
\r
608 Read-only. True if this button is disabled </div>
\r
610 <td class="msource">Button</td>
\r
612 <tr class="property-row alt">
\r
613 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
615 <a id="Ext.Button-hidden"></a>
\r
616 <b>hidden</b> : Boolean <div class="mdesc">
\r
617 Read-only. True if this button is hidden </div>
\r
619 <td class="msource">Button</td>
\r
621 <tr class="property-row inherited">
\r
622 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
624 <a id="Ext.Button-initialConfig"></a>
\r
625 <b>initialConfig</b> : Object <div class="mdesc">
\r
626 This Component's initial configuration specification. Read-only. </div>
\r
628 <td class="msource"><a ext:cls="Ext.Component" ext:member="#initialConfig" href="output/Ext.Component.html#initialConfig">Component</a></td>
\r
630 <tr class="property-row alt expandable">
\r
631 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
633 <a id="Ext.Button-ownerCt"></a>
\r
634 <b>ownerCt</b> : Ext.Panel <div class="mdesc">
\r
635 <div class="short">The Button's owner Ext.Panel (defaults to undefined, and is set automatically when
636 the Button is added to a container...</div>
\r
638 The Button's owner <a ext:cls="Ext.Panel" href="output/Ext.Panel.html">Ext.Panel</a> (defaults to undefined, and is set automatically when
639 the Button is added to a container). Read-only. </div>
\r
642 <td class="msource">Button</td>
\r
644 <tr class="property-row">
\r
645 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
647 <a id="Ext.Button-pressed"></a>
\r
648 <b>pressed</b> : Boolean <div class="mdesc">
\r
649 Read-only. True if this button is pressed (only if enableToggle = true) </div>
\r
651 <td class="msource">Button</td>
\r
653 <tr class="property-row inherited alt">
\r
654 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
656 <a id="Ext.Button-rendered"></a>
\r
657 <b>rendered</b> : Boolean <div class="mdesc">
\r
658 True if this component has been rendered. Read-only. </div>
\r
660 <td class="msource"><a ext:cls="Ext.Component" ext:member="#rendered" href="output/Ext.Component.html#rendered">Component</a></td>
\r
663 <a id="Ext.Button-methods"></a>
664 <h2>Public Methods</h2>
665 <table cellspacing="0" class="member-table">
667 <th class="sig-header" colspan="2">Method</th>
668 <th class="msource-header">Defined By</th>
670 <tr class="method-row expandable">
\r
671 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
673 <a id="Ext.Button-Button"></a>
\r
674 <b>Button</b>( <code>Object config</code> ) <div class="mdesc">
\r
675 <div class="short">Create a new button</div>
\r
677 Create a new button <div class="mdetail-params">
\r
678 <strong>Parameters:</strong>
\r
679 <ul><li><code>config</code> : Object<div class="sub-desc">The config object</div></li> </ul>
\r
680 <strong>Returns:</strong>
\r
682 <li><code></code></li>
\r
688 <td class="msource">Button</td>
\r
690 <tr class="method-row inherited alt expandable">
\r
691 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
693 <a id="Ext.Button-addClass"></a>
\r
694 <b>addClass</b>( <code>string cls</code> ) : void <div class="mdesc">
\r
695 <div class="short">Adds a CSS class to the component's underlying element.</div>
\r
697 Adds a CSS class to the component's underlying element. <div class="mdetail-params">
\r
698 <strong>Parameters:</strong>
\r
699 <ul><li><code>cls</code> : string<div class="sub-desc">The CSS class name to add</div></li> </ul>
\r
700 <strong>Returns:</strong>
\r
702 <li><code>void</code></li>
\r
708 <td class="msource"><a ext:cls="Ext.Component" ext:member="#addClass" href="output/Ext.Component.html#addClass">Component</a></td>
\r
710 <tr class="method-row inherited expandable">
\r
711 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
713 <a id="Ext.Button-addEvents"></a>
\r
714 <b>addEvents</b>( <code>Object object</code> ) : void <div class="mdesc">
\r
715 <div class="short">Used to define events on this Observable</div>
\r
717 Used to define events on this Observable <div class="mdetail-params">
\r
718 <strong>Parameters:</strong>
\r
719 <ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li> </ul>
\r
720 <strong>Returns:</strong>
\r
722 <li><code>void</code></li>
\r
728 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td>
\r
730 <tr class="method-row inherited alt expandable">
\r
731 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
733 <a id="Ext.Button-addListener"></a>
\r
734 <b>addListener</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span> ) : void <div class="mdesc">
\r
735 <div class="short">Appends an event handler to this component</div>
\r
737 Appends an event handler to this component <div class="mdetail-params">
\r
738 <strong>Parameters:</strong>
\r
739 <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
740 function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration
741 properties. This may contain any of the following properties:<ul>
742 <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>
743 <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>
744 <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>
745 <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
746 by the specified number of milliseconds. If the event fires again within that time, the original
747 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</p></li>
750 <b>Combining Options</b><br>
751 Using the options argument, it is possible to combine different types of listeners:<br>
753 A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
754 <pre><code>el.on(<em>'click'</em>, <b>this</b>.onClick, <b>this</b>, {
760 <b>Attaching multiple handlers in 1 call</b><br>
761 The method also allows for a single argument to be passed which is a config object containing properties
762 which specify multiple handlers.
766 fn: <b>this</b>.onClick,
770 <em>'mouseover'</em> : {
771 fn: <b>this</b>.onMouseOver,
774 <em>'mouseout'</em> : {
775 fn: <b>this</b>.onMouseOut,
780 Or a shorthand syntax:<br>
782 <em>'click'</em> : <b>this</b>.onClick,
783 <em>'mouseover'</em> : <b>this</b>.onMouseOver,
784 <em>'mouseout'</em> : <b>this</b>.onMouseOut,
786 });</code></pre></div></li> </ul>
\r
787 <strong>Returns:</strong>
\r
789 <li><code>void</code></li>
\r
795 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td>
\r
797 <tr class="method-row inherited expandable">
\r
798 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
800 <a id="Ext.Button-applyToMarkup"></a>
\r
801 <b>applyToMarkup</b>( <code>String/HTMLElement el</code> ) : void <div class="mdesc">
\r
802 <div class="short">Apply this component to existing markup that is valid. With this function, no call to render() is required.</div>
\r
804 Apply this component to existing markup that is valid. With this function, no call to render() is required. <div class="mdetail-params">
\r
805 <strong>Parameters:</strong>
\r
806 <ul><li><code>el</code> : String/HTMLElement<div class="sub-desc"></div></li> </ul>
\r
807 <strong>Returns:</strong>
\r
809 <li><code>void</code></li>
\r
815 <td class="msource"><a ext:cls="Ext.Component" ext:member="#applyToMarkup" href="output/Ext.Component.html#applyToMarkup">Component</a></td>
\r
817 <tr class="method-row inherited alt expandable">
\r
818 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
820 <a id="Ext.Button-cloneConfig"></a>
\r
821 <b>cloneConfig</b>( <code>Object overrides</code> ) : Ext.Component <div class="mdesc">
\r
822 <div class="short">Clone the current component using the original config values passed into this instance by default.</div>
\r
824 Clone the current component using the original config values passed into this instance by default. <div class="mdetail-params">
\r
825 <strong>Parameters:</strong>
\r
826 <ul><li><code>overrides</code> : Object<div class="sub-desc">A new config containing any properties to override in the cloned version.
827 An id property can be passed on this object, otherwise one will be generated to avoid duplicates.</div></li> </ul>
\r
828 <strong>Returns:</strong>
\r
830 <li><code>Ext.Component</code><div class="sub-desc">clone The cloned copy of this component</div></li>
\r
836 <td class="msource"><a ext:cls="Ext.Component" ext:member="#cloneConfig" href="output/Ext.Component.html#cloneConfig">Component</a></td>
\r
838 <tr class="method-row inherited expandable">
\r
839 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
841 <a id="Ext.Button-destroy"></a>
\r
842 <b>destroy</b>() : void <div class="mdesc">
\r
843 <div class="short">Destroys this component by purging any event listeners, removing the component's element from the DOM,
844 removing the c...</div>
\r
846 Destroys this component by purging any event listeners, removing the component's element from the DOM,
847 removing the component from its <a ext:cls="Ext.Container" href="output/Ext.Container.html">Ext.Container</a> (if applicable) and unregistering it from
848 <a ext:cls="Ext.ComponentMgr" href="output/Ext.ComponentMgr.html">Ext.ComponentMgr</a>. Destruction is generally handled automatically by the framework and this method
849 should usually not need to be called directly. <div class="mdetail-params">
\r
850 <strong>Parameters:</strong>
\r
851 <ul><li>None.</li> </ul>
\r
852 <strong>Returns:</strong>
\r
854 <li><code>void</code></li>
\r
860 <td class="msource"><a ext:cls="Ext.Component" ext:member="#destroy" href="output/Ext.Component.html#destroy">Component</a></td>
\r
862 <tr class="method-row inherited alt expandable">
\r
863 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
865 <a id="Ext.Button-disable"></a>
\r
866 <b>disable</b>() : Ext.Component <div class="mdesc">
\r
867 <div class="short">Disable this component.</div>
\r
869 Disable this component. <div class="mdetail-params">
\r
870 <strong>Parameters:</strong>
\r
871 <ul><li>None.</li> </ul>
\r
872 <strong>Returns:</strong>
\r
874 <li><code>Ext.Component</code><div class="sub-desc">this</div></li>
\r
880 <td class="msource"><a ext:cls="Ext.Component" ext:member="#disable" href="output/Ext.Component.html#disable">Component</a></td>
\r
882 <tr class="method-row inherited expandable">
\r
883 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
885 <a id="Ext.Button-enable"></a>
\r
886 <b>enable</b>() : Ext.Component <div class="mdesc">
\r
887 <div class="short">Enable this component.</div>
\r
889 Enable this component. <div class="mdetail-params">
\r
890 <strong>Parameters:</strong>
\r
891 <ul><li>None.</li> </ul>
\r
892 <strong>Returns:</strong>
\r
894 <li><code>Ext.Component</code><div class="sub-desc">this</div></li>
\r
900 <td class="msource"><a ext:cls="Ext.Component" ext:member="#enable" href="output/Ext.Component.html#enable">Component</a></td>
\r
902 <tr class="method-row inherited alt expandable">
\r
903 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
905 <a id="Ext.Button-findParentBy"></a>
\r
906 <b>findParentBy</b>( <code>Function fcn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : Ext.Container <div class="mdesc">
\r
907 <div class="short">Find a container above this component at any level by a custom function. If the passed function returns
908 true, the con...</div>
\r
910 Find a container above this component at any level by a custom function. If the passed function returns
911 true, the container will be returned. The passed function is called with the arguments (container, this component). <div class="mdetail-params">
\r
912 <strong>Parameters:</strong>
\r
913 <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
914 <strong>Returns:</strong>
\r
916 <li><code>Ext.Container</code><div class="sub-desc">The first Container for which the custom function returns true</div></li>
\r
922 <td class="msource"><a ext:cls="Ext.Component" ext:member="#findParentBy" href="output/Ext.Component.html#findParentBy">Component</a></td>
\r
924 <tr class="method-row inherited expandable">
\r
925 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
927 <a id="Ext.Button-findParentByType"></a>
\r
928 <b>findParentByType</b>( <code>String/Class xtype</code> ) : Ext.Container <div class="mdesc">
\r
929 <div class="short">Find a container above this component at any level by xtype or class</div>
\r
931 Find a container above this component at any level by xtype or class <div class="mdetail-params">
\r
932 <strong>Parameters:</strong>
\r
933 <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
934 <strong>Returns:</strong>
\r
936 <li><code>Ext.Container</code><div class="sub-desc">The first Container which matches the given xtype or class</div></li>
\r
942 <td class="msource"><a ext:cls="Ext.Component" ext:member="#findParentByType" href="output/Ext.Component.html#findParentByType">Component</a></td>
\r
944 <tr class="method-row inherited alt expandable">
\r
945 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
947 <a id="Ext.Button-fireEvent"></a>
\r
948 <b>fireEvent</b>( <code>String eventName</code>, <code>Object... args</code> ) : Boolean <div class="mdesc">
\r
949 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
\r
951 Fires the specified event with the passed parameters (minus the event name). <div class="mdetail-params">
\r
952 <strong>Parameters:</strong>
\r
953 <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
954 <strong>Returns:</strong>
\r
956 <li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li>
\r
962 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td>
\r
964 <tr class="method-row expandable">
\r
965 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
967 <a id="Ext.Button-focus"></a>
\r
968 <b>focus</b>() : void <div class="mdesc">
\r
969 <div class="short">Focus the button</div>
\r
971 Focus the button <div class="mdetail-params">
\r
972 <strong>Parameters:</strong>
\r
973 <ul><li>None.</li> </ul>
\r
974 <strong>Returns:</strong>
\r
976 <li><code>void</code></li>
\r
982 <td class="msource">Button</td>
\r
984 <tr class="method-row inherited alt expandable">
\r
985 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
987 <a id="Ext.Button-getEl"></a>
\r
988 <b>getEl</b>() : Ext.Element <div class="mdesc">
\r
989 <div class="short">Returns the underlying <a ext:cls="Ext.Element" href="output/Ext.Element.html">Ext.Element</a>.</div>
\r
991 Returns the underlying <a ext:cls="Ext.Element" href="output/Ext.Element.html">Ext.Element</a>. <div class="mdetail-params">
\r
992 <strong>Parameters:</strong>
\r
993 <ul><li>None.</li> </ul>
\r
994 <strong>Returns:</strong>
\r
996 <li><code>Ext.Element</code><div class="sub-desc">The element</div></li>
\r
1002 <td class="msource"><a ext:cls="Ext.Component" ext:member="#getEl" href="output/Ext.Component.html#getEl">Component</a></td>
\r
1004 <tr class="method-row inherited expandable">
\r
1005 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1007 <a id="Ext.Button-getId"></a>
\r
1008 <b>getId</b>() : String <div class="mdesc">
\r
1009 <div class="short">Returns the id of this component.</div>
\r
1010 <div class="long">
\r
1011 Returns the id of this component. <div class="mdetail-params">
\r
1012 <strong>Parameters:</strong>
\r
1013 <ul><li>None.</li> </ul>
\r
1014 <strong>Returns:</strong>
\r
1016 <li><code>String</code></li>
\r
1022 <td class="msource"><a ext:cls="Ext.Component" ext:member="#getId" href="output/Ext.Component.html#getId">Component</a></td>
\r
1024 <tr class="method-row inherited alt expandable">
\r
1025 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1027 <a id="Ext.Button-getItemId"></a>
\r
1028 <b>getItemId</b>() : String <div class="mdesc">
\r
1029 <div class="short">Returns the item id of this component.</div>
\r
1030 <div class="long">
\r
1031 Returns the item id of this component. <div class="mdetail-params">
\r
1032 <strong>Parameters:</strong>
\r
1033 <ul><li>None.</li> </ul>
\r
1034 <strong>Returns:</strong>
\r
1036 <li><code>String</code></li>
\r
1042 <td class="msource"><a ext:cls="Ext.Component" ext:member="#getItemId" href="output/Ext.Component.html#getItemId">Component</a></td>
\r
1044 <tr class="method-row expandable">
\r
1045 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1047 <a id="Ext.Button-getText"></a>
\r
1048 <b>getText</b>() : String <div class="mdesc">
\r
1049 <div class="short">Gets the text for this button</div>
\r
1050 <div class="long">
\r
1051 Gets the text for this button <div class="mdetail-params">
\r
1052 <strong>Parameters:</strong>
\r
1053 <ul><li>None.</li> </ul>
\r
1054 <strong>Returns:</strong>
\r
1056 <li><code>String</code><div class="sub-desc">The button text</div></li>
\r
1062 <td class="msource">Button</td>
\r
1064 <tr class="method-row inherited alt expandable">
\r
1065 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1067 <a id="Ext.Button-getXType"></a>
\r
1068 <b>getXType</b>() : String <div class="mdesc">
\r
1069 <div class="short">Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
1070 available xtypes, see the Ex...</div>
\r
1071 <div class="long">
\r
1072 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
1073 available xtypes, see the <a ext:cls="Ext.Component" href="output/Ext.Component.html">Ext.Component</a> header. Example usage:
1074 <pre><code>var t = <b>new</b> Ext.form.TextField();
1075 alert(t.getXType()); // alerts <em>'textfield'</em></code></pre> <div class="mdetail-params">
\r
1076 <strong>Parameters:</strong>
\r
1077 <ul><li>None.</li> </ul>
\r
1078 <strong>Returns:</strong>
\r
1080 <li><code>String</code><div class="sub-desc">The xtype</div></li>
\r
1086 <td class="msource"><a ext:cls="Ext.Component" ext:member="#getXType" href="output/Ext.Component.html#getXType">Component</a></td>
\r
1088 <tr class="method-row inherited expandable">
\r
1089 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1091 <a id="Ext.Button-getXTypes"></a>
\r
1092 <b>getXTypes</b>() : String <div class="mdesc">
\r
1093 <div class="short">Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all
1094 available xtypes, see the Ext...</div>
\r
1095 <div class="long">
\r
1096 <p>Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all
1097 available xtypes, see the <a ext:cls="Ext.Component" href="output/Ext.Component.html">Ext.Component</a> header.</p>
1098 <p><b>If using your own subclasses, be aware that a Component must register its own xtype
1099 to participate in determination of inherited xtypes.</b></p>
1100 <p>Example usage:</p>
1102 var t = new Ext.form.TextField();
\r
1103 alert(t.getXTypes()); // alerts 'component/box/field/textfield'</pre></code> <div class="mdetail-params">
\r
1104 <strong>Parameters:</strong>
\r
1105 <ul><li>None.</li> </ul>
\r
1106 <strong>Returns:</strong>
\r
1108 <li><code>String</code><div class="sub-desc">The xtype hierarchy string</div></li>
\r
1114 <td class="msource"><a ext:cls="Ext.Component" ext:member="#getXTypes" href="output/Ext.Component.html#getXTypes">Component</a></td>
\r
1116 <tr class="method-row inherited alt expandable">
\r
1117 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1119 <a id="Ext.Button-hasListener"></a>
\r
1120 <b>hasListener</b>( <code>String eventName</code> ) : Boolean <div class="mdesc">
\r
1121 <div class="short">Checks to see if this object has any listeners for a specified event</div>
\r
1122 <div class="long">
\r
1123 Checks to see if this object has any listeners for a specified event <div class="mdetail-params">
\r
1124 <strong>Parameters:</strong>
\r
1125 <ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li> </ul>
\r
1126 <strong>Returns:</strong>
\r
1128 <li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li>
\r
1134 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td>
\r
1136 <tr class="method-row expandable">
\r
1137 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1139 <a id="Ext.Button-hasVisibleMenu"></a>
\r
1140 <b>hasVisibleMenu</b>() : Boolean <div class="mdesc">
\r
1141 <div class="short">Returns true if the button has a menu and it is visible</div>
\r
1142 <div class="long">
\r
1143 Returns true if the button has a menu and it is visible <div class="mdetail-params">
\r
1144 <strong>Parameters:</strong>
\r
1145 <ul><li>None.</li> </ul>
\r
1146 <strong>Returns:</strong>
\r
1148 <li><code>Boolean</code></li>
\r
1154 <td class="msource">Button</td>
\r
1156 <tr class="method-row inherited alt expandable">
\r
1157 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1159 <a id="Ext.Button-hide"></a>
\r
1160 <b>hide</b>() : Ext.Component <div class="mdesc">
\r
1161 <div class="short">Hide this component.</div>
\r
1162 <div class="long">
\r
1163 Hide this component. <div class="mdetail-params">
\r
1164 <strong>Parameters:</strong>
\r
1165 <ul><li>None.</li> </ul>
\r
1166 <strong>Returns:</strong>
\r
1168 <li><code>Ext.Component</code><div class="sub-desc">this</div></li>
\r
1174 <td class="msource"><a ext:cls="Ext.Component" ext:member="#hide" href="output/Ext.Component.html#hide">Component</a></td>
\r
1176 <tr class="method-row expandable">
\r
1177 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1179 <a id="Ext.Button-hideMenu"></a>
\r
1180 <b>hideMenu</b>() : void <div class="mdesc">
\r
1181 <div class="short">Hide this button's menu (if it has one)</div>
\r
1182 <div class="long">
\r
1183 Hide this button's menu (if it has one) <div class="mdetail-params">
\r
1184 <strong>Parameters:</strong>
\r
1185 <ul><li>None.</li> </ul>
\r
1186 <strong>Returns:</strong>
\r
1188 <li><code>void</code></li>
\r
1194 <td class="msource">Button</td>
\r
1196 <tr class="method-row alt expandable">
\r
1197 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1199 <a id="Ext.Button-initComponent"></a>
\r
1200 <b>initComponent</b>() : void <div class="mdesc">
\r
1201 <div class="short"></div>
\r
1202 <div class="long">
\r
1203 <div class="mdetail-params">
\r
1204 <strong>Parameters:</strong>
\r
1205 <ul><li>None.</li> </ul>
\r
1206 <strong>Returns:</strong>
\r
1208 <li><code>void</code></li>
\r
1214 <td class="msource">Button</td>
\r
1216 <tr class="method-row inherited expandable">
\r
1217 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1219 <a id="Ext.Button-isVisible"></a>
\r
1220 <b>isVisible</b>() : void <div class="mdesc">
\r
1221 <div class="short">Returns true if this component is visible.</div>
\r
1222 <div class="long">
\r
1223 Returns true if this component is visible. <div class="mdetail-params">
\r
1224 <strong>Parameters:</strong>
\r
1225 <ul><li>None.</li> </ul>
\r
1226 <strong>Returns:</strong>
\r
1228 <li><code>void</code></li>
\r
1234 <td class="msource"><a ext:cls="Ext.Component" ext:member="#isVisible" href="output/Ext.Component.html#isVisible">Component</a></td>
\r
1236 <tr class="method-row inherited alt expandable">
\r
1237 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1239 <a id="Ext.Button-isXType"></a>
\r
1240 <b>isXType</b>( <code>String xtype</code>, <span class="optional" title="Optional">[<code>Boolean shallow</code>]</span> ) : void <div class="mdesc">
\r
1241 <div class="short">Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended
1243 <div class="long">
\r
1244 <p>Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended
1245 from the xtype (default) or whether it is directly of the xtype specified (shallow = true).</p>
1246 <p><b>If using your own subclasses, be aware that a Component must register its own xtype
1247 to participate in determination of inherited xtypes.</b></p>
1248 <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>
1249 <p>Example usage:</p>
1250 <pre><code>var t = <b>new</b> Ext.form.TextField();
1251 <b>var</b> isText = t.isXType(<em>'textfield'</em>); <i>// true</i>
1252 <b>var</b> isBoxSubclass = t.isXType(<em>'box'</em>); <i>// true, descended from BoxComponent</i>
1253 <b>var</b> isBoxInstance = t.isXType(<em>'box'</em>, true); // false, not a direct BoxComponent instance</code></pre> <div class="mdetail-params">
\r
1254 <strong>Parameters:</strong>
\r
1255 <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
1256 the default), or true to check whether this Component is directly of the specified xtype.</div></li> </ul>
\r
1257 <strong>Returns:</strong>
\r
1259 <li><code>void</code></li>
\r
1265 <td class="msource"><a ext:cls="Ext.Component" ext:member="#isXType" href="output/Ext.Component.html#isXType">Component</a></td>
\r
1267 <tr class="method-row inherited expandable">
\r
1268 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1270 <a id="Ext.Button-on"></a>
\r
1271 <b>on</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span> ) : void <div class="mdesc">
\r
1272 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
\r
1273 <div class="long">
\r
1274 Appends an event handler to this element (shorthand for addListener) <div class="mdetail-params">
\r
1275 <strong>Parameters:</strong>
\r
1276 <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
1277 function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li> </ul>
\r
1278 <strong>Returns:</strong>
\r
1280 <li><code>void</code></li>
\r
1286 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td>
\r
1288 <tr class="method-row inherited alt expandable">
\r
1289 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1291 <a id="Ext.Button-purgeListeners"></a>
\r
1292 <b>purgeListeners</b>() : void <div class="mdesc">
\r
1293 <div class="short">Removes all listeners for this object</div>
\r
1294 <div class="long">
\r
1295 Removes all listeners for this object <div class="mdetail-params">
\r
1296 <strong>Parameters:</strong>
\r
1297 <ul><li>None.</li> </ul>
\r
1298 <strong>Returns:</strong>
\r
1300 <li><code>void</code></li>
\r
1306 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td>
\r
1308 <tr class="method-row inherited expandable">
\r
1309 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1311 <a id="Ext.Button-relayEvents"></a>
\r
1312 <b>relayEvents</b>( <code>Object o</code>, <code>Array events</code> ) : void <div class="mdesc">
\r
1313 <div class="short">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.</div>
\r
1314 <div class="long">
\r
1315 Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>. <div class="mdetail-params">
\r
1316 <strong>Parameters:</strong>
\r
1317 <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
1318 <strong>Returns:</strong>
\r
1320 <li><code>void</code></li>
\r
1326 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#relayEvents" href="output/Ext.util.Observable.html#relayEvents">Observable</a></td>
\r
1328 <tr class="method-row inherited alt expandable">
\r
1329 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1331 <a id="Ext.Button-removeClass"></a>
\r
1332 <b>removeClass</b>( <code>string cls</code> ) : void <div class="mdesc">
\r
1333 <div class="short">Removes a CSS class from the component's underlying element.</div>
\r
1334 <div class="long">
\r
1335 Removes a CSS class from the component's underlying element. <div class="mdetail-params">
\r
1336 <strong>Parameters:</strong>
\r
1337 <ul><li><code>cls</code> : string<div class="sub-desc">The CSS class name to remove</div></li> </ul>
\r
1338 <strong>Returns:</strong>
\r
1340 <li><code>void</code></li>
\r
1346 <td class="msource"><a ext:cls="Ext.Component" ext:member="#removeClass" href="output/Ext.Component.html#removeClass">Component</a></td>
\r
1348 <tr class="method-row inherited expandable">
\r
1349 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1351 <a id="Ext.Button-removeListener"></a>
\r
1352 <b>removeListener</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc">
\r
1353 <div class="short">Removes a listener</div>
\r
1354 <div class="long">
\r
1355 Removes a listener <div class="mdetail-params">
\r
1356 <strong>Parameters:</strong>
\r
1357 <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
1358 <strong>Returns:</strong>
\r
1360 <li><code>void</code></li>
\r
1366 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td>
\r
1368 <tr class="method-row inherited alt expandable">
\r
1369 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1371 <a id="Ext.Button-render"></a>
\r
1372 <b>render</b>( <span class="optional" title="Optional">[<code>Element/HTMLElement/String container</code>]</span>, <span class="optional" title="Optional">[<code>String/Number position</code>]</span> ) : void <div class="mdesc">
\r
1373 <div class="short">Render this Component into the passed HTML element.
1374 If you are using a Container object to house this Component, then...</div>
\r
1375 <div class="long">
\r
1376 <p>Render this Component into the passed HTML element.</p>
1377 <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
1378 do not use the render method.</b></p>
1379 <p>A Container's child Components are rendered by that Container's
1380 <a ext:cls="Ext.Container" ext:member="layout" href="output/Ext.Container.html#layout">layout</a> manager when the Container is first rendered.</p>
1381 <p>Certain layout managers allow dynamic addition of child components. Those that do
1382 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>,
1383 <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>
1384 <p>If the Container is already rendered when a new child Component is added, you may need to call
1385 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
1386 unrendered child Components to be rendered. This is required so that you can add multiple
1387 child components if needed while only refreshing the layout once.</p>
1388 <p>When creating complex UIs, it is important to remember that sizing and positioning
1389 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.
1390 If you expect child items to be sized in response to user interactions, you must
1391 configure the Container with a layout manager which creates and manages the type of layout you
1393 <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
1394 layout manager is used which does nothing but render child components sequentially into the
1395 Container. No sizing or positioning will be performed in this situation.</b></p> <div class="mdetail-params">
\r
1396 <strong>Parameters:</strong>
\r
1397 <ul><li><code>container</code> : Element/HTMLElement/String<div class="sub-desc">(optional) The element this Component should be
1398 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>
1399 which this component will be inserted (defaults to appending to the end of the container)</div></li> </ul>
\r
1400 <strong>Returns:</strong>
\r
1402 <li><code>void</code></li>
\r
1408 <td class="msource"><a ext:cls="Ext.Component" ext:member="#render" href="output/Ext.Component.html#render">Component</a></td>
\r
1410 <tr class="method-row inherited expandable">
\r
1411 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1413 <a id="Ext.Button-resumeEvents"></a>
\r
1414 <b>resumeEvents</b>() : void <div class="mdesc">
\r
1415 <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
1416 <div class="long">
\r
1417 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
1418 <strong>Parameters:</strong>
\r
1419 <ul><li>None.</li> </ul>
\r
1420 <strong>Returns:</strong>
\r
1422 <li><code>void</code></li>
\r
1428 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td>
\r
1430 <tr class="method-row inherited alt expandable">
\r
1431 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1433 <a id="Ext.Button-setDisabled"></a>
\r
1434 <b>setDisabled</b>( <code>Boolean disabled</code> ) : void <div class="mdesc">
\r
1435 <div class="short">Convenience function for setting disabled/enabled by boolean.</div>
\r
1436 <div class="long">
\r
1437 Convenience function for setting disabled/enabled by boolean. <div class="mdetail-params">
\r
1438 <strong>Parameters:</strong>
\r
1439 <ul><li><code>disabled</code> : Boolean<div class="sub-desc"></div></li> </ul>
\r
1440 <strong>Returns:</strong>
\r
1442 <li><code>void</code></li>
\r
1448 <td class="msource"><a ext:cls="Ext.Component" ext:member="#setDisabled" href="output/Ext.Component.html#setDisabled">Component</a></td>
\r
1450 <tr class="method-row expandable">
\r
1451 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1453 <a id="Ext.Button-setHandler"></a>
\r
1454 <b>setHandler</b>( <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc">
\r
1455 <div class="short">Assigns this button's click handler</div>
\r
1456 <div class="long">
\r
1457 Assigns this button's click handler <div class="mdetail-params">
\r
1458 <strong>Parameters:</strong>
\r
1459 <ul><li><code>handler</code> : Function<div class="sub-desc">The function to call when the button is clicked</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) Scope for the function passed in</div></li> </ul>
\r
1460 <strong>Returns:</strong>
\r
1462 <li><code>void</code></li>
\r
1468 <td class="msource">Button</td>
\r
1470 <tr class="method-row alt expandable">
\r
1471 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1473 <a id="Ext.Button-setIconClass"></a>
\r
1474 <b>setIconClass</b>( <code>String cls</code> ) : void <div class="mdesc">
\r
1475 <div class="short">Sets the CSS class that provides a background image to use as the button's icon. This method also changes
1476 the value ...</div>
\r
1477 <div class="long">
\r
1478 Sets the CSS class that provides a background image to use as the button's icon. This method also changes
1479 the value of the <a ext:cls="iconCls" href="output/iconCls.html">iconCls</a> config internally. <div class="mdetail-params">
\r
1480 <strong>Parameters:</strong>
\r
1481 <ul><li><code>cls</code> : String<div class="sub-desc">The CSS class providing the icon image</div></li> </ul>
\r
1482 <strong>Returns:</strong>
\r
1484 <li><code>void</code></li>
\r
1490 <td class="msource">Button</td>
\r
1492 <tr class="method-row expandable">
\r
1493 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1495 <a id="Ext.Button-setText"></a>
\r
1496 <b>setText</b>( <code>String text</code> ) : void <div class="mdesc">
\r
1497 <div class="short">Sets this button's text</div>
\r
1498 <div class="long">
\r
1499 Sets this button's text <div class="mdetail-params">
\r
1500 <strong>Parameters:</strong>
\r
1501 <ul><li><code>text</code> : String<div class="sub-desc">The button text</div></li> </ul>
\r
1502 <strong>Returns:</strong>
\r
1504 <li><code>void</code></li>
\r
1510 <td class="msource">Button</td>
\r
1512 <tr class="method-row inherited alt expandable">
\r
1513 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1515 <a id="Ext.Button-setVisible"></a>
\r
1516 <b>setVisible</b>( <code>Boolean visible</code> ) : Ext.Component <div class="mdesc">
\r
1517 <div class="short">Convenience function to hide or show this component by boolean.</div>
\r
1518 <div class="long">
\r
1519 Convenience function to hide or show this component by boolean. <div class="mdetail-params">
\r
1520 <strong>Parameters:</strong>
\r
1521 <ul><li><code>visible</code> : Boolean<div class="sub-desc">True to show, false to hide</div></li> </ul>
\r
1522 <strong>Returns:</strong>
\r
1524 <li><code>Ext.Component</code><div class="sub-desc">this</div></li>
\r
1530 <td class="msource"><a ext:cls="Ext.Component" ext:member="#setVisible" href="output/Ext.Component.html#setVisible">Component</a></td>
\r
1532 <tr class="method-row inherited expandable">
\r
1533 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1535 <a id="Ext.Button-show"></a>
\r
1536 <b>show</b>() : Ext.Component <div class="mdesc">
\r
1537 <div class="short">Show this component.</div>
\r
1538 <div class="long">
\r
1539 Show this component. <div class="mdetail-params">
\r
1540 <strong>Parameters:</strong>
\r
1541 <ul><li>None.</li> </ul>
\r
1542 <strong>Returns:</strong>
\r
1544 <li><code>Ext.Component</code><div class="sub-desc">this</div></li>
\r
1550 <td class="msource"><a ext:cls="Ext.Component" ext:member="#show" href="output/Ext.Component.html#show">Component</a></td>
\r
1552 <tr class="method-row alt expandable">
\r
1553 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1555 <a id="Ext.Button-showMenu"></a>
\r
1556 <b>showMenu</b>() : void <div class="mdesc">
\r
1557 <div class="short">Show this button's menu (if it has one)</div>
\r
1558 <div class="long">
\r
1559 Show this button's menu (if it has one) <div class="mdetail-params">
\r
1560 <strong>Parameters:</strong>
\r
1561 <ul><li>None.</li> </ul>
\r
1562 <strong>Returns:</strong>
\r
1564 <li><code>void</code></li>
\r
1570 <td class="msource">Button</td>
\r
1572 <tr class="method-row inherited expandable">
\r
1573 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1575 <a id="Ext.Button-suspendEvents"></a>
\r
1576 <b>suspendEvents</b>() : void <div class="mdesc">
\r
1577 <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
1578 <div class="long">
\r
1579 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
1580 <strong>Parameters:</strong>
\r
1581 <ul><li>None.</li> </ul>
\r
1582 <strong>Returns:</strong>
\r
1584 <li><code>void</code></li>
\r
1590 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td>
\r
1592 <tr class="method-row alt expandable">
\r
1593 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1595 <a id="Ext.Button-toggle"></a>
\r
1596 <b>toggle</b>( <span class="optional" title="Optional">[<code>Boolean state</code>]</span> ) : void <div class="mdesc">
\r
1597 <div class="short">If a state it passed, it becomes the pressed state otherwise the current state is toggled.</div>
\r
1598 <div class="long">
\r
1599 If a state it passed, it becomes the pressed state otherwise the current state is toggled. <div class="mdetail-params">
\r
1600 <strong>Parameters:</strong>
\r
1601 <ul><li><code>state</code> : Boolean<div class="sub-desc">(optional) Force a particular state</div></li> </ul>
\r
1602 <strong>Returns:</strong>
\r
1604 <li><code>void</code></li>
\r
1610 <td class="msource">Button</td>
\r
1612 <tr class="method-row inherited expandable">
\r
1613 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1615 <a id="Ext.Button-un"></a>
\r
1616 <b>un</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc">
\r
1617 <div class="short">Removes a listener (shorthand for removeListener)</div>
\r
1618 <div class="long">
\r
1619 Removes a listener (shorthand for removeListener) <div class="mdetail-params">
\r
1620 <strong>Parameters:</strong>
\r
1621 <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
1622 <strong>Returns:</strong>
\r
1624 <li><code>void</code></li>
\r
1630 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td>
\r
1633 <a id="Ext.Button-events"></a>
1634 <h2>Public Events</h2>
1635 <table cellspacing="0" class="member-table">
1637 <th class="sig-header" colspan="2">Event</th>
1638 <th class="msource-header">Defined By</th>
1640 <tr class="event-row inherited expandable">
\r
1641 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1643 <a id="Ext.Button-beforedestroy"></a>
\r
1644 <b>beforedestroy</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
\r
1645 <div class="short">Fires before the component is destroyed. Return false to stop the destroy.</div>
\r
1646 <div class="long">
\r
1647 Fires before the component is destroyed. Return false to stop the destroy. <div class="mdetail-params">
\r
1648 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
1649 <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
\r
1654 <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-beforedestroy" href="output/Ext.Component.html#event-beforedestroy">Component</a></td>
\r
1656 <tr class="event-row inherited alt expandable">
\r
1657 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1659 <a id="Ext.Button-beforehide"></a>
\r
1660 <b>beforehide</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
\r
1661 <div class="short">Fires before the component is hidden. Return false to stop the hide.</div>
\r
1662 <div class="long">
\r
1663 Fires before the component is hidden. Return false to stop the hide. <div class="mdetail-params">
\r
1664 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
1665 <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
\r
1670 <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-beforehide" href="output/Ext.Component.html#event-beforehide">Component</a></td>
\r
1672 <tr class="event-row inherited expandable">
\r
1673 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1675 <a id="Ext.Button-beforerender"></a>
\r
1676 <b>beforerender</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
\r
1677 <div class="short">Fires before the component is rendered. Return false to stop the render.</div>
\r
1678 <div class="long">
\r
1679 Fires before the component is rendered. Return false to stop the render. <div class="mdetail-params">
\r
1680 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
1681 <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
\r
1686 <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-beforerender" href="output/Ext.Component.html#event-beforerender">Component</a></td>
\r
1688 <tr class="event-row inherited alt expandable">
\r
1689 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1691 <a id="Ext.Button-beforeshow"></a>
\r
1692 <b>beforeshow</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
\r
1693 <div class="short">Fires before the component is shown. Return false to stop the show.</div>
\r
1694 <div class="long">
\r
1695 Fires before the component is shown. Return false to stop the show. <div class="mdetail-params">
\r
1696 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
1697 <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
\r
1702 <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-beforeshow" href="output/Ext.Component.html#event-beforeshow">Component</a></td>
\r
1704 <tr class="event-row inherited expandable">
\r
1705 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1707 <a id="Ext.Button-beforestaterestore"></a>
\r
1708 <b>beforestaterestore</b> : ( <code>Ext.Component this</code>, <code>Object state</code> ) <div class="mdesc">
\r
1709 <div class="short">Fires before the state of the component is restored. Return false to stop the restore.</div>
\r
1710 <div class="long">
\r
1711 Fires before the state of the component is restored. Return false to stop the restore. <div class="mdetail-params">
\r
1712 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
1713 <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
1718 <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-beforestaterestore" href="output/Ext.Component.html#event-beforestaterestore">Component</a></td>
\r
1720 <tr class="event-row inherited alt expandable">
\r
1721 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1723 <a id="Ext.Button-beforestatesave"></a>
\r
1724 <b>beforestatesave</b> : ( <code>Ext.Component this</code>, <code>Object state</code> ) <div class="mdesc">
\r
1725 <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
1726 <div class="long">
\r
1727 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
1728 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
1729 <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
1734 <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-beforestatesave" href="output/Ext.Component.html#event-beforestatesave">Component</a></td>
\r
1736 <tr class="event-row expandable">
\r
1737 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1739 <a id="Ext.Button-click"></a>
\r
1740 <b>click</b> : ( <code>Button this</code>, <code>EventObject e</code> ) <div class="mdesc">
\r
1741 <div class="short">Fires when this button is clicked</div>
\r
1742 <div class="long">
\r
1743 Fires when this button is clicked <div class="mdetail-params">
\r
1744 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
1745 <ul><li><code>this</code> : Button<div class="sub-desc"></div></li><li><code>e</code> : EventObject<div class="sub-desc">The click event</div></li> </ul>
\r
1750 <td class="msource">Button</td>
\r
1752 <tr class="event-row inherited alt expandable">
\r
1753 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1755 <a id="Ext.Button-destroy"></a>
\r
1756 <b>destroy</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
\r
1757 <div class="short">Fires after the component is destroyed.</div>
\r
1758 <div class="long">
\r
1759 Fires after the component is destroyed. <div class="mdetail-params">
\r
1760 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
1761 <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
\r
1766 <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-destroy" href="output/Ext.Component.html#event-destroy">Component</a></td>
\r
1768 <tr class="event-row inherited expandable">
\r
1769 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1771 <a id="Ext.Button-disable"></a>
\r
1772 <b>disable</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
\r
1773 <div class="short">Fires after the component is disabled.</div>
\r
1774 <div class="long">
\r
1775 Fires after the component is disabled. <div class="mdetail-params">
\r
1776 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
1777 <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
\r
1782 <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-disable" href="output/Ext.Component.html#event-disable">Component</a></td>
\r
1784 <tr class="event-row inherited alt expandable">
\r
1785 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1787 <a id="Ext.Button-enable"></a>
\r
1788 <b>enable</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
\r
1789 <div class="short">Fires after the component is enabled.</div>
\r
1790 <div class="long">
\r
1791 Fires after the component is enabled. <div class="mdetail-params">
\r
1792 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
1793 <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
\r
1798 <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-enable" href="output/Ext.Component.html#event-enable">Component</a></td>
\r
1800 <tr class="event-row inherited expandable">
\r
1801 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1803 <a id="Ext.Button-hide"></a>
\r
1804 <b>hide</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
\r
1805 <div class="short">Fires after the component is hidden.</div>
\r
1806 <div class="long">
\r
1807 Fires after the component is hidden. <div class="mdetail-params">
\r
1808 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
1809 <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
\r
1814 <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-hide" href="output/Ext.Component.html#event-hide">Component</a></td>
\r
1816 <tr class="event-row alt expandable">
\r
1817 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1819 <a id="Ext.Button-menuhide"></a>
\r
1820 <b>menuhide</b> : ( <code>Button this</code>, <code>Menu menu</code> ) <div class="mdesc">
\r
1821 <div class="short">If this button has a menu, this event fires when it is hidden</div>
\r
1822 <div class="long">
\r
1823 If this button has a menu, this event fires when it is hidden <div class="mdetail-params">
\r
1824 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
1825 <ul><li><code>this</code> : Button<div class="sub-desc"></div></li><li><code>menu</code> : Menu<div class="sub-desc"></div></li> </ul>
\r
1830 <td class="msource">Button</td>
\r
1832 <tr class="event-row expandable">
\r
1833 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1835 <a id="Ext.Button-menushow"></a>
\r
1836 <b>menushow</b> : ( <code>Button this</code>, <code>Menu menu</code> ) <div class="mdesc">
\r
1837 <div class="short">If this button has a menu, this event fires when it is shown</div>
\r
1838 <div class="long">
\r
1839 If this button has a menu, this event fires when it is shown <div class="mdetail-params">
\r
1840 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
1841 <ul><li><code>this</code> : Button<div class="sub-desc"></div></li><li><code>menu</code> : Menu<div class="sub-desc"></div></li> </ul>
\r
1846 <td class="msource">Button</td>
\r
1848 <tr class="event-row alt expandable">
\r
1849 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1851 <a id="Ext.Button-menutriggerout"></a>
\r
1852 <b>menutriggerout</b> : ( <code>Button this</code>, <code>Menu menu</code>, <code>EventObject e</code> ) <div class="mdesc">
\r
1853 <div class="short">If this button has a menu, this event fires when the mouse leaves the menu triggering element</div>
\r
1854 <div class="long">
\r
1855 If this button has a menu, this event fires when the mouse leaves the menu triggering element <div class="mdetail-params">
\r
1856 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
1857 <ul><li><code>this</code> : Button<div class="sub-desc"></div></li><li><code>menu</code> : Menu<div class="sub-desc"></div></li><li><code>e</code> : EventObject<div class="sub-desc"></div></li> </ul>
\r
1862 <td class="msource">Button</td>
\r
1864 <tr class="event-row expandable">
\r
1865 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1867 <a id="Ext.Button-menutriggerover"></a>
\r
1868 <b>menutriggerover</b> : ( <code>Button this</code>, <code>Menu menu</code>, <code>EventObject e</code> ) <div class="mdesc">
\r
1869 <div class="short">If this button has a menu, this event fires when the mouse enters the menu triggering element</div>
\r
1870 <div class="long">
\r
1871 If this button has a menu, this event fires when the mouse enters the menu triggering element <div class="mdetail-params">
\r
1872 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
1873 <ul><li><code>this</code> : Button<div class="sub-desc"></div></li><li><code>menu</code> : Menu<div class="sub-desc"></div></li><li><code>e</code> : EventObject<div class="sub-desc"></div></li> </ul>
\r
1878 <td class="msource">Button</td>
\r
1880 <tr class="event-row alt expandable">
\r
1881 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1883 <a id="Ext.Button-mouseout"></a>
\r
1884 <b>mouseout</b> : ( <code>Button this</code>, <code>Event e</code> ) <div class="mdesc">
\r
1885 <div class="short">Fires when the mouse exits the button</div>
\r
1886 <div class="long">
\r
1887 Fires when the mouse exits the button <div class="mdetail-params">
\r
1888 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
1889 <ul><li><code>this</code> : Button<div class="sub-desc"></div></li><li><code>e</code> : Event<div class="sub-desc">The event object</div></li> </ul>
\r
1894 <td class="msource">Button</td>
\r
1896 <tr class="event-row expandable">
\r
1897 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1899 <a id="Ext.Button-mouseover"></a>
\r
1900 <b>mouseover</b> : ( <code>Button this</code>, <code>Event e</code> ) <div class="mdesc">
\r
1901 <div class="short">Fires when the mouse hovers over the button</div>
\r
1902 <div class="long">
\r
1903 Fires when the mouse hovers over the button <div class="mdetail-params">
\r
1904 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
1905 <ul><li><code>this</code> : Button<div class="sub-desc"></div></li><li><code>e</code> : Event<div class="sub-desc">The event object</div></li> </ul>
\r
1910 <td class="msource">Button</td>
\r
1912 <tr class="event-row inherited alt expandable">
\r
1913 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1915 <a id="Ext.Button-render"></a>
\r
1916 <b>render</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
\r
1917 <div class="short">Fires after the component is rendered.</div>
\r
1918 <div class="long">
\r
1919 Fires after the component is rendered. <div class="mdetail-params">
\r
1920 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
1921 <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
\r
1926 <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-render" href="output/Ext.Component.html#event-render">Component</a></td>
\r
1928 <tr class="event-row inherited expandable">
\r
1929 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1931 <a id="Ext.Button-show"></a>
\r
1932 <b>show</b> : ( <code>Ext.Component this</code> ) <div class="mdesc">
\r
1933 <div class="short">Fires after the component is shown.</div>
\r
1934 <div class="long">
\r
1935 Fires after the component is shown. <div class="mdetail-params">
\r
1936 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
1937 <ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li> </ul>
\r
1942 <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-show" href="output/Ext.Component.html#event-show">Component</a></td>
\r
1944 <tr class="event-row inherited alt expandable">
\r
1945 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1947 <a id="Ext.Button-staterestore"></a>
\r
1948 <b>staterestore</b> : ( <code>Ext.Component this</code>, <code>Object state</code> ) <div class="mdesc">
\r
1949 <div class="short">Fires after the state of the component is restored.</div>
\r
1950 <div class="long">
\r
1951 Fires after the state of the component is restored. <div class="mdetail-params">
\r
1952 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
1953 <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
1958 <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-staterestore" href="output/Ext.Component.html#event-staterestore">Component</a></td>
\r
1960 <tr class="event-row inherited expandable">
\r
1961 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1963 <a id="Ext.Button-statesave"></a>
\r
1964 <b>statesave</b> : ( <code>Ext.Component this</code>, <code>Object state</code> ) <div class="mdesc">
\r
1965 <div class="short">Fires after the state of the component is saved to the configured state provider.</div>
\r
1966 <div class="long">
\r
1967 Fires after the state of the component is saved to the configured state provider. <div class="mdetail-params">
\r
1968 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
1969 <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
1974 <td class="msource"><a ext:cls="Ext.Component" ext:member="#event-statesave" href="output/Ext.Component.html#event-statesave">Component</a></td>
\r
1976 <tr class="event-row alt expandable">
\r
1977 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
1979 <a id="Ext.Button-toggle"></a>
\r
1980 <b>toggle</b> : ( <code>Button this</code>, <code>Boolean pressed</code> ) <div class="mdesc">
\r
1981 <div class="short">Fires when the "pressed" state of this button changes (only if enableToggle = true)</div>
\r
1982 <div class="long">
\r
1983 Fires when the "pressed" state of this button changes (only if enableToggle = true) <div class="mdetail-params">
\r
1984 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
1985 <ul><li><code>this</code> : Button<div class="sub-desc"></div></li><li><code>pressed</code> : Boolean<div class="sub-desc"></div></li> </ul>
\r
1990 <td class="msource">Button</td>
\r