Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / docs / api / Ext.button.Cycle.html
1 <!DOCTYPE html><html><head><title>Ext.button.Cycle | Ext JS 4.0 Documentation</title><script type="text/javascript" src="../ext-all.js"></script><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../scrollbars.css" type="text/css"><link rel="stylesheet" href="../docs.css" type="text/css"><link id="styleCss" rel="stylesheet" href="../style.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script><link rel="stylesheet" href="../prettify.css" type="text/css"><!-- link(rel: 'stylesheet', href: req.baseURL + '/css/ext4.css', type: 'text/css')--><link rel="shortcut icon" type="image/ico" href="../favicon.ico"><!--[if IE]>
2 <style type="text/css">.head-band { display: none; }
3 .header { border: 0; top: 0; left: 0px; background: url(../header.gif) repeat-x; }
4 .doc-tab .members .member a.more { background-color: #efefef; }
5 </style><link rel="stylesheet" href="/new/css/ie.css" type="text/css"><![endif]-->
6 </head><body id="ext-body" class="iScroll"><div id="notice" class="notice">For up to date documentation and features, visit 
7 <a href="http://docs.sencha.com/ext-js/4-0">http://docs.sencha.com/ext-js/4-0</a></div><div class="wrapper"><div class="head-band"></div><div class="header"><h2><a href="../index.html">Sencha Documentation</a></h2></div><div id="search"><form><input type="text" placeholder="Search" id="search-field" autocomplete="off" name="q"></form><div id="search-box"></div></div><div id="treePanel"></div><div id="container"><script type="text/javascript">
8
9     req = {
10         liveURL: '.',
11         standAloneMode: true,
12         origDocClass: 'Ext.button.Cycle',
13         docClass: 'Ext.button.Cycle',
14         docReq: 'Ext.button.Cycle',
15         version: '4.0',
16         baseURL: '.',
17         baseDocURL: '.',
18         baseProdURL: '.'
19     };
20
21     clsInfo = {};
22
23
24
25 </script>
26
27 <script type="text/javascript" src="../search.js"></script>
28 <!--script type="text/javascript" src="/new/javascripts/app/examples.js"></script-->
29 <script type="text/javascript" src="../class_tree.js"></script>
30 <script type="text/javascript" src="../class_doc.js"></script>
31 <script type="text/javascript">
32     req.source = 'Cycle.html#Ext-button.Cycle';
33     clsInfo = {"methods":["Cycle","addClass","addCls","addClsWithUI","addEvents","addListener","addManagedListener","addStateEvents","afterComponentLayout","alignTo","animate","applyState","beforeComponentLayout","bubble","capture","center","clearListeners","clearManagedListeners","cloneConfig","destroy","disable","doAutoRender","doComponentLayout","doConstrain","enable","enableBubble","findLayoutController","findParentBy","findParentByType","fireEvent","focus","getActiveAnimation","getActiveItem","getBox","getBubbleTarget","getEl","getHeight","getId","getInsertPosition","getLoader","getPlugin","getPosition","getPressed","getSize","getState","getStateId","getTemplateArgs","getText","getWidth","getXType","getXTypes","hasListener","hasUICls","hasVisibleMenu","hide","hideMenu","is","isDescendantOf","isDisabled","isDraggable","isDroppable","isFloating","isHidden","isVisible","isXType","nextNode","nextSibling","observe","on","previousNode","previousSibling","relayEvents","releaseCapture","removeCls","removeClsWithUI","removeListener","removeManagedListener","resumeEvents","sequenceFx","setActive","setActiveItem","setArrowHandler","setAutoScroll","setDisabled","setDocked","setHandler","setHeight","setIcon","setIconCls","setLoading","setPagePosition","setParams","setPosition","setScale","setSize","setText","setTooltip","setUI","setVisible","setWidth","show","showMenu","stopAnimation","suspendEvents","syncFx","toBack","toFront","toggle","toggleSelected","un","up","update","updateBox"],"cfgs":["allowDepress","arrowAlign","arrowCls","arrowHandler","arrowTooltip","autoEl","autoRender","autoScroll","autoShow","autoWidth","baseCls","border","changeHandler","clickEvent","cls","componentCls","componentLayout","contentEl","data","disabled","disabledCls","draggable","enableToggle","floating","focusCls","focusOnToFront","forceIcon","frame","handleMouseEvents","handler","height","hidden","hideMode","html","icon","iconAlign","iconCls","id","itemId","items","listeners","loader","maintainFlex","margin","maxHeight","maxWidth","menu","menuActiveCls","menuAlign","minHeight","minWidth","overCls","overflowText","padding","plugins","prependText","pressed","pressedCls","preventDefault","renderSelectors","renderTo","renderTpl","repeat","resizable","resizeHandles","saveBuffer","scale","scope","shadow","showText","stateEvents","stateId","stateful","style","styleHtmlCls","styleHtmlContent","tabIndex","text","toFrontOnShow","toggleGroup","toggleHandler","tooltip","tooltipType","tpl","tplWriteMode","type","ui","width"],"properties":["disabled","draggable","floatParent","frameSize","hasActiveFx","hidden","maskOnDisable","menu","ownerCt","pressed","rendered","stopFx","template","zIndexManager"],"events":["activate","added","afterrender","arrowclick","beforeactivate","beforedeactivate","beforedestroy","beforehide","beforerender","beforeshow","beforestaterestore","beforestatesave","change","click","deactivate","destroy","disable","enable","hide","menuhide","menushow","menutriggerout","menutriggerover","mouseout","mouseover","move","removed","render","resize","show","staterestore","statesave","toggle"],"subclasses":[]};
34     Ext.onReady(function() {
35         Ext.create('Docs.classPanel');
36     });
37 </script><div id="top-block" class="top-block"><h1 id="clsTitle" class="comp"><a href="../source/Cycle.html#Ext-button.Cycle" target="_blank">Ext.button.Cycle</a><span>xtype: cycle</span></h1></div><div id="docContent"><div id="doc-overview-content"><div class="lft"><pre class="subclasses"><h4>Hierarchy</h4><div class="subclass f"><a href="Ext.AbstractComponent.html" rel="Ext.AbstractComponent" class="cls docClass">Ext.AbstractComponent</a><div class="subclass"><a href="Ext.Component.html" rel="Ext.Component" class="cls docClass">Ext.Component</a><div class="subclass"><a href="Ext.button.Button.html" rel="Ext.button.Button" class="cls docClass">Ext.button.Button</a><div class="subclass"><a href="Ext.button.Split.html" rel="Ext.button.Split" class="cls docClass">Ext.button.Split</a><div class="subclass"><strong>Ext.button.Cycle</strong></div></div></div></div></div><h4>Mixins</h4><div class="mixin"><a href="Ext.util.Observable.html" rel="Ext.util.Observable" class="cls docClass">Ext.util.Observable</a></div><div class="mixin"><a href="Ext.util.Animate.html" rel="Ext.util.Animate" class="cls docClass">Ext.util.Animate</a></div><div class="mixin"><a href="Ext.state.Stateful.html" rel="Ext.state.Stateful" class="cls docClass">Ext.state.Stateful</a></div><div class="mixin"><a href="Ext.util.Floating.html" rel="Ext.util.Floating" class="cls docClass">Ext.util.Floating</a></div></pre><p>A specialized SplitButton that contains a menu of <a href="Ext.menu.CheckItem.html" rel="Ext.menu.CheckItem" class="docClass">Ext.menu.CheckItem</a> elements.  The button automatically
38 cycles through each menu item on click, raising the button's <a href="Ext.button.Cycle.html#change" rel="Ext.button.Cycle#change" class="docClass">change</a> event (or calling the button's
39 <a href="Ext.button.Cycle.html#changeHandler" rel="Ext.button.Cycle#changeHandler" class="docClass">changeHandler</a> function, if supplied) for the active menu item. Clicking on the arrow section of the
40 button displays the dropdown menu just like a normal SplitButton.<br/>
41 <img class="screenshot" src="../Ext.button.Cycle.png" alt="Ext.button.Cycle component" />
42 Example usage:</p>
43
44 <pre class="prettyprint"><code>Ext.create('Ext.button.Cycle', {
45     showText: true,
46     prependText: 'View as ',
47     renderTo: Ext.getBody(),
48     menu: {
49         id: 'view-type-menu',
50         items: [{
51             text:'text only',
52             iconCls:'view-text',
53             checked:true
54         },{
55             text:'HTML',
56             iconCls:'view-html'
57         }]
58     },
59     changeHandler:function(cycleBtn, activeItem){
60         Ext.Msg.alert('Change View', activeItem.text);
61     }
62 });
63 </code></pre>
64
65 <div class="members"><div class="m-cfgs"><div class="definedBy">Defined By</div><a name="configs"></a><h3 class="cfg p">Config Options</h3><h4 class="cfgGroup">CSS Class configs</h4><div id="config-arrowCls" class="member f inherited"><a href="Ext.button.Cycle.html#config-arrowCls" rel="config-arrowCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-arrowCls" class="viewSource">view source</a></div><a name="arrowCls"></a><a name="config-arrowCls"></a><a href="Ext.button.Cycle.html#" rel="config-arrowCls" class="cls expand">arrowCls</a><span> : String</span></div><div class="description"><div class="short"><p>(Optional) The className used for the inner arrow element if the button has a menu.</p>
66
67 </div><div class="long"><p>(Optional) The className used for the inner arrow element if the button has a menu.</p>
68
69 </div></div></div><div id="config-baseCls" class="member inherited"><a href="Ext.button.Cycle.html#config-baseCls" rel="config-baseCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-baseCls" class="viewSource">view source</a></div><a name="baseCls"></a><a name="config-baseCls"></a><a href="Ext.button.Cycle.html#" rel="config-baseCls" class="cls expand">baseCls</a><span> : String</span></div><div class="description"><div class="short"><p>The base CSS class to add to all buttons. (Defaults to 'x-btn')</p>
70 </div><div class="long"><p>The base CSS class to add to all buttons. (Defaults to 'x-btn')</p>
71 </div></div></div><div id="config-cls" class="member inherited"><a href="Ext.button.Cycle.html#config-cls" rel="config-cls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-cls" class="viewSource">view source</a></div><a name="cls"></a><a name="config-cls"></a><a href="Ext.button.Cycle.html#" rel="config-cls" class="cls expand">cls</a><span> : String</span></div><div class="description"><div class="short"><p>A CSS class string to apply to the button's main element.</p>
72 </div><div class="long"><p>A CSS class string to apply to the button's main element.</p>
73 </div></div></div><div id="config-componentCls" class="member inherited"><a href="Ext.button.Cycle.html#config-componentCls" rel="config-componentCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-componentCls" class="viewSource">view source</a></div><a name="componentCls"></a><a name="config-componentCls"></a><a href="Ext.button.Cycle.html#" rel="config-componentCls" class="cls expand">componentCls</a><span> : String</span></div><div class="description"><div class="short"><p>CSS Class to be added to a components root level element to give distinction to it
74 via styling.</p>
75 </div><div class="long"><p>CSS Class to be added to a components root level element to give distinction to it
76 via styling.</p>
77 </div></div></div><div id="config-disabledCls" class="member inherited"><a href="Ext.button.Cycle.html#config-disabledCls" rel="config-disabledCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-disabledCls" class="viewSource">view source</a></div><a name="disabledCls"></a><a name="config-disabledCls"></a><a href="Ext.button.Cycle.html#" rel="config-disabledCls" class="cls expand">disabledCls</a><span> : String</span></div><div class="description"><div class="short"><p>CSS class to add when the Component is disabled. Defaults to 'x-item-disabled'.</p>
78 </div><div class="long"><p>CSS class to add when the Component is disabled. Defaults to 'x-item-disabled'.</p>
79 </div></div></div><div id="config-focusCls" class="member inherited"><a href="Ext.button.Cycle.html#config-focusCls" rel="config-focusCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-focusCls" class="viewSource">view source</a></div><a name="focusCls"></a><a name="config-focusCls"></a><a href="Ext.button.Cycle.html#" rel="config-focusCls" class="cls expand">focusCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class to add to a button when it is in the focussed state. (Defaults to 'x-btn-focus')</p>
80 </div><div class="long"><p>The CSS class to add to a button when it is in the focussed state. (Defaults to 'x-btn-focus')</p>
81 </div></div></div><div id="config-iconCls" class="member inherited"><a href="Ext.button.Cycle.html#config-iconCls" rel="config-iconCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-iconCls" class="viewSource">view source</a></div><a name="iconCls"></a><a name="config-iconCls"></a><a href="Ext.button.Cycle.html#" rel="config-iconCls" class="cls expand">iconCls</a><span> : String</span></div><div class="description"><div class="short"><p>A css class which sets a background image to be used as the icon for this button</p>
82 </div><div class="long"><p>A css class which sets a background image to be used as the icon for this button</p>
83 </div></div></div><div id="config-menuActiveCls" class="member inherited"><a href="Ext.button.Cycle.html#config-menuActiveCls" rel="config-menuActiveCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-menuActiveCls" class="viewSource">view source</a></div><a name="menuActiveCls"></a><a name="config-menuActiveCls"></a><a href="Ext.button.Cycle.html#" rel="config-menuActiveCls" class="cls expand">menuActiveCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class to add to a button when it's menu is active. (Defaults to 'x-btn-menu-active')</p>
84 </div><div class="long"><p>The CSS class to add to a button when it's menu is active. (Defaults to 'x-btn-menu-active')</p>
85 </div></div></div><div id="config-overCls" class="member inherited"><a href="Ext.button.Cycle.html#config-overCls" rel="config-overCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-overCls" class="viewSource">view source</a></div><a name="overCls"></a><a name="config-overCls"></a><a href="Ext.button.Cycle.html#" rel="config-overCls" class="cls expand">overCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class to add to a button when it is in the over (hovered) state. (Defaults to 'x-btn-over')</p>
86 </div><div class="long"><p>The CSS class to add to a button when it is in the over (hovered) state. (Defaults to 'x-btn-over')</p>
87 </div></div></div><div id="config-pressedCls" class="member inherited"><a href="Ext.button.Cycle.html#config-pressedCls" rel="config-pressedCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-pressedCls" class="viewSource">view source</a></div><a name="pressedCls"></a><a name="config-pressedCls"></a><a href="Ext.button.Cycle.html#" rel="config-pressedCls" class="cls expand">pressedCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class to add to a button when it is in the pressed state. (Defaults to 'x-btn-pressed')</p>
88 </div><div class="long"><p>The CSS class to add to a button when it is in the pressed state. (Defaults to 'x-btn-pressed')</p>
89 </div></div></div><div id="config-styleHtmlCls" class="member inherited"><a href="Ext.button.Cycle.html#config-styleHtmlCls" rel="config-styleHtmlCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-styleHtmlCls" class="viewSource">view source</a></div><a name="styleHtmlCls"></a><a name="config-styleHtmlCls"></a><a href="Ext.button.Cycle.html#" rel="config-styleHtmlCls" class="cls expand">styleHtmlCls</a><span> : String</span></div><div class="description"><div class="short"><p>The class that is added to the content target when you set styleHtmlContent to true.
90 Defaults to 'x-html'</p>
91 </div><div class="long"><p>The class that is added to the content target when you set styleHtmlContent to true.
92 Defaults to 'x-html'</p>
93 </div></div></div><h4 class="cfgGroup">Other Configs</h4><div id="config-allowDepress" class="member f inherited"><a href="Ext.button.Cycle.html#config-allowDepress" rel="config-allowDepress" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-allowDepress" class="viewSource">view source</a></div><a name="allowDepress"></a><a name="config-allowDepress"></a><a href="Ext.button.Cycle.html#" rel="config-allowDepress" class="cls expand">allowDepress</a><span> : Boolean</span></div><div class="description"><div class="short"><p>False to not allow a pressed Button to be depressed (defaults to undefined). Only valid when <a href="Ext.button.Cycle.html#enableToggle" rel="Ext.button.Cycle#enableToggle" class="docClass">enableToggle</a> is true.</p>
94 </div><div class="long"><p>False to not allow a pressed Button to be depressed (defaults to undefined). Only valid when <a href="Ext.button.Cycle.html#enableToggle" rel="Ext.button.Cycle#enableToggle" class="docClass">enableToggle</a> is true.</p>
95 </div></div></div><div id="config-arrowAlign" class="member inherited"><a href="Ext.button.Cycle.html#config-arrowAlign" rel="config-arrowAlign" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-arrowAlign" class="viewSource">view source</a></div><a name="arrowAlign"></a><a name="config-arrowAlign"></a><a href="Ext.button.Cycle.html#" rel="config-arrowAlign" class="cls expand">arrowAlign</a><span> : String</span></div><div class="description"><div class="short">(Optional) The side of the Button box to render the arrow if the button has an associated menu.
96 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="Ext.button.Cycle.html#menu" rel="Ext.button.Cycle#menu" class="docClass">menu</a>.
97 Two values are allowed:</p>
98
99
100 <ul class="mdetail-params">
101 <li>'right'<div class="sub-desc"></div></li>
102 <li>'bottom'<div class="sub-desc"></div></li>
103 </ul>
104
105
106 <p>Defaults to <b><tt>'right'</tt></b>.</p>
107
108 </div></div></div><div id="config-arrowCls" class="member inherited"><a href="Ext.button.Cycle.html#config-arrowCls" rel="config-arrowCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-arrowCls" class="viewSource">view source</a></div><a name="arrowCls"></a><a name="config-arrowCls"></a><a href="Ext.button.Cycle.html#" rel="config-arrowCls" class="cls expand">arrowCls</a><span> : String</span></div><div class="description"><div class="short"><p>(Optional) The className used for the inner arrow element if the button has a menu.</p>
109
110 </div><div class="long"><p>(Optional) The className used for the inner arrow element if the button has a menu.</p>
111
112 </div></div></div><div id="config-arrowHandler" class="member inherited"><a href="Ext.button.Cycle.html#config-arrowHandler" rel="config-arrowHandler" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Split.html" class="definedIn docClass">Ext.button.Split</a><br/><a href="../source/Split.html#Ext-button.Split-cfg-arrowHandler" class="viewSource">view source</a></div><a name="arrowHandler"></a><a name="config-arrowHandler"></a><a href="Ext.button.Cycle.html#" rel="config-arrowHandler" class="cls expand">arrowHandler</a><span> : Function</span></div><div class="description"><div class="short"><p>A function called when the arrow button is clicked (can be used instead of click event)</p>
113 </div><div class="long"><p>A function called when the arrow button is clicked (can be used instead of click event)</p>
114 </div></div></div><div id="config-arrowTooltip" class="member inherited"><a href="Ext.button.Cycle.html#config-arrowTooltip" rel="config-arrowTooltip" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Split.html" class="definedIn docClass">Ext.button.Split</a><br/><a href="../source/Split.html#Ext-button.Split-cfg-arrowTooltip" class="viewSource">view source</a></div><a name="arrowTooltip"></a><a name="config-arrowTooltip"></a><a href="Ext.button.Cycle.html#" rel="config-arrowTooltip" class="cls expand">arrowTooltip</a><span> : String</span></div><div class="description"><div class="short"><p>The title attribute of the arrow</p>
115 </div><div class="long"><p>The title attribute of the arrow</p>
116 </div></div></div><div id="config-autoEl" class="member inherited"><a href="Ext.button.Cycle.html#config-autoEl" rel="config-autoEl" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-autoEl" class="viewSource">view source</a></div><a name="autoEl"></a><a name="config-autoEl"></a><a href="Ext.button.Cycle.html#" rel="config-autoEl" class="cls expand">autoEl</a><span> : Mixed</span></div><div class="description"><div class="short">A tag name or DomHelper spec used to create the Element which will
117 encapsulate this Component.
118
119
120 You do not normally ...</div><div class="long"><p>A tag name or <a href="Ext.core.DomHelper.html" rel="Ext.core.DomHelper" class="docClass">DomHelper</a> spec used to create the <a href="Ext.button.Cycle.html#getEl" rel="Ext.button.Cycle#getEl" class="docClass">Element</a> which will
121 encapsulate this Component.</p>
122
123
124 <p>You do not normally need to specify this. For the base classes <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a> and <a href="Ext.container.Container.html" rel="Ext.container.Container" class="docClass">Ext.container.Container</a>,
125 this defaults to <b><tt>'div'</tt></b>. The more complex Sencha classes use a more complex
126 DOM structure specified by their own <a href="Ext.button.Cycle.html#renderTpl" rel="Ext.button.Cycle#renderTpl" class="docClass">renderTpl</a>s.</p>
127
128
129 <p>This is intended to allow the developer to create application-specific utility Components encapsulated by
130 different DOM elements. Example usage:</p>
131
132
133 <pre><code>{
134     xtype: 'component',
135     autoEl: {
136         tag: 'img',
137         src: 'http://www.example.com/example.jpg'
138     }
139 }, {
140     xtype: 'component',
141     autoEl: {
142         tag: 'blockquote',
143         html: 'autoEl is cool!'
144     }
145 }, {
146     xtype: 'container',
147     autoEl: 'ul',
148     cls: 'ux-unordered-list',
149     items: {
150         xtype: 'component',
151         autoEl: 'li',
152         html: 'First list item'
153     }
154 }
155 </code></pre>
156
157 </div></div></div><div id="config-autoRender" class="member inherited"><a href="Ext.button.Cycle.html#config-autoRender" rel="config-autoRender" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-autoRender" class="viewSource">view source</a></div><a name="autoRender"></a><a name="config-autoRender"></a><a href="Ext.button.Cycle.html#" rel="config-autoRender" class="cls expand">autoRender</a><span> : Mixed</span></div><div class="description"><div class="short">This config is intended mainly for floating Components which may or may not be shown. Instead
158 of using renderTo in th...</div><div class="long"><p>This config is intended mainly for <a href="Ext.button.Cycle.html#floating" rel="Ext.button.Cycle#floating" class="docClass">floating</a> Components which may or may not be shown. Instead
159 of using <a href="Ext.button.Cycle.html#renderTo" rel="Ext.button.Cycle#renderTo" class="docClass">renderTo</a> in the configuration, and rendering upon construction, this allows a Component
160 to render itself upon first <i><a href="Ext.button.Cycle.html#show" rel="Ext.button.Cycle#show" class="docClass">show</a></i>.</p>
161
162
163 <p>Specify as <code>true</code> to have this Component render to the document body upon first show.</p>
164
165
166 <p>Specify as an element, or the ID of an element to have this Component render to a specific element upon first show.</p>
167
168
169 <p><b>This defaults to <code>true</code> for the <a href="Ext.window.Window.html" rel="Ext.window.Window" class="docClass">Window</a> class.</b></p>
170
171 </div></div></div><div id="config-autoScroll" class="member inherited"><a href="Ext.button.Cycle.html#config-autoScroll" rel="config-autoScroll" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-cfg-autoScroll" class="viewSource">view source</a></div><a name="autoScroll"></a><a name="config-autoScroll"></a><a href="Ext.button.Cycle.html#" rel="config-autoScroll" class="cls expand">autoScroll</a><span> : Boolean</span></div><div class="description"><div class="short">true to use overflow:'auto' on the components layout element and show scroll bars automatically when
172 necessary, false...</div><div class="long"><p><code>true</code> to use overflow:'auto' on the components layout element and show scroll bars automatically when
173 necessary, <code>false</code> to clip any overflowing content (defaults to <code>false</code>).</p>
174 </div></div></div><div id="config-autoShow" class="member inherited"><a href="Ext.button.Cycle.html#config-autoShow" rel="config-autoShow" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-autoShow" class="viewSource">view source</a></div><a name="autoShow"></a><a name="config-autoShow"></a><a href="Ext.button.Cycle.html#" rel="config-autoShow" class="cls expand">autoShow</a><span> : Boolean</span></div><div class="description"><div class="short">True to automatically show the component upon creation.
175 This config option may only be used for floating components o...</div><div class="long"><p>True to automatically show the component upon creation.
176 This config option may only be used for <a href="Ext.button.Cycle.html#floating" rel="Ext.button.Cycle#floating" class="docClass">floating</a> components or components
177 that use <a href="Ext.button.Cycle.html#autoRender" rel="Ext.button.Cycle#autoRender" class="docClass">autoRender</a>. Defaults to <tt>false</tt>.</p>
178 </div></div></div><div id="config-autoWidth" class="member inherited"><a href="Ext.button.Cycle.html#config-autoWidth" rel="config-autoWidth" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-autoWidth" class="viewSource">view source</a></div><a name="autoWidth"></a><a name="config-autoWidth"></a><a href="Ext.button.Cycle.html#" rel="config-autoWidth" class="cls expand">autoWidth</a><span> : Boolean</span></div><div class="description"><div class="short">By default, if a width is not specified the button will attempt to stretch horizontally to fit its content.
179 If the bu...</div><div class="long"><p>By default, if a width is not specified the button will attempt to stretch horizontally to fit its content.
180 If the button is being managed by a width sizing layout (hbox, fit, anchor), set this to false to prevent
181 the button from doing this automatic sizing.
182 Defaults to <tt>undefined</tt>.</p>
183 </div></div></div><div id="config-baseCls" class="member inherited"><a href="Ext.button.Cycle.html#config-baseCls" rel="config-baseCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-baseCls" class="viewSource">view source</a></div><a name="baseCls"></a><a name="config-baseCls"></a><a href="Ext.button.Cycle.html#" rel="config-baseCls" class="cls expand">baseCls</a><span> : String</span></div><div class="description"><div class="short"><p>The base CSS class to add to all buttons. (Defaults to 'x-btn')</p>
184 </div><div class="long"><p>The base CSS class to add to all buttons. (Defaults to 'x-btn')</p>
185 </div></div></div><div id="config-border" class="member inherited"><a href="Ext.button.Cycle.html#config-border" rel="config-border" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-border" class="viewSource">view source</a></div><a name="border"></a><a name="config-border"></a><a href="Ext.button.Cycle.html#" rel="config-border" class="cls expand">border</a><span> : Number/String</span></div><div class="description"><div class="short">Specifies the border for this component. The border can be a single numeric value to apply to all sides or
186 it can be ...</div><div class="long"><p>Specifies the border for this component. The border can be a single numeric value to apply to all sides or
187 it can be a CSS style specification for each style, for example: '10 5 3 10'.</p>
188 </div></div></div><div id="config-changeHandler" class="member ni"><a href="Ext.button.Cycle.html#config-changeHandler" rel="config-changeHandler" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Cycle.html" class="definedIn docClass">Ext.button.Cycle</a><br/><a href="../source/Cycle.html#Ext-button.Cycle-cfg-changeHandler" class="viewSource">view source</a></div><a name="changeHandler"></a><a name="config-changeHandler"></a><a href="Ext.button.Cycle.html#" rel="config-changeHandler" class="cls expand">changeHandler</a><span> : Function</span></div><div class="description"><div class="short">A callback function that will be invoked each time the active menu
189 item in the button's menu has changed.  If this ca...</div><div class="long"><p>A callback function that will be invoked each time the active menu
190 item in the button's menu has changed.  If this callback is not supplied, the SplitButton will instead
191 fire the <a href="Ext.button.Cycle.html#change" rel="Ext.button.Cycle#change" class="docClass">change</a> event on active item change.  The changeHandler function will be called with the
192 following argument list: (SplitButton this, <a href="Ext.menu.CheckItem.html" rel="Ext.menu.CheckItem" class="docClass">Ext.menu.CheckItem</a> item)</p>
193 </div></div></div><div id="config-clickEvent" class="member inherited"><a href="Ext.button.Cycle.html#config-clickEvent" rel="config-clickEvent" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-clickEvent" class="viewSource">view source</a></div><a name="clickEvent"></a><a name="config-clickEvent"></a><a href="Ext.button.Cycle.html#" rel="config-clickEvent" class="cls expand">clickEvent</a><span> : String</span></div><div class="description"><div class="short">The DOM event that will fire the handler of the button. This can be any valid event name (dblclick, contextmenu).
194 Def...</div><div class="long"><p>The DOM event that will fire the handler of the button. This can be any valid event name (dblclick, contextmenu).
195 Defaults to <tt>'click'</tt>.</p>
196 </div></div></div><div id="config-cls" class="member inherited"><a href="Ext.button.Cycle.html#config-cls" rel="config-cls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-cls" class="viewSource">view source</a></div><a name="cls"></a><a name="config-cls"></a><a href="Ext.button.Cycle.html#" rel="config-cls" class="cls expand">cls</a><span> : String</span></div><div class="description"><div class="short"><p>A CSS class string to apply to the button's main element.</p>
197 </div><div class="long"><p>A CSS class string to apply to the button's main element.</p>
198 </div></div></div><div id="config-componentCls" class="member inherited"><a href="Ext.button.Cycle.html#config-componentCls" rel="config-componentCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-componentCls" class="viewSource">view source</a></div><a name="componentCls"></a><a name="config-componentCls"></a><a href="Ext.button.Cycle.html#" rel="config-componentCls" class="cls expand">componentCls</a><span> : String</span></div><div class="description"><div class="short"><p>CSS Class to be added to a components root level element to give distinction to it
199 via styling.</p>
200 </div><div class="long"><p>CSS Class to be added to a components root level element to give distinction to it
201 via styling.</p>
202 </div></div></div><div id="config-componentLayout" class="member inherited"><a href="Ext.button.Cycle.html#config-componentLayout" rel="config-componentLayout" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-componentLayout" class="viewSource">view source</a></div><a name="componentLayout"></a><a name="config-componentLayout"></a><a href="Ext.button.Cycle.html#" rel="config-componentLayout" class="cls expand">componentLayout</a><span> : String/Object</span></div><div class="description"><div class="short">The sizing and positioning of a Component's internal Elements is the responsibility of
203 the Component's layout manager...</div><div class="long"><p>The sizing and positioning of a Component's internal Elements is the responsibility of
204 the Component's layout manager which sizes a Component's internal structure in response to the Component being sized.</p>
205
206
207 <p>Generally, developers will not use this configuration as all provided Components which need their internal
208 elements sizing (Such as <a href="Ext.form.field.Base.html" rel="Ext.form.field.Base" class="docClass">input fields</a>) come with their own componentLayout managers.</p>
209
210
211 <p>The <a href="Ext.layout.container.Auto.html" rel="Ext.layout.container.Auto" class="docClass">default layout manager</a> will be used on instances of the base <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a> class
212 which simply sizes the Component's encapsulating element to the height and width specified in the <a href="Ext.button.Cycle.html#setSize" rel="Ext.button.Cycle#setSize" class="docClass">setSize</a> method.</p>
213
214 </div></div></div><div id="config-contentEl" class="member inherited"><a href="Ext.button.Cycle.html#config-contentEl" rel="config-contentEl" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-contentEl" class="viewSource">view source</a></div><a name="contentEl"></a><a name="config-contentEl"></a><a href="Ext.button.Cycle.html#" rel="config-contentEl" class="cls expand">contentEl</a><span> : String</span></div><div class="description"><div class="short">Optional. Specify an existing HTML element, or the id of an existing HTML element to use as the content
215 for this comp...</div><div class="long"><p>Optional. Specify an existing HTML element, or the <code>id</code> of an existing HTML element to use as the content
216 for this component.</p>
217
218
219 <ul>
220 <li><b>Description</b> :
221 <div class="sub-desc">This config option is used to take an existing HTML element and place it in the layout element
222 of a new component (it simply moves the specified DOM element <i>after the Component is rendered</i> to use as the content.</div></li>
223 <li><b>Notes</b> :
224 <div class="sub-desc">The specified HTML element is appended to the layout element of the component <i>after any configured
225 <a href="Ext.button.Cycle.html#html" rel="Ext.button.Cycle#html" class="docClass">HTML</a> has been inserted</i>, and so the document will not contain this element at the time the <a href="Ext.button.Cycle.html#render" rel="Ext.button.Cycle#render" class="docClass">render</a> event is fired.</div>
226 <div class="sub-desc">The specified HTML element used will not participate in any <code><b><a href="Ext.container.Container.html#layout" rel="Ext.container.Container#layout" class="docClass">layout</a></b></code>
227 scheme that the Component may use. It is just HTML. Layouts operate on child <code><b><a href="Ext.container.Container.html#items" rel="Ext.container.Container#items" class="docClass">items</a></b></code>.</div>
228 <div class="sub-desc">Add either the <code>x-hidden</code> or the <code>x-hide-display</code> CSS class to
229 prevent a brief flicker of the content before it is rendered to the panel.</div></li>
230 </ul>
231
232 </div></div></div><div id="config-data" class="member inherited"><a href="Ext.button.Cycle.html#config-data" rel="config-data" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-data" class="viewSource">view source</a></div><a name="data"></a><a name="config-data"></a><a href="Ext.button.Cycle.html#" rel="config-data" class="cls expand">data</a><span> : Mixed</span></div><div class="description"><div class="short"><p>The initial set of data to apply to the <code><a href="Ext.button.Cycle.html#tpl" rel="Ext.button.Cycle#tpl" class="docClass">tpl</a></code> to
233 update the content area of the Component.</p>
234 </div><div class="long"><p>The initial set of data to apply to the <code><a href="Ext.button.Cycle.html#tpl" rel="Ext.button.Cycle#tpl" class="docClass">tpl</a></code> to
235 update the content area of the Component.</p>
236 </div></div></div><div id="config-disabled" class="member inherited"><a href="Ext.button.Cycle.html#config-disabled" rel="config-disabled" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-disabled" class="viewSource">view source</a></div><a name="disabled"></a><a name="config-disabled"></a><a href="Ext.button.Cycle.html#" rel="config-disabled" class="cls expand">disabled</a><span> : Boolean</span></div><div class="description"><div class="short"><p>True to start disabled (defaults to false)</p>
237 </div><div class="long"><p>True to start disabled (defaults to false)</p>
238 </div></div></div><div id="config-disabledCls" class="member inherited"><a href="Ext.button.Cycle.html#config-disabledCls" rel="config-disabledCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-disabledCls" class="viewSource">view source</a></div><a name="disabledCls"></a><a name="config-disabledCls"></a><a href="Ext.button.Cycle.html#" rel="config-disabledCls" class="cls expand">disabledCls</a><span> : String</span></div><div class="description"><div class="short"><p>CSS class to add when the Component is disabled. Defaults to 'x-item-disabled'.</p>
239 </div><div class="long"><p>CSS class to add when the Component is disabled. Defaults to 'x-item-disabled'.</p>
240 </div></div></div><div id="config-draggable" class="member inherited"><a href="Ext.button.Cycle.html#config-draggable" rel="config-draggable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-cfg-draggable" class="viewSource">view source</a></div><a name="draggable"></a><a name="config-draggable"></a><a href="Ext.button.Cycle.html#" rel="config-draggable" class="cls expand">draggable</a><span> : Mixed</span></div><div class="description"><div class="short">Specify as true to make a floating Component draggable using the Component's encapsulating element as the drag handle...</div><div class="long"><p>Specify as true to make a <a href="Ext.button.Cycle.html#floating" rel="Ext.button.Cycle#floating" class="docClass">floating</a> Component draggable using the Component's encapsulating element as the drag handle.</p>
241
242
243 <p>This may also be specified as a config object for the <a href="Ext.util.ComponentDragger.html" rel="Ext.util.ComponentDragger" class="docClass">ComponentDragger</a> which is instantiated to perform dragging.</p>
244
245
246 <p>For example to create a Component which may only be dragged around using a certain internal element as the drag handle,
247 use the delegate option:</p>
248
249
250 <p><code></p>
251
252 <pre>new Ext.Component({
253     constrain: true,
254     floating:true,
255     style: {
256         backgroundColor: '#fff',
257         border: '1px solid black'
258     },
259     html: '&lt;h1 style="cursor:move"&gt;The title&lt;/h1&gt;&lt;p&gt;The content&lt;/p&gt;',
260     draggable: {
261         delegate: 'h1'
262     }
263 }).show();
264 </pre>
265
266
267 <p></code></p>
268 </div></div></div><div id="config-enableToggle" class="member inherited"><a href="Ext.button.Cycle.html#config-enableToggle" rel="config-enableToggle" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-enableToggle" class="viewSource">view source</a></div><a name="enableToggle"></a><a name="config-enableToggle"></a><a href="Ext.button.Cycle.html#" rel="config-enableToggle" class="cls expand">enableToggle</a><span> : Boolean</span></div><div class="description"><div class="short"><p>True to enable pressed/not pressed toggling (defaults to false)</p>
269 </div><div class="long"><p>True to enable pressed/not pressed toggling (defaults to false)</p>
270 </div></div></div><div id="config-floating" class="member inherited"><a href="Ext.button.Cycle.html#config-floating" rel="config-floating" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-cfg-floating" class="viewSource">view source</a></div><a name="floating"></a><a name="config-floating"></a><a href="Ext.button.Cycle.html#" rel="config-floating" class="cls expand">floating</a><span> : Boolean</span></div><div class="description"><div class="short">Specify as true to float the Component outside of the document flow using CSS absolute positioning.
271
272
273 Components such...</div><div class="long"><p>Specify as true to float the Component outside of the document flow using CSS absolute positioning.</p>
274
275
276 <p>Components such as <a href="Ext.window.Window.html" rel="Ext.window.Window" class="docClass">Window</a>s and <a href="Ext.menu.Menu.html" rel="Ext.menu.Menu" class="docClass">Menu</a>s are floating
277 by default.</p>
278
279
280 <p>Floating Components that are programatically <a href="Ext.Component.html#render" rel="Ext.Component#render" class="docClass">rendered</a> will register themselves with the global
281 <a href="Ext.WindowManager.html" rel="Ext.WindowManager" class="docClass">ZIndexManager</a></p>
282
283
284 <h3 class="pa">Floating Components as child items of a Container</h3>
285
286
287 <p>A floating Component may be used as a child item of a Container. This just allows the floating Component to seek a ZIndexManager by
288 examining the ownerCt chain.</p>
289
290
291 <p>When configured as floating, Components acquire, at render time, a <a href="Ext.ZIndexManager.html" rel="Ext.ZIndexManager" class="docClass">ZIndexManager</a> which manages a stack
292 of related floating Components. The ZIndexManager brings a single floating Component to the top of its stack when
293 the Component's <a href="Ext.button.Cycle.html#toFront" rel="Ext.button.Cycle#toFront" class="docClass">toFront</a> method is called.</p>
294
295
296 <p>The ZIndexManager is found by traversing up the <a href="Ext.button.Cycle.html#ownerCt" rel="Ext.button.Cycle#ownerCt" class="docClass">ownerCt</a> chain to find an ancestor which itself is floating. This is so that
297 descendant floating Components of floating <i>Containers</i> (Such as a ComboBox dropdown within a Window) can have its zIndex managed relative
298 to any siblings, but always <b>above</b> that floating ancestor Container.</p>
299
300
301 <p>If no floating ancestor is found, a floating Component registers itself with the default <a href="Ext.WindowManager.html" rel="Ext.WindowManager" class="docClass">ZIndexManager</a>.</p>
302
303
304 <p>Floating components <i>do not participate in the Container's layout</i>. Because of this, they are not rendered until you explicitly
305 <a href="Ext.button.Cycle.html#show" rel="Ext.button.Cycle#show" class="docClass">show</a> them.</p>
306
307
308 <p>After rendering, the ownerCt reference is deleted, and the <a href="Ext.button.Cycle.html#floatParent" rel="Ext.button.Cycle#floatParent" class="docClass">floatParent</a> property is set to the found floating ancestor Container.
309 If no floating ancestor Container was found the <a href="Ext.button.Cycle.html#floatParent" rel="Ext.button.Cycle#floatParent" class="docClass">floatParent</a> property will not be set.</p>
310
311 </div></div></div><div id="config-focusCls" class="member inherited"><a href="Ext.button.Cycle.html#config-focusCls" rel="config-focusCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-focusCls" class="viewSource">view source</a></div><a name="focusCls"></a><a name="config-focusCls"></a><a href="Ext.button.Cycle.html#" rel="config-focusCls" class="cls expand">focusCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class to add to a button when it is in the focussed state. (Defaults to 'x-btn-focus')</p>
312 </div><div class="long"><p>The CSS class to add to a button when it is in the focussed state. (Defaults to 'x-btn-focus')</p>
313 </div></div></div><div id="config-focusOnToFront" class="member inherited"><a href="Ext.button.Cycle.html#config-focusOnToFront" rel="config-focusOnToFront" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Floating.html" class="definedIn docClass">Ext.util.Floating</a><br/><a href="../source/Floating.html#Ext-util.Floating-cfg-focusOnToFront" class="viewSource">view source</a></div><a name="focusOnToFront"></a><a name="config-focusOnToFront"></a><a href="Ext.button.Cycle.html#" rel="config-focusOnToFront" class="cls expand">focusOnToFront</a><span> : Boolean</span></div><div class="description"><div class="short">Specifies whether the floated component should be automatically focused when it is
314 brought to the front. Defaults to ...</div><div class="long"><p>Specifies whether the floated component should be automatically <a href="Ext.button.Cycle.html#focus" rel="Ext.button.Cycle#focus" class="docClass">focused</a> when it is
315 <a href="Ext.button.Cycle.html#toFront" rel="Ext.button.Cycle#toFront" class="docClass">brought to the front</a>. Defaults to true.</p>
316 </div></div></div><div id="config-forceIcon" class="member ni"><a href="Ext.button.Cycle.html#config-forceIcon" rel="config-forceIcon" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Cycle.html" class="definedIn docClass">Ext.button.Cycle</a><br/><a href="../source/Cycle.html#Ext-button.Cycle-cfg-forceIcon" class="viewSource">view source</a></div><a name="forceIcon"></a><a name="config-forceIcon"></a><a href="Ext.button.Cycle.html#" rel="config-forceIcon" class="cls expand">forceIcon</a><span> : String</span></div><div class="description"><div class="short">A css class which sets an image to be used as the static icon for this button.  This
317 icon will always be displayed re...</div><div class="long"><p>A css class which sets an image to be used as the static icon for this button.  This
318 icon will always be displayed regardless of which item is selected in the dropdown list.  This overrides the
319 default behavior of changing the button's icon to match the selected item's icon on change.</p>
320 </div></div></div><div id="config-frame" class="member inherited"><a href="Ext.button.Cycle.html#config-frame" rel="config-frame" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-frame" class="viewSource">view source</a></div><a name="frame"></a><a name="config-frame"></a><a href="Ext.button.Cycle.html#" rel="config-frame" class="cls expand">frame</a><span> : Boolean</span></div><div class="description"><div class="short">Specify as true to have the Component inject framing elements within the Component at render time to
321 provide a graphi...</div><div class="long"><p>Specify as <code>true</code> to have the Component inject framing elements within the Component at render time to
322 provide a graphical rounded frame around the Component content.</p>
323
324
325 <p>This is only necessary when running on outdated, or non standard-compliant browsers such as Microsoft's Internet Explorer
326 prior to version 9 which do not support rounded corners natively.</p>
327
328
329 <p>The extra space taken up by this framing is available from the read only property <a href="Ext.button.Cycle.html#frameSize" rel="Ext.button.Cycle#frameSize" class="docClass">frameSize</a>.</p>
330
331 </div></div></div><div id="config-handleMouseEvents" class="member inherited"><a href="Ext.button.Cycle.html#config-handleMouseEvents" rel="config-handleMouseEvents" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-handleMouseEvents" class="viewSource">view source</a></div><a name="handleMouseEvents"></a><a name="config-handleMouseEvents"></a><a href="Ext.button.Cycle.html#" rel="config-handleMouseEvents" class="cls expand">handleMouseEvents</a><span> : Boolean</span></div><div class="description"><div class="short"><p>False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)</p>
332 </div><div class="long"><p>False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)</p>
333 </div></div></div><div id="config-handler" class="member inherited"><a href="Ext.button.Cycle.html#config-handler" rel="config-handler" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-handler" class="viewSource">view source</a></div><a name="handler"></a><a name="config-handler"></a><a href="Ext.button.Cycle.html#" rel="config-handler" class="cls expand">handler</a><span> : Function</span></div><div class="description"><div class="short">A function called when the button is clicked (can be used instead of click event).
334 The handler is passed the followin...</div><div class="long"><p>A function called when the button is clicked (can be used instead of click event).
335 The handler is passed the following parameters:<div class="mdetail-params"><ul>
336 <li><code>b</code> : Button<div class="sub-desc">This Button.</div></li>
337 <li><code>e</code> : EventObject<div class="sub-desc">The click event.</div></li>
338 </ul></div></p>
339 </div></div></div><div id="config-height" class="member inherited"><a href="Ext.button.Cycle.html#config-height" rel="config-height" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-height" class="viewSource">view source</a></div><a name="height"></a><a name="config-height"></a><a href="Ext.button.Cycle.html#" rel="config-height" class="cls expand">height</a><span> : Number</span></div><div class="description"><div class="short"><p>The height of this component in pixels.</p>
340 </div><div class="long"><p>The height of this component in pixels.</p>
341 </div></div></div><div id="config-hidden" class="member inherited"><a href="Ext.button.Cycle.html#config-hidden" rel="config-hidden" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-hidden" class="viewSource">view source</a></div><a name="hidden"></a><a name="config-hidden"></a><a href="Ext.button.Cycle.html#" rel="config-hidden" class="cls expand">hidden</a><span> : Boolean</span></div><div class="description"><div class="short"><p>True to start hidden (defaults to false)</p>
342 </div><div class="long"><p>True to start hidden (defaults to false)</p>
343 </div></div></div><div id="config-hideMode" class="member inherited"><a href="Ext.button.Cycle.html#config-hideMode" rel="config-hideMode" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-hideMode" class="viewSource">view source</a></div><a name="hideMode"></a><a name="config-hideMode"></a><a href="Ext.button.Cycle.html#" rel="config-hideMode" class="cls expand">hideMode</a><span> : String</span></div><div class="description"><div class="short">A String which specifies how this Component's encapsulating DOM element will be hidden.
344 Values may be
345 'display' : The...</div><div class="long"><p>A String which specifies how this Component's encapsulating DOM element will be hidden.
346 Values may be<div class="mdetail-params"><ul>
347 <li><code>'display'</code> : The Component will be hidden using the <code>display: none</code> style.</li>
348 <li><code>'visibility'</code> : The Component will be hidden using the <code>visibility: hidden</code> style.</li>
349 <li><code>'offsets'</code> : The Component will be hidden by absolutely positioning it out of the visible area of the document. This
350 is useful when a hidden Component must maintain measurable dimensions. Hiding using <code>display</code> results
351 in a Component having zero dimensions.</li></ul></div>
352 Defaults to <code>'display'</code>.</p>
353 </div></div></div><div id="config-html" class="member inherited"><a href="Ext.button.Cycle.html#config-html" rel="config-html" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-html" class="viewSource">view source</a></div><a name="html"></a><a name="config-html"></a><a href="Ext.button.Cycle.html#" rel="config-html" class="cls expand">html</a><span> : String/Object</span></div><div class="description"><div class="short">An HTML fragment, or a DomHelper specification to use as the layout element
354 content (defaults to ''). The HTML conten...</div><div class="long"><p>An HTML fragment, or a <a href="Ext.core.DomHelper.html" rel="Ext.core.DomHelper" class="docClass">DomHelper</a> specification to use as the layout element
355 content (defaults to ''). The HTML content is added after the component is rendered,
356 so the document will not contain this HTML at the time the <a href="Ext.button.Cycle.html#render" rel="Ext.button.Cycle#render" class="docClass">render</a> event is fired.
357 This content is inserted into the body <i>before</i> any configured <a href="Ext.button.Cycle.html#contentEl" rel="Ext.button.Cycle#contentEl" class="docClass">contentEl</a> is appended.</p>
358 </div></div></div><div id="config-icon" class="member inherited"><a href="Ext.button.Cycle.html#config-icon" rel="config-icon" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-icon" class="viewSource">view source</a></div><a name="icon"></a><a name="config-icon"></a><a href="Ext.button.Cycle.html#" rel="config-icon" class="cls expand">icon</a><span> : String</span></div><div class="description"><div class="short">The path to an image to display in the button (the image will be set as the background-image
359 CSS property of the butt...</div><div class="long"><p>The path to an image to display in the button (the image will be set as the background-image
360 CSS property of the button by default, so if you want a mixed icon/text button, set cls:'x-btn-text-icon')</p>
361 </div></div></div><div id="config-iconAlign" class="member inherited"><a href="Ext.button.Cycle.html#config-iconAlign" rel="config-iconAlign" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-iconAlign" class="viewSource">view source</a></div><a name="iconAlign"></a><a name="config-iconAlign"></a><a href="Ext.button.Cycle.html#" rel="config-iconAlign" class="cls expand">iconAlign</a><span> : String</span></div><div class="description"><div class="short">(Optional) The side of the Button box to render the icon. Four values are allowed:
362
363
364
365 'top'
366 'right'
367 'bottom'
368 'left'
369
370 ...</div><div class="long"><p>(Optional) The side of the Button box to render the icon. Four values are allowed:</p>
371
372
373 <ul class="mdetail-params">
374 <li>'top'<div class="sub-desc"></div></li>
375 <li>'right'<div class="sub-desc"></div></li>
376 <li>'bottom'<div class="sub-desc"></div></li>
377 <li>'left'<div class="sub-desc"></div></li>
378 </ul>
379
380
381 <p>Defaults to <b><tt>'left'</tt></b>.</p>
382
383 </div></div></div><div id="config-iconCls" class="member inherited"><a href="Ext.button.Cycle.html#config-iconCls" rel="config-iconCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-iconCls" class="viewSource">view source</a></div><a name="iconCls"></a><a name="config-iconCls"></a><a href="Ext.button.Cycle.html#" rel="config-iconCls" class="cls expand">iconCls</a><span> : String</span></div><div class="description"><div class="short"><p>A css class which sets a background image to be used as the icon for this button</p>
384 </div><div class="long"><p>A css class which sets a background image to be used as the icon for this button</p>
385 </div></div></div><div id="config-id" class="member inherited"><a href="Ext.button.Cycle.html#config-id" rel="config-id" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-id" class="viewSource">view source</a></div><a name="id"></a><a name="config-id"></a><a href="Ext.button.Cycle.html#" rel="config-id" class="cls expand">id</a><span> : String</span></div><div class="description"><div class="short">The unique id of this component instance (defaults to an auto-assigned id).
386
387
388 It should not be necessary to use this ...</div><div class="long"><p>The <b><u>unique id of this component instance</u></b> (defaults to an <a href="Ext.button.Cycle.html#getId" rel="Ext.button.Cycle#getId" class="docClass">auto-assigned id</a>).</p>
389
390
391 <p>It should not be necessary to use this configuration except for singleton objects in your application.
392 Components created with an id may be accessed globally using <a href="Ext.html#getCmp" rel="Ext#getCmp" class="docClass">Ext.getCmp</a>.</p>
393
394
395 <p>Instead of using assigned ids, use the <a href="Ext.button.Cycle.html#itemId" rel="Ext.button.Cycle#itemId" class="docClass">itemId</a> config, and <a href="Ext.ComponentQuery.html" rel="Ext.ComponentQuery" class="docClass">ComponentQuery</a> which
396 provides selector-based searching for Sencha Components analogous to DOM querying. The <a href="Ext.container.Container.html" rel="Ext.container.Container" class="docClass">Container</a>
397 class contains <a href="Ext.container.Container.html#down" rel="Ext.container.Container#down" class="docClass">shortcut methods</a> to query its descendant Components by selector.</p>
398
399
400 <p>Note that this id will also be used as the element id for the containing HTML element
401 that is rendered to the page for this component. This allows you to write id-based CSS
402 rules to style the specific instance of this component uniquely, and also to select
403 sub-elements using this component's id as the parent.</p>
404
405
406 <p><b>Note</b>: to avoid complications imposed by a unique <tt>id</tt> also see <code><a href="Ext.button.Cycle.html#itemId" rel="Ext.button.Cycle#itemId" class="docClass">itemId</a></code>.</p>
407
408
409 <p><b>Note</b>: to access the container of a Component see <code><a href="Ext.button.Cycle.html#ownerCt" rel="Ext.button.Cycle#ownerCt" class="docClass">ownerCt</a></code>.</p>
410
411 </div></div></div><div id="config-itemId" class="member inherited"><a href="Ext.button.Cycle.html#config-itemId" rel="config-itemId" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-itemId" class="viewSource">view source</a></div><a name="itemId"></a><a name="config-itemId"></a><a href="Ext.button.Cycle.html#" rel="config-itemId" class="cls expand">itemId</a><span> : String</span></div><div class="description"><div class="short">An itemId can be used as an alternative way to get a reference to a component
412 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
413 when no object reference is available.  Instead of using an <code><a href="Ext.button.Cycle.html#id" rel="Ext.button.Cycle#id" class="docClass">id</a></code> with
414 <a href="Ext.html" rel="Ext" class="docClass">Ext</a>.<a href="Ext.html#getCmp" rel="Ext#getCmp" class="docClass">getCmp</a>, use <code>itemId</code> with
415 <a href="Ext.container.Container.html" rel="Ext.container.Container" class="docClass">Ext.container.Container</a>.<a href="Ext.container.Container.html#getComponent" rel="Ext.container.Container#getComponent" class="docClass">getComponent</a> which will retrieve
416 <code>itemId</code>'s or <tt><a href="Ext.button.Cycle.html#id" rel="Ext.button.Cycle#id" class="docClass">id</a></tt>'s. Since <code>itemId</code>'s are an index to the
417 container's internal MixedCollection, the <code>itemId</code> is scoped locally to the container --
418 avoiding potential conflicts with <a href="Ext.ComponentManager.html" rel="Ext.ComponentManager" class="docClass">Ext.ComponentManager</a> which requires a <b>unique</b>
419 <code><a href="Ext.button.Cycle.html#id" rel="Ext.button.Cycle#id" class="docClass">id</a></code>.</p>
420
421
422 <pre><code>var c = new Ext.panel.Panel({ //
423     <a href="Ext.Component.html#height" rel="Ext.Component#height" class="docClass">height</a>: 300,
424     <a href="Ext.button.Cycle.html#renderTo" rel="Ext.button.Cycle#renderTo" class="docClass">renderTo</a>: document.body,
425     <a href="Ext.container.Container.html#layout" rel="Ext.container.Container#layout" class="docClass">layout</a>: 'auto',
426     <a href="Ext.container.Container.html#items" rel="Ext.container.Container#items" class="docClass">items</a>: [
427         {
428             itemId: 'p1',
429             <a href="Ext.panel.Panel.html#title" rel="Ext.panel.Panel#title" class="docClass">title</a>: 'Panel 1',
430             <a href="Ext.Component.html#height" rel="Ext.Component#height" class="docClass">height</a>: 150
431         },
432         {
433             itemId: 'p2',
434             <a href="Ext.panel.Panel.html#title" rel="Ext.panel.Panel#title" class="docClass">title</a>: 'Panel 2',
435             <a href="Ext.Component.html#height" rel="Ext.Component#height" class="docClass">height</a>: 150
436         }
437     ]
438 })
439 p1 = c.<a href="Ext.container.Container.html#getComponent" rel="Ext.container.Container#getComponent" class="docClass">getComponent</a>('p1'); // not the same as <a href="Ext.html#getCmp" rel="Ext#getCmp" class="docClass">Ext.getCmp()</a>
440 p2 = p1.<a href="Ext.button.Cycle.html#ownerCt" rel="Ext.button.Cycle#ownerCt" class="docClass">ownerCt</a>.<a href="Ext.container.Container.html#getComponent" rel="Ext.container.Container#getComponent" class="docClass">getComponent</a>('p2'); // reference via a sibling
441 </code></pre>
442
443
444 <p>Also see <tt><a href="Ext.button.Cycle.html#id" rel="Ext.button.Cycle#id" class="docClass">id</a></tt>, <code><a href="Ext.button.Cycle.html#query" rel="Ext.button.Cycle#query" class="docClass">query</a></code>, <code><a href="Ext.button.Cycle.html#down" rel="Ext.button.Cycle#down" class="docClass">down</a></code> and <code><a href="Ext.button.Cycle.html#child" rel="Ext.button.Cycle#child" class="docClass">child</a></code>.</p>
445
446
447 <p><b>Note</b>: to access the container of an item see <tt><a href="Ext.button.Cycle.html#ownerCt" rel="Ext.button.Cycle#ownerCt" class="docClass">ownerCt</a></tt>.</p>
448
449 </div></div></div><div id="config-items" class="member ni"><a href="Ext.button.Cycle.html#config-items" rel="config-items" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Cycle.html" class="definedIn docClass">Ext.button.Cycle</a><br/><a href="../source/Cycle.html#Ext-button.Cycle-cfg-items" class="viewSource">view source</a></div><a name="items"></a><a name="config-items"></a><a href="Ext.button.Cycle.html#" rel="config-items" class="cls expand">items</a><span> : Array</span></div><div class="description"><div class="short">Deprecated as of 4.0. Use the menu config instead. All menu items will be created
450 as CheckItems.
451
452
453 An array of Ext.me...</div><div class="long"><p>Deprecated as of 4.0. Use the <a href="Ext.button.Cycle.html#menu" rel="Ext.button.Cycle#menu" class="docClass">menu</a> config instead. All menu items will be created
454 as <a href="Ext.menu.CheckItem.html" rel="Ext.menu.CheckItem" class="docClass">CheckItem</a>s.</p>
455
456
457 <p>An array of <a href="Ext.menu.CheckItem.html" rel="Ext.menu.CheckItem" class="docClass">Ext.menu.CheckItem</a> <b>config</b> objects to be used when creating the
458 button's menu items (e.g., {text:'Foo', iconCls:'foo-icon'})
459
460 </div></div></div><div id="config-listeners" class="member inherited"><a href="Ext.button.Cycle.html#config-listeners" rel="config-listeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-cfg-listeners" class="viewSource">view source</a></div><a name="listeners"></a><a name="config-listeners"></a><a href="Ext.button.Cycle.html#" rel="config-listeners" class="cls expand">listeners</a><span> : Object</span></div><div class="description"><div class="short">(optional) A config object containing one or more event handlers to be added to this
461 object during initialization.  T...</div><div class="long"><p>(optional) <p>A config object containing one or more event handlers to be added to this
462 object during initialization.  This should be a valid listeners config object as specified in the
463 <a href="Ext.button.Cycle.html#addListener" rel="Ext.button.Cycle#addListener" class="docClass">addListener</a> example for attaching multiple handlers at once.</p></p>
464
465 <br><p><b><u>DOM events from ExtJs <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a></u></b></p>
466
467
468 <br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
469
470
471 <p>is usually only done when extra value can be added. For example the <a href="Ext.view.View.html" rel="Ext.view.View" class="docClass">DataView</a>'s
472 <b><code><a href="Ext.view.View.html#click" rel="Ext.view.View#click" class="docClass">click</a></code></b> event passing the node clicked on. To access DOM
473 events directly from a child element of a Component, we need to specify the <code>element</code> option to
474 identify the Component property to add a DOM listener to:</p>
475
476 <pre><code>new Ext.panel.Panel({
477     width: 400,
478     height: 200,
479     dockedItems: [{
480         xtype: 'toolbar'
481     }],
482     listeners: {
483         click: {
484             element: 'el', //bind to the underlying el property on the panel
485             fn: function(){ console.log('click el'); }
486         },
487         dblclick: {
488             element: 'body', //bind to the underlying body property on the panel
489             fn: function(){ console.log('dblclick body'); }
490         }
491     }
492 });
493 </code></pre>
494
495
496 <p></p></p>
497 </div></div></div><div id="config-loader" class="member inherited"><a href="Ext.button.Cycle.html#config-loader" rel="config-loader" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-loader" class="viewSource">view source</a></div><a name="loader"></a><a name="config-loader"></a><a href="Ext.button.Cycle.html#" rel="config-loader" class="cls expand">loader</a><span> : Ext.ComponentLoader/Object</span></div><div class="description"><div class="short"><p>A configuration object or an instance of a <a href="Ext.ComponentLoader.html" rel="Ext.ComponentLoader" class="docClass">Ext.ComponentLoader</a> to load remote
498 content for this Component.</p>
499 </div><div class="long"><p>A configuration object or an instance of a <a href="Ext.ComponentLoader.html" rel="Ext.ComponentLoader" class="docClass">Ext.ComponentLoader</a> to load remote
500 content for this Component.</p>
501 </div></div></div><div id="config-maintainFlex" class="member inherited"><a href="Ext.button.Cycle.html#config-maintainFlex" rel="config-maintainFlex" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-cfg-maintainFlex" class="viewSource">view source</a></div><a name="maintainFlex"></a><a name="config-maintainFlex"></a><a href="Ext.button.Cycle.html#" rel="config-maintainFlex" class="cls expand">maintainFlex</a><span> : Boolean</span></div><div class="description"><div class="short">Only valid when a sibling element of a Splitter within a VBox or
502 HBox layout.
503
504
505 Specifies that if an immediate siblin...</div><div class="long"><p><b>Only valid when a sibling element of a <a href="Ext.resizer.Splitter.html" rel="Ext.resizer.Splitter" class="docClass">Splitter</a> within a <a href="Ext.layout.container.VBox.html" rel="Ext.layout.container.VBox" class="docClass">VBox</a> or
506 <a href="Ext.layout.container.HBox.html" rel="Ext.layout.container.HBox" class="docClass">HBox</a> layout.</b></p>
507
508
509 <p>Specifies that if an immediate sibling Splitter is moved, the Component on the <i>other</i> side is resized, and this
510 Component maintains its configured <a href="Ext.layout.container.Box.html#flex" rel="Ext.layout.container.Box#flex" class="docClass">flex</a> value.</p>
511
512 </div></div></div><div id="config-margin" class="member inherited"><a href="Ext.button.Cycle.html#config-margin" rel="config-margin" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-margin" class="viewSource">view source</a></div><a name="margin"></a><a name="config-margin"></a><a href="Ext.button.Cycle.html#" rel="config-margin" class="cls expand">margin</a><span> : Number/String</span></div><div class="description"><div class="short">Specifies the margin for this component. The margin can be a single numeric value to apply to all sides or
513 it can be ...</div><div class="long"><p>Specifies the margin for this component. The margin can be a single numeric value to apply to all sides or
514 it can be a CSS style specification for each style, for example: '10 5 3 10'.</p>
515 </div></div></div><div id="config-maxHeight" class="member inherited"><a href="Ext.button.Cycle.html#config-maxHeight" rel="config-maxHeight" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-maxHeight" class="viewSource">view source</a></div><a name="maxHeight"></a><a name="config-maxHeight"></a><a href="Ext.button.Cycle.html#" rel="config-maxHeight" class="cls expand">maxHeight</a><span> : Number</span></div><div class="description"><div class="short">The maximum value in pixels which this Component will set its height to.
516
517
518 Warning: This will override any size manag...</div><div class="long"><p>The maximum value in pixels which this Component will set its height to.</p>
519
520
521 <p><b>Warning:</b> This will override any size management applied by layout managers.</p>
522
523 </div></div></div><div id="config-maxWidth" class="member inherited"><a href="Ext.button.Cycle.html#config-maxWidth" rel="config-maxWidth" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-maxWidth" class="viewSource">view source</a></div><a name="maxWidth"></a><a name="config-maxWidth"></a><a href="Ext.button.Cycle.html#" rel="config-maxWidth" class="cls expand">maxWidth</a><span> : Number</span></div><div class="description"><div class="short">The maximum value in pixels which this Component will set its width to.
524
525
526 Warning: This will override any size manage...</div><div class="long"><p>The maximum value in pixels which this Component will set its width to.</p>
527
528
529 <p><b>Warning:</b> This will override any size management applied by layout managers.</p>
530
531 </div></div></div><div id="config-menu" class="member inherited"><a href="Ext.button.Cycle.html#config-menu" rel="config-menu" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-menu" class="viewSource">view source</a></div><a name="menu"></a><a name="config-menu"></a><a href="Ext.button.Cycle.html#" rel="config-menu" class="cls expand">menu</a><span> : Mixed</span></div><div class="description"><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"><p>Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).</p>
532 </div></div></div><div id="config-menuActiveCls" class="member inherited"><a href="Ext.button.Cycle.html#config-menuActiveCls" rel="config-menuActiveCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-menuActiveCls" class="viewSource">view source</a></div><a name="menuActiveCls"></a><a name="config-menuActiveCls"></a><a href="Ext.button.Cycle.html#" rel="config-menuActiveCls" class="cls expand">menuActiveCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class to add to a button when it's menu is active. (Defaults to 'x-btn-menu-active')</p>
533 </div><div class="long"><p>The CSS class to add to a button when it's menu is active. (Defaults to 'x-btn-menu-active')</p>
534 </div></div></div><div id="config-menuAlign" class="member inherited"><a href="Ext.button.Cycle.html#config-menuAlign" rel="config-menuAlign" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-menuAlign" class="viewSource">view source</a></div><a name="menuAlign"></a><a name="config-menuAlign"></a><a href="Ext.button.Cycle.html#" rel="config-menuAlign" class="cls expand">menuAlign</a><span> : String</span></div><div class="description"><div class="short"><p>The position to align the menu to (see <a href="Ext.core.Element.html#alignTo" rel="Ext.core.Element#alignTo" class="docClass">Ext.core.Element.alignTo</a> for more details, defaults to 'tl-bl?').</p>
535 </div><div class="long"><p>The position to align the menu to (see <a href="Ext.core.Element.html#alignTo" rel="Ext.core.Element#alignTo" class="docClass">Ext.core.Element.alignTo</a> for more details, defaults to 'tl-bl?').</p>
536 </div></div></div><div id="config-minHeight" class="member inherited"><a href="Ext.button.Cycle.html#config-minHeight" rel="config-minHeight" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-minHeight" class="viewSource">view source</a></div><a name="minHeight"></a><a name="config-minHeight"></a><a href="Ext.button.Cycle.html#" rel="config-minHeight" class="cls expand">minHeight</a><span> : Number</span></div><div class="description"><div class="short">The minimum value in pixels which this Component will set its height to.
537
538
539 Warning: This will override any size manag...</div><div class="long"><p>The minimum value in pixels which this Component will set its height to.</p>
540
541
542 <p><b>Warning:</b> This will override any size management applied by layout managers.</p>
543
544 </div></div></div><div id="config-minWidth" class="member inherited"><a href="Ext.button.Cycle.html#config-minWidth" rel="config-minWidth" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-minWidth" class="viewSource">view source</a></div><a name="minWidth"></a><a name="config-minWidth"></a><a href="Ext.button.Cycle.html#" rel="config-minWidth" class="cls expand">minWidth</a><span> : Number</span></div><div class="description"><div class="short">The minimum width for this button (used to give a set of buttons a common width).
545 See also Ext.panel.Panel.minButtonW...</div><div class="long"><p>The minimum width for this button (used to give a set of buttons a common width).
546 See also <a href="Ext.panel.Panel.html" rel="Ext.panel.Panel" class="docClass">Ext.panel.Panel</a>.<tt><a href="Ext.panel.Panel.html#minButtonWidth" rel="Ext.panel.Panel#minButtonWidth" class="docClass">minButtonWidth</a></tt>.</p>
547 </div></div></div><div id="config-overCls" class="member inherited"><a href="Ext.button.Cycle.html#config-overCls" rel="config-overCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-overCls" class="viewSource">view source</a></div><a name="overCls"></a><a name="config-overCls"></a><a href="Ext.button.Cycle.html#" rel="config-overCls" class="cls expand">overCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class to add to a button when it is in the over (hovered) state. (Defaults to 'x-btn-over')</p>
548 </div><div class="long"><p>The CSS class to add to a button when it is in the over (hovered) state. (Defaults to 'x-btn-over')</p>
549 </div></div></div><div id="config-overflowText" class="member inherited"><a href="Ext.button.Cycle.html#config-overflowText" rel="config-overflowText" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-overflowText" class="viewSource">view source</a></div><a name="overflowText"></a><a name="config-overflowText"></a><a href="Ext.button.Cycle.html#" rel="config-overflowText" class="cls expand">overflowText</a><span> : String</span></div><div class="description"><div class="short">If used in a Toolbar, the
550 text to be used if this item is shown in the overflow menu. See also
551 Ext.toolbar.Item.overf...</div><div class="long"><p>If used in a <a href="Ext.toolbar.Toolbar.html" rel="Ext.toolbar.Toolbar" class="docClass">Toolbar</a>, the
552 text to be used if this item is shown in the overflow menu. See also
553 <a href="Ext.toolbar.Item.html" rel="Ext.toolbar.Item" class="docClass">Ext.toolbar.Item</a>.<code><a href="Ext.toolbar.Item.html#overflowText" rel="Ext.toolbar.Item#overflowText" class="docClass">overflowText</a></code>.</p>
554 </div></div></div><div id="config-padding" class="member inherited"><a href="Ext.button.Cycle.html#config-padding" rel="config-padding" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-padding" class="viewSource">view source</a></div><a name="padding"></a><a name="config-padding"></a><a href="Ext.button.Cycle.html#" rel="config-padding" class="cls expand">padding</a><span> : Number/String</span></div><div class="description"><div class="short">Specifies the padding for this component. The padding can be a single numeric value to apply to all sides or
555 it can b...</div><div class="long"><p>Specifies the padding for this component. The padding can be a single numeric value to apply to all sides or
556 it can be a CSS style specification for each style, for example: '10 5 3 10'.</p>
557 </div></div></div><div id="config-plugins" class="member inherited"><a href="Ext.button.Cycle.html#config-plugins" rel="config-plugins" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-plugins" class="viewSource">view source</a></div><a name="plugins"></a><a name="config-plugins"></a><a href="Ext.button.Cycle.html#" rel="config-plugins" class="cls expand">plugins</a><span> : Object/Array</span></div><div class="description"><div class="short">An object or array of objects that will provide custom functionality for this component.  The only
558 requirement for a ...</div><div class="long"><p>An object or array of objects that will provide custom functionality for this component.  The only
559 requirement for a valid plugin is that it contain an init method that accepts a reference of type <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a>.
560 When a component is created, if any plugins are available, the component will call the init method on each
561 plugin, passing a reference to itself.  Each plugin can then call methods or respond to events on the
562 component as needed to provide its functionality.</p>
563 </div></div></div><div id="config-prependText" class="member ni"><a href="Ext.button.Cycle.html#config-prependText" rel="config-prependText" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Cycle.html" class="definedIn docClass">Ext.button.Cycle</a><br/><a href="../source/Cycle.html#Ext-button.Cycle-cfg-prependText" class="viewSource">view source</a></div><a name="prependText"></a><a name="config-prependText"></a><a href="Ext.button.Cycle.html#" rel="config-prependText" class="cls expand">prependText</a><span> : String</span></div><div class="description"><div class="short">A static string to prepend before the active item's text when displayed as the
564 button's text (only applies when showT...</div><div class="long"><p>A static string to prepend before the active item's text when displayed as the
565 button's text (only applies when showText = true, defaults to '')</p>
566 </div></div></div><div id="config-pressed" class="member inherited"><a href="Ext.button.Cycle.html#config-pressed" rel="config-pressed" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-pressed" class="viewSource">view source</a></div><a name="pressed"></a><a name="config-pressed"></a><a href="Ext.button.Cycle.html#" rel="config-pressed" class="cls expand">pressed</a><span> : Boolean</span></div><div class="description"><div class="short"><p>True to start pressed (only if enableToggle = true)</p>
567 </div><div class="long"><p>True to start pressed (only if enableToggle = true)</p>
568 </div></div></div><div id="config-pressedCls" class="member inherited"><a href="Ext.button.Cycle.html#config-pressedCls" rel="config-pressedCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-pressedCls" class="viewSource">view source</a></div><a name="pressedCls"></a><a name="config-pressedCls"></a><a href="Ext.button.Cycle.html#" rel="config-pressedCls" class="cls expand">pressedCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class to add to a button when it is in the pressed state. (Defaults to 'x-btn-pressed')</p>
569 </div><div class="long"><p>The CSS class to add to a button when it is in the pressed state. (Defaults to 'x-btn-pressed')</p>
570 </div></div></div><div id="config-preventDefault" class="member inherited"><a href="Ext.button.Cycle.html#config-preventDefault" rel="config-preventDefault" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-preventDefault" class="viewSource">view source</a></div><a name="preventDefault"></a><a name="config-preventDefault"></a><a href="Ext.button.Cycle.html#" rel="config-preventDefault" class="cls expand">preventDefault</a><span> : Boolean</span></div><div class="description"><div class="short"><p>True to prevent the default action when the <a href="Ext.button.Cycle.html#clickEvent" rel="Ext.button.Cycle#clickEvent" class="docClass">clickEvent</a> is processed. Defaults to true.</p>
571 </div><div class="long"><p>True to prevent the default action when the <a href="Ext.button.Cycle.html#clickEvent" rel="Ext.button.Cycle#clickEvent" class="docClass">clickEvent</a> is processed. Defaults to true.</p>
572 </div></div></div><div id="config-renderSelectors" class="member inherited"><a href="Ext.button.Cycle.html#config-renderSelectors" rel="config-renderSelectors" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-renderSelectors" class="viewSource">view source</a></div><a name="renderSelectors"></a><a name="config-renderSelectors"></a><a href="Ext.button.Cycle.html#" rel="config-renderSelectors" class="cls expand">renderSelectors</a><span> : Object</span></div><div class="description"><div class="short">An object containing properties specifying DomQuery selectors which identify child elements
573 created by the render pro...</div><div class="long"><p>An object containing properties specifying <a href="Ext.DomQuery.html" rel="Ext.DomQuery" class="docClass">DomQuery</a> selectors which identify child elements
574 created by the render process.</p>
575
576 <p>After the Component's internal structure is rendered according to the <a href="Ext.button.Cycle.html#renderTpl" rel="Ext.button.Cycle#renderTpl" class="docClass">renderTpl</a>, this object is iterated through,
577 and the found Elements are added as properties to the Component using the <code>renderSelector</code> property name.</p>
578
579 <p>For example, a Component which rendered an image, and description into its element might use the following properties
580 coded into its prototype:</p>
581
582 <pre><code>renderTpl: '&amp;lt;img src="{imageUrl}" class="x-image-component-img"&gt;&amp;lt;div class="x-image-component-desc"&gt;{description}&amp;gt;/div&amp;lt;',
583
584 renderSelectors: {
585     image: 'img.x-image-component-img',
586     descEl: 'div.x-image-component-desc'
587 }
588 </code></pre>
589
590 <p>After rendering, the Component would have a property <code>image</code> referencing its child <code>img</code> Element,
591 and a property <code>descEl</code> referencing the <code>div</code> Element which contains the description.</p>
592 </div></div></div><div id="config-renderTo" class="member inherited"><a href="Ext.button.Cycle.html#config-renderTo" rel="config-renderTo" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-renderTo" class="viewSource">view source</a></div><a name="renderTo"></a><a name="config-renderTo"></a><a href="Ext.button.Cycle.html#" rel="config-renderTo" class="cls expand">renderTo</a><span> : Mixed</span></div><div class="description"><div class="short">Specify the id of the element, a DOM element or an existing Element that this component
593 will be rendered into.
594
595
596
597 Not...</div><div class="long"><p>Specify the id of the element, a DOM element or an existing Element that this component
598 will be rendered into.</p>
599
600
601 <div><ul>
602 <li><b>Notes</b> : <ul>
603 <div class="sub-desc">Do <u>not</u> use this option if the Component is to be a child item of
604 a <a href="Ext.container.Container.html" rel="Ext.container.Container" class="docClass">Container</a>. It is the responsibility of the
605 <a href="Ext.container.Container.html" rel="Ext.container.Container" class="docClass">Container</a>'s <a href="Ext.container.Container.html#layout" rel="Ext.container.Container#layout" class="docClass">layout manager</a>
606 to render and manage its child items.</div>
607 <div class="sub-desc">When using this config, a call to render() is not required.</div>
608 </ul></li>
609 </ul></div>
610
611
612 <p>See <code><a href="Ext.button.Cycle.html#render" rel="Ext.button.Cycle#render" class="docClass">render</a></code> also.</p>
613
614 </div></div></div><div id="config-renderTpl" class="member inherited"><a href="Ext.button.Cycle.html#config-renderTpl" rel="config-renderTpl" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-renderTpl" class="viewSource">view source</a></div><a name="renderTpl"></a><a name="config-renderTpl"></a><a href="Ext.button.Cycle.html#" rel="config-renderTpl" class="cls expand">renderTpl</a><span> : Mixed</span></div><div class="description"><div class="short">An XTemplate used to create the internal structure inside this Component's
615 encapsulating Element.
616
617
618 You do not normal...</div><div class="long"><p>An <a href="Ext.XTemplate.html" rel="Ext.XTemplate" class="docClass">XTemplate</a> used to create the internal structure inside this Component's
619 encapsulating <a href="Ext.button.Cycle.html#getEl" rel="Ext.button.Cycle#getEl" class="docClass">Element</a>.</p>
620
621
622 <p>You do not normally need to specify this. For the base classes <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a>
623 and <a href="Ext.container.Container.html" rel="Ext.container.Container" class="docClass">Ext.container.Container</a>, this defaults to <b><code>null</code></b> which means that they will be initially rendered
624 with no internal structure; they render their <a href="Ext.button.Cycle.html#getEl" rel="Ext.button.Cycle#getEl" class="docClass">Element</a> empty. The more specialized ExtJS and Touch classes
625 which use a more complex DOM structure, provide their own template definitions.</p>
626
627
628 <p>This is intended to allow the developer to create application-specific utility Components with customized
629 internal structure.</p>
630
631
632 <p>Upon rendering, any created child elements may be automatically imported into object properties using the
633 <a href="Ext.button.Cycle.html#renderSelectors" rel="Ext.button.Cycle#renderSelectors" class="docClass">renderSelectors</a> option.</p>
634
635 </div></div></div><div id="config-repeat" class="member inherited"><a href="Ext.button.Cycle.html#config-repeat" rel="config-repeat" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-repeat" class="viewSource">view source</a></div><a name="repeat"></a><a name="config-repeat"></a><a href="Ext.button.Cycle.html#" rel="config-repeat" class="cls expand">repeat</a><span> : Boolean/Object</span></div><div class="description"><div class="short">True to repeat fire the click event while the mouse is down. This can also be
636 a ClickRepeater config object (defaults...</div><div class="long"><p>True to repeat fire the click event while the mouse is down. This can also be
637 a <a href="Ext.util.ClickRepeater.html" rel="Ext.util.ClickRepeater" class="docClass">ClickRepeater</a> config object (defaults to false).</p>
638 </div></div></div><div id="config-resizable" class="member inherited"><a href="Ext.button.Cycle.html#config-resizable" rel="config-resizable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-cfg-resizable" class="viewSource">view source</a></div><a name="resizable"></a><a name="config-resizable"></a><a href="Ext.button.Cycle.html#" rel="config-resizable" class="cls expand">resizable</a><span> : Mixed</span></div><div class="description"><div class="short">Specify as true to apply a Resizer to this Component
639 after rendering.
640
641
642 May also be specified as a config object to b...</div><div class="long"><p>Specify as <code>true</code> to apply a <a href="Ext.resizer.Resizer.html" rel="Ext.resizer.Resizer" class="docClass">Resizer</a> to this Component
643 after rendering.</p>
644
645
646 <p>May also be specified as a config object to be passed to the constructor of <a href="Ext.resizer.Resizer.html" rel="Ext.resizer.Resizer" class="docClass">Resizer</a>
647 to override any defaults. By default the Component passes its minimum and maximum size, and uses
648 <code><a href="Ext.resizer.Resizer.html#dynamic" rel="Ext.resizer.Resizer#dynamic" class="docClass">Ext.resizer.Resizer.dynamic</a>: false</code></p>
649
650 </div></div></div><div id="config-resizeHandles" class="member inherited"><a href="Ext.button.Cycle.html#config-resizeHandles" rel="config-resizeHandles" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-cfg-resizeHandles" class="viewSource">view source</a></div><a name="resizeHandles"></a><a name="config-resizeHandles"></a><a href="Ext.button.Cycle.html#" rel="config-resizeHandles" class="cls expand">resizeHandles</a><span> : String</span></div><div class="description"><div class="short"><p>A valid <a href="Ext.resizer.Resizer.html" rel="Ext.resizer.Resizer" class="docClass">Ext.resizer.Resizer</a> handles config string (defaults to 'all').  Only applies when resizable = true.</p>
651 </div><div class="long"><p>A valid <a href="Ext.resizer.Resizer.html" rel="Ext.resizer.Resizer" class="docClass">Ext.resizer.Resizer</a> handles config string (defaults to 'all').  Only applies when resizable = true.</p>
652 </div></div></div><div id="config-saveBuffer" class="member inherited"><a href="Ext.button.Cycle.html#config-saveBuffer" rel="config-saveBuffer" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.state.Stateful.html" class="definedIn docClass">Ext.state.Stateful</a><br/><a href="../source/Stateful.html#Ext-state.Stateful-cfg-saveBuffer" class="viewSource">view source</a></div><a name="saveBuffer"></a><a name="config-saveBuffer"></a><a href="Ext.button.Cycle.html#" rel="config-saveBuffer" class="cls expand">saveBuffer</a><span> : Number</span></div><div class="description"><div class="short"><p>A buffer to be applied if many state events are fired within
653 a short period. Defaults to 100.</p>
654 </div><div class="long"><p>A buffer to be applied if many state events are fired within
655 a short period. Defaults to 100.</p>
656 </div></div></div><div id="config-scale" class="member inherited"><a href="Ext.button.Cycle.html#config-scale" rel="config-scale" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-scale" class="viewSource">view source</a></div><a name="scale"></a><a name="config-scale"></a><a href="Ext.button.Cycle.html#" rel="config-scale" class="cls expand">scale</a><span> : String</span></div><div class="description"><div class="short">(Optional) The size of the Button. Three values are allowed:
657
658
659
660 'small'Results in the button element being 16px high....</div><div class="long"><p>(Optional) The size of the Button. Three values are allowed:</p>
661
662
663 <ul class="mdetail-params">
664 <li>'small'<div class="sub-desc">Results in the button element being 16px high.</div></li>
665 <li>'medium'<div class="sub-desc">Results in the button element being 24px high.</div></li>
666 <li>'large'<div class="sub-desc">Results in the button element being 32px high.</div></li>
667 </ul>
668
669
670 <p>Defaults to <b><tt>'small'</tt></b>.</p>
671
672 </div></div></div><div id="config-scope" class="member inherited"><a href="Ext.button.Cycle.html#config-scope" rel="config-scope" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-scope" class="viewSource">view source</a></div><a name="scope"></a><a name="config-scope"></a><a href="Ext.button.Cycle.html#" rel="config-scope" class="cls expand">scope</a><span> : Object</span></div><div class="description"><div class="short"><p>The scope (<tt><b>this</b></tt> reference) in which the
673 <code><a href="Ext.button.Cycle.html#handler" rel="Ext.button.Cycle#handler" class="docClass">handler</a></code> and <code><a href="Ext.button.Cycle.html#toggleHandler" rel="Ext.button.Cycle#toggleHandler" class="docClass">toggleHandler</a></code> is
674 executed. Defaults to this Button.</p>
675 </div><div class="long"><p>The scope (<tt><b>this</b></tt> reference) in which the
676 <code><a href="Ext.button.Cycle.html#handler" rel="Ext.button.Cycle#handler" class="docClass">handler</a></code> and <code><a href="Ext.button.Cycle.html#toggleHandler" rel="Ext.button.Cycle#toggleHandler" class="docClass">toggleHandler</a></code> is
677 executed. Defaults to this Button.</p>
678 </div></div></div><div id="config-shadow" class="member inherited"><a href="Ext.button.Cycle.html#config-shadow" rel="config-shadow" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Floating.html" class="definedIn docClass">Ext.util.Floating</a><br/><a href="../source/Floating.html#Ext-util.Floating-cfg-shadow" class="viewSource">view source</a></div><a name="shadow"></a><a name="config-shadow"></a><a href="Ext.button.Cycle.html#" rel="config-shadow" class="cls expand">shadow</a><span> : String/Boolean</span></div><div class="description"><div class="short">Specifies whether the floating component should be given a shadow. Set to
679 true to automatically create an Ext.Shadow,...</div><div class="long"><p>Specifies whether the floating component should be given a shadow. Set to
680 <tt>true</tt> to automatically create an <a href="Ext.Shadow.html" rel="Ext.Shadow" class="docClass">Ext.Shadow</a>, or a string indicating the
681 shadow's display <a href="Ext.Shadow.html#mode" rel="Ext.Shadow#mode" class="docClass">Ext.Shadow.mode</a>. Set to <tt>false</tt> to disable the shadow.
682 (Defaults to <tt>'sides'</tt>.)</p>
683 </div></div></div><div id="config-showText" class="member ni"><a href="Ext.button.Cycle.html#config-showText" rel="config-showText" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Cycle.html" class="definedIn docClass">Ext.button.Cycle</a><br/><a href="../source/Cycle.html#Ext-button.Cycle-cfg-showText" class="viewSource">view source</a></div><a name="showText"></a><a name="config-showText"></a><a href="Ext.button.Cycle.html#" rel="config-showText" class="cls expand">showText</a><span> : Boolean</span></div><div class="description"><div class="short">True to display the active item's text as the button text (defaults to false).
684 The Button will show its configured te...</div><div class="long"><p>True to display the active item's text as the button text (defaults to false).
685 The Button will show its configured <a href="Ext.button.Cycle.html#text" rel="Ext.button.Cycle#text" class="docClass">text</a> if this. config is omitted.</p>
686 </div></div></div><div id="config-stateEvents" class="member inherited"><a href="Ext.button.Cycle.html#config-stateEvents" rel="config-stateEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.state.Stateful.html" class="definedIn docClass">Ext.state.Stateful</a><br/><a href="../source/Stateful.html#Ext-state.Stateful-cfg-stateEvents" class="viewSource">view source</a></div><a name="stateEvents"></a><a name="config-stateEvents"></a><a href="Ext.button.Cycle.html#" rel="config-stateEvents" class="cls expand">stateEvents</a><span> : Array</span></div><div class="description"><div class="short">An array of events that, when fired, should trigger this object to
687 save its state (defaults to none). stateEvents may...</div><div class="long"><p>An array of events that, when fired, should trigger this object to
688 save its state (defaults to none). <code>stateEvents</code> may be any type
689 of event supported by this object, including browser or custom events
690 (e.g., <tt>['click', 'customerchange']</tt>).</p>
691
692
693 <p>See <code><a href="Ext.button.Cycle.html#stateful" rel="Ext.button.Cycle#stateful" class="docClass">stateful</a></code> for an explanation of saving and
694 restoring object state.</p>
695
696 </div></div></div><div id="config-stateId" class="member inherited"><a href="Ext.button.Cycle.html#config-stateId" rel="config-stateId" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.state.Stateful.html" class="definedIn docClass">Ext.state.Stateful</a><br/><a href="../source/Stateful.html#Ext-state.Stateful-cfg-stateId" class="viewSource">view source</a></div><a name="stateId"></a><a name="config-stateId"></a><a href="Ext.button.Cycle.html#" rel="config-stateId" class="cls expand">stateId</a><span> : String</span></div><div class="description"><div class="short">The unique id for this object to use for state management purposes.
697
698 See stateful for an explanation of saving and re...</div><div class="long"><p>The unique id for this object to use for state management purposes.</p>
699
700 <p>See <a href="Ext.button.Cycle.html#stateful" rel="Ext.button.Cycle#stateful" class="docClass">stateful</a> for an explanation of saving and restoring state.</p>
701
702 </div></div></div><div id="config-stateful" class="member inherited"><a href="Ext.button.Cycle.html#config-stateful" rel="config-stateful" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.state.Stateful.html" class="definedIn docClass">Ext.state.Stateful</a><br/><a href="../source/Stateful.html#Ext-state.Stateful-cfg-stateful" class="viewSource">view source</a></div><a name="stateful"></a><a name="config-stateful"></a><a href="Ext.button.Cycle.html#" rel="config-stateful" class="cls expand">stateful</a><span> : Boolean</span></div><div class="description"><div class="short">A flag which causes the object to attempt to restore the state of
703 internal properties from a saved state on startup. ...</div><div class="long"><p>A flag which causes the object to attempt to restore the state of
704 internal properties from a saved state on startup. The object must have
705 a <code><a href="Ext.button.Cycle.html#stateId" rel="Ext.button.Cycle#stateId" class="docClass">stateId</a></code> for state to be managed. 
706 Auto-generated ids are not guaranteed to be stable across page loads and 
707 cannot be relied upon to save and restore the same state for a object.<p>
708 <p>For state saving to work, the state manager's provider must have been
709 set to an implementation of <a href="Ext.state.Provider.html" rel="Ext.state.Provider" class="docClass">Ext.state.Provider</a> which overrides the
710 <a href="Ext.state.Provider.html#set" rel="Ext.state.Provider#set" class="docClass">set</a> and <a href="Ext.state.Provider.html#get" rel="Ext.state.Provider#get" class="docClass">get</a>
711 methods to save and recall name/value pairs. A built-in implementation,
712 <a href="Ext.state.CookieProvider.html" rel="Ext.state.CookieProvider" class="docClass">Ext.state.CookieProvider</a> is available.</p>
713 <p>To set the state provider for the current page:</p>
714 <pre><code>Ext.state.Manager.setProvider(new Ext.state.CookieProvider({
715     expires: new Date(new Date().getTime()+(1000*60*60*24*7)), //7 days from now
716 }));
717 </code></pre>
718 <p>A stateful object attempts to save state when one of the events
719 listed in the <code><a href="Ext.button.Cycle.html#stateEvents" rel="Ext.button.Cycle#stateEvents" class="docClass">stateEvents</a></code> configuration fires.</p>
720 <p>To save state, a stateful object first serializes its state by
721 calling <b><code><a href="Ext.button.Cycle.html#getState" rel="Ext.button.Cycle#getState" class="docClass">getState</a></code></b>. By default, this function does
722 nothing. The developer must provide an implementation which returns an
723 object hash which represents the restorable state of the object.</p>
724 <p>The value yielded by getState is passed to <a href="Ext.state.Manager.html#set" rel="Ext.state.Manager#set" class="docClass">Ext.state.Manager.set</a>
725 which uses the configured <a href="Ext.state.Provider.html" rel="Ext.state.Provider" class="docClass">Ext.state.Provider</a> to save the object
726 keyed by the <code><a href="stateId.html" rel="stateId" class="docClass">stateId</a></code></p>.
727 <p>During construction, a stateful object attempts to <i>restore</i>
728 its state by calling <a href="Ext.state.Manager.html#get" rel="Ext.state.Manager#get" class="docClass">Ext.state.Manager.get</a> passing the
729 <code><a href="Ext.button.Cycle.html#stateId" rel="Ext.button.Cycle#stateId" class="docClass">stateId</a></code></p>
730 <p>The resulting object is passed to <b><code><a href="Ext.button.Cycle.html#applyState" rel="Ext.button.Cycle#applyState" class="docClass">applyState</a></code></b>.
731 The default implementation of <code><a href="Ext.button.Cycle.html#applyState" rel="Ext.button.Cycle#applyState" class="docClass">applyState</a></code> simply copies
732 properties into the object, but a developer may override this to support
733 more behaviour.</p>
734 <p>You can perform extra processing on state save and restore by attaching
735 handlers to the <a href="Ext.button.Cycle.html#beforestaterestore" rel="Ext.button.Cycle#beforestaterestore" class="docClass">beforestaterestore</a>, <a href="Ext.button.Cycle.html#staterestore" rel="Ext.button.Cycle#staterestore" class="docClass">staterestore</a>,
736 <a href="Ext.button.Cycle.html#beforestatesave" rel="Ext.button.Cycle#beforestatesave" class="docClass">beforestatesave</a> and <a href="Ext.button.Cycle.html#statesave" rel="Ext.button.Cycle#statesave" class="docClass">statesave</a> events.</p>
737
738 </div></div></div><div id="config-style" class="member inherited"><a href="Ext.button.Cycle.html#config-style" rel="config-style" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-style" class="viewSource">view source</a></div><a name="style"></a><a name="config-style"></a><a href="Ext.button.Cycle.html#" rel="config-style" class="cls expand">style</a><span> : String</span></div><div class="description"><div class="short">A custom style specification to be applied to this component's Element.  Should be a valid argument to
739 Ext.core.Eleme...</div><div class="long"><p>A custom style specification to be applied to this component's Element.  Should be a valid argument to
740 <a href="Ext.core.Element.html#applyStyles" rel="Ext.core.Element#applyStyles" class="docClass">Ext.core.Element.applyStyles</a>.</p>
741
742 <pre><code>        new Ext.panel.Panel({
743             title: 'Some Title',
744             renderTo: Ext.getBody(),
745             width: 400, height: 300,
746             layout: 'form',
747             items: [{
748                 xtype: 'textarea',
749                 style: {
750                     width: '95%',
751                     marginBottom: '10px'
752                 }
753             },
754             new Ext.button.Button({
755                 text: 'Send',
756                 minWidth: '100',
757                 style: {
758                     marginBottom: '10px'
759                 }
760             })
761             ]
762         });
763      </code></pre>
764
765 </div></div></div><div id="config-styleHtmlCls" class="member inherited"><a href="Ext.button.Cycle.html#config-styleHtmlCls" rel="config-styleHtmlCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-styleHtmlCls" class="viewSource">view source</a></div><a name="styleHtmlCls"></a><a name="config-styleHtmlCls"></a><a href="Ext.button.Cycle.html#" rel="config-styleHtmlCls" class="cls expand">styleHtmlCls</a><span> : String</span></div><div class="description"><div class="short"><p>The class that is added to the content target when you set styleHtmlContent to true.
766 Defaults to 'x-html'</p>
767 </div><div class="long"><p>The class that is added to the content target when you set styleHtmlContent to true.
768 Defaults to 'x-html'</p>
769 </div></div></div><div id="config-styleHtmlContent" class="member inherited"><a href="Ext.button.Cycle.html#config-styleHtmlContent" rel="config-styleHtmlContent" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-styleHtmlContent" class="viewSource">view source</a></div><a name="styleHtmlContent"></a><a name="config-styleHtmlContent"></a><a href="Ext.button.Cycle.html#" rel="config-styleHtmlContent" class="cls expand">styleHtmlContent</a><span> : String</span></div><div class="description"><div class="short"><p>True to automatically style the html inside the content target of this component (body for panels).
770 Defaults to false.</p>
771 </div><div class="long"><p>True to automatically style the html inside the content target of this component (body for panels).
772 Defaults to false.</p>
773 </div></div></div><div id="config-tabIndex" class="member inherited"><a href="Ext.button.Cycle.html#config-tabIndex" rel="config-tabIndex" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-tabIndex" class="viewSource">view source</a></div><a name="tabIndex"></a><a name="config-tabIndex"></a><a href="Ext.button.Cycle.html#" rel="config-tabIndex" class="cls expand">tabIndex</a><span> : Number</span></div><div class="description"><div class="short"><p>Set a DOM tabIndex for this button (defaults to undefined)</p>
774 </div><div class="long"><p>Set a DOM tabIndex for this button (defaults to undefined)</p>
775 </div></div></div><div id="config-text" class="member inherited"><a href="Ext.button.Cycle.html#config-text" rel="config-text" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-text" class="viewSource">view source</a></div><a name="text"></a><a name="config-text"></a><a href="Ext.button.Cycle.html#" rel="config-text" class="cls expand">text</a><span> : String</span></div><div class="description"><div class="short"><p>The button text to be used as innerHTML (html tags are accepted)</p>
776 </div><div class="long"><p>The button text to be used as innerHTML (html tags are accepted)</p>
777 </div></div></div><div id="config-toFrontOnShow" class="member inherited"><a href="Ext.button.Cycle.html#config-toFrontOnShow" rel="config-toFrontOnShow" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-cfg-toFrontOnShow" class="viewSource">view source</a></div><a name="toFrontOnShow"></a><a name="config-toFrontOnShow"></a><a href="Ext.button.Cycle.html#" rel="config-toFrontOnShow" class="cls expand">toFrontOnShow</a><span> : Boolean</span></div><div class="description"><div class="short">True to automatically call toFront when the show method is called
778 on an already visible, floating component (default ...</div><div class="long"><p>True to automatically call <a href="Ext.button.Cycle.html#toFront" rel="Ext.button.Cycle#toFront" class="docClass">toFront</a> when the <a href="Ext.button.Cycle.html#show" rel="Ext.button.Cycle#show" class="docClass">show</a> method is called
779 on an already visible, floating component (default is <code>true</code>).</p>
780
781 </div></div></div><div id="config-toggleGroup" class="member inherited"><a href="Ext.button.Cycle.html#config-toggleGroup" rel="config-toggleGroup" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-toggleGroup" class="viewSource">view source</a></div><a name="toggleGroup"></a><a name="config-toggleGroup"></a><a href="Ext.button.Cycle.html#" rel="config-toggleGroup" class="cls expand">toggleGroup</a><span> : String</span></div><div class="description"><div class="short"><p>The group this toggle button is a member of (only 1 per group can be pressed)</p>
782 </div><div class="long"><p>The group this toggle button is a member of (only 1 per group can be pressed)</p>
783 </div></div></div><div id="config-toggleHandler" class="member inherited"><a href="Ext.button.Cycle.html#config-toggleHandler" rel="config-toggleHandler" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-toggleHandler" class="viewSource">view source</a></div><a name="toggleHandler"></a><a name="config-toggleHandler"></a><a href="Ext.button.Cycle.html#" rel="config-toggleHandler" class="cls expand">toggleHandler</a><span> : Function</span></div><div class="description"><div class="short">Function called when a Button with enableToggle set to true is clicked. Two arguments are passed:
784 button : Ext.button...</div><div class="long"><p>Function called when a Button with <a href="Ext.button.Cycle.html#enableToggle" rel="Ext.button.Cycle#enableToggle" class="docClass">enableToggle</a> set to true is clicked. Two arguments are passed:<ul class="mdetail-params">
785 <li><b>button</b> : Ext.button.Button<div class="sub-desc">this Button object</div></li>
786 <li><b>state</b> : Boolean<div class="sub-desc">The next state of the Button, true means pressed.</div></li>
787 </ul></p>
788 </div></div></div><div id="config-tooltip" class="member inherited"><a href="Ext.button.Cycle.html#config-tooltip" rel="config-tooltip" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-tooltip" class="viewSource">view source</a></div><a name="tooltip"></a><a name="config-tooltip"></a><a href="Ext.button.Cycle.html#" rel="config-tooltip" class="cls expand">tooltip</a><span> : String/Object</span></div><div class="description"><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"><p>The tooltip for the button - can be a string to be used as innerHTML (html tags are accepted) or QuickTips config object</p>
789 </div></div></div><div id="config-tooltipType" class="member inherited"><a href="Ext.button.Cycle.html#config-tooltipType" rel="config-tooltipType" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-tooltipType" class="viewSource">view source</a></div><a name="tooltipType"></a><a name="config-tooltipType"></a><a href="Ext.button.Cycle.html#" rel="config-tooltipType" class="cls expand">tooltipType</a><span> : String</span></div><div class="description"><div class="short"><p>The type of tooltip to use. Either 'qtip' (default) for QuickTips or 'title' for title attribute.</p>
790 </div><div class="long"><p>The type of tooltip to use. Either 'qtip' (default) for QuickTips or 'title' for title attribute.</p>
791 </div></div></div><div id="config-tpl" class="member inherited"><a href="Ext.button.Cycle.html#config-tpl" rel="config-tpl" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-tpl" class="viewSource">view source</a></div><a name="tpl"></a><a name="config-tpl"></a><a href="Ext.button.Cycle.html#" rel="config-tpl" class="cls expand">tpl</a><span> : Mixed</span></div><div class="description"><div class="short">An Ext.Template, Ext.XTemplate
792 or an array of strings to form an Ext.XTemplate.
793 Used in conjunction with the data and...</div><div class="long"><p>An <bold><a href="Ext.Template.html" rel="Ext.Template" class="docClass">Ext.Template</a></bold>, <bold><a href="Ext.XTemplate.html" rel="Ext.XTemplate" class="docClass">Ext.XTemplate</a></bold>
794 or an array of strings to form an <a href="Ext.XTemplate.html" rel="Ext.XTemplate" class="docClass">Ext.XTemplate</a>.
795 Used in conjunction with the <code><a href="Ext.button.Cycle.html#data" rel="Ext.button.Cycle#data" class="docClass">data</a></code> and
796 <code><a href="Ext.button.Cycle.html#tplWriteMode" rel="Ext.button.Cycle#tplWriteMode" class="docClass">tplWriteMode</a></code> configurations.</p>
797 </div></div></div><div id="config-tplWriteMode" class="member inherited"><a href="Ext.button.Cycle.html#config-tplWriteMode" rel="config-tplWriteMode" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-tplWriteMode" class="viewSource">view source</a></div><a name="tplWriteMode"></a><a name="config-tplWriteMode"></a><a href="Ext.button.Cycle.html#" rel="config-tplWriteMode" class="cls expand">tplWriteMode</a><span> : String</span></div><div class="description"><div class="short">The Ext.(X)Template method to use when
798 updating the content area of the Component. Defaults to 'overwrite'
799 (see Ext.X...</div><div class="long"><p>The Ext.(X)Template method to use when
800 updating the content area of the Component. Defaults to <code>'overwrite'</code>
801 (see <code><a href="Ext.XTemplate.html#overwrite" rel="Ext.XTemplate#overwrite" class="docClass">Ext.XTemplate.overwrite</a></code>).</p>
802 </div></div></div><div id="config-type" class="member inherited"><a href="Ext.button.Cycle.html#config-type" rel="config-type" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-cfg-type" class="viewSource">view source</a></div><a name="type"></a><a name="config-type"></a><a href="Ext.button.Cycle.html#" rel="config-type" class="cls expand">type</a><span> : String</span></div><div class="description"><div class="short"><p>submit, reset or button - defaults to 'button'</p>
803 </div><div class="long"><p>submit, reset or button - defaults to 'button'</p>
804 </div></div></div><div id="config-ui" class="member inherited"><a href="Ext.button.Cycle.html#config-ui" rel="config-ui" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-ui" class="viewSource">view source</a></div><a name="ui"></a><a name="config-ui"></a><a href="Ext.button.Cycle.html#" rel="config-ui" class="cls expand">ui</a><span> : String/Array</span></div><div class="description"><div class="short"><p>A set style for a component. Can be a string or an Array of multiple strings (UIs)</p>
805 </div><div class="long"><p>A set style for a component. Can be a string or an Array of multiple strings (UIs)</p>
806 </div></div></div><div id="config-width" class="member inherited"><a href="Ext.button.Cycle.html#config-width" rel="config-width" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-width" class="viewSource">view source</a></div><a name="width"></a><a name="config-width"></a><a href="Ext.button.Cycle.html#" rel="config-width" class="cls expand">width</a><span> : Number</span></div><div class="description"><div class="short"><p>The width of this component in pixels.</p>
807 </div><div class="long"><p>The width of this component in pixels.</p>
808 </div></div></div></div><div class="m-properties"><a name="properties"></a><div class="definedBy">Defined By</div><h3 class="prp p">Properties</h3><div id="property-disabled" class="member f inherited"><a href="Ext.button.Cycle.html#property-disabled" rel="property-disabled" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-property-disabled" class="viewSource">view source</a></div><a name="disabled"></a><a name="property-disabled"></a><a href="Ext.button.Cycle.html#" rel="property-disabled" class="cls expand">disabled</a><span> : Boolean</span></div><div class="description"><div class="short"><p>Read-only. True if this button is disabled</p>
809 </div><div class="long"><p>Read-only. True if this button is disabled</p>
810 </div></div></div><div id="property-draggable" class="member inherited"><a href="Ext.button.Cycle.html#property-draggable" rel="property-draggable" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-property-draggable" class="viewSource">view source</a></div><a name="draggable"></a><a name="property-draggable"></a><a href="Ext.button.Cycle.html#" rel="property-draggable" class="cls expand">draggable</a><span> : Boolean</span></div><div class="description"><div class="short"><p>Read-only property indicating whether or not the component can be dragged</p>
811 </div><div class="long"><p>Read-only property indicating whether or not the component can be dragged</p>
812 </div></div></div><div id="property-floatParent" class="member inherited"><a href="Ext.button.Cycle.html#property-floatParent" rel="property-floatParent" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-property-floatParent" class="viewSource">view source</a></div><a name="floatParent"></a><a name="property-floatParent"></a><a href="Ext.button.Cycle.html#" rel="property-floatParent" class="cls expand">floatParent</a><span> : Ext.Container</span></div><div class="description"><div class="short">Optional. Only present for floating Components which were inserted as descendant items of floating Containers.
813
814
815 Floa...</div><div class="long"><p>Optional. Only present for <a href="Ext.button.Cycle.html#floating" rel="Ext.button.Cycle#floating" class="docClass">floating</a> Components which were inserted as descendant items of floating Containers.</p>
816
817
818 <p>Floating Components that are programatically <a href="Ext.Component.html#render" rel="Ext.Component#render" class="docClass">rendered</a> will not have a <code>floatParent</code> property.</p>
819
820
821 <p>For <a href="Ext.button.Cycle.html#floating" rel="Ext.button.Cycle#floating" class="docClass">floating</a> Components which are child items of a Container, the floatParent will be the floating ancestor Container which is
822 responsible for the base z-index value of all its floating descendants. It provides a <a href="Ext.ZIndexManager.html" rel="Ext.ZIndexManager" class="docClass">ZIndexManager</a> which provides
823 z-indexing services for all its descendant floating Components.</p>
824
825
826 <p>For example, the dropdown <a href="Ext.view.BoundList.html" rel="Ext.view.BoundList" class="docClass">BoundList</a> of a ComboBox which is in a Window will have the Window as its
827 <code>floatParent</code></p>
828
829
830 <p>See <a href="Ext.button.Cycle.html#floating" rel="Ext.button.Cycle#floating" class="docClass">floating</a> and <a href="Ext.button.Cycle.html#zIndexManager" rel="Ext.button.Cycle#zIndexManager" class="docClass">zIndexManager</a></p>
831
832 </div></div></div><div id="property-frameSize" class="member inherited"><a href="Ext.button.Cycle.html#property-frameSize" rel="property-frameSize" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-property-frameSize" class="viewSource">view source</a></div><a name="frameSize"></a><a name="property-frameSize"></a><a href="Ext.button.Cycle.html#" rel="property-frameSize" class="cls expand">frameSize</a><span> : Object</span></div><div class="description"><div class="short">Read-only property indicating the width of any framing elements which were added within the encapsulating element
833 to ...</div><div class="long"><p>Read-only property indicating the width of any framing elements which were added within the encapsulating element
834 to provide graphical, rounded borders. See the <a href="Ext.button.Cycle.html#frame" rel="Ext.button.Cycle#frame" class="docClass">frame</a> config.</p>
835
836
837 <p> This is an object containing the frame width in pixels for all four sides of the Component containing
838 the following properties:</p>
839
840
841 <div class="mdetail-params"><ul>
842 <li><code>top</code> The width of the top framing element in pixels.</li>
843 <li><code>right</code> The width of the right framing element in pixels.</li>
844 <li><code>bottom</code> The width of the bottom framing element in pixels.</li>
845 <li><code>left</code> The width of the left framing element in pixels.</li>
846 </ul></div>
847
848 </div></div></div><div id="property-hasActiveFx" class="member inherited"><a href="Ext.button.Cycle.html#property-hasActiveFx" rel="property-hasActiveFx" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Animate.html" class="definedIn docClass">Ext.util.Animate</a><br/><a href="../source/Animate.html#Ext-util.Animate-property-hasActiveFx" class="viewSource">view source</a></div><a name="hasActiveFx"></a><a name="property-hasActiveFx"></a><a href="Ext.button.Cycle.html#" rel="property-hasActiveFx" class="cls expand">hasActiveFx</a><span> : Object</span></div><div class="description"><div class="short">@deprecated 4.0 Replaced by getActiveAnimation
849 Returns thq current animation if this object has any effects actively ...</div><div class="long"><p>@deprecated 4.0 Replaced by <a href="Ext.button.Cycle.html#getActiveAnimation" rel="Ext.button.Cycle#getActiveAnimation" class="docClass">getActiveAnimation</a>
850 Returns thq current animation if this object has any effects actively running or queued, else returns false.</p>
851 </div></div></div><div id="property-hidden" class="member inherited"><a href="Ext.button.Cycle.html#property-hidden" rel="property-hidden" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-property-hidden" class="viewSource">view source</a></div><a name="hidden"></a><a name="property-hidden"></a><a href="Ext.button.Cycle.html#" rel="property-hidden" class="cls expand">hidden</a><span> : Boolean</span></div><div class="description"><div class="short"><p>Read-only. True if this button is hidden</p>
852 </div><div class="long"><p>Read-only. True if this button is hidden</p>
853 </div></div></div><div id="property-maskOnDisable" class="member inherited"><a href="Ext.button.Cycle.html#property-maskOnDisable" rel="property-maskOnDisable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-property-maskOnDisable" class="viewSource">view source</a></div><a name="maskOnDisable"></a><a name="property-maskOnDisable"></a><a href="Ext.button.Cycle.html#" rel="property-maskOnDisable" class="cls expand">maskOnDisable</a><span> : Boolean</span></div><div class="description"><div class="short">This is an internal flag that you use when creating custom components.
854 By default this is set to true which means tha...</div><div class="long"><p>This is an internal flag that you use when creating custom components.
855 By default this is set to true which means that every component gets a mask when its disabled.
856 Components like FieldContainer, FieldSet, Field, Button, Tab override this property to false
857 since they want to implement custom disable logic.</p>
858 </div></div></div><div id="property-menu" class="member ni"><a href="Ext.button.Cycle.html#property-menu" rel="property-menu" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Cycle.html" class="definedIn docClass">Ext.button.Cycle</a><br/><a href="../source/Cycle.html#Ext-button.Cycle-property-menu" class="viewSource">view source</a></div><a name="menu"></a><a name="property-menu"></a><a href="Ext.button.Cycle.html#" rel="property-menu" class="cls expand">menu</a><span> : Menu</span></div><div class="description"><div class="short"><p>The <a href="Ext.menu.Menu.html" rel="Ext.menu.Menu" class="docClass">Menu</a> object used to display the <a href="Ext.menu.CheckItem.html" rel="Ext.menu.CheckItem" class="docClass">CheckItems</a> representing the available choices.</p>
859 </div><div class="long"><p>The <a href="Ext.menu.Menu.html" rel="Ext.menu.Menu" class="docClass">Menu</a> object used to display the <a href="Ext.menu.CheckItem.html" rel="Ext.menu.CheckItem" class="docClass">CheckItems</a> representing the available choices.</p>
860 </div></div></div><div id="property-ownerCt" class="member inherited"><a href="Ext.button.Cycle.html#property-ownerCt" rel="property-ownerCt" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-property-ownerCt" class="viewSource">view source</a></div><a name="ownerCt"></a><a name="property-ownerCt"></a><a href="Ext.button.Cycle.html#" rel="property-ownerCt" class="cls expand">ownerCt</a><span> : Ext.Container</span></div><div class="description"><div class="short">This Component's owner Container (defaults to undefined, and is set automatically when
861 this Component is added to a C...</div><div class="long"><p>This Component's owner <a href="Ext.container.Container.html" rel="Ext.container.Container" class="docClass">Container</a> (defaults to undefined, and is set automatically when
862 this Component is added to a Container).  Read-only.</p>
863
864 <p><b>Note</b>: to access items within the Container see <tt><a href="Ext.button.Cycle.html#itemId" rel="Ext.button.Cycle#itemId" class="docClass">itemId</a></tt>.</p>
865
866 </div></div></div><div id="property-pressed" class="member inherited"><a href="Ext.button.Cycle.html#property-pressed" rel="property-pressed" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-property-pressed" class="viewSource">view source</a></div><a name="pressed"></a><a name="property-pressed"></a><a href="Ext.button.Cycle.html#" rel="property-pressed" class="cls expand">pressed</a><span> : Boolean</span></div><div class="description"><div class="short"><p>Read-only. True if this button is pressed (only if enableToggle = true)</p>
867 </div><div class="long"><p>Read-only. True if this button is pressed (only if enableToggle = true)</p>
868 </div></div></div><div id="property-rendered" class="member inherited"><a href="Ext.button.Cycle.html#property-rendered" rel="property-rendered" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-property-rendered" class="viewSource">view source</a></div><a name="rendered"></a><a name="property-rendered"></a><a href="Ext.button.Cycle.html#" rel="property-rendered" class="cls expand">rendered</a><span> : Boolean</span></div><div class="description"><div class="short"><p>Read-only property indicating whether or not the component has been rendered.</p>
869 </div><div class="long"><p>Read-only property indicating whether or not the component has been rendered.</p>
870 </div></div></div><div id="property-stopFx" class="member inherited"><a href="Ext.button.Cycle.html#property-stopFx" rel="property-stopFx" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Animate.html" class="definedIn docClass">Ext.util.Animate</a><br/><a href="../source/Animate.html#Ext-util.Animate-property-stopFx" class="viewSource">view source</a></div><a name="stopFx"></a><a name="property-stopFx"></a><a href="Ext.button.Cycle.html#" rel="property-stopFx" class="cls expand">stopFx</a><span> : Object</span></div><div class="description"><div class="short">Stops any running effects and clears this object's internal effects queue if it contains
871 any additional effects that ...</div><div class="long"><p>Stops any running effects and clears this object's internal effects queue if it contains
872 any additional effects that haven't started yet.</p>
873 </div></div></div><div id="property-template" class="member inherited"><a href="Ext.button.Cycle.html#property-template" rel="property-template" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-property-template" class="viewSource">view source</a></div><a name="template"></a><a name="property-template"></a><a href="Ext.button.Cycle.html#" rel="property-template" class="cls expand">template</a><span> : Ext.Template</span></div><div class="description"><div class="short">(Optional)
874
875 A Template used to create the Button's DOM structure.
876
877
878 Instances, or subclasses which need a different D...</div><div class="long"><p>(Optional)</p>
879
880 <p>A <a href="Ext.Template.html" rel="Ext.Template" class="docClass">Template</a> used to create the Button's DOM structure.</p>
881
882
883 <p>Instances, or subclasses which need a different DOM structure may provide a different
884 template layout in conjunction with an implementation of <a href="Ext.button.Cycle.html#getTemplateArgs" rel="Ext.button.Cycle#getTemplateArgs" class="docClass">getTemplateArgs</a>.</p>
885 </div></div></div><div id="property-zIndexManager" class="member inherited"><a href="Ext.button.Cycle.html#property-zIndexManager" rel="property-zIndexManager" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-property-zIndexManager" class="viewSource">view source</a></div><a name="zIndexManager"></a><a name="property-zIndexManager"></a><a href="Ext.button.Cycle.html#" rel="property-zIndexManager" class="cls expand">zIndexManager</a><span> : Ext.ZIndexManager</span></div><div class="description"><div class="short">Optional. Only present for floating Components after they have been rendered.
886
887
888 A reference to the ZIndexManager whic...</div><div class="long"><p>Optional. Only present for <a href="Ext.button.Cycle.html#floating" rel="Ext.button.Cycle#floating" class="docClass">floating</a> Components after they have been rendered.</p>
889
890
891 <p>A reference to the ZIndexManager which is managing this Component's z-index.</p>
892
893
894 <p>The <a href="Ext.ZIndexManager.html" rel="Ext.ZIndexManager" class="docClass">ZIndexManager</a> maintains a stack of floating Component z-indices, and also provides a single modal
895 mask which is insert just beneath the topmost visible modal floating Component.</p>
896
897
898 <p>Floating Components may be <a href="Ext.button.Cycle.html#toFront" rel="Ext.button.Cycle#toFront" class="docClass">brought to the front</a> or <a href="Ext.button.Cycle.html#toBack" rel="Ext.button.Cycle#toBack" class="docClass">sent to the back</a> of the z-index stack.</p>
899
900
901 <p>This defaults to the global <a href="Ext.WindowManager.html" rel="Ext.WindowManager" class="docClass">ZIndexManager</a> for floating Components that are programatically
902 <a href="Ext.Component.html#render" rel="Ext.Component#render" class="docClass">rendered</a>.</p>
903
904
905 <p>For <a href="Ext.button.Cycle.html#floating" rel="Ext.button.Cycle#floating" class="docClass">floating</a> Components which are added to a Container, the ZIndexManager is acquired from the first ancestor Container found
906 which is floating, or if not found the global <a href="Ext.WindowManager.html" rel="Ext.WindowManager" class="docClass">ZIndexManager</a> is used.</p>
907
908
909 <p>See <a href="Ext.button.Cycle.html#floating" rel="Ext.button.Cycle#floating" class="docClass">floating</a> and <a href="Ext.button.Cycle.html#floatParent" rel="Ext.button.Cycle#floatParent" class="docClass">floatParent</a></p>
910
911 </div></div></div></div><div class="m-methods"><a name="methods"></a><div class="definedBy">Defined By</div><h3 class="mth p">Methods</h3><div id="method-Cycle" class="member f ni"><a href="Ext.button.Cycle.html#method-Cycle" rel="method-Cycle" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Cycle.html" class="definedIn docClass">Ext.button.Cycle</a><br/><a href="../source/Cycle.html#Ext-button.Cycle-method-constructor" class="viewSource">view source</a></div><a name="Cycle"></a><a name="method-Cycle"></a><a href="Ext.button.Cycle.html#" rel="method-Cycle" class="cls expand">Cycle</a>(
912 <span class="pre">Object config</span>)
913  : void</div><div class="description"><div class="short"><p>Create a new split button</p>
914 </div><div class="long"><p>Create a new split button</p>
915 <h3 class="pa">Parameters</h3><ul><li><span class="pre">config</span> : Object<div class="sub-desc"><p>The config object</p>
916 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
917 </li></ul></div></div></div><div id="method-addClass" class="member inherited"><a href="Ext.button.Cycle.html#method-addClass" rel="method-addClass" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-addClass" class="viewSource">view source</a></div><a name="addClass"></a><a name="method-addClass"></a><a href="Ext.button.Cycle.html#" rel="method-addClass" class="cls expand">addClass</a>(
918 <span class="pre">String cls</span>)
919  : Ext.Component</div><div class="description"><div class="short"><p>@deprecated 4.0 Replaced by {link:#addCls}
920 Adds a CSS class to the top level element representing this component.</p>
921 </div><div class="long"><p>@deprecated 4.0 Replaced by {link:#addCls}
922 Adds a CSS class to the top level element representing this component.</p>
923 <h3 class="pa">Parameters</h3><ul><li><span class="pre">cls</span> : String<div class="sub-desc"><p>The CSS class name to add</p>
924 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>Returns the Component to allow method chaining.</p>
925 </li></ul></div></div></div><div id="method-addCls" class="member inherited"><a href="Ext.button.Cycle.html#method-addCls" rel="method-addCls" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-addCls" class="viewSource">view source</a></div><a name="addCls"></a><a name="method-addCls"></a><a href="Ext.button.Cycle.html#" rel="method-addCls" class="cls expand">addCls</a>(
926 <span class="pre">String cls</span>)
927  : Ext.Component</div><div class="description"><div class="short"><p>Adds a CSS class to the top level element representing this component.</p>
928 </div><div class="long"><p>Adds a CSS class to the top level element representing this component.</p>
929 <h3 class="pa">Parameters</h3><ul><li><span class="pre">cls</span> : String<div class="sub-desc"><p>The CSS class name to add</p>
930 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>Returns the Component to allow method chaining.</p>
931 </li></ul></div></div></div><div id="method-addClsWithUI" class="member inherited"><a href="Ext.button.Cycle.html#method-addClsWithUI" rel="method-addClsWithUI" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-addClsWithUI" class="viewSource">view source</a></div><a name="addClsWithUI"></a><a name="method-addClsWithUI"></a><a href="Ext.button.Cycle.html#" rel="method-addClsWithUI" class="cls expand">addClsWithUI</a>(
932 <span class="pre">String/Array cls</span>)
933  : void</div><div class="description"><div class="short"><p>Adds a cls to the uiCls array, which will also call <a href="Ext.button.Cycle.html#addUIClsToElement" rel="Ext.button.Cycle#addUIClsToElement" class="docClass">addUIClsToElement</a> and adds
934 to all elements of this component.</p>
935 </div><div class="long"><p>Adds a cls to the uiCls array, which will also call <a href="Ext.button.Cycle.html#addUIClsToElement" rel="Ext.button.Cycle#addUIClsToElement" class="docClass">addUIClsToElement</a> and adds
936 to all elements of this component.</p>
937 <h3 class="pa">Parameters</h3><ul><li><span class="pre">cls</span> : String/Array<div class="sub-desc"><p>A string or an array of strings to add to the uiCls</p>
938 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
939 </li></ul></div></div></div><div id="method-addEvents" class="member inherited"><a href="Ext.button.Cycle.html#method-addEvents" rel="method-addEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addEvents" class="viewSource">view source</a></div><a name="addEvents"></a><a name="method-addEvents"></a><a href="Ext.button.Cycle.html#" rel="method-addEvents" class="cls expand">addEvents</a>(
940 <span class="pre">Object/String o, String </span>)
941  : void</div><div class="description"><div class="short"><p>Adds the specified events to the list of events which this Observable may fire.</p>
942 </div><div class="long"><p>Adds the specified events to the list of events which this Observable may fire.</p>
943 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Object/String<div class="sub-desc"><p>Either an object with event names as properties with a value of <code>true</code>
944 or the first event name string if multiple event names are being passed as separate parameters.</p>
945 </div></li><li><span class="pre"></span> : String<div class="sub-desc"><p>[additional] Optional additional event names if multiple event names are being passed as separate parameters.
946 Usage:</p>
947
948 <pre><code>this.addEvents('storeloaded', 'storecleared');
949 </code></pre>
950
951 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
952 </li></ul></div></div></div><div id="method-addListener" class="member inherited"><a href="Ext.button.Cycle.html#method-addListener" rel="method-addListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addListener" class="viewSource">view source</a></div><a name="addListener"></a><a name="method-addListener"></a><a href="Ext.button.Cycle.html#" rel="method-addListener" class="cls expand">addListener</a>(
953 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
954  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object.</p>
955 </div><div class="long"><p>Appends an event handler to this object.</p>
956 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to listen for. May also be an object who's property names are event names. See</p>
957 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes.</p>
958 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
959 <b>If omitted, defaults to the object which fired the event.</b></p>
960 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.
961 properties. This may contain any of the following properties:<ul>
962 <li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
963 <b>If omitted, defaults to the object which fired the event.</b></div></li>
964 <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>
965 <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>
966 <li><b>buffer</b> : Number<div class="sub-desc">Causes the handler to be scheduled to run in an <a href="Ext.util.DelayedTask.html" rel="Ext.util.DelayedTask" class="docClass">Ext.util.DelayedTask</a> delayed
967 by the specified number of milliseconds. If the event fires again within that time, the original
968 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
969 <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>
970 if the event was bubbled up from a child Observable.</div></li>
971 <li><b>element</b> : String<div class="sub-desc"><b>This option is only valid for listeners bound to <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a>.</b>
972 The name of a Component property which references an element to add a listener to.</p>
973
974 <p>This option is useful during Component construction to add DOM event listeners to elements of <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a> which
975 will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:
976 <pre><code>new Ext.panel.Panel({
977     title: 'The title',
978     listeners: {
979         click: this.handlePanelClick,
980         element: 'body'
981     }
982 });
983 </code></pre></p>
984
985
986 <p>When added in this way, the options available are the options applicable to <a href="Ext.core.Element.html#addListener" rel="Ext.core.Element#addListener" class="docClass">Ext.core.Element.addListener</a></p>
987
988
989 <p></div></li>
990 </ul><br></p>
991
992 <p>
993 <b>Combining Options</b><br>
994 Using the options argument, it is possible to combine different types of listeners:<br>
995 <br>
996 A delayed, one-time listener.
997 <pre><code>myPanel.on('hide', this.handleClick, this, {
998 single: true,
999 delay: 100
1000 });</code></pre>
1001 <p>
1002 <b>Attaching multiple handlers in 1 call</b><br>
1003 The method also allows for a single argument to be passed which is a config object containing properties
1004 which specify multiple events. For example:
1005 <pre><code>myGridPanel.on({
1006     cellClick: this.onCellClick,
1007     mouseover: this.onMouseOver,
1008     mouseout: this.onMouseOut,
1009     scope: this // Important. Ensure "this" is correct during handler execution
1010 });
1011 </code></pre>.
1012 <p>
1013
1014 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1015 </li></ul></div></div></div><div id="method-addManagedListener" class="member inherited"><a href="Ext.button.Cycle.html#method-addManagedListener" rel="method-addManagedListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addManagedListener" class="viewSource">view source</a></div><a name="addManagedListener"></a><a name="method-addManagedListener"></a><a href="Ext.button.Cycle.html#" rel="method-addManagedListener" class="cls expand">addManagedListener</a>(
1016 <span class="pre">Observable/Element item, Object/String ename, Function fn, Object scope, Object opt</span>)
1017  : void</div><div class="description"><div class="short"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
1018 is destroyed.
1019
1020 </div><div class="long"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
1021 is destroyed.
1022
1023 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Observable/Element<div class="sub-desc"><p>The item to which to add a listener/listeners.</p>
1024 </div></li><li><span class="pre">ename</span> : Object/String<div class="sub-desc"><p>The event name, or an object containing event name properties.</p>
1025 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
1026 is the handler function.</p>
1027 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
1028 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
1029 </div></li><li><span class="pre">opt</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
1030 is the <a href="Ext.util.Observable.html#addListener" rel="Ext.util.Observable#addListener" class="docClass">addListener</a> options.</p>
1031 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1032 </li></ul></div></div></div><div id="method-addStateEvents" class="member inherited"><a href="Ext.button.Cycle.html#method-addStateEvents" rel="method-addStateEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.state.Stateful.html" class="definedIn docClass">Ext.state.Stateful</a><br/><a href="../source/Stateful.html#Ext-state.Stateful-method-addStateEvents" class="viewSource">view source</a></div><a name="addStateEvents"></a><a name="method-addStateEvents"></a><a href="Ext.button.Cycle.html#" rel="method-addStateEvents" class="cls expand">addStateEvents</a>(
1033 <span class="pre">String/Array events</span>)
1034  : void</div><div class="description"><div class="short"><p>Add events that will trigger the state to be saved.</p>
1035 </div><div class="long"><p>Add events that will trigger the state to be saved.</p>
1036 <h3 class="pa">Parameters</h3><ul><li><span class="pre">events</span> : String/Array<div class="sub-desc"><p>The event name or an array of event names.</p>
1037 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1038 </li></ul></div></div></div><div id="method-afterComponentLayout" class="member inherited"><a href="Ext.button.Cycle.html#method-afterComponentLayout" rel="method-afterComponentLayout" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-afterComponentLayout" class="viewSource">view source</a></div><a name="afterComponentLayout"></a><a name="method-afterComponentLayout"></a><a href="Ext.button.Cycle.html#" rel="method-afterComponentLayout" class="cls expand">afterComponentLayout</a>(
1039 <span class="pre">Number adjWidth, Number adjHeight, Boolean isSetSize, Ext.Component layoutOwner</span>)
1040  : void</div><div class="description"><div class="short"><p>&nbsp;</p></div><div class="long">
1041 <h3 class="pa">Parameters</h3><ul><li><span class="pre">adjWidth</span> : Number<div class="sub-desc"><p>The box-adjusted width that was set</p>
1042 </div></li><li><span class="pre">adjHeight</span> : Number<div class="sub-desc"><p>The box-adjusted height that was set</p>
1043 </div></li><li><span class="pre">isSetSize</span> : Boolean<div class="sub-desc"><p>Whether or not the height/width are stored on the component permanently</p>
1044 </div></li><li><span class="pre">layoutOwner</span> : Ext.Component<div class="sub-desc"><p>Component which sent the layout. Only used when isSetSize is false.</p>
1045 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1046 </li></ul></div></div></div><div id="method-alignTo" class="member inherited"><a href="Ext.button.Cycle.html#method-alignTo" rel="method-alignTo" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Floating.html" class="definedIn docClass">Ext.util.Floating</a><br/><a href="../source/Floating.html#Ext-util.Floating-method-alignTo" class="viewSource">view source</a></div><a name="alignTo"></a><a name="method-alignTo"></a><a href="Ext.button.Cycle.html#" rel="method-alignTo" class="cls expand">alignTo</a>(
1047 <span class="pre">Mixed element, String position, [Array offsets]</span>)
1048  : Component</div><div class="description"><div class="short"><p>Aligns this floating Component to the specified element</p>
1049 </div><div class="long"><p>Aligns this floating Component to the specified element</p>
1050 <h3 class="pa">Parameters</h3><ul><li><span class="pre">element</span> : Mixed<div class="sub-desc"><p>The element or <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a> to align to. If passing a component, it must
1051 be a omponent instance. If a string id is passed, it will be used as an element id.</p>
1052 </div></li><li><span class="pre">position</span> : String<div class="sub-desc"><p>(optional, defaults to "tl-bl?") The position to align to (see <a href="Ext.core.Element.html#alignTo" rel="Ext.core.Element#alignTo" class="docClass">Ext.core.Element.alignTo</a> for more details).</p>
1053 </div></li><li><span class="pre">offsets</span> : Array<div class="sub-desc"><p>(optional) Offset the positioning by [x, y]</p>
1054 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Component</span>&nbsp; &nbsp;<p>this</p>
1055 </li></ul></div></div></div><div id="method-animate" class="member inherited"><a href="Ext.button.Cycle.html#method-animate" rel="method-animate" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Animate.html" class="definedIn docClass">Ext.util.Animate</a><br/><a href="../source/Animate.html#Ext-util.Animate-method-animate" class="viewSource">view source</a></div><a name="animate"></a><a name="method-animate"></a><a href="Ext.button.Cycle.html#" rel="method-animate" class="cls expand">animate</a>(
1056 <span class="pre">Object config</span>)
1057  : Object</div><div class="description"><div class="short">Perform custom animation on this object.
1058 This method is applicable to both the the Component class and the Element cl...</div><div class="long"><p>Perform custom animation on this object.<p>
1059 <p>This method is applicable to both the the <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Component</a> class and the <a href="Ext.core.Element.html" rel="Ext.core.Element" class="docClass">Element</a> class.
1060 It performs animated transitions of certain properties of this object over a specified timeline.</p>
1061 <p>The sole parameter is an object which specifies start property values, end property values, and properties which
1062 describe the timeline. Of the properties listed below, only <b><code>to</code></b> is mandatory.</p>
1063 <p>Properties include<ul>
1064 <li><code>from</code> <div class="sub-desc">An object which specifies start values for the properties being animated.
1065 If not supplied, properties are animated from current settings. The actual properties which may be animated depend upon
1066 ths object being animated. See the sections below on Element and Component animation.<div></li>
1067 <li><code>to</code> <div class="sub-desc">An object which specifies end values for the properties being animated.</div></li>
1068 <li><code>duration</code><div class="sub-desc">The duration <b>in milliseconds</b> for which the animation will run.</div></li>
1069 <li><code>easing</code> <div class="sub-desc">A string value describing an easing type to modify the rate of change from the default linear to non-linear. Values may be one of:<code><ul>
1070 <li>ease</li>
1071 <li>easeIn</li>
1072 <li>easeOut</li>
1073 <li>easeInOut</li>
1074 <li>backIn</li>
1075 <li>backOut</li>
1076 <li>elasticIn</li>
1077 <li>elasticOut</li>
1078 <li>bounceIn</li>
1079 <li>bounceOut</li>
1080 </ul></code></div></li>
1081 <li><code>keyframes</code> <div class="sub-desc">This is an object which describes the state of animated properties at certain points along the timeline.
1082 it is an object containing properties who's names are the percentage along the timeline being described and who's values specify the animation state at that point.</div></li>
1083 <li><code>listeners</code> <div class="sub-desc">This is a standard <a href="Ext.util.Observable.html#listeners" rel="Ext.util.Observable#listeners" class="docClass">listeners</a> configuration object which may be used
1084 to inject behaviour at either the <code>beforeanimate</code> event or the <code>afteranimate</code> event.</div></li>
1085 </ul></p>
1086 <h3>Animating an <a href="Ext.core.Element.html" rel="Ext.core.Element" class="docClass">Element</a></h3>
1087 When animating an Element, the following properties may be specified in <code>from</code>, <code>to</code>, and <code>keyframe</code> objects:<ul>
1088 <li><code>x</code> <div class="sub-desc">The page X position in pixels.</div></li>
1089 <li><code>y</code> <div class="sub-desc">The page Y position in pixels</div></li>
1090 <li><code>left</code> <div class="sub-desc">The element's CSS <code>left</code> value. Units must be supplied.</div></li>
1091 <li><code>top</code> <div class="sub-desc">The element's CSS <code>top</code> value. Units must be supplied.</div></li>
1092 <li><code>width</code> <div class="sub-desc">The element's CSS <code>width</code> value. Units must be supplied.</div></li>
1093 <li><code>height</code> <div class="sub-desc">The element's CSS <code>height</code> value. Units must be supplied.</div></li>
1094 <li><code>scrollLeft</code> <div class="sub-desc">The element's <code>scrollLeft</code> value.</div></li>
1095 <li><code>scrollTop</code> <div class="sub-desc">The element's <code>scrollLeft</code> value.</div></li>
1096 <li><code>opacity</code> <div class="sub-desc">The element's <code>opacity</code> value. This must be a value between <code>0</code> and <code>1</code>.</div></li>
1097 </ul>
1098 <p><b>Be aware than animating an Element which is being used by an <a href="Ext.html" rel="Ext" class="docClass">Ext</a> Component without in some way informing the Component about the changed element state
1099 will result in incorrect Component behaviour. This is because the Component will be using the old state of the element. To avoid this problem, it is now possible to
1100 directly animate certain properties of Components.</b></p>
1101 <h3>Animating a <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Component</a></h3>
1102 When animating an Element, the following properties may be specified in <code>from</code>, <code>to</code>, and <code>keyframe</code> objects:<ul>
1103 <li><code>x</code> <div class="sub-desc">The Component's page X position in pixels.</div></li>
1104 <li><code>y</code> <div class="sub-desc">The Component's page Y position in pixels</div></li>
1105 <li><code>left</code> <div class="sub-desc">The Component's <code>left</code> value in pixels.</div></li>
1106 <li><code>top</code> <div class="sub-desc">The Component's <code>top</code> value in pixels.</div></li>
1107 <li><code>width</code> <div class="sub-desc">The Component's <code>width</code> value in pixels.</div></li>
1108 <li><code>width</code> <div class="sub-desc">The Component's <code>width</code> value in pixels.</div></li>
1109 <li><code>dynamic</code> <div class="sub-desc">Specify as true to update the Component's layout (if it is a Container) at every frame
1110 of the animation. <i>Use sparingly as laying out on every intermediate size change is an expensive operation</i>.</div></li>
1111 </ul>
1112 <p>For example, to animate a Window to a new size, ensuring that its internal layout, and any shadow is correct:</p>
1113 <pre><code>myWindow = Ext.create('Ext.window.Window', {
1114     title: 'Test Component animation',
1115     width: 500,
1116     height: 300,
1117     layout: {
1118         type: 'hbox',
1119         align: 'stretch'
1120     },
1121     items: [{
1122         title: 'Left: 33%',
1123         margins: '5 0 5 5',
1124         flex: 1
1125     }, {
1126         title: 'Left: 66%',
1127         margins: '5 5 5 5',
1128         flex: 2
1129     }]
1130 });
1131 myWindow.show();
1132 myWindow.header.el.on('click', function() {
1133     myWindow.animate({
1134         to: {
1135             width: (myWindow.getWidth() == 500) ? 700 : 500,
1136             height: (myWindow.getHeight() == 300) ? 400 : 300,
1137         }
1138     });
1139 });
1140 </code></pre>
1141 <p>For performance reasons, by default, the internal layout is only updated when the Window reaches its final <code>"to"</code> size. If dynamic updating of the Window's child
1142 Components is required, then configure the animation with <code>dynamic: true</code> and the two child items will maintain their proportions during the animation.</p>
1143
1144 <h3 class="pa">Parameters</h3><ul><li><span class="pre">config</span> : Object<div class="sub-desc"><p>An object containing properties which describe the animation's start and end states, and the timeline of the animation.</p>
1145 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>this</p>
1146 </li></ul></div></div></div><div id="method-applyState" class="member inherited"><a href="Ext.button.Cycle.html#method-applyState" rel="method-applyState" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.state.Stateful.html" class="definedIn docClass">Ext.state.Stateful</a><br/><a href="../source/Stateful.html#Ext-state.Stateful-method-applyState" class="viewSource">view source</a></div><a name="applyState"></a><a name="method-applyState"></a><a href="Ext.button.Cycle.html#" rel="method-applyState" class="cls expand">applyState</a>(
1147 <span class="pre">Object state</span>)
1148  : void</div><div class="description"><div class="short">Applies the state to the object. This should be overridden in subclasses to do
1149 more complex state operations. By defa...</div><div class="long"><p>Applies the state to the object. This should be overridden in subclasses to do
1150 more complex state operations. By default it applies the state properties onto
1151 the current object.</p>
1152 <h3 class="pa">Parameters</h3><ul><li><span class="pre">state</span> : Object<div class="sub-desc"><p>The state</p>
1153 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1154 </li></ul></div></div></div><div id="method-beforeComponentLayout" class="member inherited"><a href="Ext.button.Cycle.html#method-beforeComponentLayout" rel="method-beforeComponentLayout" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-beforeComponentLayout" class="viewSource">view source</a></div><a name="beforeComponentLayout"></a><a name="method-beforeComponentLayout"></a><a href="Ext.button.Cycle.html#" rel="method-beforeComponentLayout" class="cls expand">beforeComponentLayout</a>(
1155 <span class="pre">Number adjWidth, Number adjHeight, Boolean isSetSize, Ext.Component layoutOwner</span>)
1156  : void</div><div class="description"><div class="short">Occurs before componentLayout is run. Returning false from this method will prevent the componentLayout
1157 from being ex...</div><div class="long"><p>Occurs before componentLayout is run. Returning false from this method will prevent the componentLayout
1158 from being executed.</p>
1159 <h3 class="pa">Parameters</h3><ul><li><span class="pre">adjWidth</span> : Number<div class="sub-desc"><p>The box-adjusted width that was set</p>
1160 </div></li><li><span class="pre">adjHeight</span> : Number<div class="sub-desc"><p>The box-adjusted height that was set</p>
1161 </div></li><li><span class="pre">isSetSize</span> : Boolean<div class="sub-desc"><p>Whether or not the height/width are stored on the component permanently</p>
1162 </div></li><li><span class="pre">layoutOwner</span> : Ext.Component<div class="sub-desc"><p>Component which sent the layout. Only used when isSetSize is false.</p>
1163 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1164 </li></ul></div></div></div><div id="method-bubble" class="member inherited"><a href="Ext.button.Cycle.html#method-bubble" rel="method-bubble" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-bubble" class="viewSource">view source</a></div><a name="bubble"></a><a name="method-bubble"></a><a href="Ext.button.Cycle.html#" rel="method-bubble" class="cls expand">bubble</a>(
1165 <span class="pre">Function fn, [Object scope], [Array args]</span>)
1166  : Ext.Component</div><div class="description"><div class="short">Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of...</div><div class="long"><p>Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (<i>this</i>) of
1167 function call will be the scope provided or the current component. The arguments to the function
1168 will be the args provided or the current component. If the function returns false at any point,
1169 the bubble is stopped.</p>
1170 <h3 class="pa">Parameters</h3><ul><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The function to call</p>
1171 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope of the function (defaults to current node)</p>
1172 </div></li><li><span class="pre">args</span> : Array<div class="sub-desc"><p>(optional) The args to call the function with (default to passing the current component)</p>
1173 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>this</p>
1174 </li></ul></div></div></div><div id="method-capture" class="member inherited"><a href="Ext.button.Cycle.html#method-capture" rel="method-capture" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-capture" class="viewSource">view source</a></div><a name="capture"></a><a name="method-capture"></a><a href="Ext.button.Cycle.html#" rel="method-capture" class="cls expand">capture</a>(
1175 <span class="pre">Observable o, Function fn, [Object scope]</span>)
1176  : void</div><div class="description"><div class="short">Starts capture on the specified Observable. All events will be passed
1177 to the supplied function with the event name + ...</div><div class="long"><p>Starts capture on the specified Observable. All events will be passed
1178 to the supplied function with the event name + standard signature of the event
1179 <b>before</b> the event is fired. If the supplied function returns false,
1180 the event will not fire.</p>
1181 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to capture events from.</p>
1182 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The function to call when an event is fired.</p>
1183 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>
1184 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1185 </li></ul></div></div></div><div id="method-center" class="member inherited"><a href="Ext.button.Cycle.html#method-center" rel="method-center" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Floating.html" class="definedIn docClass">Ext.util.Floating</a><br/><a href="../source/Floating.html#Ext-util.Floating-method-center" class="viewSource">view source</a></div><a name="center"></a><a name="method-center"></a><a href="Ext.button.Cycle.html#" rel="method-center" class="cls expand">center</a> : Component</div><div class="description"><div class="short"><p>Center this Component in its container.</p>
1186 </div><div class="long"><p>Center this Component in its container.</p>
1187 <h3 class="pa">Returns</h3><ul><li><span class="pre">Component</span>&nbsp; &nbsp;<p>this</p>
1188 </li></ul></div></div></div><div id="method-clearListeners" class="member inherited"><a href="Ext.button.Cycle.html#method-clearListeners" rel="method-clearListeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-clearListeners" class="viewSource">view source</a></div><a name="clearListeners"></a><a name="method-clearListeners"></a><a href="Ext.button.Cycle.html#" rel="method-clearListeners" class="cls expand">clearListeners</a> : void</div><div class="description"><div class="short"><p>Removes all listeners for this object including the managed listeners</p>
1189 </div><div class="long"><p>Removes all listeners for this object including the managed listeners</p>
1190 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1191 </li></ul></div></div></div><div id="method-clearManagedListeners" class="member inherited"><a href="Ext.button.Cycle.html#method-clearManagedListeners" rel="method-clearManagedListeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-clearManagedListeners" class="viewSource">view source</a></div><a name="clearManagedListeners"></a><a name="method-clearManagedListeners"></a><a href="Ext.button.Cycle.html#" rel="method-clearManagedListeners" class="cls expand">clearManagedListeners</a> : void</div><div class="description"><div class="short"><p>Removes all managed listeners for this object.</p>
1192 </div><div class="long"><p>Removes all managed listeners for this object.</p>
1193 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1194 </li></ul></div></div></div><div id="method-cloneConfig" class="member inherited"><a href="Ext.button.Cycle.html#method-cloneConfig" rel="method-cloneConfig" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-cloneConfig" class="viewSource">view source</a></div><a name="cloneConfig"></a><a name="method-cloneConfig"></a><a href="Ext.button.Cycle.html#" rel="method-cloneConfig" class="cls expand">cloneConfig</a>(
1195 <span class="pre">Object overrides</span>)
1196  : Ext.Component</div><div class="description"><div class="short"><p>Clone the current component using the original config values passed into this instance by default.</p>
1197 </div><div class="long"><p>Clone the current component using the original config values passed into this instance by default.</p>
1198 <h3 class="pa">Parameters</h3><ul><li><span class="pre">overrides</span> : Object<div class="sub-desc"><p>A new config containing any properties to override in the cloned version.
1199 An id property can be passed on this object, otherwise one will be generated to avoid duplicates.</p>
1200 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>clone The cloned copy of this component</p>
1201 </li></ul></div></div></div><div id="method-destroy" class="member inherited"><a href="Ext.button.Cycle.html#method-destroy" rel="method-destroy" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.state.Stateful.html" class="definedIn docClass">Ext.state.Stateful</a><br/><a href="../source/Stateful.html#Ext-state.Stateful-method-destroy" class="viewSource">view source</a></div><a name="destroy"></a><a name="method-destroy"></a><a href="Ext.button.Cycle.html#" rel="method-destroy" class="cls expand">destroy</a> : void</div><div class="description"><div class="short"><p>Destroys this stateful object.</p>
1202 </div><div class="long"><p>Destroys this stateful object.</p>
1203 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1204 </li></ul></div></div></div><div id="method-disable" class="member inherited"><a href="Ext.button.Cycle.html#method-disable" rel="method-disable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-disable" class="viewSource">view source</a></div><a name="disable"></a><a name="method-disable"></a><a href="Ext.button.Cycle.html#" rel="method-disable" class="cls expand">disable</a>(
1205 <span class="pre">Boolean silent</span>)
1206  : void</div><div class="description"><div class="short"><p>Disable the component.</p>
1207 </div><div class="long"><p>Disable the component.</p>
1208 <h3 class="pa">Parameters</h3><ul><li><span class="pre">silent</span> : Boolean<div class="sub-desc"><p>Passing true, will supress the 'disable' event from being fired.</p>
1209 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1210 </li></ul></div></div></div><div id="method-doAutoRender" class="member inherited"><a href="Ext.button.Cycle.html#method-doAutoRender" rel="method-doAutoRender" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-doAutoRender" class="viewSource">view source</a></div><a name="doAutoRender"></a><a name="method-doAutoRender"></a><a href="Ext.button.Cycle.html#" rel="method-doAutoRender" class="cls expand">doAutoRender</a> : void</div><div class="description"><div class="short">Handles autoRender.
1211 Floating Components may have an ownerCt. If they are asking to be constrained, constrain them wit...</div><div class="long"><p>Handles autoRender.
1212 Floating Components may have an ownerCt. If they are asking to be constrained, constrain them within that
1213 ownerCt, and have their z-index managed locally. Floating Components are always rendered to document.body</p>
1214 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1215 </li></ul></div></div></div><div id="method-doComponentLayout" class="member inherited"><a href="Ext.button.Cycle.html#method-doComponentLayout" rel="method-doComponentLayout" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-doComponentLayout" class="viewSource">view source</a></div><a name="doComponentLayout"></a><a name="method-doComponentLayout"></a><a href="Ext.button.Cycle.html#" rel="method-doComponentLayout" class="cls expand">doComponentLayout</a>(
1216 <span class="pre">Object width, Object height, Object isSetSize, Object ownerCt</span>)
1217  : Ext.container.Container</div><div class="description"><div class="short">This method needs to be called whenever you change something on this component that requires the Component's
1218 layout t...</div><div class="long"><p>This method needs to be called whenever you change something on this component that requires the Component's
1219 layout to be recalculated.</p>
1220 <h3 class="pa">Parameters</h3><ul><li><span class="pre">width</span> : Object<div class="sub-desc">
1221 </div></li><li><span class="pre">height</span> : Object<div class="sub-desc">
1222 </div></li><li><span class="pre">isSetSize</span> : Object<div class="sub-desc">
1223 </div></li><li><span class="pre">ownerCt</span> : Object<div class="sub-desc">
1224 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.container.Container</span>&nbsp; &nbsp;<p>this</p>
1225 </li></ul></div></div></div><div id="method-doConstrain" class="member inherited"><a href="Ext.button.Cycle.html#method-doConstrain" rel="method-doConstrain" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Floating.html" class="definedIn docClass">Ext.util.Floating</a><br/><a href="../source/Floating.html#Ext-util.Floating-method-doConstrain" class="viewSource">view source</a></div><a name="doConstrain"></a><a name="method-doConstrain"></a><a href="Ext.button.Cycle.html#" rel="method-doConstrain" class="cls expand">doConstrain</a>(
1226 <span class="pre">Mixed constrainTo</span>)
1227  : void</div><div class="description"><div class="short">Moves this floating Component into a constrain region.
1228
1229
1230 By default, this Component is constrained to be within the c...</div><div class="long"><p>Moves this floating Component into a constrain region.</p>
1231
1232
1233 <p>By default, this Component is constrained to be within the container it was added to, or the element
1234 it was rendered to.</p>
1235
1236
1237 <p>An alternative constraint may be passed.</p>
1238
1239 <h3 class="pa">Parameters</h3><ul><li><span class="pre">constrainTo</span> : Mixed<div class="sub-desc"><p>Optional. The Element or <a href="Ext.util.Region.html" rel="Ext.util.Region" class="docClass">Region</a> into which this Component is to be constrained.</p>
1240 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1241 </li></ul></div></div></div><div id="method-enable" class="member inherited"><a href="Ext.button.Cycle.html#method-enable" rel="method-enable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-enable" class="viewSource">view source</a></div><a name="enable"></a><a name="method-enable"></a><a href="Ext.button.Cycle.html#" rel="method-enable" class="cls expand">enable</a>(
1242 <span class="pre">Boolean silent</span>)
1243  : void</div><div class="description"><div class="short"><p>Enable the component</p>
1244 </div><div class="long"><p>Enable the component</p>
1245 <h3 class="pa">Parameters</h3><ul><li><span class="pre">silent</span> : Boolean<div class="sub-desc"><p>Passing false will supress the 'enable' event from being fired.</p>
1246 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1247 </li></ul></div></div></div><div id="method-enableBubble" class="member inherited"><a href="Ext.button.Cycle.html#method-enableBubble" rel="method-enableBubble" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-enableBubble" class="viewSource">view source</a></div><a name="enableBubble"></a><a name="method-enableBubble"></a><a href="Ext.button.Cycle.html#" rel="method-enableBubble" class="cls expand">enableBubble</a>(
1248 <span class="pre">String/Array events</span>)
1249  : void</div><div class="description"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
1250 this.getBubbleTarget() if present....</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling
1251 <code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>
1252
1253
1254 <p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href="Ext.Component.html#getBubbleTarget" rel="Ext.Component#getBubbleTarget" class="docClass">Ext.Component.getBubbleTarget</a>. The default
1255 implementation in <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a> returns the Component's immediate owner. But if a known target is required, this can be overridden to
1256 access the required target more quickly.</p>
1257
1258
1259 <p>Example:</p>
1260
1261
1262 <pre><code>Ext.override(Ext.form.field.Base, {
1263 //  Add functionality to Field&#39;s initComponent to enable the change event to bubble
1264 initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
1265     this.enableBubble('change');
1266 }),
1267
1268 //  We know that we want Field&#39;s events to bubble directly to the FormPanel.
1269 getBubbleTarget : function() {
1270     if (!this.formPanel) {
1271         this.formPanel = this.findParentByType('form');
1272     }
1273     return this.formPanel;
1274 }
1275 });
1276
1277 var myForm = new Ext.formPanel({
1278 title: 'User Details',
1279 items: [{
1280     ...
1281 }],
1282 listeners: {
1283     change: function() {
1284         // Title goes red if form has been modified.
1285         myForm.header.setStyle('color', 'red');
1286     }
1287 }
1288 });
1289 </code></pre>
1290
1291 <h3 class="pa">Parameters</h3><ul><li><span class="pre">events</span> : String/Array<div class="sub-desc"><p>The event name to bubble, or an Array of event names.</p>
1292 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1293 </li></ul></div></div></div><div id="method-findLayoutController" class="member inherited"><a href="Ext.button.Cycle.html#method-findLayoutController" rel="method-findLayoutController" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-findLayoutController" class="viewSource">view source</a></div><a name="findLayoutController"></a><a name="method-findLayoutController"></a><a href="Ext.button.Cycle.html#" rel="method-findLayoutController" class="cls expand">findLayoutController</a> : void</div><div class="description"><div class="short">This method finds the topmost active layout who's processing will eventually determine the size and position of this
1294 ...</div><div class="long"><p>This method finds the topmost active layout who's processing will eventually determine the size and position of this
1295 Component.<p>
1296 <p>This method is useful when dynamically adding Components into Containers, and some processing must take place after the
1297 final sizing and positioning of the Component has been performed.</p>
1298
1299 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1300 </li></ul></div></div></div><div id="method-findParentBy" class="member inherited"><a href="Ext.button.Cycle.html#method-findParentBy" rel="method-findParentBy" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-findParentBy" class="viewSource">view source</a></div><a name="findParentBy"></a><a name="method-findParentBy"></a><a href="Ext.button.Cycle.html#" rel="method-findParentBy" class="cls expand">findParentBy</a>(
1301 <span class="pre">Function fn</span>)
1302  : Ext.container.Container</div><div class="description"><div class="short">Find a container above this component at any level by a custom function. If the passed function returns
1303 true, the con...</div><div class="long"><p>Find a container above this component at any level by a custom function. If the passed function returns
1304 true, the container will be returned.</p>
1305 <h3 class="pa">Parameters</h3><ul><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The custom function to call with the arguments (container, this component).</p>
1306 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.container.Container</span>&nbsp; &nbsp;<p>The first Container for which the custom function returns true</p>
1307 </li></ul></div></div></div><div id="method-findParentByType" class="member inherited"><a href="Ext.button.Cycle.html#method-findParentByType" rel="method-findParentByType" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-findParentByType" class="viewSource">view source</a></div><a name="findParentByType"></a><a name="method-findParentByType"></a><a href="Ext.button.Cycle.html#" rel="method-findParentByType" class="cls expand">findParentByType</a>(
1308 <span class="pre">String/Class xtype</span>)
1309  : Ext.container.Container</div><div class="description"><div class="short"><p>Find a container above this component at any level by xtype or class</p>
1310
1311
1312 <p>See also the <a href="Ext.Component.html#up" rel="Ext.Component#up" class="docClass">up</a> method.</p>
1313
1314 </div><div class="long"><p>Find a container above this component at any level by xtype or class</p>
1315
1316
1317 <p>See also the <a href="Ext.Component.html#up" rel="Ext.Component#up" class="docClass">up</a> method.</p>
1318
1319 <h3 class="pa">Parameters</h3><ul><li><span class="pre">xtype</span> : String/Class<div class="sub-desc"><p>The xtype string for a component, or the class of the component directly</p>
1320 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.container.Container</span>&nbsp; &nbsp;<p>The first Container which matches the given xtype or class</p>
1321 </li></ul></div></div></div><div id="method-fireEvent" class="member inherited"><a href="Ext.button.Cycle.html#method-fireEvent" rel="method-fireEvent" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-fireEvent" class="viewSource">view source</a></div><a name="fireEvent"></a><a name="method-fireEvent"></a><a href="Ext.button.Cycle.html#" rel="method-fireEvent" class="cls expand">fireEvent</a>(
1322 <span class="pre">String eventName, Object... args</span>)
1323  : Boolean</div><div class="description"><div class="short">Fires the specified event with the passed parameters (minus the event name).
1324
1325
1326 An event may be set to bubble up an Ob...</div><div class="long"><p>Fires the specified event with the passed parameters (minus the event name).</p>
1327
1328
1329 <p>An event may be set to bubble up an Observable parent hierarchy (See <a href="Ext.Component.html#getBubbleTarget" rel="Ext.Component#getBubbleTarget" class="docClass">Ext.Component.getBubbleTarget</a>)
1330 by calling <a href="Ext.button.Cycle.html#enableBubble" rel="Ext.button.Cycle#enableBubble" class="docClass">enableBubble</a>.</p>
1331
1332 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to fire.</p>
1333 </div></li><li><span class="pre">args</span> : Object...<div class="sub-desc"><p>Variable number of parameters are passed to handlers.</p>
1334 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>returns false if any of the handlers return false otherwise it returns true.</p>
1335 </li></ul></div></div></div><div id="method-focus" class="member inherited"><a href="Ext.button.Cycle.html#method-focus" rel="method-focus" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-focus" class="viewSource">view source</a></div><a name="focus"></a><a name="method-focus"></a><a href="Ext.button.Cycle.html#" rel="method-focus" class="cls expand">focus</a>(
1336 <span class="pre">[Boolean selectText], [Boolean/Number delay]</span>)
1337  : Ext.Component</div><div class="description"><div class="short"><p>Try to focus this component.</p>
1338 </div><div class="long"><p>Try to focus this component.</p>
1339 <h3 class="pa">Parameters</h3><ul><li><span class="pre">selectText</span> : Boolean<div class="sub-desc"><p>(optional) If applicable, true to also select the text in this component</p>
1340 </div></li><li><span class="pre">delay</span> : Boolean/Number<div class="sub-desc"><p>(optional) Delay the focus this number of milliseconds (true for 10 milliseconds).</p>
1341 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>this</p>
1342 </li></ul></div></div></div><div id="method-getActiveAnimation" class="member inherited"><a href="Ext.button.Cycle.html#method-getActiveAnimation" rel="method-getActiveAnimation" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Animate.html" class="definedIn docClass">Ext.util.Animate</a><br/><a href="../source/Animate.html#Ext-util.Animate-method-getActiveAnimation" class="viewSource">view source</a></div><a name="getActiveAnimation"></a><a name="method-getActiveAnimation"></a><a href="Ext.button.Cycle.html#" rel="method-getActiveAnimation" class="cls expand">getActiveAnimation</a> : Mixed</div><div class="description"><div class="short"><p>Returns thq current animation if this object has any effects actively running or queued, else returns false.</p>
1343 </div><div class="long"><p>Returns thq current animation if this object has any effects actively running or queued, else returns false.</p>
1344 <h3 class="pa">Returns</h3><ul><li><span class="pre">Mixed</span>&nbsp; &nbsp;<p>anim if element has active effects, else false</p>
1345 </li></ul></div></div></div><div id="method-getActiveItem" class="member ni"><a href="Ext.button.Cycle.html#method-getActiveItem" rel="method-getActiveItem" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Cycle.html" class="definedIn docClass">Ext.button.Cycle</a><br/><a href="../source/Cycle.html#Ext-button.Cycle-method-getActiveItem" class="viewSource">view source</a></div><a name="getActiveItem"></a><a name="method-getActiveItem"></a><a href="Ext.button.Cycle.html#" rel="method-getActiveItem" class="cls expand">getActiveItem</a> : Ext.menu.CheckItem</div><div class="description"><div class="short"><p>Gets the currently active menu item.</p>
1346 </div><div class="long"><p>Gets the currently active menu item.</p>
1347 <h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.menu.CheckItem</span>&nbsp; &nbsp;<p>The active item</p>
1348 </li></ul></div></div></div><div id="method-getBox" class="member inherited"><a href="Ext.button.Cycle.html#method-getBox" rel="method-getBox" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-getBox" class="viewSource">view source</a></div><a name="getBox"></a><a name="method-getBox"></a><a href="Ext.button.Cycle.html#" rel="method-getBox" class="cls expand">getBox</a>(
1349 <span class="pre">[Boolean local]</span>)
1350  : Object</div><div class="description"><div class="short"><p>Gets the current box measurements of the component's underlying element.</p>
1351 </div><div class="long"><p>Gets the current box measurements of the component's underlying element.</p>
1352 <h3 class="pa">Parameters</h3><ul><li><span class="pre">local</span> : Boolean<div class="sub-desc"><p>(optional) If true the element's left and top are returned instead of page XY (defaults to false)</p>
1353 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>box An object in the format {x, y, width, height}</p>
1354 </li></ul></div></div></div><div id="method-getBubbleTarget" class="member inherited"><a href="Ext.button.Cycle.html#method-getBubbleTarget" rel="method-getBubbleTarget" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-getBubbleTarget" class="viewSource">view source</a></div><a name="getBubbleTarget"></a><a name="method-getBubbleTarget"></a><a href="Ext.button.Cycle.html#" rel="method-getBubbleTarget" class="cls expand">getBubbleTarget</a> : Ext.container.Container</div><div class="description"><div class="short"><p>Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy.</p>
1355 </div><div class="long"><p>Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy.</p>
1356 <h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.container.Container</span>&nbsp; &nbsp;<p>the Container which owns this Component.</p>
1357 </li></ul></div></div></div><div id="method-getEl" class="member inherited"><a href="Ext.button.Cycle.html#method-getEl" rel="method-getEl" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-getEl" class="viewSource">view source</a></div><a name="getEl"></a><a name="method-getEl"></a><a href="Ext.button.Cycle.html#" rel="method-getEl" class="cls expand">getEl</a> : void</div><div class="description"><div class="short"><p>Retrieves the top level element representing this component.</p>
1358 </div><div class="long"><p>Retrieves the top level element representing this component.</p>
1359 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1360 </li></ul></div></div></div><div id="method-getHeight" class="member inherited"><a href="Ext.button.Cycle.html#method-getHeight" rel="method-getHeight" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-getHeight" class="viewSource">view source</a></div><a name="getHeight"></a><a name="method-getHeight"></a><a href="Ext.button.Cycle.html#" rel="method-getHeight" class="cls expand">getHeight</a> : Number</div><div class="description"><div class="short"><p>Gets the current height of the component's underlying element.</p>
1361 </div><div class="long"><p>Gets the current height of the component's underlying element.</p>
1362 <h3 class="pa">Returns</h3><ul><li><span class="pre">Number</span>&nbsp; &nbsp;
1363 </li></ul></div></div></div><div id="method-getId" class="member inherited"><a href="Ext.button.Cycle.html#method-getId" rel="method-getId" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-getId" class="viewSource">view source</a></div><a name="getId"></a><a name="method-getId"></a><a href="Ext.button.Cycle.html#" rel="method-getId" class="cls expand">getId</a> : void</div><div class="description"><div class="short"><p>Retrieves the id of this component.
1364 Will autogenerate an id if one has not already been set.</p>
1365 </div><div class="long"><p>Retrieves the id of this component.
1366 Will autogenerate an id if one has not already been set.</p>
1367 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1368 </li></ul></div></div></div><div id="method-getInsertPosition" class="member inherited"><a href="Ext.button.Cycle.html#method-getInsertPosition" rel="method-getInsertPosition" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-getInsertPosition" class="viewSource">view source</a></div><a name="getInsertPosition"></a><a name="method-getInsertPosition"></a><a href="Ext.button.Cycle.html#" rel="method-getInsertPosition" class="cls expand">getInsertPosition</a>(
1369 <span class="pre">String/Number/Element/HTMLElement position</span>)
1370  : HTMLElement</div><div class="description"><div class="short">This function takes the position argument passed to onRender and returns a
1371 DOM element that you can use in the insert...</div><div class="long"><p>This function takes the position argument passed to onRender and returns a
1372 DOM element that you can use in the insertBefore.</p>
1373 <h3 class="pa">Parameters</h3><ul><li><span class="pre">position</span> : String/Number/Element/HTMLElement<div class="sub-desc"><p>Index, element id or element you want
1374 to put this component before.</p>
1375 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">HTMLElement</span>&nbsp; &nbsp;<p>DOM element that you can use in the insertBefore</p>
1376 </li></ul></div></div></div><div id="method-getLoader" class="member inherited"><a href="Ext.button.Cycle.html#method-getLoader" rel="method-getLoader" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-getLoader" class="viewSource">view source</a></div><a name="getLoader"></a><a name="method-getLoader"></a><a href="Ext.button.Cycle.html#" rel="method-getLoader" class="cls expand">getLoader</a> : Ext.ComponentLoader</div><div class="description"><div class="short"><p>Gets the <a href="Ext.ComponentLoader.html" rel="Ext.ComponentLoader" class="docClass">Ext.ComponentLoader</a> for this Component.</p>
1377 </div><div class="long"><p>Gets the <a href="Ext.ComponentLoader.html" rel="Ext.ComponentLoader" class="docClass">Ext.ComponentLoader</a> for this Component.</p>
1378 <h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.ComponentLoader</span>&nbsp; &nbsp;<p>The loader instance, null if it doesn't exist.</p>
1379 </li></ul></div></div></div><div id="method-getPlugin" class="member inherited"><a href="Ext.button.Cycle.html#method-getPlugin" rel="method-getPlugin" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-getPlugin" class="viewSource">view source</a></div><a name="getPlugin"></a><a name="method-getPlugin"></a><a href="Ext.button.Cycle.html#" rel="method-getPlugin" class="cls expand">getPlugin</a>(
1380 <span class="pre">Object pluginId</span>)
1381  : Ext.AbstractPlugin</div><div class="description"><div class="short"><p>Retrieves a plugin by its pluginId which has been bound to this
1382 component.</p>
1383 </div><div class="long"><p>Retrieves a plugin by its pluginId which has been bound to this
1384 component.</p>
1385 <h3 class="pa">Parameters</h3><ul><li><span class="pre">pluginId</span> : Object<div class="sub-desc">
1386 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.AbstractPlugin</span>&nbsp; &nbsp;<p>pluginInstance</p>
1387 </li></ul></div></div></div><div id="method-getPosition" class="member inherited"><a href="Ext.button.Cycle.html#method-getPosition" rel="method-getPosition" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-getPosition" class="viewSource">view source</a></div><a name="getPosition"></a><a name="method-getPosition"></a><a href="Ext.button.Cycle.html#" rel="method-getPosition" class="cls expand">getPosition</a>(
1388 <span class="pre">[Boolean local]</span>)
1389  : Array</div><div class="description"><div class="short"><p>Gets the current XY position of the component's underlying element.</p>
1390 </div><div class="long"><p>Gets the current XY position of the component's underlying element.</p>
1391 <h3 class="pa">Parameters</h3><ul><li><span class="pre">local</span> : Boolean<div class="sub-desc"><p>(optional) If true the element's left and top are returned instead of page XY (defaults to false)</p>
1392 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Array</span>&nbsp; &nbsp;<p>The XY position of the element (e.g., [100, 200])</p>
1393 </li></ul></div></div></div><div id="method-getPressed" class="member inherited"><a href="Ext.button.Cycle.html#method-getPressed" rel="method-getPressed" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-method-getPressed" class="viewSource">view source</a></div><a name="getPressed"></a><a name="method-getPressed"></a><a href="Ext.button.Cycle.html#" rel="method-getPressed" class="cls expand">getPressed</a>(
1394 <span class="pre">String group</span>)
1395  : void</div><div class="description"><div class="short"><p>Gets the pressed button in the passed group or null</p>
1396 </div><div class="long"><p>Gets the pressed button in the passed group or null</p>
1397 <h3 class="pa">Parameters</h3><ul><li><span class="pre">group</span> : String<div class="sub-desc">
1398 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;<p>Button</p>
1399 </li></ul></div></div></div><div id="method-getSize" class="member inherited"><a href="Ext.button.Cycle.html#method-getSize" rel="method-getSize" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-getSize" class="viewSource">view source</a></div><a name="getSize"></a><a name="method-getSize"></a><a href="Ext.button.Cycle.html#" rel="method-getSize" class="cls expand">getSize</a> : Object</div><div class="description"><div class="short"><p>Gets the current size of the component's underlying element.</p>
1400 </div><div class="long"><p>Gets the current size of the component's underlying element.</p>
1401 <h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>An object containing the element's size {width: (element width), height: (element height)}</p>
1402 </li></ul></div></div></div><div id="method-getState" class="member inherited"><a href="Ext.button.Cycle.html#method-getState" rel="method-getState" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.state.Stateful.html" class="definedIn docClass">Ext.state.Stateful</a><br/><a href="../source/Stateful.html#Ext-state.Stateful-method-getState" class="viewSource">view source</a></div><a name="getState"></a><a name="method-getState"></a><a href="Ext.button.Cycle.html#" rel="method-getState" class="cls expand">getState</a> : Object</div><div class="description"><div class="short">Gets the current state of the object. By default this function returns null,
1403 it should be overridden in subclasses to...</div><div class="long"><p>Gets the current state of the object. By default this function returns null,
1404 it should be overridden in subclasses to implement methods for getting the state.</p>
1405 <h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>The current state</p>
1406 </li></ul></div></div></div><div id="method-getStateId" class="member inherited"><a href="Ext.button.Cycle.html#method-getStateId" rel="method-getStateId" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.state.Stateful.html" class="definedIn docClass">Ext.state.Stateful</a><br/><a href="../source/Stateful.html#Ext-state.Stateful-method-getStateId" class="viewSource">view source</a></div><a name="getStateId"></a><a name="method-getStateId"></a><a href="Ext.button.Cycle.html#" rel="method-getStateId" class="cls expand">getStateId</a> : String</div><div class="description"><div class="short"><p>Gets the state id for this object.</p>
1407 </div><div class="long"><p>Gets the state id for this object.</p>
1408 <h3 class="pa">Returns</h3><ul><li><span class="pre">String</span>&nbsp; &nbsp;<p>The state id, null if not found.</p>
1409 </li></ul></div></div></div><div id="method-getTemplateArgs" class="member inherited"><a href="Ext.button.Cycle.html#method-getTemplateArgs" rel="method-getTemplateArgs" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-method-getTemplateArgs" class="viewSource">view source</a></div><a name="getTemplateArgs"></a><a name="method-getTemplateArgs"></a><a href="Ext.button.Cycle.html#" rel="method-getTemplateArgs" class="cls expand">getTemplateArgs</a> : Array</div><div class="description"><div class="short">This method returns an object which provides substitution parameters for the XTemplate used
1410 to create this Button's D...</div><div class="long"><p>This method returns an object which provides substitution parameters for the <a href="Ext.button.Cycle.html#renderTpl" rel="Ext.button.Cycle#renderTpl" class="docClass">XTemplate</a> used
1411 to create this Button's DOM structure.</p>
1412
1413
1414 <p>Instances or subclasses which use a different Template to create a different DOM structure may need to provide their
1415 own implementation of this method.</p>
1416
1417
1418 <p>The default implementation which provides data for the default <a href="Ext.button.Cycle.html#template" rel="Ext.button.Cycle#template" class="docClass">template</a> returns an Object containing the
1419 following properties:</p>
1420
1421
1422 <div class="mdetail-params"><ul>
1423 <li><code>type</code> : The &lt;button&gt;'s <a href="Ext.button.Cycle.html#type" rel="Ext.button.Cycle#type" class="docClass">type</a></li>
1424 <li><code>splitCls</code> : A CSS class to determine the presence and position of an arrow icon. (<code>'x-btn-arrow'</code> or <code>'x-btn-arrow-bottom'</code> or <code>''</code>)</li>
1425 <li><code>cls</code> : A CSS class name applied to the Button's main &lt;tbody&gt; element which determines the button's scale and icon alignment.</li>
1426 <li><code>text</code> : The <a href="Ext.button.Cycle.html#text" rel="Ext.button.Cycle#text" class="docClass">text</a> to display ion the Button.</li>
1427 <li><code>tabIndex</code> : The tab index within the input flow.</li>
1428 </ul></div>
1429
1430 <h3 class="pa">Returns</h3><ul><li><span class="pre">Array</span>&nbsp; &nbsp;<p>Substitution data for a Template.</p>
1431 </li></ul></div></div></div><div id="method-getText" class="member inherited"><a href="Ext.button.Cycle.html#method-getText" rel="method-getText" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-method-getText" class="viewSource">view source</a></div><a name="getText"></a><a name="method-getText"></a><a href="Ext.button.Cycle.html#" rel="method-getText" class="cls expand">getText</a> : String</div><div class="description"><div class="short"><p>Gets the text for this Button</p>
1432 </div><div class="long"><p>Gets the text for this Button</p>
1433 <h3 class="pa">Returns</h3><ul><li><span class="pre">String</span>&nbsp; &nbsp;<p>The button text</p>
1434 </li></ul></div></div></div><div id="method-getWidth" class="member inherited"><a href="Ext.button.Cycle.html#method-getWidth" rel="method-getWidth" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-getWidth" class="viewSource">view source</a></div><a name="getWidth"></a><a name="method-getWidth"></a><a href="Ext.button.Cycle.html#" rel="method-getWidth" class="cls expand">getWidth</a> : Number</div><div class="description"><div class="short"><p>Gets the current width of the component's underlying element.</p>
1435 </div><div class="long"><p>Gets the current width of the component's underlying element.</p>
1436 <h3 class="pa">Returns</h3><ul><li><span class="pre">Number</span>&nbsp; &nbsp;
1437 </li></ul></div></div></div><div id="method-getXType" class="member inherited"><a href="Ext.button.Cycle.html#method-getXType" rel="method-getXType" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-getXType" class="viewSource">view source</a></div><a name="getXType"></a><a name="method-getXType"></a><a href="Ext.button.Cycle.html#" rel="method-getXType" class="cls expand">getXType</a> : String</div><div class="description"><div class="short">Gets the xtype for this component as registered with Ext.ComponentManager. For a list of all
1438 available xtypes, see th...</div><div class="long"><p>Gets the xtype for this component as registered with <a href="Ext.ComponentManager.html" rel="Ext.ComponentManager" class="docClass">Ext.ComponentManager</a>. For a list of all
1439 available xtypes, see the <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a> header. Example usage:</p>
1440
1441 <pre><code>var t = new Ext.form.field.Text();
1442 alert(t.getXType());  // alerts 'textfield'
1443 </code></pre>
1444
1445 <h3 class="pa">Returns</h3><ul><li><span class="pre">String</span>&nbsp; &nbsp;<p>The xtype</p>
1446 </li></ul></div></div></div><div id="method-getXTypes" class="member inherited"><a href="Ext.button.Cycle.html#method-getXTypes" rel="method-getXTypes" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-getXTypes" class="viewSource">view source</a></div><a name="getXTypes"></a><a name="method-getXTypes"></a><a href="Ext.button.Cycle.html#" rel="method-getXTypes" class="cls expand">getXTypes</a> : String</div><div class="description"><div class="short">Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all
1447 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
1448 available xtypes, see the <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a> header.</p>
1449
1450
1451 <p><b>If using your own subclasses, be aware that a Component must register its own xtype
1452 to participate in determination of inherited xtypes.</b></p>
1453
1454
1455 <p>Example usage:</p>
1456
1457
1458 <pre><code>var t = new Ext.form.field.Text();
1459 alert(t.getXTypes());  // alerts 'component/field/textfield'
1460 </code></pre>
1461
1462 <h3 class="pa">Returns</h3><ul><li><span class="pre">String</span>&nbsp; &nbsp;<p>The xtype hierarchy string</p>
1463 </li></ul></div></div></div><div id="method-hasListener" class="member inherited"><a href="Ext.button.Cycle.html#method-hasListener" rel="method-hasListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-hasListener" class="viewSource">view source</a></div><a name="hasListener"></a><a name="method-hasListener"></a><a href="Ext.button.Cycle.html#" rel="method-hasListener" class="cls expand">hasListener</a>(
1464 <span class="pre">String eventName</span>)
1465  : Boolean</div><div class="description"><div class="short"><p>Checks to see if this object has any listeners for a specified event</p>
1466 </div><div class="long"><p>Checks to see if this object has any listeners for a specified event</p>
1467 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to check for</p>
1468 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if the event is being listened for, else false</p>
1469 </li></ul></div></div></div><div id="method-hasUICls" class="member inherited"><a href="Ext.button.Cycle.html#method-hasUICls" rel="method-hasUICls" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-hasUICls" class="viewSource">view source</a></div><a name="hasUICls"></a><a name="method-hasUICls"></a><a href="Ext.button.Cycle.html#" rel="method-hasUICls" class="cls expand">hasUICls</a>(
1470 <span class="pre">String cls</span>)
1471  : void</div><div class="description"><div class="short"><p>Checks if there is currently a specified uiCls</p>
1472 </div><div class="long"><p>Checks if there is currently a specified uiCls</p>
1473 <h3 class="pa">Parameters</h3><ul><li><span class="pre">cls</span> : String<div class="sub-desc"><p>The cls to check</p>
1474 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1475 </li></ul></div></div></div><div id="method-hasVisibleMenu" class="member inherited"><a href="Ext.button.Cycle.html#method-hasVisibleMenu" rel="method-hasVisibleMenu" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-method-hasVisibleMenu" class="viewSource">view source</a></div><a name="hasVisibleMenu"></a><a name="method-hasVisibleMenu"></a><a href="Ext.button.Cycle.html#" rel="method-hasVisibleMenu" class="cls expand">hasVisibleMenu</a> : Boolean</div><div class="description"><div class="short"><p>Returns true if the button has a menu and it is visible</p>
1476 </div><div class="long"><p>Returns true if the button has a menu and it is visible</p>
1477 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;
1478 </li></ul></div></div></div><div id="method-hide" class="member inherited"><a href="Ext.button.Cycle.html#method-hide" rel="method-hide" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-hide" class="viewSource">view source</a></div><a name="hide"></a><a name="method-hide"></a><a href="Ext.button.Cycle.html#" rel="method-hide" class="cls expand">hide</a>(
1479 <span class="pre">String/Element/Component animateTarget, [Function callback], [Object scope]</span>)
1480  : Ext.Component</div><div class="description"><div class="short"><p>Hides this Component, setting it to invisible using the configured <a href="Ext.button.Cycle.html#hideMode" rel="Ext.button.Cycle#hideMode" class="docClass">hideMode</a>.</p>
1481 </div><div class="long"><p>Hides this Component, setting it to invisible using the configured <a href="Ext.button.Cycle.html#hideMode" rel="Ext.button.Cycle#hideMode" class="docClass">hideMode</a>.</p>
1482 <h3 class="pa">Parameters</h3><ul><li><span class="pre">animateTarget</span> : String/Element/Component<div class="sub-desc"><p>Optional, and <b>only valid for <a href="Ext.button.Cycle.html#floating" rel="Ext.button.Cycle#floating" class="docClass">floating</a> Components such as
1483 <a href="Ext.window.Window.html" rel="Ext.window.Window" class="docClass">Window</a>s or <a href="Ext.tip.ToolTip.html" rel="Ext.tip.ToolTip" class="docClass">ToolTip</a>s, or regular Components which have been configured
1484 with <code>floating: true</code>.</b>.
1485 The target to which the Component should animate while hiding (defaults to null with no animation)</p>
1486 </div></li><li><span class="pre">callback</span> : Function<div class="sub-desc"><p>(optional) A callback function to call after the Component is hidden.</p>
1487 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code>this</code> reference) in which the callback is executed. Defaults to this Component.</p>
1488 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>this</p>
1489 </li></ul></div></div></div><div id="method-hideMenu" class="member inherited"><a href="Ext.button.Cycle.html#method-hideMenu" rel="method-hideMenu" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-method-hideMenu" class="viewSource">view source</a></div><a name="hideMenu"></a><a name="method-hideMenu"></a><a href="Ext.button.Cycle.html#" rel="method-hideMenu" class="cls expand">hideMenu</a> : void</div><div class="description"><div class="short"><p>Hide this button's menu (if it has one)</p>
1490 </div><div class="long"><p>Hide this button's menu (if it has one)</p>
1491 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1492 </li></ul></div></div></div><div id="method-is" class="member inherited"><a href="Ext.button.Cycle.html#method-is" rel="method-is" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-is" class="viewSource">view source</a></div><a name="is"></a><a name="method-is"></a><a href="Ext.button.Cycle.html#" rel="method-is" class="cls expand">is</a>(
1493 <span class="pre">String selector</span>)
1494  : Boolean</div><div class="description"><div class="short"><p>Tests whether this Component matches the selector string.</p>
1495 </div><div class="long"><p>Tests whether this Component matches the selector string.</p>
1496 <h3 class="pa">Parameters</h3><ul><li><span class="pre">selector</span> : String<div class="sub-desc"><p>The selector string to test against.</p>
1497 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if this Component matches the selector.</p>
1498 </li></ul></div></div></div><div id="method-isDescendantOf" class="member inherited"><a href="Ext.button.Cycle.html#method-isDescendantOf" rel="method-isDescendantOf" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-isDescendantOf" class="viewSource">view source</a></div><a name="isDescendantOf"></a><a name="method-isDescendantOf"></a><a href="Ext.button.Cycle.html#" rel="method-isDescendantOf" class="cls expand">isDescendantOf</a>(
1499 <span class="pre">Ext.Container container</span>)
1500  : Boolean</div><div class="description"><div class="short"><p>Determines whether this component is the descendant of a particular container.</p>
1501 </div><div class="long"><p>Determines whether this component is the descendant of a particular container.</p>
1502 <h3 class="pa">Parameters</h3><ul><li><span class="pre">container</span> : Ext.Container<div class="sub-desc">
1503 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>isDescendant</p>
1504 </li></ul></div></div></div><div id="method-isDisabled" class="member inherited"><a href="Ext.button.Cycle.html#method-isDisabled" rel="method-isDisabled" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-isDisabled" class="viewSource">view source</a></div><a name="isDisabled"></a><a name="method-isDisabled"></a><a href="Ext.button.Cycle.html#" rel="method-isDisabled" class="cls expand">isDisabled</a> : Boolean</div><div class="description"><div class="short"><p>Method to determine whether this Component is currently disabled.</p>
1505 </div><div class="long"><p>Method to determine whether this Component is currently disabled.</p>
1506 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>the disabled state of this Component.</p>
1507 </li></ul></div></div></div><div id="method-isDraggable" class="member inherited"><a href="Ext.button.Cycle.html#method-isDraggable" rel="method-isDraggable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-isDraggable" class="viewSource">view source</a></div><a name="isDraggable"></a><a name="method-isDraggable"></a><a href="Ext.button.Cycle.html#" rel="method-isDraggable" class="cls expand">isDraggable</a> : Boolean</div><div class="description"><div class="short"><p>Method to determine whether this Component is draggable.</p>
1508 </div><div class="long"><p>Method to determine whether this Component is draggable.</p>
1509 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>the draggable state of this component.</p>
1510 </li></ul></div></div></div><div id="method-isDroppable" class="member inherited"><a href="Ext.button.Cycle.html#method-isDroppable" rel="method-isDroppable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-isDroppable" class="viewSource">view source</a></div><a name="isDroppable"></a><a name="method-isDroppable"></a><a href="Ext.button.Cycle.html#" rel="method-isDroppable" class="cls expand">isDroppable</a> : Boolean</div><div class="description"><div class="short"><p>Method to determine whether this Component is droppable.</p>
1511 </div><div class="long"><p>Method to determine whether this Component is droppable.</p>
1512 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>the droppable state of this component.</p>
1513 </li></ul></div></div></div><div id="method-isFloating" class="member inherited"><a href="Ext.button.Cycle.html#method-isFloating" rel="method-isFloating" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-isFloating" class="viewSource">view source</a></div><a name="isFloating"></a><a name="method-isFloating"></a><a href="Ext.button.Cycle.html#" rel="method-isFloating" class="cls expand">isFloating</a> : Boolean</div><div class="description"><div class="short"><p>Method to determine whether this Component is floating.</p>
1514 </div><div class="long"><p>Method to determine whether this Component is floating.</p>
1515 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>the floating state of this component.</p>
1516 </li></ul></div></div></div><div id="method-isHidden" class="member inherited"><a href="Ext.button.Cycle.html#method-isHidden" rel="method-isHidden" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-isHidden" class="viewSource">view source</a></div><a name="isHidden"></a><a name="method-isHidden"></a><a href="Ext.button.Cycle.html#" rel="method-isHidden" class="cls expand">isHidden</a> : Boolean</div><div class="description"><div class="short"><p>Method to determine whether this Component is currently set to hidden.</p>
1517 </div><div class="long"><p>Method to determine whether this Component is currently set to hidden.</p>
1518 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>the hidden state of this Component.</p>
1519 </li></ul></div></div></div><div id="method-isVisible" class="member inherited"><a href="Ext.button.Cycle.html#method-isVisible" rel="method-isVisible" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-isVisible" class="viewSource">view source</a></div><a name="isVisible"></a><a name="method-isVisible"></a><a href="Ext.button.Cycle.html#" rel="method-isVisible" class="cls expand">isVisible</a>(
1520 <span class="pre">Boolean deep</span>)
1521  : Boolean</div><div class="description"><div class="short"><p>Returns true if this component is visible.</p>
1522 </div><div class="long"><p>Returns true if this component is visible.</p>
1523 <h3 class="pa">Parameters</h3><ul><li><span class="pre">deep</span> : Boolean<div class="sub-desc"><p>. <p>Optional. Pass <code>true</code> to interrogate the visibility status of all
1524 parent Containers to determine whether this Component is truly visible to the user.</p></p>
1525
1526 <p>Generally, to determine whether a Component is hidden, the no argument form is needed. For example
1527 when creating dynamically laid out UIs in a hidden Container before showing them.</p>
1528
1529 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if this component is visible, false otherwise.</p>
1530 </li></ul></div></div></div><div id="method-isXType" class="member inherited"><a href="Ext.button.Cycle.html#method-isXType" rel="method-isXType" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-isXType" class="viewSource">view source</a></div><a name="isXType"></a><a name="method-isXType"></a><a href="Ext.button.Cycle.html#" rel="method-isXType" class="cls expand">isXType</a>(
1531 <span class="pre">String xtype, [Boolean shallow]</span>)
1532  : Boolean</div><div class="description"><div class="short">Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended
1533 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
1534 from the xtype (default) or whether it is directly of the xtype specified (shallow = true).</p>
1535
1536
1537 <p><b>If using your own subclasses, be aware that a Component must register its own xtype
1538 to participate in determination of inherited xtypes.</b></p>
1539
1540
1541 <p>For a list of all available xtypes, see the <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a> header.</p>
1542
1543
1544 <p>Example usage:</p>
1545
1546
1547 <pre><code>var t = new Ext.form.field.Text();
1548 var isText = t.isXType('textfield');        // true
1549 var isBoxSubclass = t.isXType('field');       // true, descended from <a href="Ext.form.field.Base.html" rel="Ext.form.field.Base" class="docClass">Ext.form.field.Base</a>
1550 var isBoxInstance = t.isXType('field', true); // false, not a direct <a href="Ext.form.field.Base.html" rel="Ext.form.field.Base" class="docClass">Ext.form.field.Base</a> instance
1551 </code></pre>
1552
1553 <h3 class="pa">Parameters</h3><ul><li><span class="pre">xtype</span> : String<div class="sub-desc"><p>The xtype to check for this Component</p>
1554 </div></li><li><span class="pre">shallow</span> : Boolean<div class="sub-desc"><p>(optional) False to check whether this Component is descended from the xtype (this is
1555 the default), or true to check whether this Component is directly of the specified xtype.</p>
1556 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if this component descends from the specified xtype, false otherwise.</p>
1557 </li></ul></div></div></div><div id="method-nextNode" class="member inherited"><a href="Ext.button.Cycle.html#method-nextNode" rel="method-nextNode" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-nextNode" class="viewSource">view source</a></div><a name="nextNode"></a><a name="method-nextNode"></a><a href="Ext.button.Cycle.html#" rel="method-nextNode" class="cls expand">nextNode</a>(
1558 <span class="pre">String selector, Object includeSelf</span>)
1559  : void</div><div class="description"><div class="short">Returns the next node in the Component tree in tree traversal order.
1560
1561
1562 Note that this is not limited to siblings, and...</div><div class="long"><p>Returns the next node in the Component tree in tree traversal order.</p>
1563
1564
1565 <p>Note that this is not limited to siblings, and if invoked upon a node with no matching siblings, will
1566 walk the tree to attempt to find a match. Contrast with <a href="Ext.button.Cycle.html#pnextSibling" rel="Ext.button.Cycle#pnextSibling" class="docClass">pnextSibling</a>.</p>
1567
1568 <h3 class="pa">Parameters</h3><ul><li><span class="pre">selector</span> : String<div class="sub-desc"><p>Optional A <a href="Ext.ComponentQuery.html" rel="Ext.ComponentQuery" class="docClass">ComponentQuery</a> selector to filter the following nodes.</p>
1569 </div></li><li><span class="pre">includeSelf</span> : Object<div class="sub-desc">
1570 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;<p>The next node (or the next node which matches the selector). Returns null if there is no matching node.</p>
1571 </li></ul></div></div></div><div id="method-nextSibling" class="member inherited"><a href="Ext.button.Cycle.html#method-nextSibling" rel="method-nextSibling" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-nextSibling" class="viewSource">view source</a></div><a name="nextSibling"></a><a name="method-nextSibling"></a><a href="Ext.button.Cycle.html#" rel="method-nextSibling" class="cls expand">nextSibling</a>(
1572 <span class="pre">String selector</span>)
1573  : void</div><div class="description"><div class="short">Returns the next sibling of this Component.
1574
1575
1576 Optionally selects the next sibling which matches the passed ComponentQ...</div><div class="long"><p>Returns the next sibling of this Component.</p>
1577
1578
1579 <p>Optionally selects the next sibling which matches the passed <a href="Ext.ComponentQuery.html" rel="Ext.ComponentQuery" class="docClass">ComponentQuery</a> selector.</p>
1580
1581
1582 <p>May also be refered to as <code><b>next()</b></code></p>
1583
1584
1585 <p>Note that this is limited to siblings, and if no siblings of the item match, <code>null</code> is returned. Contrast with <a href="Ext.button.Cycle.html#nextNode" rel="Ext.button.Cycle#nextNode" class="docClass">nextNode</a></p>
1586
1587 <h3 class="pa">Parameters</h3><ul><li><span class="pre">selector</span> : String<div class="sub-desc"><p>Optional A <a href="Ext.ComponentQuery.html" rel="Ext.ComponentQuery" class="docClass">ComponentQuery</a> selector to filter the following items.</p>
1588 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;<p>The next sibling (or the next sibling which matches the selector). Returns null if there is no matching sibling.</p>
1589 </li></ul></div></div></div><div id="method-observe" class="member inherited"><a href="Ext.button.Cycle.html#method-observe" rel="method-observe" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-observe" class="viewSource">view source</a></div><a name="observe"></a><a name="method-observe"></a><a href="Ext.button.Cycle.html#" rel="method-observe" class="cls expand">observe</a>(
1590 <span class="pre">Function c, Object listeners</span>)
1591  : void</div><div class="description"><div class="short">Sets observability on the passed class constructor.
1592
1593 This makes any event fired on any instance of the passed class a...</div><div class="long"><p>Sets observability on the passed class constructor.</p>
1594
1595 <p>This makes any event fired on any instance of the passed class also fire a single event through
1596 the <strong>class</strong> allowing for central handling of events on many instances at once.</p>
1597
1598 <p>Usage:</p>
1599
1600 <pre><code>Ext.util.Observable.observe(Ext.data.Connection);
1601 Ext.data.Connection.on('beforerequest', function(con, options) {
1602     console.log('Ajax request made to ' + options.url);
1603 });
1604 </code></pre>
1605 <h3 class="pa">Parameters</h3><ul><li><span class="pre">c</span> : Function<div class="sub-desc"><p>The class constructor to make observable.</p>
1606 </div></li><li><span class="pre">listeners</span> : Object<div class="sub-desc"><p>An object containing a series of listeners to add. See <a href="Ext.button.Cycle.html#addListener" rel="Ext.button.Cycle#addListener" class="docClass">addListener</a>.</p>
1607 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1608 </li></ul></div></div></div><div id="method-on" class="member inherited"><a href="Ext.button.Cycle.html#method-on" rel="method-on" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-on" class="viewSource">view source</a></div><a name="on"></a><a name="method-on"></a><a href="Ext.button.Cycle.html#" rel="method-on" class="cls expand">on</a>(
1609 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
1610  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object (shorthand for <a href="Ext.button.Cycle.html#addListener" rel="Ext.button.Cycle#addListener" class="docClass">addListener</a>.)</p>
1611 </div><div class="long"><p>Appends an event handler to this object (shorthand for <a href="Ext.button.Cycle.html#addListener" rel="Ext.button.Cycle#addListener" class="docClass">addListener</a>.)</p>
1612 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event to listen for</p>
1613 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes</p>
1614 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
1615 <b>If omitted, defaults to the object which fired the event.</b></p>
1616 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.</p>
1617 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1618 </li></ul></div></div></div><div id="method-previousNode" class="member inherited"><a href="Ext.button.Cycle.html#method-previousNode" rel="method-previousNode" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-previousNode" class="viewSource">view source</a></div><a name="previousNode"></a><a name="method-previousNode"></a><a href="Ext.button.Cycle.html#" rel="method-previousNode" class="cls expand">previousNode</a>(
1619 <span class="pre">String selector, Object includeSelf</span>)
1620  : void</div><div class="description"><div class="short">Returns the previous node in the Component tree in tree traversal order.
1621
1622
1623 Note that this is not limited to siblings,...</div><div class="long"><p>Returns the previous node in the Component tree in tree traversal order.</p>
1624
1625
1626 <p>Note that this is not limited to siblings, and if invoked upon a node with no matching siblings, will
1627 walk the tree in reverse order to attempt to find a match. Contrast with <a href="Ext.button.Cycle.html#previousSibling" rel="Ext.button.Cycle#previousSibling" class="docClass">previousSibling</a>.</p>
1628
1629 <h3 class="pa">Parameters</h3><ul><li><span class="pre">selector</span> : String<div class="sub-desc"><p>Optional. A <a href="Ext.ComponentQuery.html" rel="Ext.ComponentQuery" class="docClass">ComponentQuery</a> selector to filter the preceding nodes.</p>
1630 </div></li><li><span class="pre">includeSelf</span> : Object<div class="sub-desc">
1631 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;<p>The previous node (or the previous node which matches the selector). Returns null if there is no matching node.</p>
1632 </li></ul></div></div></div><div id="method-previousSibling" class="member inherited"><a href="Ext.button.Cycle.html#method-previousSibling" rel="method-previousSibling" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-previousSibling" class="viewSource">view source</a></div><a name="previousSibling"></a><a name="method-previousSibling"></a><a href="Ext.button.Cycle.html#" rel="method-previousSibling" class="cls expand">previousSibling</a>(
1633 <span class="pre">String selector</span>)
1634  : void</div><div class="description"><div class="short">Returns the previous sibling of this Component.
1635
1636
1637 Optionally selects the previous sibling which matches the passed Co...</div><div class="long"><p>Returns the previous sibling of this Component.</p>
1638
1639
1640 <p>Optionally selects the previous sibling which matches the passed <a href="Ext.ComponentQuery.html" rel="Ext.ComponentQuery" class="docClass">ComponentQuery</a> selector.</p>
1641
1642
1643 <p>May also be refered to as <code><b>prev()</b></code></p>
1644
1645
1646 <p>Note that this is limited to siblings, and if no siblings of the item match, <code>null</code> is returned. Contrast with <a href="Ext.button.Cycle.html#previousNode" rel="Ext.button.Cycle#previousNode" class="docClass">previousNode</a></p>
1647
1648 <h3 class="pa">Parameters</h3><ul><li><span class="pre">selector</span> : String<div class="sub-desc"><p>Optional. A <a href="Ext.ComponentQuery.html" rel="Ext.ComponentQuery" class="docClass">ComponentQuery</a> selector to filter the preceding items.</p>
1649 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;<p>The previous sibling (or the previous sibling which matches the selector). Returns null if there is no matching sibling.</p>
1650 </li></ul></div></div></div><div id="method-relayEvents" class="member inherited"><a href="Ext.button.Cycle.html#method-relayEvents" rel="method-relayEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-relayEvents" class="viewSource">view source</a></div><a name="relayEvents"></a><a name="method-relayEvents"></a><a href="Ext.button.Cycle.html#" rel="method-relayEvents" class="cls expand">relayEvents</a>(
1651 <span class="pre">Object origin, Array events, Object prefix</span>)
1652  : void</div><div class="description"><div class="short"><p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>
1653 </div><div class="long"><p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>
1654 <h3 class="pa">Parameters</h3><ul><li><span class="pre">origin</span> : Object<div class="sub-desc"><p>The Observable whose events this object is to relay.</p>
1655 </div></li><li><span class="pre">events</span> : Array<div class="sub-desc"><p>Array of event names to relay.</p>
1656 </div></li><li><span class="pre">prefix</span> : Object<div class="sub-desc">
1657 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1658 </li></ul></div></div></div><div id="method-releaseCapture" class="member inherited"><a href="Ext.button.Cycle.html#method-releaseCapture" rel="method-releaseCapture" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-releaseCapture" class="viewSource">view source</a></div><a name="releaseCapture"></a><a name="method-releaseCapture"></a><a href="Ext.button.Cycle.html#" rel="method-releaseCapture" class="cls expand">releaseCapture</a>(
1659 <span class="pre">Observable o</span>)
1660  : void</div><div class="description"><div class="short"><p>Removes <b>all</b> added captures from the Observable.</p>
1661 </div><div class="long"><p>Removes <b>all</b> added captures from the Observable.</p>
1662 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to release</p>
1663 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1664 </li></ul></div></div></div><div id="method-removeCls" class="member inherited"><a href="Ext.button.Cycle.html#method-removeCls" rel="method-removeCls" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-removeCls" class="viewSource">view source</a></div><a name="removeCls"></a><a name="method-removeCls"></a><a href="Ext.button.Cycle.html#" rel="method-removeCls" class="cls expand">removeCls</a>(
1665 <span class="pre">Object className</span>)
1666  : Ext.Component</div><div class="description"><div class="short"><p>Removes a CSS class from the top level element representing this component.</p>
1667 </div><div class="long"><p>Removes a CSS class from the top level element representing this component.</p>
1668 <h3 class="pa">Parameters</h3><ul><li><span class="pre">className</span> : Object<div class="sub-desc">
1669 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>Returns the Component to allow method chaining.</p>
1670 </li></ul></div></div></div><div id="method-removeClsWithUI" class="member inherited"><a href="Ext.button.Cycle.html#method-removeClsWithUI" rel="method-removeClsWithUI" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-removeClsWithUI" class="viewSource">view source</a></div><a name="removeClsWithUI"></a><a name="method-removeClsWithUI"></a><a href="Ext.button.Cycle.html#" rel="method-removeClsWithUI" class="cls expand">removeClsWithUI</a>(
1671 <span class="pre">String/Array cls</span>)
1672  : void</div><div class="description"><div class="short">Removes a cls to the uiCls array, which will also call removeUIClsToElement and removes
1673 it from all elements of this ...</div><div class="long"><p>Removes a cls to the uiCls array, which will also call <a href="Ext.button.Cycle.html#removeUIClsToElement" rel="Ext.button.Cycle#removeUIClsToElement" class="docClass">removeUIClsToElement</a> and removes
1674 it from all elements of this component.</p>
1675 <h3 class="pa">Parameters</h3><ul><li><span class="pre">cls</span> : String/Array<div class="sub-desc"><p>A string or an array of strings to remove to the uiCls</p>
1676 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1677 </li></ul></div></div></div><div id="method-removeListener" class="member inherited"><a href="Ext.button.Cycle.html#method-removeListener" rel="method-removeListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-removeListener" class="viewSource">view source</a></div><a name="removeListener"></a><a name="method-removeListener"></a><a href="Ext.button.Cycle.html#" rel="method-removeListener" class="cls expand">removeListener</a>(
1678 <span class="pre">String eventName, Function handler, [Object scope]</span>)
1679  : void</div><div class="description"><div class="short"><p>Removes an event handler.</p>
1680 </div><div class="long"><p>Removes an event handler.</p>
1681 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event the handler was associated with.</p>
1682 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The handler to remove. <b>This must be a reference to the function passed into the <a href="Ext.button.Cycle.html#addListener" rel="Ext.button.Cycle#addListener" class="docClass">addListener</a> call.</b></p>
1683 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
1684 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1685 </li></ul></div></div></div><div id="method-removeManagedListener" class="member inherited"><a href="Ext.button.Cycle.html#method-removeManagedListener" rel="method-removeManagedListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-removeManagedListener" class="viewSource">view source</a></div><a name="removeManagedListener"></a><a name="method-removeManagedListener"></a><a href="Ext.button.Cycle.html#" rel="method-removeManagedListener" class="cls expand">removeManagedListener</a>(
1686 <span class="pre">Observable|Element item, Object|String ename, Function fn, Object scope</span>)
1687  : void</div><div class="description"><div class="short"><p>Removes listeners that were added by the <a href="Ext.button.Cycle.html#mon" rel="Ext.button.Cycle#mon" class="docClass">mon</a> method.</p>
1688 </div><div class="long"><p>Removes listeners that were added by the <a href="Ext.button.Cycle.html#mon" rel="Ext.button.Cycle#mon" class="docClass">mon</a> method.</p>
1689 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Observable|Element<div class="sub-desc"><p>The item from which to remove a listener/listeners.</p>
1690 </div></li><li><span class="pre">ename</span> : Object|String<div class="sub-desc"><p>The event name, or an object containing event name properties.</p>
1691 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
1692 is the handler function.</p>
1693 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
1694 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
1695 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1696 </li></ul></div></div></div><div id="method-resumeEvents" class="member inherited"><a href="Ext.button.Cycle.html#method-resumeEvents" rel="method-resumeEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-resumeEvents" class="viewSource">view source</a></div><a name="resumeEvents"></a><a name="method-resumeEvents"></a><a href="Ext.button.Cycle.html#" rel="method-resumeEvents" class="cls expand">resumeEvents</a> : void</div><div class="description"><div class="short">Resume firing events. (see suspendEvents)
1697 If events were suspended using the queueSuspended parameter, then all
1698 event...</div><div class="long"><p>Resume firing events. (see <a href="Ext.button.Cycle.html#suspendEvents" rel="Ext.button.Cycle#suspendEvents" class="docClass">suspendEvents</a>)
1699 If events were suspended using the <code><b>queueSuspended</b></code> parameter, then all
1700 events fired during event suspension will be sent to any listeners now.</p>
1701 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1702 </li></ul></div></div></div><div id="method-sequenceFx" class="member inherited"><a href="Ext.button.Cycle.html#method-sequenceFx" rel="method-sequenceFx" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Animate.html" class="definedIn docClass">Ext.util.Animate</a><br/><a href="../source/Animate.html#Ext-util.Animate-method-sequenceFx" class="viewSource">view source</a></div><a name="sequenceFx"></a><a name="method-sequenceFx"></a><a href="Ext.button.Cycle.html#" rel="method-sequenceFx" class="cls expand">sequenceFx</a> : Ext.core.Element</div><div class="description"><div class="short">Ensures that all effects queued after sequenceFx is called on this object are
1703 run in sequence.  This is the opposite ...</div><div class="long"><p>Ensures that all effects queued after sequenceFx is called on this object are
1704 run in sequence.  This is the opposite of <a href="Ext.button.Cycle.html#syncFx" rel="Ext.button.Cycle#syncFx" class="docClass">syncFx</a>.</p>
1705 <h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.core.Element</span>&nbsp; &nbsp;<p>The Element</p>
1706 </li></ul></div></div></div><div id="method-setActive" class="member inherited"><a href="Ext.button.Cycle.html#method-setActive" rel="method-setActive" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Floating.html" class="definedIn docClass">Ext.util.Floating</a><br/><a href="../source/Floating.html#Ext-util.Floating-method-setActive" class="viewSource">view source</a></div><a name="setActive"></a><a name="method-setActive"></a><a href="Ext.button.Cycle.html#" rel="method-setActive" class="cls expand">setActive</a>(
1707 <span class="pre">Boolean active, Component newActive</span>)
1708  : void</div><div class="description"><div class="short">This method is called internally by Ext.ZIndexManager to signal that a floating
1709 Component has either been moved to th...</div><div class="long"><p>This method is called internally by <a href="Ext.ZIndexManager.html" rel="Ext.ZIndexManager" class="docClass">Ext.ZIndexManager</a> to signal that a floating
1710 Component has either been moved to the top of its zIndex stack, or pushed from the top of its zIndex stack.</p>
1711
1712
1713 <p>If a <i>Window</i> is superceded by another Window, deactivating it hides its shadow.</p>
1714
1715
1716 <p>This method also fires the <a href="Ext.button.Cycle.html#activate" rel="Ext.button.Cycle#activate" class="docClass">activate</a> or <a href="Ext.button.Cycle.html#deactivate" rel="Ext.button.Cycle#deactivate" class="docClass">deactivate</a> event depending on which action occurred.</p>
1717
1718 <h3 class="pa">Parameters</h3><ul><li><span class="pre">active</span> : Boolean<div class="sub-desc"><p>True to activate the Component, false to deactivate it (defaults to false)</p>
1719 </div></li><li><span class="pre">newActive</span> : Component<div class="sub-desc"><p>The newly active Component which is taking over topmost zIndex position.</p>
1720 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1721 </li></ul></div></div></div><div id="method-setActiveItem" class="member ni"><a href="Ext.button.Cycle.html#method-setActiveItem" rel="method-setActiveItem" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Cycle.html" class="definedIn docClass">Ext.button.Cycle</a><br/><a href="../source/Cycle.html#Ext-button.Cycle-method-setActiveItem" class="viewSource">view source</a></div><a name="setActiveItem"></a><a name="method-setActiveItem"></a><a href="Ext.button.Cycle.html#" rel="method-setActiveItem" class="cls expand">setActiveItem</a>(
1722 <span class="pre">Ext.menu.CheckItem item, Boolean suppressEvent</span>)
1723  : void</div><div class="description"><div class="short"><p>Sets the button's active menu item.</p>
1724 </div><div class="long"><p>Sets the button's active menu item.</p>
1725 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Ext.menu.CheckItem<div class="sub-desc"><p>The item to activate</p>
1726 </div></li><li><span class="pre">suppressEvent</span> : Boolean<div class="sub-desc"><p>True to prevent the button's change event from firing (defaults to false)</p>
1727 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1728 </li></ul></div></div></div><div id="method-setArrowHandler" class="member inherited"><a href="Ext.button.Cycle.html#method-setArrowHandler" rel="method-setArrowHandler" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Split.html" class="definedIn docClass">Ext.button.Split</a><br/><a href="../source/Split.html#Ext-button.Split-method-setArrowHandler" class="viewSource">view source</a></div><a name="setArrowHandler"></a><a name="method-setArrowHandler"></a><a href="Ext.button.Cycle.html#" rel="method-setArrowHandler" class="cls expand">setArrowHandler</a>(
1729 <span class="pre">Function handler, [Object scope]</span>)
1730  : void</div><div class="description"><div class="short"><p>Sets this button's arrow click handler.</p>
1731 </div><div class="long"><p>Sets this button's arrow click handler.</p>
1732 <h3 class="pa">Parameters</h3><ul><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The function to call when the arrow is clicked</p>
1733 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) Scope for the function passed above</p>
1734 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1735 </li></ul></div></div></div><div id="method-setAutoScroll" class="member inherited"><a href="Ext.button.Cycle.html#method-setAutoScroll" rel="method-setAutoScroll" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-setAutoScroll" class="viewSource">view source</a></div><a name="setAutoScroll"></a><a name="method-setAutoScroll"></a><a href="Ext.button.Cycle.html#" rel="method-setAutoScroll" class="cls expand">setAutoScroll</a>(
1736 <span class="pre">Boolean scroll</span>)
1737  : Ext.Component</div><div class="description"><div class="short"><p>Sets the overflow on the content element of the component.</p>
1738 </div><div class="long"><p>Sets the overflow on the content element of the component.</p>
1739 <h3 class="pa">Parameters</h3><ul><li><span class="pre">scroll</span> : Boolean<div class="sub-desc"><p>True to allow the Component to auto scroll.</p>
1740 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>this</p>
1741 </li></ul></div></div></div><div id="method-setDisabled" class="member inherited"><a href="Ext.button.Cycle.html#method-setDisabled" rel="method-setDisabled" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-setDisabled" class="viewSource">view source</a></div><a name="setDisabled"></a><a name="method-setDisabled"></a><a href="Ext.button.Cycle.html#" rel="method-setDisabled" class="cls expand">setDisabled</a>(
1742 <span class="pre">Boolean disabled</span>)
1743  : void</div><div class="description"><div class="short"><p>Enable or disable the component.</p>
1744 </div><div class="long"><p>Enable or disable the component.</p>
1745 <h3 class="pa">Parameters</h3><ul><li><span class="pre">disabled</span> : Boolean<div class="sub-desc">
1746 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1747 </li></ul></div></div></div><div id="method-setDocked" class="member inherited"><a href="Ext.button.Cycle.html#method-setDocked" rel="method-setDocked" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-setDocked" class="viewSource">view source</a></div><a name="setDocked"></a><a name="method-setDocked"></a><a href="Ext.button.Cycle.html#" rel="method-setDocked" class="cls expand">setDocked</a>(
1748 <span class="pre">Object dock, Object layoutParent</span>)
1749  : Component</div><div class="description"><div class="short">Sets the dock position of this component in its parent panel. Note that
1750 this only has effect if this item is part of ...</div><div class="long"><p>Sets the dock position of this component in its parent panel. Note that
1751 this only has effect if this item is part of the dockedItems collection
1752 of a parent that has a DockLayout (note that any Panel has a DockLayout
1753 by default)</p>
1754 <h3 class="pa">Parameters</h3><ul><li><span class="pre">dock</span> : Object<div class="sub-desc">
1755 </div></li><li><span class="pre">layoutParent</span> : Object<div class="sub-desc">
1756 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Component</span>&nbsp; &nbsp;<p>this</p>
1757 </li></ul></div></div></div><div id="method-setHandler" class="member inherited"><a href="Ext.button.Cycle.html#method-setHandler" rel="method-setHandler" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-method-setHandler" class="viewSource">view source</a></div><a name="setHandler"></a><a name="method-setHandler"></a><a href="Ext.button.Cycle.html#" rel="method-setHandler" class="cls expand">setHandler</a>(
1758 <span class="pre">Function handler, [Object scope]</span>)
1759  : Ext.button.Button</div><div class="description"><div class="short"><p>Assigns this Button's click handler</p>
1760 </div><div class="long"><p>Assigns this Button's click handler</p>
1761 <h3 class="pa">Parameters</h3><ul><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The function to call when the button is clicked</p>
1762 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code>this</code> reference) in which the handler function is executed.
1763 Defaults to this Button.</p>
1764 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.button.Button</span>&nbsp; &nbsp;<p>this</p>
1765 </li></ul></div></div></div><div id="method-setHeight" class="member inherited"><a href="Ext.button.Cycle.html#method-setHeight" rel="method-setHeight" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-setHeight" class="viewSource">view source</a></div><a name="setHeight"></a><a name="method-setHeight"></a><a href="Ext.button.Cycle.html#" rel="method-setHeight" class="cls expand">setHeight</a>(
1766 <span class="pre">Number height</span>)
1767  : Ext.Component</div><div class="description"><div class="short"><p>Sets the height of the component.  This method fires the <a href="Ext.button.Cycle.html#resize" rel="Ext.button.Cycle#resize" class="docClass">resize</a> event.</p>
1768 </div><div class="long"><p>Sets the height of the component.  This method fires the <a href="Ext.button.Cycle.html#resize" rel="Ext.button.Cycle#resize" class="docClass">resize</a> event.</p>
1769 <h3 class="pa">Parameters</h3><ul><li><span class="pre">height</span> : Number<div class="sub-desc"><p>The new height to set. This may be one of:<div class="mdetail-params"><ul>
1770 <li>A Number specifying the new height in the <a href="Ext.button.Cycle.html#getEl" rel="Ext.button.Cycle#getEl" class="docClass">Element</a>'s <a href="Ext.core.Element.html#defaultUnit" rel="Ext.core.Element#defaultUnit" class="docClass">Ext.core.Element.defaultUnit</a>s (by default, pixels).</li>
1771 <li>A String used to set the CSS height style.</li>
1772 <li><i>undefined</i> to leave the height unchanged.</li>
1773 </ul></div></p>
1774 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>this</p>
1775 </li></ul></div></div></div><div id="method-setIcon" class="member inherited"><a href="Ext.button.Cycle.html#method-setIcon" rel="method-setIcon" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-method-setIcon" class="viewSource">view source</a></div><a name="setIcon"></a><a name="method-setIcon"></a><a href="Ext.button.Cycle.html#" rel="method-setIcon" class="cls expand">setIcon</a>(
1776 <span class="pre">String icon</span>)
1777  : Ext.button.Button</div><div class="description"><div class="short">Sets the background image (inline style) of the button.  This method also changes
1778 the value of the icon config intern...</div><div class="long"><p>Sets the background image (inline style) of the button.  This method also changes
1779 the value of the <a href="Ext.button.Cycle.html#icon" rel="Ext.button.Cycle#icon" class="docClass">icon</a> config internally.</p>
1780 <h3 class="pa">Parameters</h3><ul><li><span class="pre">icon</span> : String<div class="sub-desc"><p>The path to an image to display in the button</p>
1781 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.button.Button</span>&nbsp; &nbsp;<p>this</p>
1782 </li></ul></div></div></div><div id="method-setIconCls" class="member inherited"><a href="Ext.button.Cycle.html#method-setIconCls" rel="method-setIconCls" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-method-setIconCls" class="viewSource">view source</a></div><a name="setIconCls"></a><a name="method-setIconCls"></a><a href="Ext.button.Cycle.html#" rel="method-setIconCls" class="cls expand">setIconCls</a>(
1783 <span class="pre">String cls</span>)
1784  : Ext.button.Button</div><div class="description"><div class="short">Sets the CSS class that provides a background image to use as the button's icon.  This method also changes
1785 the value ...</div><div class="long"><p>Sets the CSS class that provides a background image to use as the button's icon.  This method also changes
1786 the value of the <a href="Ext.button.Cycle.html#iconCls" rel="Ext.button.Cycle#iconCls" class="docClass">iconCls</a> config internally.</p>
1787 <h3 class="pa">Parameters</h3><ul><li><span class="pre">cls</span> : String<div class="sub-desc"><p>The CSS class providing the icon image</p>
1788 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.button.Button</span>&nbsp; &nbsp;<p>this</p>
1789 </li></ul></div></div></div><div id="method-setLoading" class="member inherited"><a href="Ext.button.Cycle.html#method-setLoading" rel="method-setLoading" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-setLoading" class="viewSource">view source</a></div><a name="setLoading"></a><a name="method-setLoading"></a><a href="Ext.button.Cycle.html#" rel="method-setLoading" class="cls expand">setLoading</a>(
1790 <span class="pre">Boolean/Object/String load, Boolean targetEl</span>)
1791  : Ext.LoadMask</div><div class="description"><div class="short"><p>This method allows you to show or hide a LoadMask on top of this component.</p>
1792 </div><div class="long"><p>This method allows you to show or hide a LoadMask on top of this component.</p>
1793 <h3 class="pa">Parameters</h3><ul><li><span class="pre">load</span> : Boolean/Object/String<div class="sub-desc"><p>True to show the default LoadMask, a config object
1794 that will be passed to the LoadMask constructor, or a message String to show. False to
1795 hide the current LoadMask.</p>
1796 </div></li><li><span class="pre">targetEl</span> : Boolean<div class="sub-desc"><p>True to mask the targetEl of this Component instead of the this.el.
1797 For example, setting this to true on a Panel will cause only the body to be masked. (defaults to false)</p>
1798 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.LoadMask</span>&nbsp; &nbsp;<p>The LoadMask instance that has just been shown.</p>
1799 </li></ul></div></div></div><div id="method-setPagePosition" class="member inherited"><a href="Ext.button.Cycle.html#method-setPagePosition" rel="method-setPagePosition" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-setPagePosition" class="viewSource">view source</a></div><a name="setPagePosition"></a><a name="method-setPagePosition"></a><a href="Ext.button.Cycle.html#" rel="method-setPagePosition" class="cls expand">setPagePosition</a>(
1800 <span class="pre">Number x, Number y, Mixed animate</span>)
1801  : Ext.Component</div><div class="description"><div class="short">Sets the page XY position of the component.  To set the left and top instead, use setPosition.
1802 This method fires the ...</div><div class="long"><p>Sets the page XY position of the component.  To set the left and top instead, use <a href="Ext.button.Cycle.html#setPosition" rel="Ext.button.Cycle#setPosition" class="docClass">setPosition</a>.
1803 This method fires the <a href="Ext.button.Cycle.html#move" rel="Ext.button.Cycle#move" class="docClass">move</a> event.</p>
1804 <h3 class="pa">Parameters</h3><ul><li><span class="pre">x</span> : Number<div class="sub-desc"><p>The new x position</p>
1805 </div></li><li><span class="pre">y</span> : Number<div class="sub-desc"><p>The new y position</p>
1806 </div></li><li><span class="pre">animate</span> : Mixed<div class="sub-desc"><p>If passed, the Component is <i>animated</i> into its new position. If this parameter
1807 is a number, it is used as the animation duration in milliseconds.</p>
1808 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>this</p>
1809 </li></ul></div></div></div><div id="method-setParams" class="member inherited"><a href="Ext.button.Cycle.html#method-setParams" rel="method-setParams" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-method-setParams" class="viewSource">view source</a></div><a name="setParams"></a><a name="method-setParams"></a><a href="Ext.button.Cycle.html#" rel="method-setParams" class="cls expand">setParams</a>(
1810 <span class="pre">Object Parameters</span>)
1811  : void</div><div class="description"><div class="short">Only valid if the Button was originally configured with a url
1812
1813
1814 Sets the href of the link dynamically according to th...</div><div class="long"><p><b>Only valid if the Button was originally configured with a <a href="Ext.button.Cycle.html#url" rel="Ext.button.Cycle#url" class="docClass">url</a></b></p>
1815
1816
1817 <p>Sets the href of the link dynamically according to the params passed, and any <a href="Ext.button.Cycle.html#baseParams" rel="Ext.button.Cycle#baseParams" class="docClass">baseParams</a> configured.</p>
1818
1819 <h3 class="pa">Parameters</h3><ul><li><span class="pre">Parameters</span> : Object<div class="sub-desc"><p>to use in the href URL.</p>
1820 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1821 </li></ul></div></div></div><div id="method-setPosition" class="member inherited"><a href="Ext.button.Cycle.html#method-setPosition" rel="method-setPosition" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-setPosition" class="viewSource">view source</a></div><a name="setPosition"></a><a name="method-setPosition"></a><a href="Ext.button.Cycle.html#" rel="method-setPosition" class="cls expand">setPosition</a>(
1822 <span class="pre">Number left, Number top, Mixed animate</span>)
1823  : Ext.Component</div><div class="description"><div class="short">Sets the left and top of the component.  To set the page XY position instead, use setPagePosition.
1824 This method fires ...</div><div class="long"><p>Sets the left and top of the component.  To set the page XY position instead, use <a href="Ext.button.Cycle.html#setPagePosition" rel="Ext.button.Cycle#setPagePosition" class="docClass">setPagePosition</a>.
1825 This method fires the <a href="Ext.button.Cycle.html#move" rel="Ext.button.Cycle#move" class="docClass">move</a> event.</p>
1826 <h3 class="pa">Parameters</h3><ul><li><span class="pre">left</span> : Number<div class="sub-desc"><p>The new left</p>
1827 </div></li><li><span class="pre">top</span> : Number<div class="sub-desc"><p>The new top</p>
1828 </div></li><li><span class="pre">animate</span> : Mixed<div class="sub-desc"><p>If true, the Component is <i>animated</i> into its new position. You may also pass an animation configuration.</p>
1829 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>this</p>
1830 </li></ul></div></div></div><div id="method-setScale" class="member inherited"><a href="Ext.button.Cycle.html#method-setScale" rel="method-setScale" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-method-setScale" class="viewSource">view source</a></div><a name="setScale"></a><a name="method-setScale"></a><a href="Ext.button.Cycle.html#" rel="method-setScale" class="cls expand">setScale</a>(
1831 <span class="pre">String scale</span>)
1832  : void</div><div class="description"><div class="short"><p>Method to change the scale of the button. See <a href="Ext.button.Cycle.html#scale" rel="Ext.button.Cycle#scale" class="docClass">scale</a> for allowed configurations.</p>
1833 </div><div class="long"><p>Method to change the scale of the button. See <a href="Ext.button.Cycle.html#scale" rel="Ext.button.Cycle#scale" class="docClass">scale</a> for allowed configurations.</p>
1834 <h3 class="pa">Parameters</h3><ul><li><span class="pre">scale</span> : String<div class="sub-desc"><p>The scale to change to.</p>
1835 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1836 </li></ul></div></div></div><div id="method-setSize" class="member inherited"><a href="Ext.button.Cycle.html#method-setSize" rel="method-setSize" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-setSize" class="viewSource">view source</a></div><a name="setSize"></a><a name="method-setSize"></a><a href="Ext.button.Cycle.html#" rel="method-setSize" class="cls expand">setSize</a>(
1837 <span class="pre">Mixed width, Mixed height</span>)
1838  : Ext.Component</div><div class="description"><div class="short">Sets the width and height of this Component. This method fires the resize event. This method can accept
1839 either width ...</div><div class="long"><p>Sets the width and height of this Component. This method fires the <a href="Ext.button.Cycle.html#resize" rel="Ext.button.Cycle#resize" class="docClass">resize</a> event. This method can accept
1840 either width and height as separate arguments, or you can pass a size object like <code>{width:10, height:20}</code>.</p>
1841 <h3 class="pa">Parameters</h3><ul><li><span class="pre">width</span> : Mixed<div class="sub-desc"><p>The new width to set. This may be one of:<div class="mdetail-params"><ul>
1842 <li>A Number specifying the new width in the <a href="Ext.button.Cycle.html#getEl" rel="Ext.button.Cycle#getEl" class="docClass">Element</a>'s <a href="Ext.core.Element.html#defaultUnit" rel="Ext.core.Element#defaultUnit" class="docClass">Ext.core.Element.defaultUnit</a>s (by default, pixels).</li>
1843 <li>A String used to set the CSS width style.</li>
1844 <li>A size object in the format <code>{width: widthValue, height: heightValue}</code>.</li>
1845 <li><code>undefined</code> to leave the width unchanged.</li>
1846 </ul></div></p>
1847 </div></li><li><span class="pre">height</span> : Mixed<div class="sub-desc"><p>The new height to set (not required if a size object is passed as the first arg).
1848 This may be one of:<div class="mdetail-params"><ul>
1849 <li>A Number specifying the new height in the <a href="Ext.button.Cycle.html#getEl" rel="Ext.button.Cycle#getEl" class="docClass">Element</a>'s <a href="Ext.core.Element.html#defaultUnit" rel="Ext.core.Element#defaultUnit" class="docClass">Ext.core.Element.defaultUnit</a>s (by default, pixels).</li>
1850 <li>A String used to set the CSS height style. Animation may <b>not</b> be used.</li>
1851 <li><code>undefined</code> to leave the height unchanged.</li>
1852 </ul></div></p>
1853 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>this</p>
1854 </li></ul></div></div></div><div id="method-setText" class="member inherited"><a href="Ext.button.Cycle.html#method-setText" rel="method-setText" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-method-setText" class="viewSource">view source</a></div><a name="setText"></a><a name="method-setText"></a><a href="Ext.button.Cycle.html#" rel="method-setText" class="cls expand">setText</a>(
1855 <span class="pre">String text</span>)
1856  : Ext.button.Button</div><div class="description"><div class="short"><p>Sets this Button's text</p>
1857 </div><div class="long"><p>Sets this Button's text</p>
1858 <h3 class="pa">Parameters</h3><ul><li><span class="pre">text</span> : String<div class="sub-desc"><p>The button text</p>
1859 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.button.Button</span>&nbsp; &nbsp;<p>this</p>
1860 </li></ul></div></div></div><div id="method-setTooltip" class="member inherited"><a href="Ext.button.Cycle.html#method-setTooltip" rel="method-setTooltip" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-method-setTooltip" class="viewSource">view source</a></div><a name="setTooltip"></a><a name="method-setTooltip"></a><a href="Ext.button.Cycle.html#" rel="method-setTooltip" class="cls expand">setTooltip</a>(
1861 <span class="pre">String/Object tooltip, Object initial</span>)
1862  : Ext.button.Button</div><div class="description"><div class="short"><p>Sets the tooltip for this Button.</p>
1863 </div><div class="long"><p>Sets the tooltip for this Button.</p>
1864 <h3 class="pa">Parameters</h3><ul><li><span class="pre">tooltip</span> : String/Object<div class="sub-desc"><p>. This may be:<div class="mdesc-details"><ul>
1865 <li><b>String</b> : A string to be used as innerHTML (html tags are accepted) to show in a tooltip</li>
1866 <li><b>Object</b> : A configuration object for <a href="Ext.tip.QuickTipManager.html#register" rel="Ext.tip.QuickTipManager#register" class="docClass">Ext.tip.QuickTipManager.register</a>.</li>
1867 </ul></div></p>
1868 </div></li><li><span class="pre">initial</span> : Object<div class="sub-desc">
1869 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.button.Button</span>&nbsp; &nbsp;<p>this</p>
1870 </li></ul></div></div></div><div id="method-setUI" class="member inherited"><a href="Ext.button.Cycle.html#method-setUI" rel="method-setUI" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-setUI" class="viewSource">view source</a></div><a name="setUI"></a><a name="method-setUI"></a><a href="Ext.button.Cycle.html#" rel="method-setUI" class="cls expand">setUI</a>(
1871 <span class="pre">String ui</span>)
1872  : void</div><div class="description"><div class="short">Sets the UI for the component. This will remove any existing UIs on the component. It will also
1873 loop through any uiCl...</div><div class="long"><p>Sets the UI for the component. This will remove any existing UIs on the component. It will also
1874 loop through any uiCls set on the component and rename them so they include the new UI</p>
1875 <h3 class="pa">Parameters</h3><ul><li><span class="pre">ui</span> : String<div class="sub-desc"><p>The new UI for the component</p>
1876 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1877 </li></ul></div></div></div><div id="method-setVisible" class="member inherited"><a href="Ext.button.Cycle.html#method-setVisible" rel="method-setVisible" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-setVisible" class="viewSource">view source</a></div><a name="setVisible"></a><a name="method-setVisible"></a><a href="Ext.button.Cycle.html#" rel="method-setVisible" class="cls expand">setVisible</a>(
1878 <span class="pre">Boolean visible</span>)
1879  : Ext.Component</div><div class="description"><div class="short"><p>Convenience function to hide or show this component by boolean.</p>
1880 </div><div class="long"><p>Convenience function to hide or show this component by boolean.</p>
1881 <h3 class="pa">Parameters</h3><ul><li><span class="pre">visible</span> : Boolean<div class="sub-desc"><p>True to show, false to hide</p>
1882 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>this</p>
1883 </li></ul></div></div></div><div id="method-setWidth" class="member inherited"><a href="Ext.button.Cycle.html#method-setWidth" rel="method-setWidth" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-setWidth" class="viewSource">view source</a></div><a name="setWidth"></a><a name="method-setWidth"></a><a href="Ext.button.Cycle.html#" rel="method-setWidth" class="cls expand">setWidth</a>(
1884 <span class="pre">Number width</span>)
1885  : Ext.Component</div><div class="description"><div class="short"><p>Sets the width of the component.  This method fires the <a href="Ext.button.Cycle.html#resize" rel="Ext.button.Cycle#resize" class="docClass">resize</a> event.</p>
1886 </div><div class="long"><p>Sets the width of the component.  This method fires the <a href="Ext.button.Cycle.html#resize" rel="Ext.button.Cycle#resize" class="docClass">resize</a> event.</p>
1887 <h3 class="pa">Parameters</h3><ul><li><span class="pre">width</span> : Number<div class="sub-desc"><p>The new width to setThis may be one of:<div class="mdetail-params"><ul>
1888 <li>A Number specifying the new width in the <a href="Ext.button.Cycle.html#getEl" rel="Ext.button.Cycle#getEl" class="docClass">Element</a>'s <a href="Ext.core.Element.html#defaultUnit" rel="Ext.core.Element#defaultUnit" class="docClass">Ext.core.Element.defaultUnit</a>s (by default, pixels).</li>
1889 <li>A String used to set the CSS width style.</li>
1890 </ul></div></p>
1891 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>this</p>
1892 </li></ul></div></div></div><div id="method-show" class="member inherited"><a href="Ext.button.Cycle.html#method-show" rel="method-show" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-show" class="viewSource">view source</a></div><a name="show"></a><a name="method-show"></a><a href="Ext.button.Cycle.html#" rel="method-show" class="cls expand">show</a>(
1893 <span class="pre">String/Element animateTarget, [Function callback], [Object scope]</span>)
1894  : Component</div><div class="description"><div class="short">Shows this Component, rendering it first if autoRender or {&quot;floating are true.
1895
1896
1897 After being shown, a floating C...</div><div class="long"><p>Shows this Component, rendering it first if <a href="Ext.button.Cycle.html#autoRender" rel="Ext.button.Cycle#autoRender" class="docClass">autoRender</a> or {<a href="Ext.button.Cycle.html"floating" rel=""floating" class="docClass">&quot;floating</a> are <code>true</code>.</p>
1898
1899
1900 <p>After being shown, a <a href="Ext.button.Cycle.html#floating" rel="Ext.button.Cycle#floating" class="docClass">floating</a> Component (such as a <a href="Ext.window.Window.html" rel="Ext.window.Window" class="docClass">Ext.window.Window</a>), is activated it and brought to the front of
1901 its <a href="Ext.button.Cycle.html#ZIndexManager" rel="Ext.button.Cycle#ZIndexManager" class="docClass">z-index stack</a>.</p>
1902
1903 <h3 class="pa">Parameters</h3><ul><li><span class="pre">animateTarget</span> : String/Element<div class="sub-desc"><p>Optional, and <b>only valid for <a href="Ext.button.Cycle.html#floating" rel="Ext.button.Cycle#floating" class="docClass">floating</a> Components such as
1904 <a href="Ext.window.Window.html" rel="Ext.window.Window" class="docClass">Window</a>s or <a href="Ext.tip.ToolTip.html" rel="Ext.tip.ToolTip" class="docClass">ToolTip</a>s, or regular Components which have been configured
1905 with <code>floating: true</code>.</b> The target from which the Component should
1906 animate from while opening (defaults to null with no animation)</p>
1907 </div></li><li><span class="pre">callback</span> : Function<div class="sub-desc"><p>(optional) A callback function to call after the Component is displayed. Only necessary if animation was specified.</p>
1908 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code>this</code> reference) in which the callback is executed. Defaults to this Component.</p>
1909 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Component</span>&nbsp; &nbsp;<p>this</p>
1910 </li></ul></div></div></div><div id="method-showMenu" class="member inherited"><a href="Ext.button.Cycle.html#method-showMenu" rel="method-showMenu" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-method-showMenu" class="viewSource">view source</a></div><a name="showMenu"></a><a name="method-showMenu"></a><a href="Ext.button.Cycle.html#" rel="method-showMenu" class="cls expand">showMenu</a> : void</div><div class="description"><div class="short"><p>Show this button's menu (if it has one)</p>
1911 </div><div class="long"><p>Show this button's menu (if it has one)</p>
1912 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1913 </li></ul></div></div></div><div id="method-stopAnimation" class="member inherited"><a href="Ext.button.Cycle.html#method-stopAnimation" rel="method-stopAnimation" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Animate.html" class="definedIn docClass">Ext.util.Animate</a><br/><a href="../source/Animate.html#Ext-util.Animate-method-stopAnimation" class="viewSource">view source</a></div><a name="stopAnimation"></a><a name="method-stopAnimation"></a><a href="Ext.button.Cycle.html#" rel="method-stopAnimation" class="cls expand">stopAnimation</a> : Ext.core.Element</div><div class="description"><div class="short">@deprecated 4.0 Replaced by stopAnimation
1914 Stops any running effects and clears this object's internal effects queue i...</div><div class="long"><p>@deprecated 4.0 Replaced by <a href="Ext.button.Cycle.html#stopAnimation" rel="Ext.button.Cycle#stopAnimation" class="docClass">stopAnimation</a>
1915 Stops any running effects and clears this object's internal effects queue if it contains
1916 any additional effects that haven't started yet.</p>
1917 <h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.core.Element</span>&nbsp; &nbsp;<p>The Element</p>
1918 </li></ul></div></div></div><div id="method-suspendEvents" class="member inherited"><a href="Ext.button.Cycle.html#method-suspendEvents" rel="method-suspendEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-suspendEvents" class="viewSource">view source</a></div><a name="suspendEvents"></a><a name="method-suspendEvents"></a><a href="Ext.button.Cycle.html#" rel="method-suspendEvents" class="cls expand">suspendEvents</a>(
1919 <span class="pre">Boolean queueSuspended</span>)
1920  : void</div><div class="description"><div class="short"><p>Suspend the firing of all events. (see <a href="Ext.button.Cycle.html#resumeEvents" rel="Ext.button.Cycle#resumeEvents" class="docClass">resumeEvents</a>)</p>
1921 </div><div class="long"><p>Suspend the firing of all events. (see <a href="Ext.button.Cycle.html#resumeEvents" rel="Ext.button.Cycle#resumeEvents" class="docClass">resumeEvents</a>)</p>
1922 <h3 class="pa">Parameters</h3><ul><li><span class="pre">queueSuspended</span> : Boolean<div class="sub-desc"><p>Pass as true to queue up suspended events to be fired
1923 after the <a href="Ext.button.Cycle.html#resumeEvents" rel="Ext.button.Cycle#resumeEvents" class="docClass">resumeEvents</a> call instead of discarding all suspended events;</p>
1924 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1925 </li></ul></div></div></div><div id="method-syncFx" class="member inherited"><a href="Ext.button.Cycle.html#method-syncFx" rel="method-syncFx" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Animate.html" class="definedIn docClass">Ext.util.Animate</a><br/><a href="../source/Animate.html#Ext-util.Animate-method-syncFx" class="viewSource">view source</a></div><a name="syncFx"></a><a name="method-syncFx"></a><a href="Ext.button.Cycle.html#" rel="method-syncFx" class="cls expand">syncFx</a> : Ext.core.Element</div><div class="description"><div class="short">Ensures that all effects queued after syncFx is called on this object are
1926 run concurrently.  This is the opposite of ...</div><div class="long"><p>Ensures that all effects queued after syncFx is called on this object are
1927 run concurrently.  This is the opposite of <a href="Ext.button.Cycle.html#sequenceFx" rel="Ext.button.Cycle#sequenceFx" class="docClass">sequenceFx</a>.</p>
1928 <h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.core.Element</span>&nbsp; &nbsp;<p>The Element</p>
1929 </li></ul></div></div></div><div id="method-toBack" class="member inherited"><a href="Ext.button.Cycle.html#method-toBack" rel="method-toBack" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Floating.html" class="definedIn docClass">Ext.util.Floating</a><br/><a href="../source/Floating.html#Ext-util.Floating-method-toBack" class="viewSource">view source</a></div><a name="toBack"></a><a name="method-toBack"></a><a href="Ext.button.Cycle.html#" rel="method-toBack" class="cls expand">toBack</a> : Component</div><div class="description"><div class="short"><p>Sends this Component to the back of (lower z-index than) any other visible windows</p>
1930 </div><div class="long"><p>Sends this Component to the back of (lower z-index than) any other visible windows</p>
1931 <h3 class="pa">Returns</h3><ul><li><span class="pre">Component</span>&nbsp; &nbsp;<p>this</p>
1932 </li></ul></div></div></div><div id="method-toFront" class="member inherited"><a href="Ext.button.Cycle.html#method-toFront" rel="method-toFront" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Floating.html" class="definedIn docClass">Ext.util.Floating</a><br/><a href="../source/Floating.html#Ext-util.Floating-method-toFront" class="viewSource">view source</a></div><a name="toFront"></a><a name="method-toFront"></a><a href="Ext.button.Cycle.html#" rel="method-toFront" class="cls expand">toFront</a>(
1933 <span class="pre">[Boolean preventFocus]</span>)
1934  : Component</div><div class="description"><div class="short">Brings this floating Component to the front of any other visible, floating Components managed by the same ZIndexManag...</div><div class="long"><p>Brings this floating Component to the front of any other visible, floating Components managed by the same <a href="Ext.ZIndexManager.html" rel="Ext.ZIndexManager" class="docClass">ZIndexManager</a></p>
1935
1936
1937 <p>If this Component is modal, inserts the modal mask just below this Component in the z-index stack.</p>
1938
1939 <h3 class="pa">Parameters</h3><ul><li><span class="pre">preventFocus</span> : Boolean<div class="sub-desc"><p>(optional) Specify <code>true</code> to prevent the Component from being focused.</p>
1940 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Component</span>&nbsp; &nbsp;<p>this</p>
1941 </li></ul></div></div></div><div id="method-toggle" class="member inherited"><a href="Ext.button.Cycle.html#method-toggle" rel="method-toggle" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-method-toggle" class="viewSource">view source</a></div><a name="toggle"></a><a name="method-toggle"></a><a href="Ext.button.Cycle.html#" rel="method-toggle" class="cls expand">toggle</a>(
1942 <span class="pre">[Boolean state], [Boolean supressEvent]</span>)
1943  : Ext.button.Button</div><div class="description"><div class="short"><p>If a state it passed, it becomes the pressed state otherwise the current state is toggled.</p>
1944 </div><div class="long"><p>If a state it passed, it becomes the pressed state otherwise the current state is toggled.</p>
1945 <h3 class="pa">Parameters</h3><ul><li><span class="pre">state</span> : Boolean<div class="sub-desc"><p>(optional) Force a particular state</p>
1946 </div></li><li><span class="pre">supressEvent</span> : Boolean<div class="sub-desc"><p>(optional) True to stop events being fired when calling this method.</p>
1947 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.button.Button</span>&nbsp; &nbsp;<p>this</p>
1948 </li></ul></div></div></div><div id="method-toggleSelected" class="member ni"><a href="Ext.button.Cycle.html#method-toggleSelected" rel="method-toggleSelected" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Cycle.html" class="definedIn docClass">Ext.button.Cycle</a><br/><a href="../source/Cycle.html#Ext-button.Cycle-method-toggleSelected" class="viewSource">view source</a></div><a name="toggleSelected"></a><a name="method-toggleSelected"></a><a href="Ext.button.Cycle.html#" rel="method-toggleSelected" class="cls expand">toggleSelected</a> : void</div><div class="description"><div class="short">This is normally called internally on button click, but can be called externally to advance the button's
1949 active item ...</div><div class="long"><p>This is normally called internally on button click, but can be called externally to advance the button's
1950 active item programmatically to the next one in the menu.  If the current item is the last one in the menu
1951 the active item will be set to the first item in the menu.</p>
1952 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1953 </li></ul></div></div></div><div id="method-un" class="member inherited"><a href="Ext.button.Cycle.html#method-un" rel="method-un" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-un" class="viewSource">view source</a></div><a name="un"></a><a name="method-un"></a><a href="Ext.button.Cycle.html#" rel="method-un" class="cls expand">un</a>(
1954 <span class="pre">String eventName, Function handler, [Object scope]</span>)
1955  : void</div><div class="description"><div class="short"><p>Removes an event handler (shorthand for <a href="Ext.button.Cycle.html#removeListener" rel="Ext.button.Cycle#removeListener" class="docClass">removeListener</a>.)</p>
1956 </div><div class="long"><p>Removes an event handler (shorthand for <a href="Ext.button.Cycle.html#removeListener" rel="Ext.button.Cycle#removeListener" class="docClass">removeListener</a>.)</p>
1957 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event the handler was associated with.</p>
1958 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The handler to remove. <b>This must be a reference to the function passed into the <a href="Ext.button.Cycle.html#addListener" rel="Ext.button.Cycle#addListener" class="docClass">addListener</a> call.</b></p>
1959 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
1960 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1961 </li></ul></div></div></div><div id="method-up" class="member inherited"><a href="Ext.button.Cycle.html#method-up" rel="method-up" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-up" class="viewSource">view source</a></div><a name="up"></a><a name="method-up"></a><a href="Ext.button.Cycle.html#" rel="method-up" class="cls expand">up</a>(
1962 <span class="pre">String selector</span>)
1963  : Container</div><div class="description"><div class="short">Walks up the ownerCt axis looking for an ancestor Container which matches
1964 the passed simple selector.
1965
1966
1967 Example:
1968 var ...</div><div class="long"><p>Walks up the <code>ownerCt</code> axis looking for an ancestor Container which matches
1969 the passed simple selector.</p>
1970
1971
1972 <p>Example:
1973 <pre><code>var owningTabPanel = grid.up('tabpanel');
1974 </code></pre>
1975
1976 <h3 class="pa">Parameters</h3><ul><li><span class="pre">selector</span> : String<div class="sub-desc"><p>Optional. The simple selector to test.</p>
1977 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Container</span>&nbsp; &nbsp;<p>The matching ancestor Container (or <code>undefined</code> if no match was found).</p>
1978 </li></ul></div></div></div><div id="method-update" class="member inherited"><a href="Ext.button.Cycle.html#method-update" rel="method-update" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-update" class="viewSource">view source</a></div><a name="update"></a><a name="method-update"></a><a href="Ext.button.Cycle.html#" rel="method-update" class="cls expand">update</a>(
1979 <span class="pre">Mixed htmlOrData, [Boolean loadScripts], [Function callback]</span>)
1980  : void</div><div class="description"><div class="short"><p>Update the content area of a component.</p>
1981 </div><div class="long"><p>Update the content area of a component.</p>
1982 <h3 class="pa">Parameters</h3><ul><li><span class="pre">htmlOrData</span> : Mixed<div class="sub-desc"><p>If this component has been configured with a template via the tpl config
1983 then it will use this argument as data to populate the template.
1984 If this component was not configured with a template, the components
1985 content area will be updated via <a href="Ext.core.Element.html" rel="Ext.core.Element" class="docClass">Ext.core.Element</a> update</p>
1986 </div></li><li><span class="pre">loadScripts</span> : Boolean<div class="sub-desc"><p>(optional) Only legitimate when using the html configuration. Defaults to false</p>
1987 </div></li><li><span class="pre">callback</span> : Function<div class="sub-desc"><p>(optional) Only legitimate when using the html configuration. Callback to execute when scripts have finished loading</p>
1988 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1989 </li></ul></div></div></div><div id="method-updateBox" class="member inherited"><a href="Ext.button.Cycle.html#method-updateBox" rel="method-updateBox" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-updateBox" class="viewSource">view source</a></div><a name="updateBox"></a><a name="method-updateBox"></a><a href="Ext.button.Cycle.html#" rel="method-updateBox" class="cls expand">updateBox</a>(
1990 <span class="pre">Object box</span>)
1991  : Ext.Component</div><div class="description"><div class="short"><p>Sets the current box measurements of the component's underlying element.</p>
1992 </div><div class="long"><p>Sets the current box measurements of the component's underlying element.</p>
1993 <h3 class="pa">Parameters</h3><ul><li><span class="pre">box</span> : Object<div class="sub-desc"><p>An object in the format {x, y, width, height}</p>
1994 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>this</p>
1995 </li></ul></div></div></div></div><div class="m-events"><a name="events"></a><div class="definedBy">Defined By</div><h3 class="evt p">Events</h3><div id="event-activate" class="member f inherited"><a href="Ext.button.Cycle.html#event-activate" rel="event-activate" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-activate" class="viewSource">view source</a></div><a name="activate"></a><a name="event-activate"></a><a href="Ext.button.Cycle.html#" rel="event-activate" class="cls expand">activate</a>(
1996 <span class="pre">Ext.Component this</span>)
1997 </div><div class="description"><div class="short"><p>Fires after a Component has been visually activated.</p>
1998 </div><div class="long"><p>Fires after a Component has been visually activated.</p>
1999 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2000 </div></li></ul></div></div></div><div id="event-added" class="member inherited"><a href="Ext.button.Cycle.html#event-added" rel="event-added" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-added" class="viewSource">view source</a></div><a name="added"></a><a name="event-added"></a><a href="Ext.button.Cycle.html#" rel="event-added" class="cls expand">added</a>(
2001 <span class="pre">Ext.Component this, Ext.container.Container container, Number pos</span>)
2002 </div><div class="description"><div class="short"><p>Fires after a Component had been added to a Container.</p>
2003 </div><div class="long"><p>Fires after a Component had been added to a Container.</p>
2004 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2005 </div></li><li><span class="pre">container</span> : Ext.container.Container<div class="sub-desc"><p>Parent Container</p>
2006 </div></li><li><span class="pre">pos</span> : Number<div class="sub-desc"><p>position of Component</p>
2007 </div></li></ul></div></div></div><div id="event-afterrender" class="member inherited"><a href="Ext.button.Cycle.html#event-afterrender" rel="event-afterrender" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-afterrender" class="viewSource">view source</a></div><a name="afterrender"></a><a name="event-afterrender"></a><a href="Ext.button.Cycle.html#" rel="event-afterrender" class="cls expand">afterrender</a>(
2008 <span class="pre">Ext.Component this</span>)
2009 </div><div class="description"><div class="short">Fires after the component rendering is finished.
2010
2011
2012 The afterrender event is fired after this Component has been rende...</div><div class="long"><p>Fires after the component rendering is finished.</p>
2013
2014
2015 <p>The afterrender event is fired after this Component has been <a href="Ext.button.Cycle.html#rendered" rel="Ext.button.Cycle#rendered" class="docClass">rendered</a>, been postprocesed
2016 by any afterRender method defined for the Component.</p>
2017
2018 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2019 </div></li></ul></div></div></div><div id="event-arrowclick" class="member inherited"><a href="Ext.button.Cycle.html#event-arrowclick" rel="event-arrowclick" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Split.html" class="definedIn docClass">Ext.button.Split</a><br/><a href="../source/Split.html#Ext-button.Split-event-arrowclick" class="viewSource">view source</a></div><a name="arrowclick"></a><a name="event-arrowclick"></a><a href="Ext.button.Cycle.html#" rel="event-arrowclick" class="cls expand">arrowclick</a>(
2020 <span class="pre">MenuButton this, EventObject e</span>)
2021 </div><div class="description"><div class="short"><p>Fires when this button's arrow is clicked</p>
2022 </div><div class="long"><p>Fires when this button's arrow is clicked</p>
2023 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : MenuButton<div class="sub-desc">
2024 </div></li><li><span class="pre">e</span> : EventObject<div class="sub-desc"><p>The click event</p>
2025 </div></li></ul></div></div></div><div id="event-beforeactivate" class="member inherited"><a href="Ext.button.Cycle.html#event-beforeactivate" rel="event-beforeactivate" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-beforeactivate" class="viewSource">view source</a></div><a name="beforeactivate"></a><a name="event-beforeactivate"></a><a href="Ext.button.Cycle.html#" rel="event-beforeactivate" class="cls expand">beforeactivate</a>(
2026 <span class="pre">Ext.Component this</span>)
2027 </div><div class="description"><div class="short">Fires before a Component has been visually activated.
2028 Returning false from an event listener can prevent the activate...</div><div class="long"><p>Fires before a Component has been visually activated.
2029 Returning false from an event listener can prevent the activate
2030 from occurring.</p>
2031 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2032 </div></li></ul></div></div></div><div id="event-beforedeactivate" class="member inherited"><a href="Ext.button.Cycle.html#event-beforedeactivate" rel="event-beforedeactivate" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-beforedeactivate" class="viewSource">view source</a></div><a name="beforedeactivate"></a><a name="event-beforedeactivate"></a><a href="Ext.button.Cycle.html#" rel="event-beforedeactivate" class="cls expand">beforedeactivate</a>(
2033 <span class="pre">Ext.Component this</span>)
2034 </div><div class="description"><div class="short">Fires before a Component has been visually deactivated.
2035 Returning false from an event listener can prevent the deacti...</div><div class="long"><p>Fires before a Component has been visually deactivated.
2036 Returning false from an event listener can prevent the deactivate
2037 from occurring.</p>
2038 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2039 </div></li></ul></div></div></div><div id="event-beforedestroy" class="member inherited"><a href="Ext.button.Cycle.html#event-beforedestroy" rel="event-beforedestroy" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-beforedestroy" class="viewSource">view source</a></div><a name="beforedestroy"></a><a name="event-beforedestroy"></a><a href="Ext.button.Cycle.html#" rel="event-beforedestroy" class="cls expand">beforedestroy</a>(
2040 <span class="pre">Ext.Component this</span>)
2041 </div><div class="description"><div class="short"><p>Fires before the component is <a href="Ext.button.Cycle.html#destroy" rel="Ext.button.Cycle#destroy" class="docClass">destroy</a>ed. Return false from an event handler to stop the <a href="Ext.button.Cycle.html#destroy" rel="Ext.button.Cycle#destroy" class="docClass">destroy</a>.</p>
2042 </div><div class="long"><p>Fires before the component is <a href="Ext.button.Cycle.html#destroy" rel="Ext.button.Cycle#destroy" class="docClass">destroy</a>ed. Return false from an event handler to stop the <a href="Ext.button.Cycle.html#destroy" rel="Ext.button.Cycle#destroy" class="docClass">destroy</a>.</p>
2043 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2044 </div></li></ul></div></div></div><div id="event-beforehide" class="member inherited"><a href="Ext.button.Cycle.html#event-beforehide" rel="event-beforehide" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-beforehide" class="viewSource">view source</a></div><a name="beforehide"></a><a name="event-beforehide"></a><a href="Ext.button.Cycle.html#" rel="event-beforehide" class="cls expand">beforehide</a>(
2045 <span class="pre">Ext.Component this</span>)
2046 </div><div class="description"><div class="short"><p>Fires before the component is hidden when calling the <a href="Ext.button.Cycle.html#hide" rel="Ext.button.Cycle#hide" class="docClass">hide</a> method.
2047 Return false from an event handler to stop the hide.</p>
2048 </div><div class="long"><p>Fires before the component is hidden when calling the <a href="Ext.button.Cycle.html#hide" rel="Ext.button.Cycle#hide" class="docClass">hide</a> method.
2049 Return false from an event handler to stop the hide.</p>
2050 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2051 </div></li></ul></div></div></div><div id="event-beforerender" class="member inherited"><a href="Ext.button.Cycle.html#event-beforerender" rel="event-beforerender" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-beforerender" class="viewSource">view source</a></div><a name="beforerender"></a><a name="event-beforerender"></a><a href="Ext.button.Cycle.html#" rel="event-beforerender" class="cls expand">beforerender</a>(
2052 <span class="pre">Ext.Component this</span>)
2053 </div><div class="description"><div class="short"><p>Fires before the component is <a href="Ext.button.Cycle.html#rendered" rel="Ext.button.Cycle#rendered" class="docClass">rendered</a>. Return false from an
2054 event handler to stop the <a href="Ext.button.Cycle.html#render" rel="Ext.button.Cycle#render" class="docClass">render</a>.</p>
2055 </div><div class="long"><p>Fires before the component is <a href="Ext.button.Cycle.html#rendered" rel="Ext.button.Cycle#rendered" class="docClass">rendered</a>. Return false from an
2056 event handler to stop the <a href="Ext.button.Cycle.html#render" rel="Ext.button.Cycle#render" class="docClass">render</a>.</p>
2057 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2058 </div></li></ul></div></div></div><div id="event-beforeshow" class="member inherited"><a href="Ext.button.Cycle.html#event-beforeshow" rel="event-beforeshow" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-beforeshow" class="viewSource">view source</a></div><a name="beforeshow"></a><a name="event-beforeshow"></a><a href="Ext.button.Cycle.html#" rel="event-beforeshow" class="cls expand">beforeshow</a>(
2059 <span class="pre">Ext.Component this</span>)
2060 </div><div class="description"><div class="short"><p>Fires before the component is shown when calling the <a href="Ext.button.Cycle.html#show" rel="Ext.button.Cycle#show" class="docClass">show</a> method.
2061 Return false from an event handler to stop the show.</p>
2062 </div><div class="long"><p>Fires before the component is shown when calling the <a href="Ext.button.Cycle.html#show" rel="Ext.button.Cycle#show" class="docClass">show</a> method.
2063 Return false from an event handler to stop the show.</p>
2064 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2065 </div></li></ul></div></div></div><div id="event-beforestaterestore" class="member inherited"><a href="Ext.button.Cycle.html#event-beforestaterestore" rel="event-beforestaterestore" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.state.Stateful.html" class="definedIn docClass">Ext.state.Stateful</a><br/><a href="../source/Stateful.html#Ext-state.Stateful-event-beforestaterestore" class="viewSource">view source</a></div><a name="beforestaterestore"></a><a name="event-beforestaterestore"></a><a href="Ext.button.Cycle.html#" rel="event-beforestaterestore" class="cls expand">beforestaterestore</a>(
2066 <span class="pre">Ext.state.Stateful this, Object state</span>)
2067 </div><div class="description"><div class="short"><p>Fires before the state of the object is restored. Return false from an event handler to stop the restore.</p>
2068 </div><div class="long"><p>Fires before the state of the object is restored. Return false from an event handler to stop the restore.</p>
2069 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.state.Stateful<div class="sub-desc">
2070 </div></li><li><span class="pre">state</span> : Object<div class="sub-desc"><p>The hash of state values returned from the StateProvider. If this
2071 event is not vetoed, then the state object is passed to <b><tt>applyState</tt></b>. By default,
2072 that simply copies property values into this object. The method maybe overriden to
2073 provide custom state restoration.</p>
2074 </div></li></ul></div></div></div><div id="event-beforestatesave" class="member inherited"><a href="Ext.button.Cycle.html#event-beforestatesave" rel="event-beforestatesave" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.state.Stateful.html" class="definedIn docClass">Ext.state.Stateful</a><br/><a href="../source/Stateful.html#Ext-state.Stateful-event-beforestatesave" class="viewSource">view source</a></div><a name="beforestatesave"></a><a name="event-beforestatesave"></a><a href="Ext.button.Cycle.html#" rel="event-beforestatesave" class="cls expand">beforestatesave</a>(
2075 <span class="pre">Ext.state.Stateful this, Object state</span>)
2076 </div><div class="description"><div class="short"><p>Fires before the state of the object is saved to the configured state provider. Return false to stop the save.</p>
2077 </div><div class="long"><p>Fires before the state of the object is saved to the configured state provider. Return false to stop the save.</p>
2078 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.state.Stateful<div class="sub-desc">
2079 </div></li><li><span class="pre">state</span> : Object<div class="sub-desc"><p>The hash of state values. This is determined by calling
2080 <b><tt>getState()</tt></b> on the object. This method must be provided by the
2081 developer to return whetever representation of state is required, by default, <a href="Ext.state.Stateful.html" rel="Ext.state.Stateful" class="docClass">Ext.state.Stateful</a>
2082 has a null implementation.</p>
2083 </div></li></ul></div></div></div><div id="event-change" class="member ni"><a href="Ext.button.Cycle.html#event-change" rel="event-change" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Cycle.html" class="definedIn docClass">Ext.button.Cycle</a><br/><a href="../source/Cycle.html#Ext-button.Cycle-event-change" class="viewSource">view source</a></div><a name="change"></a><a name="event-change"></a><a href="Ext.button.Cycle.html#" rel="event-change" class="cls expand">change</a>(
2084 <span class="pre">Ext.button.Cycle this, Ext.menu.CheckItem item</span>)
2085 </div><div class="description"><div class="short">Fires after the button's active menu item has changed.  Note that if a changeHandler function
2086 is set on this CycleBut...</div><div class="long"><p>Fires after the button's active menu item has changed.  Note that if a <a href="Ext.button.Cycle.html#changeHandler" rel="Ext.button.Cycle#changeHandler" class="docClass">changeHandler</a> function
2087 is set on this CycleButton, it will be called instead on active item change and this change event will
2088 not be fired.</p>
2089 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.button.Cycle<div class="sub-desc">
2090 </div></li><li><span class="pre">item</span> : Ext.menu.CheckItem<div class="sub-desc"><p>The menu item that was selected</p>
2091 </div></li></ul></div></div></div><div id="event-click" class="member inherited"><a href="Ext.button.Cycle.html#event-click" rel="event-click" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-event-click" class="viewSource">view source</a></div><a name="click"></a><a name="event-click"></a><a href="Ext.button.Cycle.html#" rel="event-click" class="cls expand">click</a>(
2092 <span class="pre">Button this, EventObject e</span>)
2093 </div><div class="description"><div class="short"><p>Fires when this button is clicked</p>
2094 </div><div class="long"><p>Fires when this button is clicked</p>
2095 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Button<div class="sub-desc">
2096 </div></li><li><span class="pre">e</span> : EventObject<div class="sub-desc"><p>The click event</p>
2097 </div></li></ul></div></div></div><div id="event-deactivate" class="member inherited"><a href="Ext.button.Cycle.html#event-deactivate" rel="event-deactivate" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-deactivate" class="viewSource">view source</a></div><a name="deactivate"></a><a name="event-deactivate"></a><a href="Ext.button.Cycle.html#" rel="event-deactivate" class="cls expand">deactivate</a>(
2098 <span class="pre">Ext.Component this</span>)
2099 </div><div class="description"><div class="short"><p>Fires after a Component has been visually deactivated.</p>
2100 </div><div class="long"><p>Fires after a Component has been visually deactivated.</p>
2101 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2102 </div></li></ul></div></div></div><div id="event-destroy" class="member inherited"><a href="Ext.button.Cycle.html#event-destroy" rel="event-destroy" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-destroy" class="viewSource">view source</a></div><a name="destroy"></a><a name="event-destroy"></a><a href="Ext.button.Cycle.html#" rel="event-destroy" class="cls expand">destroy</a>(
2103 <span class="pre">Ext.Component this</span>)
2104 </div><div class="description"><div class="short"><p>Fires after the component is <a href="Ext.button.Cycle.html#destroy" rel="Ext.button.Cycle#destroy" class="docClass">destroy</a>ed.</p>
2105 </div><div class="long"><p>Fires after the component is <a href="Ext.button.Cycle.html#destroy" rel="Ext.button.Cycle#destroy" class="docClass">destroy</a>ed.</p>
2106 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2107 </div></li></ul></div></div></div><div id="event-disable" class="member inherited"><a href="Ext.button.Cycle.html#event-disable" rel="event-disable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-disable" class="viewSource">view source</a></div><a name="disable"></a><a name="event-disable"></a><a href="Ext.button.Cycle.html#" rel="event-disable" class="cls expand">disable</a>(
2108 <span class="pre">Ext.Component this</span>)
2109 </div><div class="description"><div class="short"><p>Fires after the component is disabled.</p>
2110 </div><div class="long"><p>Fires after the component is disabled.</p>
2111 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2112 </div></li></ul></div></div></div><div id="event-enable" class="member inherited"><a href="Ext.button.Cycle.html#event-enable" rel="event-enable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-enable" class="viewSource">view source</a></div><a name="enable"></a><a name="event-enable"></a><a href="Ext.button.Cycle.html#" rel="event-enable" class="cls expand">enable</a>(
2113 <span class="pre">Ext.Component this</span>)
2114 </div><div class="description"><div class="short"><p>Fires after the component is enabled.</p>
2115 </div><div class="long"><p>Fires after the component is enabled.</p>
2116 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2117 </div></li></ul></div></div></div><div id="event-hide" class="member inherited"><a href="Ext.button.Cycle.html#event-hide" rel="event-hide" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-hide" class="viewSource">view source</a></div><a name="hide"></a><a name="event-hide"></a><a href="Ext.button.Cycle.html#" rel="event-hide" class="cls expand">hide</a>(
2118 <span class="pre">Ext.Component this</span>)
2119 </div><div class="description"><div class="short"><p>Fires after the component is hidden.
2120 Fires after the component is hidden when calling the <a href="Ext.button.Cycle.html#hide" rel="Ext.button.Cycle#hide" class="docClass">hide</a> method.</p>
2121 </div><div class="long"><p>Fires after the component is hidden.
2122 Fires after the component is hidden when calling the <a href="Ext.button.Cycle.html#hide" rel="Ext.button.Cycle#hide" class="docClass">hide</a> method.</p>
2123 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2124 </div></li></ul></div></div></div><div id="event-menuhide" class="member inherited"><a href="Ext.button.Cycle.html#event-menuhide" rel="event-menuhide" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-event-menuhide" class="viewSource">view source</a></div><a name="menuhide"></a><a name="event-menuhide"></a><a href="Ext.button.Cycle.html#" rel="event-menuhide" class="cls expand">menuhide</a>(
2125 <span class="pre">Button this, Menu menu</span>)
2126 </div><div class="description"><div class="short"><p>If this button has a menu, this event fires when it is hidden</p>
2127 </div><div class="long"><p>If this button has a menu, this event fires when it is hidden</p>
2128 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Button<div class="sub-desc">
2129 </div></li><li><span class="pre">menu</span> : Menu<div class="sub-desc">
2130 </div></li></ul></div></div></div><div id="event-menushow" class="member inherited"><a href="Ext.button.Cycle.html#event-menushow" rel="event-menushow" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-event-menushow" class="viewSource">view source</a></div><a name="menushow"></a><a name="event-menushow"></a><a href="Ext.button.Cycle.html#" rel="event-menushow" class="cls expand">menushow</a>(
2131 <span class="pre">Button this, Menu menu</span>)
2132 </div><div class="description"><div class="short"><p>If this button has a menu, this event fires when it is shown</p>
2133 </div><div class="long"><p>If this button has a menu, this event fires when it is shown</p>
2134 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Button<div class="sub-desc">
2135 </div></li><li><span class="pre">menu</span> : Menu<div class="sub-desc">
2136 </div></li></ul></div></div></div><div id="event-menutriggerout" class="member inherited"><a href="Ext.button.Cycle.html#event-menutriggerout" rel="event-menutriggerout" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-event-menutriggerout" class="viewSource">view source</a></div><a name="menutriggerout"></a><a name="event-menutriggerout"></a><a href="Ext.button.Cycle.html#" rel="event-menutriggerout" class="cls expand">menutriggerout</a>(
2137 <span class="pre">Button this, Menu menu, EventObject e</span>)
2138 </div><div class="description"><div class="short"><p>If this button has a menu, this event fires when the mouse leaves the menu triggering element</p>
2139 </div><div class="long"><p>If this button has a menu, this event fires when the mouse leaves the menu triggering element</p>
2140 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Button<div class="sub-desc">
2141 </div></li><li><span class="pre">menu</span> : Menu<div class="sub-desc">
2142 </div></li><li><span class="pre">e</span> : EventObject<div class="sub-desc">
2143 </div></li></ul></div></div></div><div id="event-menutriggerover" class="member inherited"><a href="Ext.button.Cycle.html#event-menutriggerover" rel="event-menutriggerover" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-event-menutriggerover" class="viewSource">view source</a></div><a name="menutriggerover"></a><a name="event-menutriggerover"></a><a href="Ext.button.Cycle.html#" rel="event-menutriggerover" class="cls expand">menutriggerover</a>(
2144 <span class="pre">Button this, Menu menu, EventObject e</span>)
2145 </div><div class="description"><div class="short"><p>If this button has a menu, this event fires when the mouse enters the menu triggering element</p>
2146 </div><div class="long"><p>If this button has a menu, this event fires when the mouse enters the menu triggering element</p>
2147 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Button<div class="sub-desc">
2148 </div></li><li><span class="pre">menu</span> : Menu<div class="sub-desc">
2149 </div></li><li><span class="pre">e</span> : EventObject<div class="sub-desc">
2150 </div></li></ul></div></div></div><div id="event-mouseout" class="member inherited"><a href="Ext.button.Cycle.html#event-mouseout" rel="event-mouseout" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-event-mouseout" class="viewSource">view source</a></div><a name="mouseout"></a><a name="event-mouseout"></a><a href="Ext.button.Cycle.html#" rel="event-mouseout" class="cls expand">mouseout</a>(
2151 <span class="pre">Button this, Event e</span>)
2152 </div><div class="description"><div class="short"><p>Fires when the mouse exits the button</p>
2153 </div><div class="long"><p>Fires when the mouse exits the button</p>
2154 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Button<div class="sub-desc">
2155 </div></li><li><span class="pre">e</span> : Event<div class="sub-desc"><p>The event object</p>
2156 </div></li></ul></div></div></div><div id="event-mouseover" class="member inherited"><a href="Ext.button.Cycle.html#event-mouseover" rel="event-mouseover" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-event-mouseover" class="viewSource">view source</a></div><a name="mouseover"></a><a name="event-mouseover"></a><a href="Ext.button.Cycle.html#" rel="event-mouseover" class="cls expand">mouseover</a>(
2157 <span class="pre">Button this, Event e</span>)
2158 </div><div class="description"><div class="short"><p>Fires when the mouse hovers over the button</p>
2159 </div><div class="long"><p>Fires when the mouse hovers over the button</p>
2160 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Button<div class="sub-desc">
2161 </div></li><li><span class="pre">e</span> : Event<div class="sub-desc"><p>The event object</p>
2162 </div></li></ul></div></div></div><div id="event-move" class="member inherited"><a href="Ext.button.Cycle.html#event-move" rel="event-move" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-move" class="viewSource">view source</a></div><a name="move"></a><a name="event-move"></a><a href="Ext.button.Cycle.html#" rel="event-move" class="cls expand">move</a>(
2163 <span class="pre">Ext.Component this, Number x, Number y</span>)
2164 </div><div class="description"><div class="short"><p>Fires after the component is moved.</p>
2165 </div><div class="long"><p>Fires after the component is moved.</p>
2166 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2167 </div></li><li><span class="pre">x</span> : Number<div class="sub-desc"><p>The new x position</p>
2168 </div></li><li><span class="pre">y</span> : Number<div class="sub-desc"><p>The new y position</p>
2169 </div></li></ul></div></div></div><div id="event-removed" class="member inherited"><a href="Ext.button.Cycle.html#event-removed" rel="event-removed" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-removed" class="viewSource">view source</a></div><a name="removed"></a><a name="event-removed"></a><a href="Ext.button.Cycle.html#" rel="event-removed" class="cls expand">removed</a>(
2170 <span class="pre">Ext.Component this, Ext.container.Container ownerCt</span>)
2171 </div><div class="description"><div class="short"><p>Fires when a component is removed from an Ext.container.Container</p>
2172 </div><div class="long"><p>Fires when a component is removed from an Ext.container.Container</p>
2173 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2174 </div></li><li><span class="pre">ownerCt</span> : Ext.container.Container<div class="sub-desc"><p>Container which holds the component</p>
2175 </div></li></ul></div></div></div><div id="event-render" class="member inherited"><a href="Ext.button.Cycle.html#event-render" rel="event-render" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-render" class="viewSource">view source</a></div><a name="render"></a><a name="event-render"></a><a href="Ext.button.Cycle.html#" rel="event-render" class="cls expand">render</a>(
2176 <span class="pre">Ext.Component this</span>)
2177 </div><div class="description"><div class="short"><p>Fires after the component markup is <a href="Ext.button.Cycle.html#rendered" rel="Ext.button.Cycle#rendered" class="docClass">rendered</a>.</p>
2178 </div><div class="long"><p>Fires after the component markup is <a href="Ext.button.Cycle.html#rendered" rel="Ext.button.Cycle#rendered" class="docClass">rendered</a>.</p>
2179 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2180 </div></li></ul></div></div></div><div id="event-resize" class="member inherited"><a href="Ext.button.Cycle.html#event-resize" rel="event-resize" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-resize" class="viewSource">view source</a></div><a name="resize"></a><a name="event-resize"></a><a href="Ext.button.Cycle.html#" rel="event-resize" class="cls expand">resize</a>(
2181 <span class="pre">Ext.Component this, Number adjWidth, Number adjHeight</span>)
2182 </div><div class="description"><div class="short"><p>Fires after the component is resized.</p>
2183 </div><div class="long"><p>Fires after the component is resized.</p>
2184 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2185 </div></li><li><span class="pre">adjWidth</span> : Number<div class="sub-desc"><p>The box-adjusted width that was set</p>
2186 </div></li><li><span class="pre">adjHeight</span> : Number<div class="sub-desc"><p>The box-adjusted height that was set</p>
2187 </div></li></ul></div></div></div><div id="event-show" class="member inherited"><a href="Ext.button.Cycle.html#event-show" rel="event-show" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-show" class="viewSource">view source</a></div><a name="show"></a><a name="event-show"></a><a href="Ext.button.Cycle.html#" rel="event-show" class="cls expand">show</a>(
2188 <span class="pre">Ext.Component this</span>)
2189 </div><div class="description"><div class="short"><p>Fires after the component is shown when calling the <a href="Ext.button.Cycle.html#show" rel="Ext.button.Cycle#show" class="docClass">show</a> method.</p>
2190 </div><div class="long"><p>Fires after the component is shown when calling the <a href="Ext.button.Cycle.html#show" rel="Ext.button.Cycle#show" class="docClass">show</a> method.</p>
2191 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2192 </div></li></ul></div></div></div><div id="event-staterestore" class="member inherited"><a href="Ext.button.Cycle.html#event-staterestore" rel="event-staterestore" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.state.Stateful.html" class="definedIn docClass">Ext.state.Stateful</a><br/><a href="../source/Stateful.html#Ext-state.Stateful-event-staterestore" class="viewSource">view source</a></div><a name="staterestore"></a><a name="event-staterestore"></a><a href="Ext.button.Cycle.html#" rel="event-staterestore" class="cls expand">staterestore</a>(
2193 <span class="pre">Ext.state.Stateful this, Object state</span>)
2194 </div><div class="description"><div class="short"><p>Fires after the state of the object is restored.</p>
2195 </div><div class="long"><p>Fires after the state of the object is restored.</p>
2196 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.state.Stateful<div class="sub-desc">
2197 </div></li><li><span class="pre">state</span> : Object<div class="sub-desc"><p>The hash of state values returned from the StateProvider. This is passed
2198 to <b><tt>applyState</tt></b>. By default, that simply copies property values into this
2199 object. The method maybe overriden to provide custom state restoration.</p>
2200 </div></li></ul></div></div></div><div id="event-statesave" class="member inherited"><a href="Ext.button.Cycle.html#event-statesave" rel="event-statesave" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.state.Stateful.html" class="definedIn docClass">Ext.state.Stateful</a><br/><a href="../source/Stateful.html#Ext-state.Stateful-event-statesave" class="viewSource">view source</a></div><a name="statesave"></a><a name="event-statesave"></a><a href="Ext.button.Cycle.html#" rel="event-statesave" class="cls expand">statesave</a>(
2201 <span class="pre">Ext.state.Stateful this, Object state</span>)
2202 </div><div class="description"><div class="short"><p>Fires after the state of the object is saved to the configured state provider.</p>
2203 </div><div class="long"><p>Fires after the state of the object is saved to the configured state provider.</p>
2204 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.state.Stateful<div class="sub-desc">
2205 </div></li><li><span class="pre">state</span> : Object<div class="sub-desc"><p>The hash of state values. This is determined by calling
2206 <b><tt>getState()</tt></b> on the object. This method must be provided by the
2207 developer to return whetever representation of state is required, by default, <a href="Ext.state.Stateful.html" rel="Ext.state.Stateful" class="docClass">Ext.state.Stateful</a>
2208 has a null implementation.</p>
2209 </div></li></ul></div></div></div><div id="event-toggle" class="member inherited"><a href="Ext.button.Cycle.html#event-toggle" rel="event-toggle" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.button.Button.html" class="definedIn docClass">Ext.button.Button</a><br/><a href="../source/Button.html#Ext-button.Button-event-toggle" class="viewSource">view source</a></div><a name="toggle"></a><a name="event-toggle"></a><a href="Ext.button.Cycle.html#" rel="event-toggle" class="cls expand">toggle</a>(
2210 <span class="pre">Button this, Boolean pressed</span>)
2211 </div><div class="description"><div class="short"><p>Fires when the 'pressed' state of this button changes (only if enableToggle = true)</p>
2212 </div><div class="long"><p>Fires when the 'pressed' state of this button changes (only if enableToggle = true)</p>
2213 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Button<div class="sub-desc">
2214 </div></li><li><span class="pre">pressed</span> : Boolean<div class="sub-desc">
2215 </div></li></ul></div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>