1
<div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.CycleButton-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a> <a class="inner-link" href="#Ext.CycleButton-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a> <a class="inner-link" href="#Ext.CycleButton-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a> <a class="inner-link" href="#Ext.CycleButton-configs"><img src="resources/images/default/s.gif" class="item-icon icon-config">Config Options</a> <a class="bookmark" href="../docs/?class=Ext.CycleButton"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a> </div><div class="inheritance res-block"><pre class="res-block-inner"><a href="output/Ext.util.Observable.html" ext:member="" ext:cls="Ext.util.Observable">Observable</a> <img src="resources/elbow-end.gif"><a href="output/Ext.Component.html" ext:member="" ext:cls="Ext.Component">Component</a> <img src="resources/elbow-end.gif"><a href="output/Ext.BoxComponent.html" ext:member="" ext:cls="Ext.BoxComponent">BoxComponent</a> <img src="resources/elbow-end.gif"><a href="output/Ext.Button.html" ext:member="" ext:cls="Ext.Button">Button</a> <img src="resources/elbow-end.gif"><a href="output/Ext.SplitButton.html" ext:member="" ext:cls="Ext.SplitButton">SplitButton</a> <img src="resources/elbow-end.gif">CycleButton</pre></div><h1>Class <a href="source/CycleButton.html#cls-Ext.CycleButton">Ext.CycleButton</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext</td></tr><tr><td class="label">Defined In:</td><td class="hd-info">CycleButton.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/CycleButton.html#cls-Ext.CycleButton">CycleButton</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.SplitButton.html" ext:cls="Ext.SplitButton" ext:member="">SplitButton</a></td></tr><tr><td class="label">xtype:</td><td class="hd-info">cycle</td></tr></table><div class="description">A specialized SplitButton that contains a menu of <a href="output/Ext.menu.CheckItem.html" ext:cls="Ext.menu.CheckItem">Ext.menu.CheckItem</a> elements. The button automatically
2
cycles through each menu item on click, raising the button's <a href="output/Ext.CycleButton.html#Ext.CycleButton-change" ext:member="change" ext:cls="Ext.CycleButton">change</a> event (or calling the button's
3
<a href="output/Ext.CycleButton.html#Ext.CycleButton-changeHandler" ext:member="changeHandler" ext:cls="Ext.CycleButton">changeHandler</a> function, if supplied) for the active menu item. Clicking on the arrow section of the
4
button displays the dropdown menu just like a normal SplitButton. Example usage:
5
<pre><code><b>var</b> btn = <b>new</b> Ext.CycleButton({
7
prependText: <em>'View as '</em>,
9
text:<em>'text only'</em>,
10
iconCls:<em>'view-text'</em>,
14
iconCls:<em>'view-html'</em>
16
changeHandler:<b>function</b>(btn, item){
17
Ext.Msg.alert(<em>'Change View'</em>, item.text);
19
});</code></pre></div><div class="hr"></div><a id="Ext.CycleButton-configs"></a><h2>Config Options</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Config Options</th><th class="msource-header">Defined By</th></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-allowDepress"></a><b><a href="source/Button.html#cfg-Ext.Button-allowDepress">allowDepress</a></b> : Boolean<div class="mdesc">False to not allow a pressed Button to be depressed (defaults to undefined). Only valid when <a href="output/Ext.Button.html#Ext.Button-enableToggle" ext:member="enableToggle" ext:cls="Ext.Button">enableToggle</a> is true.</div></td><td class="msource"><a href="output/Ext.Button.html#allowDepress" ext:member="#allowDepress" ext:cls="Ext.Button">Button</a></td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-allowDomMove"></a><b><a href="source/Component.html#cfg-Ext.Component-allowDomMove">allowDomMove</a></b> : Boolean<div class="mdesc">Whether the component can move the Dom node when rendering (defaults to true).</div></td><td class="msource"><a href="output/Ext.Component.html#allowDomMove" ext:member="#allowDomMove" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-anchor"></a><b><a href="source/Component.html#cfg-Ext.Component-anchor">anchor</a></b> : String<div class="mdesc"><div class="short">Note: this config is only used when this Component is rendered
20
by a Container which has been configured to use an Anc...</div><div class="long"><p><b>Note</b>: this config is only used when this Component is rendered
21
by a Container which has been configured to use an <b><a href="output/Ext.layout.AnchorLayout.html" ext:cls="Ext.layout.AnchorLayout">AnchorLayout</a></b>
22
based layout manager, for example:<div class="mdetail-params"><ul>
23
<li><a href="output/Ext.form.FormPanel.html" ext:cls="Ext.form.FormPanel">Ext.form.FormPanel</a></li>
24
<li>specifying <code>layout: <em>'anchor'</em> <i>// or <em>'form'</em>, or <em>'absolute'</em></i></code></li>
26
<p>See <a href="output/Ext.layout.AnchorLayout.html" ext:cls="Ext.layout.AnchorLayout">Ext.layout.AnchorLayout</a>.<a href="output/Ext.layout.AnchorLayout.html#Ext.layout.AnchorLayout-anchor" ext:member="anchor" ext:cls="Ext.layout.AnchorLayout">anchor</a> also.</p></div></div></td><td class="msource"><a href="output/Ext.Component.html#anchor" ext:member="#anchor" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-applyTo"></a><b><a href="source/Component.html#cfg-Ext.Component-applyTo">applyTo</a></b> : Mixed<div class="mdesc"><div class="short">Specify the id of the element, a DOM element or an existing Element corresponding to a DIV
27
that is already present in...</div><div class="long"><p>Specify the id of the element, a DOM element or an existing Element corresponding to a DIV
28
that is already present in the document that specifies some structural markup for this
29
component.</p><div><ul>
30
<li><b>Description</b> : <ul>
31
<div class="sub-desc">When <tt>applyTo</tt> is used, constituent parts of the component can also be specified
32
by id or CSS class name within the main element, and the component being created may attempt
33
to create its subcomponents from that markup if applicable.</div>
35
<li><b>Notes</b> : <ul>
36
<div class="sub-desc">When using this config, a call to render() is not required.</div>
37
<div class="sub-desc">If applyTo is specified, any value passed for <a href="output/Ext.Component.html#Ext.Component-renderTo" ext:member="renderTo" ext:cls="Ext.Component">renderTo</a> will be ignored and the target
38
element's parent node will automatically be used as the component's container.</div>
40
</ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#applyTo" ext:member="#applyTo" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-arrowAlign"></a><b><a href="source/Button.html#cfg-Ext.Button-arrowAlign">arrowAlign</a></b> : String<div class="mdesc"><div class="short">(Optional) The side of the Button box to render the arrow if the button has an associated menu.
41
Two values are allowe...</div><div class="long"><p>(Optional) The side of the Button box to render the arrow if the button has an associated <a href="output/Ext.Button.html#Ext.Button-menu" ext:member="menu" ext:cls="Ext.Button">menu</a>.
42
Two values are allowed:</p>
43
<ul class="mdetail-params">
44
<li>'right'<div class="sub-desc"></div></li>
45
<li>'bottom'<div class="sub-desc"></div></li>
47
<p>Defaults to <b><tt>'right'</tt></b>.</p></div></div></td><td class="msource"><a href="output/Ext.Button.html#arrowAlign" ext:member="#arrowAlign" ext:cls="Ext.Button">Button</a></td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.SplitButton-arrowHandler"></a><b><a href="source/SplitButton.html#cfg-Ext.SplitButton-arrowHandler">arrowHandler</a></b> : Function<div class="mdesc">A function called when the arrow button is clicked (can be used instead of click event)</div></td><td class="msource"><a href="output/Ext.SplitButton.html#arrowHandler" ext:member="#arrowHandler" ext:cls="Ext.SplitButton">SplitButton</a></td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.SplitButton-arrowTooltip"></a><b><a href="source/SplitButton.html#cfg-Ext.SplitButton-arrowTooltip">arrowTooltip</a></b> : String<div class="mdesc">The title attribute of the arrow</div></td><td class="msource"><a href="output/Ext.SplitButton.html#arrowTooltip" ext:member="#arrowTooltip" ext:cls="Ext.SplitButton">SplitButton</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-autoHeight"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-autoHeight">autoHeight</a></b> : Boolean<div class="mdesc"><div class="short">True to use height:'auto', false to use fixed height (or allow it to be managed by its parent
48
Container's layout mana...</div><div class="long"><p>True to use height:'auto', false to use fixed height (or allow it to be managed by its parent
49
Container's <a href="output/Ext.Container.html#Ext.Container-layout" ext:member="layout" ext:cls="Ext.Container">layout manager</a>. Defaults to false.</p>
50
<p><b>Note</b>: Although many components inherit this config option, not all will
51
function as expected with a height of 'auto'. Setting autoHeight:true means that the
52
browser will manage height based on the element's contents, and that Ext will not manage it at all.</p>
53
<p>If the <i>browser</i> is managing the height, be aware that resizes performed by the browser in response
54
to changes within the structure of the Component cannot be detected. Therefore changes to the height might
55
result in elements needing to be synchronized with the new height. Example:</p><pre><code><b>var</b> w = <b>new</b> Ext.Window({
56
title: <em>'Window'</em>,
60
title: <em>'Collapse Me'</em>,
65
beforecollapse: <b>function</b>() {
68
beforeexpand: <b>function</b>() {
71
collapse: <b>function</b>() {
74
expand: <b>function</b>() {
79
}).show();</code></pre></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#autoHeight" ext:member="#autoHeight" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-autoShow"></a><b><a href="source/Component.html#cfg-Ext.Component-autoShow">autoShow</a></b> : Boolean<div class="mdesc"><div class="short">True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove
80
them on render...</div><div class="long">True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove
81
them on render (defaults to false).</div></div></td><td class="msource"><a href="output/Ext.Component.html#autoShow" ext:member="#autoShow" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-autoWidth"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-autoWidth">autoWidth</a></b> : Boolean<div class="mdesc"><div class="short">True to use width:'auto', false to use fixed width (or allow it to be managed by its parent
82
Container's layout manage...</div><div class="long"><p>True to use width:'auto', false to use fixed width (or allow it to be managed by its parent
83
Container's <a href="output/Ext.Container.html#Ext.Container-layout" ext:member="layout" ext:cls="Ext.Container">layout manager</a>. Defaults to false.</p>
84
<p><b>Note</b>: Although many components inherit this config option, not all will
85
function as expected with a width of 'auto'. Setting autoWidth:true means that the
86
browser will manage width based on the element's contents, and that Ext will not manage it at all.</p>
87
<p>If the <i>browser</i> is managing the width, be aware that resizes performed by the browser in response
88
to changes within the structure of the Component cannot be detected. Therefore changes to the width might
89
result in elements needing to be synchronized with the new width. For example, where the target element is:</p><pre><code><div id=<em>'grid-container'</em> style=<em>'margin-left:25%;width:50%'</em>></div></code></pre>
90
A Panel rendered into that target element must listen for browser window resize in order to relay its
91
child items when the browser changes its width:<pre><code><b>var</b> myPanel = <b>new</b> Ext.Panel({
92
renderTo: <em>'grid-container'</em>,
93
monitorResize: true, <i>// relay on browser resize</i>
94
title: <em>'Panel'</em>,
97
layout: <em>'hbox'</em>,
99
align: <em>'stretch'</em>
105
title: <em>'Box 1'</em>,
107
title: <em>'Box 2'</em>
109
title: <em>'Box 3'</em>
111
});</code></pre></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#autoWidth" ext:member="#autoWidth" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-buttonSelector"></a><b><a href="source/Button.html#cfg-Ext.Button-buttonSelector">buttonSelector</a></b> : String<div class="mdesc"><div class="short">(Optional) A DomQuery selector which is used to extract the active, clickable element from the
112
DOM structure created....</div><div class="long"><p>(Optional) A <a href="output/Ext.DomQuery.html" ext:cls="Ext.DomQuery">DomQuery</a> selector which is used to extract the active, clickable element from the
113
DOM structure created.</p>
114
<p>When a custom <a href="output/Ext.Button.html#Ext.Button-template" ext:member="template" ext:cls="Ext.Button">template</a> is used, you must ensure that this selector results in the selection of
115
a focussable element.</p>
116
<p>Defaults to <b><tt>'button:first-child'</tt></b>.</p></div></div></td><td class="msource"><a href="output/Ext.Button.html#buttonSelector" ext:member="#buttonSelector" ext:cls="Ext.Button">Button</a></td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.CycleButton-changeHandler"></a><b><a href="source/CycleButton.html#cfg-Ext.CycleButton-changeHandler">changeHandler</a></b> : Function<div class="mdesc"><div class="short">A callback function that will be invoked each time the active menu
117
item in the button's menu has changed. If this c...</div><div class="long">A callback function that will be invoked each time the active menu
118
item in the button's menu has changed. If this callback is not supplied, the SplitButton will instead
119
fire the <a href="output/Ext.CycleButton.html#Ext.CycleButton-change" ext:member="change" ext:cls="Ext.CycleButton">change</a> event on active item change. The changeHandler function will be called with the
120
following argument list: (SplitButton this, Ext.menu.CheckItem item)</div></div></td><td class="msource">CycleButton</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-clearCls"></a><b><a href="source/Component.html#cfg-Ext.Component-clearCls">clearCls</a></b> : String<div class="mdesc"><div class="short">The CSS class used to to apply to the special clearing div rendered
121
directly after each form field wrapper to provide...</div><div class="long"><p>The CSS class used to to apply to the special clearing div rendered
122
directly after each form field wrapper to provide field clearing (defaults to
123
<tt>'x-form-clear-left'</tt>).</p>
124
<br><p><b>Note</b>: this config is only used when this Component is rendered by a Container
125
which has been configured to use the <b><a href="output/Ext.layout.FormLayout.html" ext:cls="Ext.layout.FormLayout">FormLayout</a></b> layout
126
manager (e.g. <a href="output/Ext.form.FormPanel.html" ext:cls="Ext.form.FormPanel">Ext.form.FormPanel</a> or specifying <tt>layout:'form'</tt>) and either a
127
<tt><a href="output/Ext.Component.html#Ext.Component-fieldLabel" ext:member="fieldLabel" ext:cls="Ext.Component">fieldLabel</a></tt> is specified or <tt>isFormField=true</tt> is specified.</p><br>
128
<p>See <a href="output/Ext.layout.FormLayout.html" ext:cls="Ext.layout.FormLayout">Ext.layout.FormLayout</a>.<a href="output/Ext.layout.FormLayout.html#Ext.layout.FormLayout-fieldTpl" ext:member="fieldTpl" ext:cls="Ext.layout.FormLayout">fieldTpl</a> also.</p></div></div></td><td class="msource"><a href="output/Ext.Component.html#clearCls" ext:member="#clearCls" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-clickEvent"></a><b><a href="source/Button.html#cfg-Ext.Button-clickEvent">clickEvent</a></b> : String<div class="mdesc">The type of event to map to the button's event handler (defaults to 'click')</div></td><td class="msource"><a href="output/Ext.Button.html#clickEvent" ext:member="#clickEvent" ext:cls="Ext.Button">Button</a></td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-cls"></a><b><a href="source/Button.html#cfg-Ext.Button-cls">cls</a></b> : String<div class="mdesc">A CSS class string to apply to the button's main element.</div></td><td class="msource"><a href="output/Ext.Button.html#cls" ext:member="#cls" ext:cls="Ext.Button">Button</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-ctCls"></a><b><a href="source/Component.html#cfg-Ext.Component-ctCls">ctCls</a></b> : String<div class="mdesc"><div class="short">An optional extra CSS class that will be added to this component's container. This can be useful for
129
adding customize...</div><div class="long"><p>An optional extra CSS class that will be added to this component's container. This can be useful for
130
adding customized styles to the container or any of its children using standard CSS rules. See
131
<a href="output/Ext.layout.ContainerLayout.html" ext:cls="Ext.layout.ContainerLayout">Ext.layout.ContainerLayout</a>.<a href="output/Ext.layout.ContainerLayout.html#Ext.layout.ContainerLayout-extraCls" ext:member="extraCls" ext:cls="Ext.layout.ContainerLayout">extraCls</a> also.</p>
132
<p><b>Note</b>: <tt>ctCls</tt> defaults to <tt>''</tt> except for the following class
133
which assigns a value by default:
134
<div class="mdetail-params"><ul>
135
<li><a href="output/Ext.layout.Box.html" ext:cls="Ext.layout.Box">Box Layout</a> : <tt>'x-box-layout-ct'</tt></li>
137
To configure the above Class with an extra CSS class append to the default. For example,
138
for BoxLayout (Hbox and Vbox):<pre><code>ctCls: <em>'x-box-layout-ct custom-class'</em></code></pre>
139
</p></div></div></td><td class="msource"><a href="output/Ext.Component.html#ctCls" ext:member="#ctCls" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-disabled"></a><b><a href="source/Button.html#cfg-Ext.Button-disabled">disabled</a></b> : Boolean<div class="mdesc">True to start disabled (defaults to false)</div></td><td class="msource"><a href="output/Ext.Button.html#disabled" ext:member="#disabled" ext:cls="Ext.Button">Button</a></td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-disabledClass"></a><b><a href="source/Component.html#cfg-Ext.Component-disabledClass">disabledClass</a></b> : String<div class="mdesc">CSS class added to the component when it is disabled (defaults to 'x-item-disabled').</div></td><td class="msource"><a href="output/Ext.Component.html#disabledClass" ext:member="#disabledClass" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-enableToggle"></a><b><a href="source/Button.html#cfg-Ext.Button-enableToggle">enableToggle</a></b> : Boolean<div class="mdesc">True to enable pressed/not pressed toggling (defaults to false)</div></td><td class="msource"><a href="output/Ext.Button.html#enableToggle" ext:member="#enableToggle" ext:cls="Ext.Button">Button</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-fieldLabel"></a><b><a href="source/Component.html#cfg-Ext.Component-fieldLabel">fieldLabel</a></b> : String<div class="mdesc"><div class="short">The label text to display next to this Component (defaults to '').
140
Note: this config is only used when this Component...</div><div class="long"><p>The label text to display next to this Component (defaults to '').</p>
141
<br><p><b>Note</b>: this config is only used when this Component is rendered by a Container which
142
has been configured to use the <b><a href="output/Ext.layout.FormLayout.html" ext:cls="Ext.layout.FormLayout">FormLayout</a></b> layout manager (e.g.
143
<a href="output/Ext.form.FormPanel.html" ext:cls="Ext.form.FormPanel">Ext.form.FormPanel</a> or specifying <tt>layout:'form'</tt>).</p><br>
144
<p>Also see <tt><a href="output/Ext.Component.html#Ext.Component-hideLabel" ext:member="hideLabel" ext:cls="Ext.Component">hideLabel</a></tt> and
145
<a href="output/Ext.layout.FormLayout.html" ext:cls="Ext.layout.FormLayout">Ext.layout.FormLayout</a>.<a href="output/Ext.layout.FormLayout.html#Ext.layout.FormLayout-fieldTpl" ext:member="fieldTpl" ext:cls="Ext.layout.FormLayout">fieldTpl</a>.</p>
146
Example use:<pre><code><b>new</b> Ext.FormPanel({
148
renderTo: Ext.getBody(),
150
xtype: <em>'textfield'</em>,
151
fieldLabel: <em>'Name'</em>
153
});</code></pre></div></div></td><td class="msource"><a href="output/Ext.Component.html#fieldLabel" ext:member="#fieldLabel" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.CycleButton-forceIcon"></a><b><a href="source/CycleButton.html#cfg-Ext.CycleButton-forceIcon">forceIcon</a></b> : String<div class="mdesc"><div class="short">A css class which sets an image to be used as the static icon for this button. This
154
icon will always be displayed r...</div><div class="long">A css class which sets an image to be used as the static icon for this button. This
155
icon will always be displayed regardless of which item is selected in the dropdown list. This overrides the
156
default behavior of changing the button's icon to match the selected item's icon on change.</div></div></td><td class="msource">CycleButton</td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-handleMouseEvents"></a><b><a href="source/Button.html#cfg-Ext.Button-handleMouseEvents">handleMouseEvents</a></b> : Boolean<div class="mdesc">False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)</div></td><td class="msource"><a href="output/Ext.Button.html#handleMouseEvents" ext:member="#handleMouseEvents" ext:cls="Ext.Button">Button</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-handler"></a><b><a href="source/Button.html#cfg-Ext.Button-handler">handler</a></b> : Function<div class="mdesc"><div class="short">A function called when the button is clicked (can be used instead of click event).
157
The handler is passed the followin...</div><div class="long">A function called when the button is clicked (can be used instead of click event).
158
The handler is passed the following parameters:<div class="mdetail-params"><ul>
159
<li><code>b</code> : Button<div class="sub-desc">This Button.</div></li>
160
<li><code>e</code> : EventObject<div class="sub-desc">The click event.</div></li>
161
</ul></div></div></div></td><td class="msource"><a href="output/Ext.Button.html#handler" ext:member="#handler" ext:cls="Ext.Button">Button</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-height"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-height">height</a></b> : Number<div class="mdesc"><div class="short">The height of this component in pixels (defaults to auto).
162
Note to express this dimension as a percentage or offset s...</div><div class="long">The height of this component in pixels (defaults to auto).
163
<b>Note</b> to express this dimension as a percentage or offset see <a href="output/Ext.Component.html#Ext.Component-anchor" ext:member="anchor" ext:cls="Ext.Component">Ext.Component.anchor</a>.</div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#height" ext:member="#height" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-hidden"></a><b><a href="source/Button.html#cfg-Ext.Button-hidden">hidden</a></b> : Boolean<div class="mdesc">True to start hidden (defaults to false)</div></td><td class="msource"><a href="output/Ext.Button.html#hidden" ext:member="#hidden" ext:cls="Ext.Button">Button</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-hideLabel"></a><b><a href="source/Component.html#cfg-Ext.Component-hideLabel">hideLabel</a></b> : Boolean<div class="mdesc"><div class="short">true to completely hide the label element
164
(label and separator). Defaults to false.
165
By default, even if you do not sp...</div><div class="long"><p><tt>true</tt> to completely hide the label element
166
(<a href="output/Ext.Component.html#Ext.Component-fieldLabel" ext:member="fieldLabel" ext:cls="Ext.Component">label</a> and <a href="output/Ext.Component.html#Ext.Component-labelSeparator" ext:member="labelSeparator" ext:cls="Ext.Component">separator</a>). Defaults to <tt>false</tt>.
167
By default, even if you do not specify a <tt><a href="output/Ext.Component.html#Ext.Component-fieldLabel" ext:member="fieldLabel" ext:cls="Ext.Component">fieldLabel</a></tt> the space will still be
168
reserved so that the field will line up with other fields that do have labels.
169
Setting this to <tt>true</tt> will cause the field to not reserve that space.</p>
170
<br><p><b>Note</b>: see the note for <tt><a href="output/Ext.Component.html#Ext.Component-clearCls" ext:member="clearCls" ext:cls="Ext.Component">clearCls</a></tt>.</p><br>
171
Example use:<pre><code><b>new</b> Ext.FormPanel({
173
renderTo: Ext.getBody(),
175
xtype: <em>'textfield'</em>
178
});</code></pre></div></div></td><td class="msource"><a href="output/Ext.Component.html#hideLabel" ext:member="#hideLabel" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-hideMode"></a><b><a href="source/Component.html#cfg-Ext.Component-hideMode">hideMode</a></b> : String<div class="mdesc"><div class="short">How this component should be hidden. Supported values are 'visibility'
179
(css visibility), 'offsets' (negative offset p...</div><div class="long"><p>How this component should be hidden. Supported values are <tt>'visibility'</tt>
180
(css visibility), <tt>'offsets'</tt> (negative offset position) and <tt>'display'</tt>
182
<br><p><b>Note</b>: the default of <tt>'display'</tt> is generally preferred
183
since items are automatically laid out when they are first shown (no sizing
184
is done while hidden).</p></div></div></td><td class="msource"><a href="output/Ext.Component.html#hideMode" ext:member="#hideMode" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-hideParent"></a><b><a href="source/Component.html#cfg-Ext.Component-hideParent">hideParent</a></b> : Boolean<div class="mdesc"><div class="short">True to hide and show the component's container when hide/show is called on the component, false to hide
185
and show the...</div><div class="long">True to hide and show the component's container when hide/show is called on the component, false to hide
186
and show the component itself (defaults to false). For example, this can be used as a shortcut for a hide
187
button on a window by setting hide:true on the button when adding it to its parent container.</div></div></td><td class="msource"><a href="output/Ext.Component.html#hideParent" ext:member="#hideParent" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-icon"></a><b><a href="source/Button.html#cfg-Ext.Button-icon">icon</a></b> : String<div class="mdesc"><div class="short">The path to an image to display in the button (the image will be set as the background-image
188
CSS property of the butt...</div><div class="long">The path to an image to display in the button (the image will be set as the background-image
189
CSS property of the button by default, so if you want a mixed icon/text button, set cls:'x-btn-text-icon')</div></div></td><td class="msource"><a href="output/Ext.Button.html#icon" ext:member="#icon" ext:cls="Ext.Button">Button</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-iconAlign"></a><b><a href="source/Button.html#cfg-Ext.Button-iconAlign">iconAlign</a></b> : String<div class="mdesc"><div class="short">(Optional) The side of the Button box to render the icon. Four values are allowed:
190
<ul class="mdetail-params">
191
'top'<...</div><div class="long"><p>(Optional) The side of the Button box to render the icon. Four values are allowed:</p>
192
<ul class="mdetail-params">
193
<li>'top'<div class="sub-desc"></div></li>
194
<li>'right'<div class="sub-desc"></div></li>
195
<li>'bottom'<div class="sub-desc"></div></li>
196
<li>'left'<div class="sub-desc"></div></li>
198
<p>Defaults to <b><tt>'left'</tt></b>.</p></div></div></td><td class="msource"><a href="output/Ext.Button.html#iconAlign" ext:member="#iconAlign" ext:cls="Ext.Button">Button</a></td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-iconCls"></a><b><a href="source/Button.html#cfg-Ext.Button-iconCls">iconCls</a></b> : String<div class="mdesc">A css class which sets a background image to be used as the icon for this button</div></td><td class="msource"><a href="output/Ext.Button.html#iconCls" ext:member="#iconCls" ext:cls="Ext.Button">Button</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-id"></a><b><a href="source/Component.html#cfg-Ext.Component-id">id</a></b> : String<div class="mdesc"><div class="short">The unique id of this component (defaults to an auto-assigned id).
199
You should assign an id if you need to be able to ...</div><div class="long"><p>The <b>unique</b> id of this component (defaults to an <a href="output/Ext.Component.html#Ext.Component-getId" ext:member="getId" ext:cls="Ext.Component">auto-assigned id</a>).
200
You should assign an id if you need to be able to access the component later and you do
201
not have an object reference available (e.g., using <a href="output/Ext.html" ext:cls="Ext">Ext</a>.<a href="output/Ext.html#Ext-getCmp" ext:member="getCmp" ext:cls="Ext">getCmp</a>).</p>
202
<p>Note that this id will also be used as the element id for the containing HTML element
203
that is rendered to the page for this component. This allows you to write id-based CSS
204
rules to style the specific instance of this component uniquely, and also to select
205
sub-elements using this component's id as the parent.</p>
206
<p><b>Note</b>: to avoid complications imposed by a unique <tt>id</tt> also see
207
<code><a href="output/Ext.Component.html#Ext.Component-itemId" ext:member="itemId" ext:cls="Ext.Component">itemId</a></code> and <code><a href="output/Ext.Component.html#Ext.Component-ref" ext:member="ref" ext:cls="Ext.Component">ref</a></code>.</p>
208
<p><b>Note</b>: to access the container of an item see <code><a href="output/Ext.Component.html#Ext.Component-ownerCt" ext:member="ownerCt" ext:cls="Ext.Component">ownerCt</a></code>.</p></div></div></td><td class="msource"><a href="output/Ext.Component.html#id" ext:member="#id" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-itemCls"></a><b><a href="source/Component.html#cfg-Ext.Component-itemCls">itemCls</a></b> : String<div class="mdesc"><div class="short">An additional CSS class to apply to the div wrapping the form item
209
element of this field. If supplied, itemCls at th...</div><div class="long"><p>An additional CSS class to apply to the div wrapping the form item
210
element of this field. If supplied, <tt>itemCls</tt> at the <b>field</b> level will override
211
the default <tt>itemCls</tt> supplied at the <b>container</b> level. The value specified for
212
<tt>itemCls</tt> will be added to the default class (<tt>'x-form-item'</tt>).</p>
213
<p>Since it is applied to the item wrapper (see
214
<a href="output/Ext.layout.FormLayout.html" ext:cls="Ext.layout.FormLayout">Ext.layout.FormLayout</a>.<a href="output/Ext.layout.FormLayout.html#Ext.layout.FormLayout-fieldTpl" ext:member="fieldTpl" ext:cls="Ext.layout.FormLayout">fieldTpl</a>), it allows
215
you to write standard CSS rules that can apply to the field, the label (if specified), or
216
any other element within the markup for the field.</p>
217
<br><p><b>Note</b>: see the note for <tt><a href="output/Ext.Component.html#Ext.Component-fieldLabel" ext:member="fieldLabel" ext:cls="Ext.Component">fieldLabel</a></tt>.</p><br>
218
Example use:<pre><code><i>// Apply a style to the field<em>'s <b>label</b>:</i>
220
.required .x-form-item-<b>label</b> {font-weight:bold;color:red;}
223
<b>new</b> Ext.FormPanel({
225
renderTo: Ext.getBody(),
227
xtype: '</em>textfield<em>',
228
fieldLabel: '</em>Name<em>',
229
itemCls: '</em>required<em>' <i>//this <b>label</b> will be styled</i>
231
xtype: '</em>textfield<em>',
232
fieldLabel: '</em>Favorite Color<em>'
234
});</code></pre></div></div></td><td class="msource"><a href="output/Ext.Component.html#itemCls" ext:member="#itemCls" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-itemId"></a><b><a href="source/Component.html#cfg-Ext.Component-itemId">itemId</a></b> : String<div class="mdesc"><div class="short">An itemId can be used as an alternative way to get a reference to a component
235
when no object reference is available. ...</div><div class="long"><p>An <tt>itemId</tt> can be used as an alternative way to get a reference to a component
236
when no object reference is available. Instead of using an <code><a href="output/Ext.Component.html#Ext.Component-id" ext:member="id" ext:cls="Ext.Component">id</a></code> with
237
<a href="output/Ext.html" ext:cls="Ext">Ext</a>.<a href="output/Ext.html#Ext-getCmp" ext:member="getCmp" ext:cls="Ext">getCmp</a>, use <code>itemId</code> with
238
<a href="output/Ext.Container.html" ext:cls="Ext.Container">Ext.Container</a>.<a href="output/Ext.Container.html#Ext.Container-getComponent" ext:member="getComponent" ext:cls="Ext.Container">getComponent</a> which will retrieve
239
<code>itemId</code>'s or <tt><a href="output/Ext.Component.html#Ext.Component-id" ext:member="id" ext:cls="Ext.Component">id</a></tt>'s. Since <code>itemId</code>'s are an index to the
240
container's internal MixedCollection, the <code>itemId</code> is scoped locally to the container --
241
avoiding potential conflicts with <a href="output/Ext.ComponentMgr.html" ext:cls="Ext.ComponentMgr">Ext.ComponentMgr</a> which requires a <b>unique</b>
242
<code><a href="output/Ext.Component.html#Ext.Component-id" ext:member="id" ext:cls="Ext.Component">id</a></code>.</p>
243
<pre><code><b>var</b> c = <b>new</b> Ext.Panel({ <i>//</i>
244
<a href="output/Ext.BoxComponent.html#Ext.BoxComponent-height" ext:member="height" ext:cls="Ext.BoxComponent">height</a>: 300,
245
<a href="output/Ext.Component.html#Ext.Component-renderTo" ext:member="renderTo" ext:cls="Ext.Component">renderTo</a>: document.body,
246
<a href="output/Ext.Container.html#Ext.Container-layout" ext:member="layout" ext:cls="Ext.Container">layout</a>: <em>'auto'</em>,
247
<a href="output/Ext.Container.html#Ext.Container-items" ext:member="items" ext:cls="Ext.Container">items</a>: [
249
itemId: <em>'p1'</em>,
250
<a href="output/Ext.Panel.html#Ext.Panel-title" ext:member="title" ext:cls="Ext.Panel">title</a>: <em>'Panel 1'</em>,
251
<a href="output/Ext.BoxComponent.html#Ext.BoxComponent-height" ext:member="height" ext:cls="Ext.BoxComponent">height</a>: 150
254
itemId: <em>'p2'</em>,
255
<a href="output/Ext.Panel.html#Ext.Panel-title" ext:member="title" ext:cls="Ext.Panel">title</a>: <em>'Panel 2'</em>,
256
<a href="output/Ext.BoxComponent.html#Ext.BoxComponent-height" ext:member="height" ext:cls="Ext.BoxComponent">height</a>: 150
260
p1 = c.<a href="output/Ext.Container.html#Ext.Container-getComponent" ext:member="getComponent" ext:cls="Ext.Container">getComponent</a>(<em>'p1'</em>); <i>// not the same as <a href="output/Ext.html#Ext-getCmp" ext:member="getCmp" ext:cls="Ext">Ext.getCmp()</a></i>
261
p2 = p1.<a href="output/Ext.Component.html#Ext.Component-ownerCt" ext:member="ownerCt" ext:cls="Ext.Component">ownerCt</a>.<a href="output/Ext.Container.html#Ext.Container-getComponent" ext:member="getComponent" ext:cls="Ext.Container">getComponent</a>(<em>'p2'</em>); <i>// reference via a sibling</i></code></pre>
262
<p>Also see <tt><a href="output/Ext.Component.html#Ext.Component-id" ext:member="id" ext:cls="Ext.Component">id</a></tt> and <code><a href="output/Ext.Component.html#Ext.Component-ref" ext:member="ref" ext:cls="Ext.Component">ref</a></code>.</p>
263
<p><b>Note</b>: to access the container of an item see <tt><a href="output/Ext.Component.html#Ext.Component-ownerCt" ext:member="ownerCt" ext:cls="Ext.Component">ownerCt</a></tt>.</p></div></div></td><td class="msource"><a href="output/Ext.Component.html#itemId" ext:member="#itemId" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.CycleButton-items"></a><b><a href="source/CycleButton.html#cfg-Ext.CycleButton-items">items</a></b> : Array<div class="mdesc"><div class="short">An array of Ext.menu.CheckItem config objects to be used when creating the
264
button's menu items (e.g., {text:'Foo', i...</div><div class="long">An array of <a href="output/Ext.menu.CheckItem.html" ext:cls="Ext.menu.CheckItem">Ext.menu.CheckItem</a> <b>config</b> objects to be used when creating the
265
button's menu items (e.g., {text:'Foo', iconCls:'foo-icon'})</div></div></td><td class="msource">CycleButton</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-labelSeparator"></a><b><a href="source/Component.html#cfg-Ext.Component-labelSeparator">labelSeparator</a></b> : String<div class="mdesc"><div class="short">The separator to display after the text of each
266
fieldLabel. This property may be configured at various levels.
267
The o...</div><div class="long"><p>The separator to display after the text of each
268
<tt><a href="output/Ext.Component.html#Ext.Component-fieldLabel" ext:member="fieldLabel" ext:cls="Ext.Component">fieldLabel</a></tt>. This property may be configured at various levels.
269
The order of precedence is:
270
<div class="mdetail-params"><ul>
271
<li>field / component level</li>
272
<li>container level</li>
273
<li><a href="output/Ext.layout.FormLayout.html#Ext.layout.FormLayout-labelSeparator" ext:member="labelSeparator" ext:cls="Ext.layout.FormLayout">layout level</a> (defaults to colon <tt>':'</tt>)</li>
275
To display no separator for this field's label specify empty string ''.</p>
276
<br><p><b>Note</b>: see the note for <tt><a href="output/Ext.Component.html#Ext.Component-clearCls" ext:member="clearCls" ext:cls="Ext.Component">clearCls</a></tt>.</p><br>
277
<p>Also see <tt><a href="output/Ext.Component.html#Ext.Component-hideLabel" ext:member="hideLabel" ext:cls="Ext.Component">hideLabel</a></tt> and
278
<a href="output/Ext.layout.FormLayout.html" ext:cls="Ext.layout.FormLayout">Ext.layout.FormLayout</a>.<a href="output/Ext.layout.FormLayout.html#Ext.layout.FormLayout-fieldTpl" ext:member="fieldTpl" ext:cls="Ext.layout.FormLayout">fieldTpl</a>.</p>
279
Example use:<pre><code><b>new</b> Ext.FormPanel({
281
renderTo: Ext.getBody(),
283
labelSeparator: <em>'~'</em> <i>// layout config has lowest priority (defaults to <em>':'</em>)</i>
285
<a href="output/Ext.layout.FormLayout.html#Ext.layout.FormLayout-labelSeparator" ext:member="labelSeparator" ext:cls="Ext.layout.FormLayout">labelSeparator</a>: <em>'>>'</em>, <i>// config at container level</i>
287
xtype: <em>'textfield'</em>,
288
fieldLabel: <em>'Field 1'</em>,
289
labelSeparator: <em>'...'</em> <i>// field/component level config supersedes others</i>
291
xtype: <em>'textfield'</em>,
292
fieldLabel: <em>'Field 2'</em> <i>// labelSeparator will be <em>'='</em></i>
294
});</code></pre></div></div></td><td class="msource"><a href="output/Ext.Component.html#labelSeparator" ext:member="#labelSeparator" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-labelStyle"></a><b><a href="source/Component.html#cfg-Ext.Component-labelStyle">labelStyle</a></b> : String<div class="mdesc"><div class="short">A CSS style specification string to apply directly to this field's
295
label. Defaults to the container's labelStyle val...</div><div class="long"><p>A CSS style specification string to apply directly to this field's
296
label. Defaults to the container's labelStyle value if set (e.g.,
297
<tt><a href="output/Ext.layout.FormLayout.html#Ext.layout.FormLayout-labelStyle" ext:member="labelStyle" ext:cls="Ext.layout.FormLayout">Ext.layout.FormLayout.labelStyle</a></tt> , or '').</p>
298
<br><p><b>Note</b>: see the note for <code><a href="output/Ext.Component.html#Ext.Component-clearCls" ext:member="clearCls" ext:cls="Ext.Component">clearCls</a></code>.</p><br>
299
<p>Also see <code><a href="output/Ext.Component.html#Ext.Component-hideLabel" ext:member="hideLabel" ext:cls="Ext.Component">hideLabel</a></code> and
300
<code><a href="output/Ext.layout.FormLayout.html" ext:cls="Ext.layout.FormLayout">Ext.layout.FormLayout</a>.<a href="output/Ext.layout.FormLayout.html#Ext.layout.FormLayout-fieldTpl" ext:member="fieldTpl" ext:cls="Ext.layout.FormLayout">fieldTpl</a>.</code></p>
301
Example use:<pre><code><b>new</b> Ext.FormPanel({
303
renderTo: Ext.getBody(),
305
xtype: <em>'textfield'</em>,
306
fieldLabel: <em>'Name'</em>,
307
labelStyle: <em>'font-weight:bold;'</em>
309
});</code></pre></div></div></td><td class="msource"><a href="output/Ext.Component.html#labelStyle" ext:member="#labelStyle" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-listeners"></a><b><a href="source/Observable.html#cfg-Ext.util.Observable-listeners">listeners</a></b> : Object<div class="mdesc"><div class="short">A config object containing one or more event handlers to be added to this
310
object during initialization. This should ...</div><div class="long"><p>A config object containing one or more event handlers to be added to this
311
object during initialization. This should be a valid listeners config object as specified in the
312
<a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> example for attaching multiple handlers at once.</p>
313
<br><p><b><u>DOM events from ExtJs <a href="output/Ext.Component.html" ext:cls="Ext.Component">Components</a></u></b></p>
314
<br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
315
is usually only done when extra value can be added. For example the <a href="output/Ext.DataView.html" ext:cls="Ext.DataView">DataView</a>'s
316
<b><code><a href="output/Ext.DataView.html#Ext.DataView-click" ext:member="click" ext:cls="Ext.DataView">click</a></code></b> event passing the node clicked on. To access DOM
317
events directly from a Component's HTMLElement, listeners must be added to the <i><a href="output/Ext.Component.html#Ext.Component-getEl" ext:member="getEl" ext:cls="Ext.Component">Element</a></i> after the Component
318
has been rendered. A plugin can simplify this step:<pre><code><i>// Plugin is configured <b>with</b> a listeners config object.</i>
319
<i>// The Component is appended to the argument list of all handler functions.</i>
320
Ext.DomObserver = Ext.extend(Object, {
321
constructor: <b>function</b>(config) {
322
this.listeners = config.listeners ? config.listeners : config;
325
<i>// Component passes itself into plugin's init method</i>
326
init: <b>function</b>(c) {
327
<b>var</b> p, l = this.listeners;
328
<b>for</b> (p <b>in</b> l) {
329
<b>if</b> (Ext.isFunction(l[p])) {
330
l[p] = this.createHandler(l[p], c);
332
l[p].fn = this.createHandler(l[p].fn, c);
336
<i>// Add the listeners to the Element immediately following the render call</i>
337
c.render = c.render.<a href="output/Function.html#Function-createSequence" ext:member="createSequence" ext:cls="Function">createSequence</a>(<b>function</b>() {
338
<b>var</b> e = c.getEl();
345
createHandler: <b>function</b>(fn, c) {
346
<b>return</b> <b>function</b>(e) {
352
<b>var</b> combo = <b>new</b> Ext.form.ComboBox({
354
<i>// Collapse combo when its element is clicked on</i>
355
plugins: [ <b>new</b> Ext.DomObserver({
356
click: <b>function</b>(evt, comp) {
362
mode: <em>'local'</em>,
363
triggerAction: <em>'all'</em>
364
});</code></pre></p></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#listeners" ext:member="#listeners" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-margins"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-margins">margins</a></b> : Object<div class="mdesc"><div class="short">Note: this config is only used when this BoxComponent is rendered
365
by a Container which has been configured to use the...</div><div class="long"><p><b>Note</b>: this config is only used when this BoxComponent is rendered
366
by a Container which has been configured to use the <b><a href="output/Ext.layout.BorderLayout.html" ext:cls="Ext.layout.BorderLayout">BorderLayout</a></b>
367
or one of the two <b><a href="output/Ext.layout.BoxLayout.html" ext:cls="Ext.layout.BoxLayout">BoxLayout</a> subclasses.</b></p>
368
<p>An object containing margins to apply to this BoxComponent in the
369
format:</p><pre><code>{
371
right: (right margin),
372
bottom: (bottom margin),
375
<p>May also be a string containing space-separated, numeric margin values. The order of the
376
sides associated with each value matches the way CSS processes margin values:</p>
377
<p><div class="mdetail-params"><ul>
378
<li>If there is only one value, it applies to all sides.</li>
379
<li>If there are two values, the top and bottom borders are set to the first value and the
380
right and left are set to the second.</li>
381
<li>If there are three values, the top is set to the first value, the left and right are set
382
to the second, and the bottom is set to the third.</li>
383
<li>If there are four values, they apply to the top, right, bottom, and left, respectively.</li>
385
<p>Defaults to:</p><pre><code>{top:0, right:0, bottom:0, left:0}</code></pre></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#margins" ext:member="#margins" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-menu"></a><b><a href="source/Button.html#cfg-Ext.Button-menu">menu</a></b> : Mixed<div class="mdesc"><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><div class="long">Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).</div></div></td><td class="msource"><a href="output/Ext.Button.html#menu" ext:member="#menu" ext:cls="Ext.Button">Button</a></td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-menuAlign"></a><b><a href="source/Button.html#cfg-Ext.Button-menuAlign">menuAlign</a></b> : String<div class="mdesc">The position to align the menu to (see <a href="output/Ext.Element.html#Ext.Element-alignTo" ext:member="alignTo" ext:cls="Ext.Element">Ext.Element.alignTo</a> for more details, defaults to 'tl-bl?').</div></td><td class="msource"><a href="output/Ext.Button.html#menuAlign" ext:member="#menuAlign" ext:cls="Ext.Button">Button</a></td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-minWidth"></a><b><a href="source/Button.html#cfg-Ext.Button-minWidth">minWidth</a></b> : Number<div class="mdesc">The minimum width for this button (used to give a set of buttons a common width).
386
See also <a href="output/Ext.Panel.html" ext:cls="Ext.Panel">Ext.Panel</a>.<tt><a href="output/Ext.Panel.html#Ext.Panel-minButtonWidth" ext:member="minButtonWidth" ext:cls="Ext.Panel">minButtonWidth</a></tt>.</div></td><td class="msource"><a href="output/Ext.Button.html#minWidth" ext:member="#minWidth" ext:cls="Ext.Button">Button</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-overCls"></a><b><a href="source/Component.html#cfg-Ext.Component-overCls">overCls</a></b> : String<div class="mdesc"><div class="short">An optional extra CSS class that will be added to this component's Element when the mouse moves
387
over the Element, and...</div><div class="long">An optional extra CSS class that will be added to this component's Element when the mouse moves
388
over the Element, and removed when the mouse moves out. (defaults to ''). This can be
389
useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules.</div></div></td><td class="msource"><a href="output/Ext.Component.html#overCls" ext:member="#overCls" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-overflowText"></a><b><a href="source/Button.html#cfg-Ext.Button-overflowText">overflowText</a></b> : String<div class="mdesc"><div class="short">If used in a Toolbar, the
390
text to be used if this item is shown in the overflow menu. See also
391
Ext.Toolbar.Item.overf...</div><div class="long">If used in a <a href="output/Ext.Toolbar.html" ext:cls="Ext.Toolbar">Toolbar</a>, the
392
text to be used if this item is shown in the overflow menu. See also
393
<a href="output/Ext.Toolbar.Item.html" ext:cls="Ext.Toolbar.Item">Ext.Toolbar.Item</a>.<code><a href="output/Ext.Toolbar.Item.html#Ext.Toolbar.Item-overflowText" ext:member="overflowText" ext:cls="Ext.Toolbar.Item">overflowText</a></code>.</div></div></td><td class="msource"><a href="output/Ext.Button.html#overflowText" ext:member="#overflowText" ext:cls="Ext.Button">Button</a></td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-pageX"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-pageX">pageX</a></b> : Number<div class="mdesc">The page level x coordinate for this component if contained within a positioning container.</div></td><td class="msource"><a href="output/Ext.BoxComponent.html#pageX" ext:member="#pageX" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-pageY"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-pageY">pageY</a></b> : Number<div class="mdesc">The page level y coordinate for this component if contained within a positioning container.</div></td><td class="msource"><a href="output/Ext.BoxComponent.html#pageY" ext:member="#pageY" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-plugins"></a><b><a href="source/Component.html#cfg-Ext.Component-plugins">plugins</a></b> : Object/Array<div class="mdesc"><div class="short">An object or array of objects that will provide custom functionality for this component. The only
394
requirement for a ...</div><div class="long">An object or array of objects that will provide custom functionality for this component. The only
395
requirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.Component.
396
When a component is created, if any plugins are available, the component will call the init method on each
397
plugin, passing a reference to itself. Each plugin can then call methods or respond to events on the
398
component as needed to provide its functionality.</div></div></td><td class="msource"><a href="output/Ext.Component.html#plugins" ext:member="#plugins" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.CycleButton-prependText"></a><b><a href="source/CycleButton.html#cfg-Ext.CycleButton-prependText">prependText</a></b> : String<div class="mdesc"><div class="short">A static string to prepend before the active item's text when displayed as the
399
button's text (only applies when show...</div><div class="long">A static string to prepend before the active item's text when displayed as the
400
button's text (only applies when showText = true, defaults to '')</div></div></td><td class="msource">CycleButton</td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-pressed"></a><b><a href="source/Button.html#cfg-Ext.Button-pressed">pressed</a></b> : Boolean<div class="mdesc">True to start pressed (only if enableToggle = true)</div></td><td class="msource"><a href="output/Ext.Button.html#pressed" ext:member="#pressed" ext:cls="Ext.Button">Button</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-ptype"></a><b><a href="source/Component.html#cfg-Ext.Component-ptype">ptype</a></b> : String<div class="mdesc"><div class="short">The registered ptype to create. This config option is not used when passing
401
a config object into a constructor. This ...</div><div class="long">The registered <tt>ptype</tt> to create. This config option is not used when passing
402
a config object into a constructor. This config option is used only when
403
lazy instantiation is being used, and a Plugin is being
404
specified not as a fully instantiated Component, but as a <i>Component config
405
object</i>. The <tt>ptype</tt> will be looked up at render time up to determine what
406
type of Plugin to create.<br><br>
407
If you create your own Plugins, you may register them using
408
<a href="output/Ext.ComponentMgr.html#Ext.ComponentMgr-registerPlugin" ext:member="registerPlugin" ext:cls="Ext.ComponentMgr">Ext.ComponentMgr.registerPlugin</a> in order to be able to
409
take advantage of lazy instantiation and rendering.</div></div></td><td class="msource"><a href="output/Ext.Component.html#ptype" ext:member="#ptype" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-ref"></a><b><a href="source/Component.html#cfg-Ext.Component-ref">ref</a></b> : String<div class="mdesc"><div class="short">A path specification, relative to the Component's ownerCt specifying into which
410
ancestor Container to place a named r...</div><div class="long"><p>A path specification, relative to the Component's <a href="output/Ext.Component.html#Ext.Component-ownerCt" ext:member="ownerCt" ext:cls="Ext.Component">ownerCt</a> specifying into which
411
ancestor Container to place a named reference to this Component.</p>
412
<p>The ancestor axis can be traversed by using '/' characters in the path.
413
For example, to put a reference to a Toolbar Button into <i>the Panel which owns the Toolbar</i>:</p><pre><code><b>var</b> myGrid = <b>new</b> Ext.grid.EditorGridPanel({
414
title: <em>'My EditorGridPanel'</em>,
416
colModel: myColModel,
418
text: <em>'Save'</em>,
419
handler: saveChanges,
421
ref: <em>'../saveButton'</em>
424
afteredit: <b>function</b>() {
425
<i>// The button reference is <b>in</b> the GridPanel</i>
426
myGrid.saveButton.enable();
430
<p>In the code above, if the ref had been <code><em>'saveButton'</em></code> the reference would
431
have been placed into the Toolbar. Each '/' in the ref moves up one level from the
432
Component's <a href="output/Ext.Component.html#Ext.Component-ownerCt" ext:member="ownerCt" ext:cls="Ext.Component">ownerCt</a>.</p></div></div></td><td class="msource"><a href="output/Ext.Component.html#ref" ext:member="#ref" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-region"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-region">region</a></b> : String<div class="mdesc"><div class="short">Note: this config is only used when this BoxComponent is rendered
433
by a Container which has been configured to use the...</div><div class="long"><p><b>Note</b>: this config is only used when this BoxComponent is rendered
434
by a Container which has been configured to use the <b><a href="output/Ext.layout.BorderLayout.html" ext:cls="Ext.layout.BorderLayout">BorderLayout</a></b>
435
layout manager (e.g. specifying <tt>layout:'border'</tt>).</p><br>
436
<p>See <a href="output/Ext.layout.BorderLayout.html" ext:cls="Ext.layout.BorderLayout">Ext.layout.BorderLayout</a> also.</p></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#region" ext:member="#region" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-renderTo"></a><b><a href="source/Component.html#cfg-Ext.Component-renderTo">renderTo</a></b> : Mixed<div class="mdesc"><div class="short">Specify the id of the element, a DOM element or an existing Element that this component
437
will be rendered into.
438
Notes ...</div><div class="long"><p>Specify the id of the element, a DOM element or an existing Element that this component
439
will be rendered into.</p><div><ul>
440
<li><b>Notes</b> : <ul>
441
<div class="sub-desc">Do <u>not</u> use this option if the Component is to be a child item of
442
a <a href="output/Ext.Container.html" ext:cls="Ext.Container">Container</a>. It is the responsibility of the
443
<a href="output/Ext.Container.html" ext:cls="Ext.Container">Container</a>'s <a href="output/Ext.Container.html#Ext.Container-layout" ext:member="layout" ext:cls="Ext.Container">layout manager</a>
444
to render and manage its child items.</div>
445
<div class="sub-desc">When using this config, a call to render() is not required.</div>
448
<p>See <tt><a href="output/Ext.Component.html#Ext.Component-render" ext:member="render" ext:cls="Ext.Component">render</a></tt> also.</p></div></div></td><td class="msource"><a href="output/Ext.Component.html#renderTo" ext:member="#renderTo" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-repeat"></a><b><a href="source/Button.html#cfg-Ext.Button-repeat">repeat</a></b> : Boolean/Object<div class="mdesc"><div class="short">True to repeat fire the click event while the mouse is down. This can also be
449
a ClickRepeater config object (defaults...</div><div class="long">True to repeat fire the click event while the mouse is down. This can also be
450
a <a href="output/Ext.util.ClickRepeater.html" ext:cls="Ext.util.ClickRepeater">ClickRepeater</a> config object (defaults to false).</div></div></td><td class="msource"><a href="output/Ext.Button.html#repeat" ext:member="#repeat" ext:cls="Ext.Button">Button</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-scale"></a><b><a href="source/Button.html#cfg-Ext.Button-scale">scale</a></b> : String<div class="mdesc"><div class="short">(Optional) The size of the Button. Three values are allowed:
451
<ul class="mdetail-params">
452
'small'<div class="sub-desc"...</div><div class="long"><p>(Optional) The size of the Button. Three values are allowed:</p>
453
<ul class="mdetail-params">
454
<li>'small'<div class="sub-desc">Results in the button element being 16px high.</div></li>
455
<li>'medium'<div class="sub-desc">Results in the button element being 24px high.</div></li>
456
<li>'large'<div class="sub-desc">Results in the button element being 32px high.</div></li>
458
<p>Defaults to <b><tt>'small'</tt></b>.</p></div></div></td><td class="msource"><a href="output/Ext.Button.html#scale" ext:member="#scale" ext:cls="Ext.Button">Button</a></td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-scope"></a><b><a href="source/Button.html#cfg-Ext.Button-scope">scope</a></b> : Object<div class="mdesc">The scope (<tt><b>this</b></tt> reference) in which the
459
<code><a href="output/Ext.Button.html#Ext.Button-handler" ext:member="handler" ext:cls="Ext.Button">handler</a></code> and <code><a href="output/Ext.Button.html#Ext.Button-toggleHandler" ext:member="toggleHandler" ext:cls="Ext.Button">toggleHandler</a></code> is
460
executed. Defaults to this Button.</div></td><td class="msource"><a href="output/Ext.Button.html#scope" ext:member="#scope" ext:cls="Ext.Button">Button</a></td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.CycleButton-showText"></a><b><a href="source/CycleButton.html#cfg-Ext.CycleButton-showText">showText</a></b> : Boolean<div class="mdesc">True to display the active item's text as the button text (defaults to false)</div></td><td class="msource">CycleButton</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-stateEvents"></a><b><a href="source/Component.html#cfg-Ext.Component-stateEvents">stateEvents</a></b> : Array<div class="mdesc"><div class="short">An array of events that, when fired, should trigger this component to
461
save its state (defaults to none). stateEvents ...</div><div class="long"><p>An array of events that, when fired, should trigger this component to
462
save its state (defaults to none). <code>stateEvents</code> may be any type
463
of event supported by this component, including browser or custom events
464
(e.g., <tt>['click', 'customerchange']</tt>).</p>
465
<p>See <code><a href="output/Ext.Component.html#Ext.Component-stateful" ext:member="stateful" ext:cls="Ext.Component">stateful</a></code> for an explanation of saving and
466
restoring Component state.</p></div></div></td><td class="msource"><a href="output/Ext.Component.html#stateEvents" ext:member="#stateEvents" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-stateId"></a><b><a href="source/Component.html#cfg-Ext.Component-stateId">stateId</a></b> : String<div class="mdesc"><div class="short">The unique id for this component to use for state management purposes
467
(defaults to the component id if one was set, o...</div><div class="long">The unique id for this component to use for state management purposes
468
(defaults to the component id if one was set, otherwise null if the
469
component is using a generated id).
470
<p>See <code><a href="output/Ext.Component.html#Ext.Component-stateful" ext:member="stateful" ext:cls="Ext.Component">stateful</a></code> for an explanation of saving and
471
restoring Component state.</p></div></div></td><td class="msource"><a href="output/Ext.Component.html#stateId" ext:member="#stateId" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-stateful"></a><b><a href="source/Component.html#cfg-Ext.Component-stateful">stateful</a></b> : Boolean<div class="mdesc"><div class="short">A flag which causes the Component to attempt to restore the state of
472
internal properties from a saved state on startu...</div><div class="long"><p>A flag which causes the Component to attempt to restore the state of
473
internal properties from a saved state on startup. The component must have
474
either a <code><a href="output/Ext.Component.html#Ext.Component-stateId" ext:member="stateId" ext:cls="Ext.Component">stateId</a></code> or <code><a href="output/Ext.Component.html#Ext.Component-id" ext:member="id" ext:cls="Ext.Component">id</a></code> assigned
475
for state to be managed. Auto-generated ids are not guaranteed to be stable
476
across page loads and cannot be relied upon to save and restore the same
477
state for a component.<p>
478
<p>For state saving to work, the state manager's provider must have been
479
set to an implementation of <a href="output/Ext.state.Provider.html" ext:cls="Ext.state.Provider">Ext.state.Provider</a> which overrides the
480
<a href="output/Ext.state.Provider.html#Ext.state.Provider-set" ext:member="set" ext:cls="Ext.state.Provider">set</a> and <a href="output/Ext.state.Provider.html#Ext.state.Provider-get" ext:member="get" ext:cls="Ext.state.Provider">get</a>
481
methods to save and recall name/value pairs. A built-in implementation,
482
<a href="output/Ext.state.CookieProvider.html" ext:cls="Ext.state.CookieProvider">Ext.state.CookieProvider</a> is available.</p>
483
<p>To set the state provider for the current page:</p>
484
<pre><code>Ext.state.Manager.setProvider(<b>new</b> Ext.state.CookieProvider({
485
expires: <b>new</b> Date(<b>new</b> Date().getTime()+(1000*60*60*24*7)), <i>//7 days from now</i>
487
<p>A stateful Component attempts to save state when one of the events
488
listed in the <code><a href="output/Ext.Component.html#Ext.Component-stateEvents" ext:member="stateEvents" ext:cls="Ext.Component">stateEvents</a></code> configuration fires.</p>
489
<p>To save state, a stateful Component first serializes its state by
490
calling <b><code>getState</code></b>. By default, this function does
491
nothing. The developer must provide an implementation which returns an
492
object hash which represents the Component's restorable state.</p>
493
<p>The value yielded by getState is passed to <a href="output/Ext.state.Manager.html#Ext.state.Manager-set" ext:member="set" ext:cls="Ext.state.Manager">Ext.state.Manager.set</a>
494
which uses the configured <a href="output/Ext.state.Provider.html" ext:cls="Ext.state.Provider">Ext.state.Provider</a> to save the object
495
keyed by the Component's <code><a href="output/stateId.html" ext:cls="stateId">stateId</a></code>, or, if that is not
496
specified, its <code><a href="output/Ext.Component.html#Ext.Component-id" ext:member="id" ext:cls="Ext.Component">id</a></code>.</p>
497
<p>During construction, a stateful Component attempts to <i>restore</i>
498
its state by calling <a href="output/Ext.state.Manager.html#Ext.state.Manager-get" ext:member="get" ext:cls="Ext.state.Manager">Ext.state.Manager.get</a> passing the
499
<code><a href="output/Ext.Component.html#Ext.Component-stateId" ext:member="stateId" ext:cls="Ext.Component">stateId</a></code>, or, if that is not specified, the
500
<code><a href="output/Ext.Component.html#Ext.Component-id" ext:member="id" ext:cls="Ext.Component">id</a></code>.</p>
501
<p>The resulting object is passed to <b><code>applyState</code></b>.
502
The default implementation of <code>applyState</code> simply copies
503
properties into the object, but a developer may override this to support
505
<p>You can perform extra processing on state save and restore by attaching
506
handlers to the <a href="output/Ext.Component.html#Ext.Component-beforestaterestore" ext:member="beforestaterestore" ext:cls="Ext.Component">beforestaterestore</a>, <a href="output/Ext.Component.html#Ext.Component-staterestore" ext:member="staterestore" ext:cls="Ext.Component">staterestore</a>,
507
<a href="output/Ext.Component.html#Ext.Component-beforestatesave" ext:member="beforestatesave" ext:cls="Ext.Component">beforestatesave</a> and <a href="output/Ext.Component.html#Ext.Component-statesave" ext:member="statesave" ext:cls="Ext.Component">statesave</a> events.</p></div></div></td><td class="msource"><a href="output/Ext.Component.html#stateful" ext:member="#stateful" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-style"></a><b><a href="source/Component.html#cfg-Ext.Component-style">style</a></b> : String<div class="mdesc"><div class="short">A custom style specification to be applied to this component's Element. Should be a valid argument to
508
Ext.Element.ap...</div><div class="long">A custom style specification to be applied to this component's Element. Should be a valid argument to
509
<a href="output/Ext.Element.html#Ext.Element-applyStyles" ext:member="applyStyles" ext:cls="Ext.Element">Ext.Element.applyStyles</a>.
510
<pre><code><b>new</b> Ext.Panel({
511
title: <em>'Some Title'</em>,
512
renderTo: Ext.getBody(),
513
width: 400, height: 300,
514
layout: <em>'form'</em>,
516
xtype: <em>'textarea'</em>,
518
width: <em>'95%'</em>,
519
marginBottom: <em>'10px'</em>
522
<b>new</b> Ext.Button({
523
text: <em>'Send'</em>,
524
minWidth: <em>'100'</em>,
526
marginBottom: <em>'10px'</em>
530
});</code></pre></div></div></td><td class="msource"><a href="output/Ext.Component.html#style" ext:member="#style" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-tabIndex"></a><b><a href="source/Button.html#cfg-Ext.Button-tabIndex">tabIndex</a></b> : Number<div class="mdesc">Set a DOM tabIndex for this button (defaults to undefined)</div></td><td class="msource"><a href="output/Ext.Button.html#tabIndex" ext:member="#tabIndex" ext:cls="Ext.Button">Button</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-template"></a><b><a href="source/Button.html#cfg-Ext.Button-template">template</a></b> : Ext.Template<div class="mdesc"><div class="short">A Template used to create the Button's DOM structure.
531
Instances, or subclasses which need a different DOM structure m...</div><div class="long"><p>A <a href="output/Ext.Template.html" ext:cls="Ext.Template">Template</a> used to create the Button's DOM structure.</p>
532
Instances, or subclasses which need a different DOM structure may provide a different
533
template layout in conjunction with an implementation of <a href="output/Ext.Button.html#Ext.Button-getTemplateArgs" ext:member="getTemplateArgs" ext:cls="Ext.Button">getTemplateArgs</a>.</div></div></td><td class="msource"><a href="output/Ext.Button.html#template" ext:member="#template" ext:cls="Ext.Button">Button</a></td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-text"></a><b><a href="source/Button.html#cfg-Ext.Button-text">text</a></b> : String<div class="mdesc">The button text to be used as innerHTML (html tags are accepted)</div></td><td class="msource"><a href="output/Ext.Button.html#text" ext:member="#text" ext:cls="Ext.Button">Button</a></td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-toggleGroup"></a><b><a href="source/Button.html#cfg-Ext.Button-toggleGroup">toggleGroup</a></b> : String<div class="mdesc">The group this toggle button is a member of (only 1 per group can be pressed)</div></td><td class="msource"><a href="output/Ext.Button.html#toggleGroup" ext:member="#toggleGroup" ext:cls="Ext.Button">Button</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-toggleHandler"></a><b><a href="source/Button.html#cfg-Ext.Button-toggleHandler">toggleHandler</a></b> : Function<div class="mdesc"><div class="short">Function called when a Button with enableToggle set to true is clicked. Two arguments are passed:<ul class="mdetail-p...</div><div class="long">Function called when a Button with <a href="output/Ext.Button.html#Ext.Button-enableToggle" ext:member="enableToggle" ext:cls="Ext.Button">enableToggle</a> set to true is clicked. Two arguments are passed:<ul class="mdetail-params">
534
<li><b>button</b> : Ext.Button<div class="sub-desc">this Button object</div></li>
535
<li><b>state</b> : Boolean<div class="sub-desc">The next state if the Button, true means pressed.</div></li>
536
</ul></div></div></td><td class="msource"><a href="output/Ext.Button.html#toggleHandler" ext:member="#toggleHandler" ext:cls="Ext.Button">Button</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-tooltip"></a><b><a href="source/Button.html#cfg-Ext.Button-tooltip">tooltip</a></b> : String/Object<div class="mdesc"><div class="short">The tooltip for the button - can be a string to be used as innerHTML (html tags are accepted) or QuickTips config obj...</div><div class="long">The tooltip for the button - can be a string to be used as innerHTML (html tags are accepted) or QuickTips config object</div></div></td><td class="msource"><a href="output/Ext.Button.html#tooltip" ext:member="#tooltip" ext:cls="Ext.Button">Button</a></td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-tooltipType"></a><b><a href="source/Button.html#cfg-Ext.Button-tooltipType">tooltipType</a></b> : String<div class="mdesc">The type of tooltip to use. Either 'qtip' (default) for QuickTips or 'title' for title attribute.</div></td><td class="msource"><a href="output/Ext.Button.html#tooltipType" ext:member="#tooltipType" ext:cls="Ext.Button">Button</a></td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-type"></a><b><a href="source/Button.html#cfg-Ext.Button-type">type</a></b> : String<div class="mdesc">submit, reset or button - defaults to 'button'</div></td><td class="msource"><a href="output/Ext.Button.html#type" ext:member="#type" ext:cls="Ext.Button">Button</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-width"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-width">width</a></b> : Number<div class="mdesc"><div class="short">The width of this component in pixels (defaults to auto).
537
Note to express this dimension as a percentage or offset se...</div><div class="long">The width of this component in pixels (defaults to auto).
538
<b>Note</b> to express this dimension as a percentage or offset see <a href="output/Ext.Component.html#Ext.Component-anchor" ext:member="anchor" ext:cls="Ext.Component">Ext.Component.anchor</a>.</div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#width" ext:member="#width" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-x"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-x">x</a></b> : Number<div class="mdesc">The local x (left) coordinate for this component if contained within a positioning container.</div></td><td class="msource"><a href="output/Ext.BoxComponent.html#x" ext:member="#x" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-xtype"></a><b><a href="source/Component.html#cfg-Ext.Component-xtype">xtype</a></b> : String<div class="mdesc"><div class="short">The registered xtype to create. This config option is not used when passing
539
a config object into a constructor. This ...</div><div class="long">The registered <tt>xtype</tt> to create. This config option is not used when passing
540
a config object into a constructor. This config option is used only when
541
lazy instantiation is being used, and a child item of a Container is being
542
specified not as a fully instantiated Component, but as a <i>Component config
543
object</i>. The <tt>xtype</tt> will be looked up at render time up to determine what
544
type of child Component to create.<br><br>
545
The predefined xtypes are listed <a href="output/Ext.Component.html" ext:cls="Ext.Component">here</a>.
547
If you subclass Components to create your own Components, you may register
548
them using <a href="output/Ext.ComponentMgr.html#Ext.ComponentMgr-registerType" ext:member="registerType" ext:cls="Ext.ComponentMgr">Ext.ComponentMgr.registerType</a> in order to be able to
549
take advantage of lazy instantiation and rendering.</div></div></td><td class="msource"><a href="output/Ext.Component.html#xtype" ext:member="#xtype" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-y"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-y">y</a></b> : Number<div class="mdesc">The local y (top) coordinate for this component if contained within a positioning container.</div></td><td class="msource"><a href="output/Ext.BoxComponent.html#y" ext:member="#y" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr></tbody></table><a id="Ext.CycleButton-props"></a><h2>Public Properties</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Property</th><th class="msource-header">Defined By</th></tr><tr class="property-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-btnEl"></a><b><a href="source/Button.html#prop-Ext.Button-btnEl">btnEl</a></b> : Ext.Element<div class="mdesc"><div class="short">An Element encapsulating the Button's clickable element. By default,
550
this references a &lt;button&gt; element. Read o...</div><div class="long">An <a href="output/Ext.Element.html" ext:cls="Ext.Element">Element</a> encapsulating the Button's clickable element. By default,
551
this references a <tt><button></tt> element. Read only.</div></div></td><td class="msource"><a href="output/Ext.Button.html#btnEl" ext:member="#btnEl" ext:cls="Ext.Button">Button</a></td></tr><tr class="property-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-disabled"></a><b><a href="source/Button.html#prop-Ext.Button-disabled">disabled</a></b> : Boolean<div class="mdesc">Read-only. True if this button is disabled</div></td><td class="msource"><a href="output/Ext.Button.html#disabled" ext:member="#disabled" ext:cls="Ext.Button">Button</a></td></tr><tr class="property-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-el"></a><b><a href="source/Component.html#prop-Ext.Component-el">el</a></b> : Ext.Element<div class="mdesc"><div class="short">The Ext.Element which encapsulates this Component. Read-only.
552
This will usually be a &lt;DIV> element created by the ...</div><div class="long"><p>The <a href="output/Ext.Element.html" ext:cls="Ext.Element">Ext.Element</a> which encapsulates this Component. Read-only.</p>
553
<p>This will <i>usually</i> be a <DIV> element created by the class's onRender method, but
554
that may be overridden using the <code><a href="output/Ext.Component.html#Ext.Component-autoEl" ext:member="autoEl" ext:cls="Ext.Component">autoEl</a></code> config.</p>
555
<br><p><b>Note</b>: this element will not be available until this Component has been rendered.</p><br>
556
<p>To add listeners for <b>DOM events</b> to this Component (as opposed to listeners
557
for this Component's own Observable events), see the <a href="output/Ext.util.Observable.html#Ext.util.Observable-listeners" ext:member="listeners" ext:cls="Ext.util.Observable">listeners</a>
558
config for a suggestion, or use a render listener directly:</p><pre><code><b>new</b> Ext.Panel({
559
title: <em>'The Clickable Panel'</em>,
561
render: <b>function</b>(p) {
562
<i>// Append the Panel to the click handler's argument list.</i>
563
p.getEl().on(<em>'click'</em>, handlePanelClick.createDelegate(null, [p], true));
565
single: true <i>// Remove the listener after first invocation</i>
568
<p>See also <tt><a href="output/Ext.Component.html#Ext.Component-getEl" ext:member="getEl" ext:cls="Ext.Component">getEl</a></p></div></div></td><td class="msource"><a href="output/Ext.Component.html#el" ext:member="#el" ext:cls="Ext.Component">Component</a></td></tr><tr class="property-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-hidden"></a><b><a href="source/Button.html#prop-Ext.Button-hidden">hidden</a></b> : Boolean<div class="mdesc">Read-only. True if this button is hidden</div></td><td class="msource"><a href="output/Ext.Button.html#hidden" ext:member="#hidden" ext:cls="Ext.Button">Button</a></td></tr><tr class="property-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-initialConfig"></a><b><a href="source/Component.html#prop-Ext.Component-initialConfig">initialConfig</a></b> : Object<div class="mdesc">This Component's initial configuration specification. Read-only.</div></td><td class="msource"><a href="output/Ext.Component.html#initialConfig" ext:member="#initialConfig" ext:cls="Ext.Component">Component</a></td></tr><tr class="property-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.CycleButton-menu"></a><b><a href="source/CycleButton.html#prop-Ext.CycleButton-menu">menu</a></b> : Menu
569
The {@link Ext.menu.Menu Menu} object used to display the {@link Ext.menu.CheckItem CheckItems} representing the available choices.<div class="mdesc"></div></td><td class="msource">CycleButton</td></tr><tr class="property-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-ownerCt"></a><b><a href="source/Button.html#prop-Ext.Button-ownerCt">ownerCt</a></b> : Ext.Panel<div class="mdesc"><div class="short">The Button's owner Ext.Panel (defaults to undefined, and is set automatically when
570
the Button is added to a container...</div><div class="long">The Button's owner <a href="output/Ext.Panel.html" ext:cls="Ext.Panel">Ext.Panel</a> (defaults to undefined, and is set automatically when
571
the Button is added to a container). Read-only.</div></div></td><td class="msource"><a href="output/Ext.Button.html#ownerCt" ext:member="#ownerCt" ext:cls="Ext.Button">Button</a></td></tr><tr class="property-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-pressed"></a><b><a href="source/Button.html#prop-Ext.Button-pressed">pressed</a></b> : Boolean<div class="mdesc">Read-only. True if this button is pressed (only if enableToggle = true)</div></td><td class="msource"><a href="output/Ext.Button.html#pressed" ext:member="#pressed" ext:cls="Ext.Button">Button</a></td></tr><tr class="property-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-rendered"></a><b><a href="source/Component.html#prop-Ext.Component-rendered">rendered</a></b> : Boolean<div class="mdesc">True if this component has been rendered. Read-only.</div></td><td class="msource"><a href="output/Ext.Component.html#rendered" ext:member="#rendered" ext:cls="Ext.Component">Component</a></td></tr></tbody></table><a id="Ext.CycleButton-methods"></a><h2>Public Methods</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.CycleButton-CycleButton"></a><b><a href="source/CycleButton.html#cls-Ext.CycleButton">CycleButton</a></b>( <code>Object config</code> )
572
<div class="mdesc"><div class="short">Create a new split button</div><div class="long">Create a new split button<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>config</code> : Object<div class="sub-desc">The config object</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div><table><tr><td class="label">xtype:</td><td class="hd-info">cycle</td></tr></table></div></div></td><td class="msource">CycleButton</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-addClass"></a><b><a href="source/Component.html#method-Ext.Component-addClass">addClass</a></b>( <code>string cls</code> )
574
Ext.Component<div class="mdesc"><div class="short">Adds a CSS class to the component's underlying element.</div><div class="long">Adds a CSS class to the component's underlying element.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>cls</code> : string<div class="sub-desc">The CSS class name to add</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Component</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#addClass" ext:member="#addClass" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-addEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-addEvents">addEvents</a></b>( <code>Object object</code> )
576
void<div class="mdesc"><div class="short">Used to define events on this Observable</div><div class="long">Used to define events on this Observable<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#addEvents" ext:member="#addEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-addListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-addListener">addListener</a></b>( <code>String eventName</code>, <code>Function handler</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span>, <span title="Optional" class="optional">[<code>Object options</code>]</span> )
578
void<div class="mdesc"><div class="short">Appends an event handler to this object.</div><div class="long">Appends an event handler to this object.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to listen for.</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes.</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
579
<b>If omitted, defaults to the object which fired the event.</b></div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration.
580
properties. This may contain any of the following properties:<ul>
581
<li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
582
<b>If omitted, defaults to the object which fired the event.</b></div></li>
583
<li><b>delay</b> : Number<div class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</div></li>
584
<li><b>single</b> : Boolean<div class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</div></li>
585
<li><b>buffer</b> : Number<div class="sub-desc">Causes the handler to be scheduled to run in an <a href="output/Ext.util.DelayedTask.html" ext:cls="Ext.util.DelayedTask">Ext.util.DelayedTask</a> delayed
586
by the specified number of milliseconds. If the event fires again within that time, the original
587
handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
588
<li><b>target</b> : Observable<div class="sub-desc">Only call the handler if the event was fired on the target Observable, <i>not</i>
589
if the event was bubbled up from a child Observable.</div></li>
592
<b>Combining Options</b><br>
593
Using the options argument, it is possible to combine different types of listeners:<br>
595
A delayed, one-time listener.
596
<pre><code>myDataView.on(<em>'click'</em>, this.onClick, this, {
601
<b>Attaching multiple handlers in 1 call</b><br>
602
The method also allows for a single argument to be passed which is a config object containing properties
603
which specify multiple handlers.
605
<pre><code>myGridPanel.on({
611
<em>'mouseover'</em> : {
612
fn: this.onMouseOver,
615
<em>'mouseout'</em> : {
621
Or a shorthand syntax:<br>
622
<pre><code>myGridPanel.on({
623
<em>'click'</em> : this.onClick,
624
<em>'mouseover'</em> : this.onMouseOver,
625
<em>'mouseout'</em> : this.onMouseOut,
627
});</code></pre></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#addListener" ext:member="#addListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-applyToMarkup"></a><b><a href="source/Component.html#method-Ext.Component-applyToMarkup">applyToMarkup</a></b>( <code>String/HTMLElement el</code> )
629
void<div class="mdesc"><div class="short">Apply this component to existing markup that is valid. With this function, no call to render() is required.</div><div class="long">Apply this component to existing markup that is valid. With this function, no call to render() is required.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>el</code> : String/HTMLElement<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#applyToMarkup" ext:member="#applyToMarkup" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-cloneConfig"></a><b><a href="source/Component.html#method-Ext.Component-cloneConfig">cloneConfig</a></b>( <code>Object overrides</code> )
631
Ext.Component<div class="mdesc"><div class="short">Clone the current component using the original config values passed into this instance by default.</div><div class="long">Clone the current component using the original config values passed into this instance by default.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>overrides</code> : Object<div class="sub-desc">A new config containing any properties to override in the cloned version.
632
An id property can be passed on this object, otherwise one will be generated to avoid duplicates.</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Component</code><div class="sub-desc">clone The cloned copy of this component</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#cloneConfig" ext:member="#cloneConfig" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-destroy"></a><b><a href="source/Component.html#method-Ext.Component-destroy">destroy</a></b>()
634
void<div class="mdesc"><div class="short">Destroys this component by purging any event listeners, removing the component's element from the DOM,
635
removing the c...</div><div class="long">Destroys this component by purging any event listeners, removing the component's element from the DOM,
636
removing the component from its <a href="output/Ext.Container.html" ext:cls="Ext.Container">Ext.Container</a> (if applicable) and unregistering it from
637
<a href="output/Ext.ComponentMgr.html" ext:cls="Ext.ComponentMgr">Ext.ComponentMgr</a>. Destruction is generally handled automatically by the framework and this method
638
should usually not need to be called directly.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#destroy" ext:member="#destroy" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-disable"></a><b><a href="source/Component.html#method-Ext.Component-disable">disable</a></b>()
640
Ext.Component<div class="mdesc"><div class="short">Disable this component and fire the 'disable' event.</div><div class="long">Disable this component and fire the 'disable' event.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.Component</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#disable" ext:member="#disable" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-enable"></a><b><a href="source/Component.html#method-Ext.Component-enable">enable</a></b>()
642
Ext.Component<div class="mdesc"><div class="short">Enable this component and fire the 'enable' event.</div><div class="long">Enable this component and fire the 'enable' event.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.Component</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#enable" ext:member="#enable" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-enableBubble"></a><b><a href="source/Observable-more.html#method-Ext.util.Observable-enableBubble">enableBubble</a></b>( <code>Object events</code> )
644
void<div class="mdesc"><div class="short">Used to enable bubbling of events</div><div class="long">Used to enable bubbling of events<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>events</code> : Object<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#enableBubble" ext:member="#enableBubble" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-findParentBy"></a><b><a href="source/Component.html#method-Ext.Component-findParentBy">findParentBy</a></b>( <code>Function fn</code> )
646
Ext.Container<div class="mdesc"><div class="short">Find a container above this component at any level by a custom function. If the passed function returns
647
true, the con...</div><div class="long">Find a container above this component at any level by a custom function. If the passed function returns
648
true, the container will be returned.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>fn</code> : Function<div class="sub-desc">The custom function to call with the arguments (container, this component).</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Container</code><div class="sub-desc">The first Container for which the custom function returns true</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#findParentBy" ext:member="#findParentBy" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-findParentByType"></a><b><a href="source/Component.html#method-Ext.Component-findParentByType">findParentByType</a></b>( <code>String/Class xtype</code> )
650
Ext.Container<div class="mdesc"><div class="short">Find a container above this component at any level by xtype or class</div><div class="long">Find a container above this component at any level by xtype or class<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>xtype</code> : String/Class<div class="sub-desc">The xtype string for a component, or the class of the component directly</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Container</code><div class="sub-desc">The first Container which matches the given xtype or class</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#findParentByType" ext:member="#findParentByType" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-fireEvent"></a><b><a href="source/Observable.html#method-Ext.util.Observable-fireEvent">fireEvent</a></b>( <code>String eventName</code>, <code>Object... args</code> )
652
Boolean<div class="mdesc"><div class="short">Fires the specified event with the passed parameters (minus the event name).
653
An event may be set to bubble up an Obse...</div><div class="long"><p>Fires the specified event with the passed parameters (minus the event name).</p>
654
<p>An event may be set to bubble up an Observable parent hierarchy (See <a href="output/Ext.Component.html#Ext.Component-getBubbleTarget" ext:member="getBubbleTarget" ext:cls="Ext.Component">Ext.Component.getBubbleTarget</a>)
655
by calling <a href="output/Ext.util.Observable.html#Ext.util.Observable-enableBubble" ext:member="enableBubble" ext:cls="Ext.util.Observable">enableBubble</a>.</p><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to fire.</div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers.</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#fireEvent" ext:member="#fireEvent" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-focus"></a><b><a href="source/Button.html#method-Ext.Button-focus">focus</a></b>()
657
void<div class="mdesc"><div class="short">Focus the button</div><div class="long">Focus the button<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Button.html#focus" ext:member="#focus" ext:cls="Ext.Button">Button</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.CycleButton-getActiveItem"></a><b><a href="source/CycleButton.html#method-Ext.CycleButton-getActiveItem">getActiveItem</a></b>()
659
Ext.menu.CheckItem<div class="mdesc"><div class="short">Gets the currently active menu item.</div><div class="long">Gets the currently active menu item.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.menu.CheckItem</code><div class="sub-desc">The active item</div></li></ul></div></div></div></td><td class="msource">CycleButton</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-getBox"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-getBox">getBox</a></b>( <span title="Optional" class="optional">[<code>Boolean local</code>]</span> )
661
Object<div class="mdesc"><div class="short">Gets the current box measurements of the component's underlying element.</div><div class="long">Gets the current box measurements of the component's underlying element.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>local</code> : Boolean<div class="sub-desc">(optional) If true the element's left and top are returned instead of page XY (defaults to false)</div></li></ul><strong>Returns:</strong><ul><li><code>Object</code><div class="sub-desc">box An object in the format {x, y, width, height}</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#getBox" ext:member="#getBox" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-getBubbleTarget"></a><b><a href="source/Component.html#method-Ext.Component-getBubbleTarget">getBubbleTarget</a></b>()
663
Ext.Container<div class="mdesc"><div class="short">Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy.</div><div class="long">Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.Container</code><div class="sub-desc">the Container which owns this Component.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#getBubbleTarget" ext:member="#getBubbleTarget" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-getEl"></a><b><a href="source/Component.html#method-Ext.Component-getEl">getEl</a></b>()
665
Ext.Element<div class="mdesc"><div class="short">Returns the Ext.Element which encapsulates this Component.
666
This will usually be a &lt;DIV> element created by the cla...</div><div class="long"><p>Returns the <a href="output/Ext.Element.html" ext:cls="Ext.Element">Ext.Element</a> which encapsulates this Component.</p>
667
<p>This will <i>usually</i> be a <DIV> element created by the class's onRender method, but
668
that may be overridden using the <a href="output/Ext.Component.html#Ext.Component-autoEl" ext:member="autoEl" ext:cls="Ext.Component">autoEl</a> config.</p>
669
<br><p><b>Note</b>: this element will not be available until this Component has been rendered.</p><br>
670
<p>To add listeners for <b>DOM events</b> to this Component (as opposed to listeners
671
for this Component's own Observable events), see the <a href="output/Ext.Component.html#Ext.Component-listeners" ext:member="listeners" ext:cls="Ext.Component">listeners</a> config for a suggestion,
672
or use a render listener directly:</p><pre><code><b>new</b> Ext.Panel({
673
title: <em>'The Clickable Panel'</em>,
675
render: <b>function</b>(p) {
676
<i>// Append the Panel to the click handler's argument list.</i>
677
p.getEl().on(<em>'click'</em>, handlePanelClick.createDelegate(null, [p], true));
679
single: true <i>// Remove the listener after first invocation</i>
681
});</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.Element</code><div class="sub-desc">The Element which encapsulates this Component.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#getEl" ext:member="#getEl" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-getHeight"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-getHeight">getHeight</a></b>()
683
Number<div class="mdesc"><div class="short">Gets the current height of the component's underlying element.</div><div class="long">Gets the current height of the component's underlying element.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#getHeight" ext:member="#getHeight" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-getId"></a><b><a href="source/Component.html#method-Ext.Component-getId">getId</a></b>()
685
String<div class="mdesc"><div class="short">Returns the id of this component or automatically generates and
686
returns an id if an id is not defined yet:'ext-comp-'...</div><div class="long">Returns the <code>id</code> of this component or automatically generates and
687
returns an <code>id</code> if an <code>id</code> is not defined yet:<pre><code><em>'ext-comp-'</em> + (++Ext.Component.AUTO_ID)</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc">id</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#getId" ext:member="#getId" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-getItemId"></a><b><a href="source/Component.html#method-Ext.Component-getItemId">getItemId</a></b>()
689
String<div class="mdesc"><div class="short">Returns the itemId of this component. If an
690
itemId was not assigned through configuration the
691
id is returned using g...</div><div class="long">Returns the <code><a href="output/Ext.Component.html#Ext.Component-itemId" ext:member="itemId" ext:cls="Ext.Component">itemId</a></code> of this component. If an
692
<code><a href="output/Ext.Component.html#Ext.Component-itemId" ext:member="itemId" ext:cls="Ext.Component">itemId</a></code> was not assigned through configuration the
693
<code>id</code> is returned using <code><a href="output/Ext.Component.html#Ext.Component-getId" ext:member="getId" ext:cls="Ext.Component">getId</a></code>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#getItemId" ext:member="#getItemId" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-getOuterSize"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-getOuterSize">getOuterSize</a></b>()
695
Object<div class="mdesc"><div class="short">Gets the current size of the component's underlying element, including space taken by its margins.</div><div class="long">Gets the current size of the component's underlying element, including space taken by its margins.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Object</code><div class="sub-desc">An object containing the element's size {width: (element width + left/right margins), height: (element height + top/bottom margins)}</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#getOuterSize" ext:member="#getOuterSize" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-getPosition"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-getPosition">getPosition</a></b>( <span title="Optional" class="optional">[<code>Boolean local</code>]</span> )
697
Array<div class="mdesc"><div class="short">Gets the current XY position of the component's underlying element.</div><div class="long">Gets the current XY position of the component's underlying element.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>local</code> : Boolean<div class="sub-desc">(optional) If true the element's left and top are returned instead of page XY (defaults to false)</div></li></ul><strong>Returns:</strong><ul><li><code>Array</code><div class="sub-desc">The XY position of the element (e.g., [100, 200])</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#getPosition" ext:member="#getPosition" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-getPressed"></a><b><a href="source/Button.html#method-Ext.Button-getPressed">getPressed</a></b>( <code>String group</code> )
699
Button<div class="mdesc"><div class="short">Gets the pressed button in the passed group or null</div><div class="long">Gets the pressed button in the passed group or null<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>group</code> : String<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li><code>Button</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Button.html#getPressed" ext:member="#getPressed" ext:cls="Ext.Button">Button</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-getResizeEl"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-getResizeEl">getResizeEl</a></b>()
701
void<div class="mdesc"><div class="short">Returns the outermost Element of this Component which defines the Components overall size.
702
Usually this will return t...</div><div class="long"><p>Returns the outermost Element of this Component which defines the Components overall size.</p>
703
<p><i>Usually</i> this will return the same Element as <code><a href="output/Ext.BoxComponent.html#Ext.BoxComponent-getEl" ext:member="getEl" ext:cls="Ext.BoxComponent">getEl</a></code>,
704
but in some cases, a Component may have some more wrapping Elements around its main
706
<p>An example is a ComboBox. It is encased in a <i>wrapping</i> Element which
707
contains both the <code><input></code> Element (which is what would be returned
708
by its <code><a href="output/Ext.BoxComponent.html#Ext.BoxComponent-getEl" ext:member="getEl" ext:cls="Ext.BoxComponent">getEl</a></code> method, <i>and</i> the trigger button Element.
709
This Element is returned as the <code>resizeEl</code>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#getResizeEl" ext:member="#getResizeEl" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-getSize"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-getSize">getSize</a></b>()
711
Object<div class="mdesc"><div class="short">Gets the current size of the component's underlying element.</div><div class="long">Gets the current size of the component's underlying element.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Object</code><div class="sub-desc">An object containing the element's size {width: (element width), height: (element height)}</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#getSize" ext:member="#getSize" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-getTemplateArgs"></a><b><a href="source/Button.html#method-Ext.Button-getTemplateArgs">getTemplateArgs</a></b>()
713
Object<div class="mdesc"><div class="short">This method returns an object which provides substitution parameters for the Template used
714
to create this Button's DO...</div><div class="long"><p>This method returns an object which provides substitution parameters for the <a href="output/Ext.Button.html#Ext.Button-template" ext:member="template" ext:cls="Ext.Button">Template</a> used
715
to create this Button's DOM structure.</p>
716
<p>Instances or subclasses which use a different Template to create a different DOM structure may need to provide their
717
own implementation of this method.</p>
718
<p>The default implementation which provides data for the default <a href="output/Ext.Button.html#Ext.Button-template" ext:member="template" ext:cls="Ext.Button">template</a> returns an Array containing the
719
following items:</p><div class="mdetail-params"><ul>
720
<li>The Button's <a href="output/Ext.Button.html#Ext.Button-text" ext:member="text" ext:cls="Ext.Button">text</a></li>
721
<li>The <button>'s <a href="output/Ext.Button.html#Ext.Button-type" ext:member="type" ext:cls="Ext.Button">type</a></li>
722
<li>The <a href="output/iconCls.html" ext:cls="iconCls">iconCls</a> applied to the <button> <a href="output/Ext.Button.html#Ext.Button-btnEl" ext:member="btnEl" ext:cls="Ext.Button">element</a></li>
723
<li>The <a href="output/Ext.Button.html#Ext.Button-cls" ext:member="cls" ext:cls="Ext.Button">cls</a> applied to the Button's main <a href="output/Ext.Button.html#Ext.Button-getEl" ext:member="getEl" ext:cls="Ext.Button">Element</a></li>
724
<li>A CSS class name controlling the Button's <a href="output/Ext.Button.html#Ext.Button-scale" ext:member="scale" ext:cls="Ext.Button">scale</a> and <a href="output/Ext.Button.html#Ext.Button-iconAlign" ext:member="iconAlign" ext:cls="Ext.Button">icon alignment</a></li>
725
<li>A CSS class name which applies an arrow to the Button if configured with a <a href="output/Ext.Button.html#Ext.Button-menu" ext:member="menu" ext:cls="Ext.Button">menu</a></li>
726
</ul></div><div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Object</code><div class="sub-desc">Substitution data for a Template.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Button.html#getTemplateArgs" ext:member="#getTemplateArgs" ext:cls="Ext.Button">Button</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-getText"></a><b><a href="source/Button.html#method-Ext.Button-getText">getText</a></b>()
728
String<div class="mdesc"><div class="short">Gets the text for this Button</div><div class="long">Gets the text for this Button<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc">The button text</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Button.html#getText" ext:member="#getText" ext:cls="Ext.Button">Button</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-getWidth"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-getWidth">getWidth</a></b>()
730
Number<div class="mdesc"><div class="short">Gets the current width of the component's underlying element.</div><div class="long">Gets the current width of the component's underlying element.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#getWidth" ext:member="#getWidth" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-getXType"></a><b><a href="source/Component.html#method-Ext.Component-getXType">getXType</a></b>()
732
String<div class="mdesc"><div class="short">Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
733
available xtypes, see the Ex...</div><div class="long">Gets the xtype for this component as registered with <a href="output/Ext.ComponentMgr.html" ext:cls="Ext.ComponentMgr">Ext.ComponentMgr</a>. For a list of all
734
available xtypes, see the <a href="output/Ext.Component.html" ext:cls="Ext.Component">Ext.Component</a> header. Example usage:
735
<pre><code><b>var</b> t = <b>new</b> Ext.form.TextField();
736
alert(t.getXType()); <i>// alerts <em>'textfield'</em></i></code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc">The xtype</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#getXType" ext:member="#getXType" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-getXTypes"></a><b><a href="source/Component.html#method-Ext.Component-getXTypes">getXTypes</a></b>()
738
String<div class="mdesc"><div class="short">Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all
739
available xtypes, see the Ext...</div><div class="long"><p>Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all
740
available xtypes, see the <a href="output/Ext.Component.html" ext:cls="Ext.Component">Ext.Component</a> header.</p>
741
<p><b>If using your own subclasses, be aware that a Component must register its own xtype
742
to participate in determination of inherited xtypes.</b></p>
743
<p>Example usage:</p>
744
<pre><code><b>var</b> t = <b>new</b> Ext.form.TextField();
745
alert(t.getXTypes()); <i>// alerts <em>'component/box/field/textfield'</em></i></code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc">The xtype hierarchy string</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#getXTypes" ext:member="#getXTypes" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-hasListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-hasListener">hasListener</a></b>( <code>String eventName</code> )
747
Boolean<div class="mdesc"><div class="short">Checks to see if this object has any listeners for a specified event</div><div class="long">Checks to see if this object has any listeners for a specified event<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#hasListener" ext:member="#hasListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-hasVisibleMenu"></a><b><a href="source/Button.html#method-Ext.Button-hasVisibleMenu">hasVisibleMenu</a></b>()
749
Boolean<div class="mdesc"><div class="short">Returns true if the button has a menu and it is visible</div><div class="long">Returns true if the button has a menu and it is visible<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Button.html#hasVisibleMenu" ext:member="#hasVisibleMenu" ext:cls="Ext.Button">Button</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-hide"></a><b><a href="source/Component.html#method-Ext.Component-hide">hide</a></b>()
751
Ext.Component<div class="mdesc"><div class="short">Hide this component. Listen to the 'beforehide' event and return
752
false to cancel hiding the component. Fires the 'h...</div><div class="long">Hide this component. Listen to the '<a href="output/Ext.Component.html#Ext.Component-beforehide" ext:member="beforehide" ext:cls="Ext.Component">beforehide</a>' event and return
753
<tt>false</tt> to cancel hiding the component. Fires the '<a href="output/Ext.Component.html#Ext.Component-hide" ext:member="hide" ext:cls="Ext.Component">hide</a>'
754
event after hiding the component. Note this method is called internally if
755
the component is configured to be <code><a href="output/Ext.Component.html#Ext.Component-hidden" ext:member="hidden" ext:cls="Ext.Component">hidden</a></code>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.Component</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#hide" ext:member="#hide" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-hideMenu"></a><b><a href="source/Button.html#method-Ext.Button-hideMenu">hideMenu</a></b>()
757
void<div class="mdesc"><div class="short">Hide this button's menu (if it has one)</div><div class="long">Hide this button's menu (if it has one)<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Button.html#hideMenu" ext:member="#hideMenu" ext:cls="Ext.Button">Button</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-isVisible"></a><b><a href="source/Component.html#method-Ext.Component-isVisible">isVisible</a></b>()
759
Boolean<div class="mdesc"><div class="short">Returns true if this component is visible.</div><div class="long">Returns true if this component is visible.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True if this component is visible, false otherwise.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#isVisible" ext:member="#isVisible" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-isXType"></a><b><a href="source/Component.html#method-Ext.Component-isXType">isXType</a></b>( <code>String xtype</code>, <span title="Optional" class="optional">[<code>Boolean shallow</code>]</span> )
761
Boolean<div class="mdesc"><div class="short">Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended
762
from th...</div><div class="long"><p>Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended
763
from the xtype (default) or whether it is directly of the xtype specified (shallow = true).</p>
764
<p><b>If using your own subclasses, be aware that a Component must register its own xtype
765
to participate in determination of inherited xtypes.</b></p>
766
<p>For a list of all available xtypes, see the <a href="output/Ext.Component.html" ext:cls="Ext.Component">Ext.Component</a> header.</p>
767
<p>Example usage:</p>
768
<pre><code><b>var</b> t = <b>new</b> Ext.form.TextField();
769
<b>var</b> isText = t.isXType(<em>'textfield'</em>); <i>// true</i>
770
<b>var</b> isBoxSubclass = t.isXType(<em>'box'</em>); <i>// true, descended from BoxComponent</i>
771
<b>var</b> isBoxInstance = t.isXType(<em>'box'</em>, true); <i>// false, not a direct BoxComponent instance</i></code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>xtype</code> : String<div class="sub-desc">The xtype to check for this Component</div></li><li><code>shallow</code> : Boolean<div class="sub-desc">(optional) False to check whether this Component is descended from the xtype (this is
772
the default), or true to check whether this Component is directly of the specified xtype.</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True if this component descends from the specified xtype, false otherwise.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#isXType" ext:member="#isXType" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-nextSibling"></a><b><a href="source/Component.html#method-Ext.Component-nextSibling">nextSibling</a></b>()
774
Ext.Component<div class="mdesc"><div class="short">Returns the next component in the owning container</div><div class="long">Returns the next component in the owning container<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.Component</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#nextSibling" ext:member="#nextSibling" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-on"></a><b><a href="source/Observable.html#method-Ext.util.Observable-on">on</a></b>( <code>String eventName</code>, <code>Function handler</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span>, <span title="Optional" class="optional">[<code>Object options</code>]</span> )
776
void<div class="mdesc"><div class="short">Appends an event handler to this object (shorthand for addListener.)</div><div class="long">Appends an event handler to this object (shorthand for <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a>.)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
777
<b>If omitted, defaults to the object which fired the event.</b></div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#on" ext:member="#on" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-previousSibling"></a><b><a href="source/Component.html#method-Ext.Component-previousSibling">previousSibling</a></b>()
779
Ext.Component<div class="mdesc"><div class="short">Returns the previous component in the owning container</div><div class="long">Returns the previous component in the owning container<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.Component</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#previousSibling" ext:member="#previousSibling" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-purgeListeners"></a><b><a href="source/Observable.html#method-Ext.util.Observable-purgeListeners">purgeListeners</a></b>()
781
void<div class="mdesc"><div class="short">Removes all listeners for this object</div><div class="long">Removes all listeners for this object<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#purgeListeners" ext:member="#purgeListeners" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-relayEvents"></a><b><a href="source/Observable-more.html#method-Ext.util.Observable-relayEvents">relayEvents</a></b>( <code>Object o</code>, <code>Array events</code> )
783
void<div class="mdesc"><div class="short">Relays selected events from the specified Observable as if the events were fired by this.</div><div class="long">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>o</code> : Object<div class="sub-desc">The Observable whose events this object is to relay.</div></li><li><code>events</code> : Array<div class="sub-desc">Array of event names to relay.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#relayEvents" ext:member="#relayEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-removeClass"></a><b><a href="source/Component.html#method-Ext.Component-removeClass">removeClass</a></b>( <code>string cls</code> )
785
Ext.Component<div class="mdesc"><div class="short">Removes a CSS class from the component's underlying element.</div><div class="long">Removes a CSS class from the component's underlying element.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>cls</code> : string<div class="sub-desc">The CSS class name to remove</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Component</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#removeClass" ext:member="#removeClass" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-removeListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-removeListener">removeListener</a></b>( <code>String eventName</code>, <code>Function handler</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span> )
787
void<div class="mdesc"><div class="short">Removes an event handler.</div><div class="long">Removes an event handler.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event the handler was associated with.</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove. <b>This must be a reference to the function passed into the <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> call.</b></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope originally specified for the handler.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#removeListener" ext:member="#removeListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-render"></a><b><a href="source/Component.html#method-Ext.Component-render">render</a></b>( <span title="Optional" class="optional">[<code>Element/HTMLElement/String container</code>]</span>, <span title="Optional" class="optional">[<code>String/Number position</code>]</span> )
789
void<div class="mdesc"><div class="short">Render this Component into the passed HTML element.
790
If you are using a Container object to house this Component, then...</div><div class="long"><p>Render this Component into the passed HTML element.</p>
791
<p><b>If you are using a <a href="output/Ext.Container.html" ext:cls="Ext.Container">Container</a> object to house this Component, then
792
do not use the render method.</b></p>
793
<p>A Container's child Components are rendered by that Container's
794
<a href="output/Ext.Container.html#Ext.Container-layout" ext:member="layout" ext:cls="Ext.Container">layout</a> manager when the Container is first rendered.</p>
795
<p>Certain layout managers allow dynamic addition of child components. Those that do
796
include <a href="output/Ext.layout.CardLayout.html" ext:cls="Ext.layout.CardLayout">Ext.layout.CardLayout</a>, <a href="output/Ext.layout.AnchorLayout.html" ext:cls="Ext.layout.AnchorLayout">Ext.layout.AnchorLayout</a>,
797
<a href="output/Ext.layout.FormLayout.html" ext:cls="Ext.layout.FormLayout">Ext.layout.FormLayout</a>, <a href="output/Ext.layout.TableLayout.html" ext:cls="Ext.layout.TableLayout">Ext.layout.TableLayout</a>.</p>
798
<p>If the Container is already rendered when a new child Component is added, you may need to call
799
the Container's <a href="output/Ext.Container.html#Ext.Container-doLayout" ext:member="doLayout" ext:cls="Ext.Container">doLayout</a> to refresh the view which causes any
800
unrendered child Components to be rendered. This is required so that you can add multiple
801
child components if needed while only refreshing the layout once.</p>
802
<p>When creating complex UIs, it is important to remember that sizing and positioning
803
of child items is the responsibility of the Container's <a href="output/Ext.Container.html#Ext.Container-layout" ext:member="layout" ext:cls="Ext.Container">layout</a> manager.
804
If you expect child items to be sized in response to user interactions, you must
805
configure the Container with a layout manager which creates and manages the type of layout you
807
<p><b>Omitting the Container's <a href="output/Ext.Container.html#Ext.Container-layout" ext:member="layout" ext:cls="Ext.Container">layout</a> config means that a basic
808
layout manager is used which does nothing but render child components sequentially into the
809
Container. No sizing or positioning will be performed in this situation.</b></p><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>container</code> : Element/HTMLElement/String<div class="sub-desc">(optional) The element this Component should be
810
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>
811
which this component will be inserted (defaults to appending to the end of the container)</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#render" ext:member="#render" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-resumeEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-resumeEvents">resumeEvents</a></b>()
813
void<div class="mdesc"><div class="short">Resume firing events. (see suspendEvents)
814
If events were suspended using the queueSuspended parameter, then all
815
event...</div><div class="long">Resume firing events. (see <a href="output/Ext.util.Observable.html#Ext.util.Observable-suspendEvents" ext:member="suspendEvents" ext:cls="Ext.util.Observable">suspendEvents</a>)
816
If events were suspended using the <tt><b>queueSuspended</b></tt> parameter, then all
817
events fired during event suspension will be sent to any listeners now.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#resumeEvents" ext:member="#resumeEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.CycleButton-setActiveItem"></a><b><a href="source/CycleButton.html#method-Ext.CycleButton-setActiveItem">setActiveItem</a></b>( <code>Ext.menu.CheckItem item</code>, <code>Boolean suppressEvent</code> )
819
void<div class="mdesc"><div class="short">Sets the button's active menu item.</div><div class="long">Sets the button's active menu item.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>item</code> : Ext.menu.CheckItem<div class="sub-desc">The item to activate</div></li><li><code>suppressEvent</code> : Boolean<div class="sub-desc">True to prevent the button's change event from firing (defaults to false)</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">CycleButton</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.SplitButton-setArrowHandler"></a><b><a href="source/SplitButton.html#method-Ext.SplitButton-setArrowHandler">setArrowHandler</a></b>( <code>Function handler</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span> )
821
void<div class="mdesc"><div class="short">Sets this button's arrow click handler.</div><div class="long">Sets this button's arrow click handler.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>handler</code> : Function<div class="sub-desc">The function to call when the arrow is clicked</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) Scope for the function passed above</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.SplitButton.html#setArrowHandler" ext:member="#setArrowHandler" ext:cls="Ext.SplitButton">SplitButton</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-setDisabled"></a><b><a href="source/Component.html#method-Ext.Component-setDisabled">setDisabled</a></b>( <code>Boolean disabled</code> )
823
Ext.Component<div class="mdesc"><div class="short">Convenience function for setting disabled/enabled by boolean.</div><div class="long">Convenience function for setting disabled/enabled by boolean.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>disabled</code> : Boolean<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Component</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#setDisabled" ext:member="#setDisabled" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-setHandler"></a><b><a href="source/Button.html#method-Ext.Button-setHandler">setHandler</a></b>( <code>Function handler</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span> )
825
Ext.Button<div class="mdesc"><div class="short">Assigns this Button's click handler</div><div class="long">Assigns this Button's click handler<div class="mdetail-params"><strong>Parameters:</strong><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. Defaults to this Button.</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Button</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Button.html#setHandler" ext:member="#setHandler" ext:cls="Ext.Button">Button</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-setHeight"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-setHeight">setHeight</a></b>( <code>Number height</code> )
827
Ext.BoxComponent<div class="mdesc"><div class="short">Sets the height of the component. This method fires the resize event.</div><div class="long">Sets the height of the component. This method fires the <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-resize" ext:member="resize" ext:cls="Ext.BoxComponent">resize</a> event.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>height</code> : Number<div class="sub-desc">The new height to set. This may be one of:<div class="mdetail-params"><ul>
828
<li>A Number specifying the new height in the <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-getEl" ext:member="getEl" ext:cls="Ext.BoxComponent">Element</a>'s <a href="output/Ext.Element.html#Ext.Element-defaultUnit" ext:member="defaultUnit" ext:cls="Ext.Element">Ext.Element.defaultUnit</a>s (by default, pixels).</li>
829
<li>A String used to set the CSS height style.</li>
830
<li><i>undefined</i> to leave the height unchanged.</li>
831
</ul></div></div></li></ul><strong>Returns:</strong><ul><li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#setHeight" ext:member="#setHeight" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-setIconClass"></a><b><a href="source/Button.html#method-Ext.Button-setIconClass">setIconClass</a></b>( <code>String cls</code> )
833
Ext.Button<div class="mdesc"><div class="short">Sets the CSS class that provides a background image to use as the button's icon. This method also changes
834
the value ...</div><div class="long">Sets the CSS class that provides a background image to use as the button's icon. This method also changes
835
the value of the <a href="output/iconCls.html" ext:cls="iconCls">iconCls</a> config internally.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>cls</code> : String<div class="sub-desc">The CSS class providing the icon image</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Button</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Button.html#setIconClass" ext:member="#setIconClass" ext:cls="Ext.Button">Button</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-setPagePosition"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-setPagePosition">setPagePosition</a></b>( <code>Number x</code>, <code>Number y</code> )
837
Ext.BoxComponent<div class="mdesc"><div class="short">Sets the page XY position of the component. To set the left and top instead, use setPosition.
838
This method fires the ...</div><div class="long">Sets the page XY position of the component. To set the left and top instead, use <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-setPosition" ext:member="setPosition" ext:cls="Ext.BoxComponent">setPosition</a>.
839
This method fires the <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-move" ext:member="move" ext:cls="Ext.BoxComponent">move</a> event.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>x</code> : Number<div class="sub-desc">The new x position</div></li><li><code>y</code> : Number<div class="sub-desc">The new y position</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#setPagePosition" ext:member="#setPagePosition" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-setPosition"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-setPosition">setPosition</a></b>( <code>Number left</code>, <code>Number top</code> )
841
Ext.BoxComponent<div class="mdesc"><div class="short">Sets the left and top of the component. To set the page XY position instead, use setPagePosition.
842
This method fires ...</div><div class="long">Sets the left and top of the component. To set the page XY position instead, use <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-setPagePosition" ext:member="setPagePosition" ext:cls="Ext.BoxComponent">setPagePosition</a>.
843
This method fires the <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-move" ext:member="move" ext:cls="Ext.BoxComponent">move</a> event.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>left</code> : Number<div class="sub-desc">The new left</div></li><li><code>top</code> : Number<div class="sub-desc">The new top</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#setPosition" ext:member="#setPosition" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-setSize"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-setSize">setSize</a></b>( <code>Mixed width</code>, <code>Mixed height</code> )
845
Ext.BoxComponent<div class="mdesc"><div class="short">Sets the width and height of this BoxComponent. This method fires the resize event. This method can accept
846
either wid...</div><div class="long">Sets the width and height of this BoxComponent. This method fires the <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-resize" ext:member="resize" ext:cls="Ext.BoxComponent">resize</a> event. This method can accept
847
either width and height as separate arguments, or you can pass a size object like <code>{width:10, height:20}</code>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>width</code> : Mixed<div class="sub-desc">The new width to set. This may be one of:<div class="mdetail-params"><ul>
848
<li>A Number specifying the new width in the <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-getEl" ext:member="getEl" ext:cls="Ext.BoxComponent">Element</a>'s <a href="output/Ext.Element.html#Ext.Element-defaultUnit" ext:member="defaultUnit" ext:cls="Ext.Element">Ext.Element.defaultUnit</a>s (by default, pixels).</li>
849
<li>A String used to set the CSS width style.</li>
850
<li>A size object in the format <code>{width: widthValue, height: heightValue}</code>.</li>
851
<li><code>undefined</code> to leave the width unchanged.</li>
852
</ul></div></div></li><li><code>height</code> : Mixed<div class="sub-desc">The new height to set (not required if a size object is passed as the first arg).
853
This may be one of:<div class="mdetail-params"><ul>
854
<li>A Number specifying the new height in the <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-getEl" ext:member="getEl" ext:cls="Ext.BoxComponent">Element</a>'s <a href="output/Ext.Element.html#Ext.Element-defaultUnit" ext:member="defaultUnit" ext:cls="Ext.Element">Ext.Element.defaultUnit</a>s (by default, pixels).</li>
855
<li>A String used to set the CSS height style. Animation may <b>not</b> be used.</li>
856
<li><code>undefined</code> to leave the height unchanged.</li>
857
</ul></div></div></li></ul><strong>Returns:</strong><ul><li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#setSize" ext:member="#setSize" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-setText"></a><b><a href="source/Button.html#method-Ext.Button-setText">setText</a></b>( <code>String text</code> )
859
Ext.Button<div class="mdesc"><div class="short">Sets this Button's text</div><div class="long">Sets this Button's text<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>text</code> : String<div class="sub-desc">The button text</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Button</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Button.html#setText" ext:member="#setText" ext:cls="Ext.Button">Button</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-setTooltip"></a><b><a href="source/Button.html#method-Ext.Button-setTooltip">setTooltip</a></b>( <code>String/Object tooltip.</code> )
861
Ext.Button<div class="mdesc"><div class="short">Sets the tooltip for this Button.</div><div class="long">Sets the tooltip for this Button.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>tooltip.</code> : String/Object<div class="sub-desc">This may be:<div class="mdesc-details"><ul>
862
<li><b>String</b> : A string to be used as innerHTML (html tags are accepted) to show in a tooltip</li>
863
<li><b>Object</b> : A configuration object for <a href="output/Ext.QuickTips.html#Ext.QuickTips-register" ext:member="register" ext:cls="Ext.QuickTips">Ext.QuickTips.register</a>.</li>
864
</ul></div></div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Button</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Button.html#setTooltip" ext:member="#setTooltip" ext:cls="Ext.Button">Button</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-setVisible"></a><b><a href="source/Component.html#method-Ext.Component-setVisible">setVisible</a></b>( <code>Boolean visible</code> )
866
Ext.Component<div class="mdesc"><div class="short">Convenience function to hide or show this component by boolean.</div><div class="long">Convenience function to hide or show this component by boolean.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>visible</code> : Boolean<div class="sub-desc">True to show, false to hide</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Component</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#setVisible" ext:member="#setVisible" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-setWidth"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-setWidth">setWidth</a></b>( <code>Number width</code> )
868
Ext.BoxComponent<div class="mdesc"><div class="short">Sets the width of the component. This method fires the resize event.</div><div class="long">Sets the width of the component. This method fires the <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-resize" ext:member="resize" ext:cls="Ext.BoxComponent">resize</a> event.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>width</code> : Number<div class="sub-desc">The new width to setThis may be one of:<div class="mdetail-params"><ul>
869
<li>A Number specifying the new width in the <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-getEl" ext:member="getEl" ext:cls="Ext.BoxComponent">Element</a>'s <a href="output/Ext.Element.html#Ext.Element-defaultUnit" ext:member="defaultUnit" ext:cls="Ext.Element">Ext.Element.defaultUnit</a>s (by default, pixels).</li>
870
<li>A String used to set the CSS width style.</li>
871
</ul></div></div></li></ul><strong>Returns:</strong><ul><li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#setWidth" ext:member="#setWidth" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-show"></a><b><a href="source/Component.html#method-Ext.Component-show">show</a></b>()
873
Ext.Component<div class="mdesc"><div class="short">Show this component. Listen to the 'beforeshow' event and return
874
false to cancel showing the component. Fires the '...</div><div class="long">Show this component. Listen to the '<a href="output/Ext.Component.html#Ext.Component-beforeshow" ext:member="beforeshow" ext:cls="Ext.Component">beforeshow</a>' event and return
875
<tt>false</tt> to cancel showing the component. Fires the '<a href="output/Ext.Component.html#Ext.Component-show" ext:member="show" ext:cls="Ext.Component">show</a>'
876
event after showing the component.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.Component</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#show" ext:member="#show" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-showMenu"></a><b><a href="source/Button.html#method-Ext.Button-showMenu">showMenu</a></b>()
878
void<div class="mdesc"><div class="short">Show this button's menu (if it has one)</div><div class="long">Show this button's menu (if it has one)<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Button.html#showMenu" ext:member="#showMenu" ext:cls="Ext.Button">Button</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-suspendEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-suspendEvents">suspendEvents</a></b>( <code>Boolean queueSuspended</code> )
880
void<div class="mdesc"><div class="short">Suspend the firing of all events. (see resumeEvents)</div><div class="long">Suspend the firing of all events. (see <a href="output/Ext.util.Observable.html#Ext.util.Observable-resumeEvents" ext:member="resumeEvents" ext:cls="Ext.util.Observable">resumeEvents</a>)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>queueSuspended</code> : Boolean<div class="sub-desc">Pass as true to queue up suspended events to be fired
881
after the <a href="output/Ext.util.Observable.html#Ext.util.Observable-resumeEvents" ext:member="resumeEvents" ext:cls="Ext.util.Observable">resumeEvents</a> call instead of discarding all suspended events;</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#suspendEvents" ext:member="#suspendEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-syncSize"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-syncSize">syncSize</a></b>()
883
Ext.BoxComponent<div class="mdesc"><div class="short">Force the component's size to recalculate based on the underlying element's current height and width.</div><div class="long">Force the component's size to recalculate based on the underlying element's current height and width.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#syncSize" ext:member="#syncSize" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-toggle"></a><b><a href="source/Button.html#method-Ext.Button-toggle">toggle</a></b>( <span title="Optional" class="optional">[<code>Boolean state</code>]</span>, <span title="Optional" class="optional">[<code>Boolean supressEvent</code>]</span> )
885
Ext.Button<div class="mdesc"><div class="short">If a state it passed, it becomes the pressed state otherwise the current state is toggled.</div><div class="long">If a state it passed, it becomes the pressed state otherwise the current state is toggled.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>state</code> : Boolean<div class="sub-desc">(optional) Force a particular state</div></li><li><code>supressEvent</code> : Boolean<div class="sub-desc">(optional) True to stop events being fired when calling this method.</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Button</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Button.html#toggle" ext:member="#toggle" ext:cls="Ext.Button">Button</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.CycleButton-toggleSelected"></a><b><a href="source/CycleButton.html#method-Ext.CycleButton-toggleSelected">toggleSelected</a></b>()
887
void<div class="mdesc"><div class="short">This is normally called internally on button click, but can be called externally to advance the button's
888
active item...</div><div class="long">This is normally called internally on button click, but can be called externally to advance the button's
889
active item programmatically to the next one in the menu. If the current item is the last one in the menu
890
the active item will be set to the first item in the menu.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">CycleButton</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-un"></a><b><a href="source/Observable.html#method-Ext.util.Observable-un">un</a></b>( <code>String eventName</code>, <code>Function handler</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span> )
892
void<div class="mdesc"><div class="short">Removes an event handler (shorthand for removeListener.)</div><div class="long">Removes an event handler (shorthand for <a href="output/Ext.util.Observable.html#Ext.util.Observable-removeListener" ext:member="removeListener" ext:cls="Ext.util.Observable">removeListener</a>.)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event the handler was associated with.</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove. <b>This must be a reference to the function passed into the <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> call.</b></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope originally specified for the handler.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#un" ext:member="#un" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-updateBox"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-updateBox">updateBox</a></b>( <code>Object box</code> )
894
Ext.BoxComponent<div class="mdesc"><div class="short">Sets the current box measurements of the component's underlying element.</div><div class="long">Sets the current box measurements of the component's underlying element.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>box</code> : Object<div class="sub-desc">An object in the format {x, y, width, height}</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#updateBox" ext:member="#updateBox" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr></tbody></table><a id="Ext.CycleButton-events"></a><h2>Public Events</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Event</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-afterrender"></a><b><a href="source/Component.html#event-Ext.Component-afterrender">afterrender</a></b> :
895
( <code>Ext.Component this</code> )
896
<div class="mdesc"><div class="short">Fires after the component rendering is finished.
897
The afterrender event is fired after this Component has been rendere...</div><div class="long"><p>Fires after the component rendering is finished.</p>
898
<p>The afterrender event is fired after this Component has been <a href="output/Ext.Component.html#Ext.Component-rendered" ext:member="rendered" ext:cls="Ext.Component">rendered</a>, been postprocesed
899
by any afterRender method defined for the Component, and, if <a href="output/Ext.Component.html#Ext.Component-stateful" ext:member="stateful" ext:cls="Ext.Component">stateful</a>, after state
900
has been restored.</p><div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#afterrender" ext:member="#afterrender" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.SplitButton-arrowclick"></a><b><a href="source/SplitButton.html#event-Ext.SplitButton-arrowclick">arrowclick</a></b> :
901
( <code>MenuButton this</code>, <code>EventObject e</code> )
902
<div class="mdesc"><div class="short">Fires when this button's arrow is clicked</div><div class="long">Fires when this button's arrow is clicked<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : MenuButton<div class="sub-desc"></div></li><li><code>e</code> : EventObject<div class="sub-desc">The click event</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.SplitButton.html#arrowclick" ext:member="#arrowclick" ext:cls="Ext.SplitButton">SplitButton</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-beforedestroy"></a><b><a href="source/Component.html#event-Ext.Component-beforedestroy">beforedestroy</a></b> :
903
( <code>Ext.Component this</code> )
904
<div class="mdesc"><div class="short">Fires before the component is destroyed. Return false from an event handler to stop the destroy.</div><div class="long">Fires before the component is <a href="output/Ext.Component.html#Ext.Component-destroy" ext:member="destroy" ext:cls="Ext.Component">destroy</a>ed. Return false from an event handler to stop the <a href="output/Ext.Component.html#Ext.Component-destroy" ext:member="destroy" ext:cls="Ext.Component">destroy</a>.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#beforedestroy" ext:member="#beforedestroy" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-beforehide"></a><b><a href="source/Component.html#event-Ext.Component-beforehide">beforehide</a></b> :
905
( <code>Ext.Component this</code> )
906
<div class="mdesc"><div class="short">Fires before the component is hidden by calling the hide method.
907
Return false from an event handler to stop the hide.</div><div class="long">Fires before the component is hidden by calling the <a href="output/Ext.Component.html#Ext.Component-hide" ext:member="hide" ext:cls="Ext.Component">hide</a> method.
908
Return false from an event handler to stop the hide.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#beforehide" ext:member="#beforehide" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-beforerender"></a><b><a href="source/Component.html#event-Ext.Component-beforerender">beforerender</a></b> :
909
( <code>Ext.Component this</code> )
910
<div class="mdesc"><div class="short">Fires before the component is rendered. Return false from an
911
event handler to stop the render.</div><div class="long">Fires before the component is <a href="output/Ext.Component.html#Ext.Component-rendered" ext:member="rendered" ext:cls="Ext.Component">rendered</a>. Return false from an
912
event handler to stop the <a href="output/Ext.Component.html#Ext.Component-render" ext:member="render" ext:cls="Ext.Component">render</a>.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#beforerender" ext:member="#beforerender" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-beforeshow"></a><b><a href="source/Component.html#event-Ext.Component-beforeshow">beforeshow</a></b> :
913
( <code>Ext.Component this</code> )
914
<div class="mdesc"><div class="short">Fires before the component is shown by calling the show method.
915
Return false from an event handler to stop the show.</div><div class="long">Fires before the component is shown by calling the <a href="output/Ext.Component.html#Ext.Component-show" ext:member="show" ext:cls="Ext.Component">show</a> method.
916
Return false from an event handler to stop the show.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#beforeshow" ext:member="#beforeshow" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-beforestaterestore"></a><b><a href="source/Component.html#event-Ext.Component-beforestaterestore">beforestaterestore</a></b> :
917
( <code>Ext.Component this</code>, <code>Object state</code> )
918
<div class="mdesc"><div class="short">Fires before the state of the component is restored. Return false from an event handler to stop the restore.</div><div class="long">Fires before the state of the component is restored. Return false from an event handler to stop the restore.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>state</code> : Object<div class="sub-desc">The hash of state values returned from the StateProvider. If this
919
event is not vetoed, then the state object is passed to <b><tt>applyState</tt></b>. By default,
920
that simply copies property values into this Component. The method maybe overriden to
921
provide custom state restoration.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#beforestaterestore" ext:member="#beforestaterestore" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-beforestatesave"></a><b><a href="source/Component.html#event-Ext.Component-beforestatesave">beforestatesave</a></b> :
922
( <code>Ext.Component this</code>, <code>Object state</code> )
923
<div class="mdesc"><div class="short">Fires before the state of the component is saved to the configured state provider. Return false to stop the save.</div><div class="long">Fires before the state of the component is saved to the configured state provider. Return false to stop the save.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>state</code> : Object<div class="sub-desc">The hash of state values. This is determined by calling
924
<b><tt>getState()</tt></b> on the Component. This method must be provided by the
925
developer to return whetever representation of state is required, by default, Ext.Component
926
has a null implementation.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#beforestatesave" ext:member="#beforestatesave" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.CycleButton-change"></a><b><a href="source/CycleButton.html#event-Ext.CycleButton-change">change</a></b> :
927
( <code>Ext.CycleButton this</code>, <code>Ext.menu.CheckItem item</code> )
928
<div class="mdesc"><div class="short">Fires after the button's active menu item has changed. Note that if a changeHandler function
929
is set on this CycleBu...</div><div class="long">Fires after the button's active menu item has changed. Note that if a <a href="output/Ext.CycleButton.html#Ext.CycleButton-changeHandler" ext:member="changeHandler" ext:cls="Ext.CycleButton">changeHandler</a> function
930
is set on this CycleButton, it will be called instead on active item change and this change event will
931
not be fired.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.CycleButton<div class="sub-desc"></div></li><li><code>item</code> : Ext.menu.CheckItem<div class="sub-desc">The menu item that was selected</div></li></ul></div></div></div></td><td class="msource">CycleButton</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-click"></a><b><a href="source/Button.html#event-Ext.Button-click">click</a></b> :
932
( <code>Button this</code>, <code>EventObject e</code> )
933
<div class="mdesc"><div class="short">Fires when this button is clicked</div><div class="long">Fires when this button is clicked<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Button<div class="sub-desc"></div></li><li><code>e</code> : EventObject<div class="sub-desc">The click event</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Button.html#click" ext:member="#click" ext:cls="Ext.Button">Button</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-destroy"></a><b><a href="source/Component.html#event-Ext.Component-destroy">destroy</a></b> :
934
( <code>Ext.Component this</code> )
935
<div class="mdesc"><div class="short">Fires after the component is destroyed.</div><div class="long">Fires after the component is <a href="output/Ext.Component.html#Ext.Component-destroy" ext:member="destroy" ext:cls="Ext.Component">destroy</a>ed.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#destroy" ext:member="#destroy" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-disable"></a><b><a href="source/Component.html#event-Ext.Component-disable">disable</a></b> :
936
( <code>Ext.Component this</code> )
937
<div class="mdesc"><div class="short">Fires after the component is disabled.</div><div class="long">Fires after the component is disabled.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#disable" ext:member="#disable" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-enable"></a><b><a href="source/Component.html#event-Ext.Component-enable">enable</a></b> :
938
( <code>Ext.Component this</code> )
939
<div class="mdesc"><div class="short">Fires after the component is enabled.</div><div class="long">Fires after the component is enabled.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#enable" ext:member="#enable" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-hide"></a><b><a href="source/Component.html#event-Ext.Component-hide">hide</a></b> :
940
( <code>Ext.Component this</code> )
941
<div class="mdesc"><div class="short">Fires after the component is hidden.
942
Fires after the component is hidden when calling the hide method.</div><div class="long">Fires after the component is hidden.
943
Fires after the component is hidden when calling the <a href="output/Ext.Component.html#Ext.Component-hide" ext:member="hide" ext:cls="Ext.Component">hide</a> method.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#hide" ext:member="#hide" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-menuhide"></a><b><a href="source/Button.html#event-Ext.Button-menuhide">menuhide</a></b> :
944
( <code>Button this</code>, <code>Menu menu</code> )
945
<div class="mdesc"><div class="short">If this button has a menu, this event fires when it is hidden</div><div class="long">If this button has a menu, this event fires when it is hidden<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Button<div class="sub-desc"></div></li><li><code>menu</code> : Menu<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Button.html#menuhide" ext:member="#menuhide" ext:cls="Ext.Button">Button</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-menushow"></a><b><a href="source/Button.html#event-Ext.Button-menushow">menushow</a></b> :
946
( <code>Button this</code>, <code>Menu menu</code> )
947
<div class="mdesc"><div class="short">If this button has a menu, this event fires when it is shown</div><div class="long">If this button has a menu, this event fires when it is shown<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Button<div class="sub-desc"></div></li><li><code>menu</code> : Menu<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Button.html#menushow" ext:member="#menushow" ext:cls="Ext.Button">Button</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-menutriggerout"></a><b><a href="source/Button.html#event-Ext.Button-menutriggerout">menutriggerout</a></b> :
948
( <code>Button this</code>, <code>Menu menu</code>, <code>EventObject e</code> )
949
<div class="mdesc"><div class="short">If this button has a menu, this event fires when the mouse leaves the menu triggering element</div><div class="long">If this button has a menu, this event fires when the mouse leaves the menu triggering element<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><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></div></div></div></td><td class="msource"><a href="output/Ext.Button.html#menutriggerout" ext:member="#menutriggerout" ext:cls="Ext.Button">Button</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-menutriggerover"></a><b><a href="source/Button.html#event-Ext.Button-menutriggerover">menutriggerover</a></b> :
950
( <code>Button this</code>, <code>Menu menu</code>, <code>EventObject e</code> )
951
<div class="mdesc"><div class="short">If this button has a menu, this event fires when the mouse enters the menu triggering element</div><div class="long">If this button has a menu, this event fires when the mouse enters the menu triggering element<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><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></div></div></div></td><td class="msource"><a href="output/Ext.Button.html#menutriggerover" ext:member="#menutriggerover" ext:cls="Ext.Button">Button</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-mouseout"></a><b><a href="source/Button.html#event-Ext.Button-mouseout">mouseout</a></b> :
952
( <code>Button this</code>, <code>Event e</code> )
953
<div class="mdesc"><div class="short">Fires when the mouse exits the button</div><div class="long">Fires when the mouse exits the button<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><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></div></div></div></td><td class="msource"><a href="output/Ext.Button.html#mouseout" ext:member="#mouseout" ext:cls="Ext.Button">Button</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-mouseover"></a><b><a href="source/Button.html#event-Ext.Button-mouseover">mouseover</a></b> :
954
( <code>Button this</code>, <code>Event e</code> )
955
<div class="mdesc"><div class="short">Fires when the mouse hovers over the button</div><div class="long">Fires when the mouse hovers over the button<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><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></div></div></div></td><td class="msource"><a href="output/Ext.Button.html#mouseover" ext:member="#mouseover" ext:cls="Ext.Button">Button</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-move"></a><b><a href="source/BoxComponent.html#event-Ext.BoxComponent-move">move</a></b> :
956
( <code>Ext.Component this</code>, <code>Number x</code>, <code>Number y</code> )
957
<div class="mdesc"><div class="short">Fires after the component is moved.</div><div class="long">Fires after the component is moved.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>x</code> : Number<div class="sub-desc">The new x position</div></li><li><code>y</code> : Number<div class="sub-desc">The new y position</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#move" ext:member="#move" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-render"></a><b><a href="source/Component.html#event-Ext.Component-render">render</a></b> :
958
( <code>Ext.Component this</code> )
959
<div class="mdesc"><div class="short">Fires after the component markup is rendered.</div><div class="long">Fires after the component markup is <a href="output/Ext.Component.html#Ext.Component-rendered" ext:member="rendered" ext:cls="Ext.Component">rendered</a>.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#render" ext:member="#render" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-resize"></a><b><a href="source/BoxComponent.html#event-Ext.BoxComponent-resize">resize</a></b> :
960
( <code>Ext.Component this</code>, <code>Number adjWidth</code>, <code>Number adjHeight</code>, <code>Number rawWidth</code>, <code>Number rawHeight</code> )
961
<div class="mdesc"><div class="short">Fires after the component is resized.</div><div class="long">Fires after the component is resized.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>adjWidth</code> : Number<div class="sub-desc">The box-adjusted width that was set</div></li><li><code>adjHeight</code> : Number<div class="sub-desc">The box-adjusted height that was set</div></li><li><code>rawWidth</code> : Number<div class="sub-desc">The width that was originally specified</div></li><li><code>rawHeight</code> : Number<div class="sub-desc">The height that was originally specified</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#resize" ext:member="#resize" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-show"></a><b><a href="source/Component.html#event-Ext.Component-show">show</a></b> :
962
( <code>Ext.Component this</code> )
963
<div class="mdesc"><div class="short">Fires after the component is shown when calling the show method.</div><div class="long">Fires after the component is shown when calling the <a href="output/Ext.Component.html#Ext.Component-show" ext:member="show" ext:cls="Ext.Component">show</a> method.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#show" ext:member="#show" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-staterestore"></a><b><a href="source/Component.html#event-Ext.Component-staterestore">staterestore</a></b> :
964
( <code>Ext.Component this</code>, <code>Object state</code> )
965
<div class="mdesc"><div class="short">Fires after the state of the component is restored.</div><div class="long">Fires after the state of the component is restored.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>state</code> : Object<div class="sub-desc">The hash of state values returned from the StateProvider. This is passed
966
to <b><tt>applyState</tt></b>. By default, that simply copies property values into this
967
Component. The method maybe overriden to provide custom state restoration.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#staterestore" ext:member="#staterestore" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-statesave"></a><b><a href="source/Component.html#event-Ext.Component-statesave">statesave</a></b> :
968
( <code>Ext.Component this</code>, <code>Object state</code> )
969
<div class="mdesc"><div class="short">Fires after the state of the component is saved to the configured state provider.</div><div class="long">Fires after the state of the component is saved to the configured state provider.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>state</code> : Object<div class="sub-desc">The hash of state values. This is determined by calling
970
<b><tt>getState()</tt></b> on the Component. This method must be provided by the
971
developer to return whetever representation of state is required, by default, Ext.Component
972
has a null implementation.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#statesave" ext:member="#statesave" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Button-toggle"></a><b><a href="source/Button.html#event-Ext.Button-toggle">toggle</a></b> :
973
( <code>Button this</code>, <code>Boolean pressed</code> )
974
<div class="mdesc"><div class="short">Fires when the 'pressed' state of this button changes (only if enableToggle = true)</div><div class="long">Fires when the 'pressed' state of this button changes (only if enableToggle = true)<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Button<div class="sub-desc"></div></li><li><code>pressed</code> : Boolean<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Button.html#toggle" ext:member="#toggle" ext:cls="Ext.Button">Button</a></td></tr></tbody></table></div>
b'\\ No newline at end of file'
added
removed
webui/ecosystem/workspace/extjs/docs/output/Ext.CycleButton.html
