Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / docs / api / Ext.AbstractComponent.html
1 <!DOCTYPE html><html><head><title>Ext.AbstractComponent | 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.AbstractComponent',
13         docClass: 'Ext.AbstractComponent',
14         docReq: 'Ext.AbstractComponent',
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 = 'AbstractComponent.html#Ext-AbstractComponent';
33     clsInfo = {"methods":["AbstractComponent","addClass","addCls","addClsWithUI","addEvents","addListener","addManagedListener","addStateEvents","afterComponentLayout","animate","applyState","beforeComponentLayout","capture","clearListeners","clearManagedListeners","destroy","disable","doAutoRender","doComponentLayout","enable","enableBubble","findLayoutController","fireEvent","getActiveAnimation","getBubbleTarget","getEl","getHeight","getId","getInsertPosition","getLoader","getPlugin","getSize","getState","getStateId","getWidth","getXTypes","hasListener","hasUICls","is","isDescendantOf","isDisabled","isDraggable","isDroppable","isFloating","isHidden","isVisible","isXType","nextNode","nextSibling","observe","on","previousNode","previousSibling","relayEvents","releaseCapture","removeCls","removeClsWithUI","removeListener","removeManagedListener","resumeEvents","sequenceFx","setDisabled","setDocked","setHeight","setLoading","setPosition","setSize","setUI","setVisible","setWidth","stopAnimation","suspendEvents","syncFx","un","up","update"],"cfgs":["autoEl","autoRender","autoShow","baseCls","border","cls","componentCls","componentLayout","contentEl","data","disabled","disabledCls","draggable","floating","frame","height","hidden","hideMode","html","id","itemId","listeners","loader","margin","maxHeight","maxWidth","minHeight","minWidth","overCls","padding","plugins","renderSelectors","renderTo","renderTpl","saveBuffer","stateEvents","stateId","stateful","style","styleHtmlCls","styleHtmlContent","tpl","tplWriteMode","ui","width"],"properties":["draggable","frameSize","hasActiveFx","maskOnDisable","ownerCt","rendered","stopFx"],"events":["activate","added","afterrender","beforeactivate","beforedeactivate","beforedestroy","beforehide","beforerender","beforeshow","beforestaterestore","beforestatesave","deactivate","destroy","disable","enable","hide","move","removed","render","resize","show","staterestore","statesave"],"subclasses":["Ext.Component"]};
34     Ext.onReady(function() {
35         Ext.create('Docs.classPanel');
36     });
37 </script><div id="top-block" class="top-block"><h1 id="clsTitle" class="cls"><a href="../source/AbstractComponent.html#Ext-AbstractComponent" target="_blank">Ext.AbstractComponent</a></h1></div><div id="docContent"><div id="doc-overview-content"><div class="lft"><pre class="subclasses"><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></pre><p>An abstract base class which provides shared methods for Components across the Sencha product line.</p>
38
39
40 <p>Please refer to sub class's documentation</p>
41
42 <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-baseCls" class="member f ni"><a href="Ext.AbstractComponent.html#config-baseCls" rel="config-baseCls" 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-baseCls" class="viewSource">view source</a></div><a name="baseCls"></a><a name="config-baseCls"></a><a href="Ext.AbstractComponent.html#" rel="config-baseCls" class="cls expand">baseCls</a><span> : String</span></div><div class="description"><div class="short">The base CSS class to apply to this components's element. This will also be prepended to
43 elements within this compone...</div><div class="long"><p>The base CSS class to apply to this components's element. This will also be prepended to
44 elements within this component like Panel's body will get a class x-panel-body. This means
45 that if you create a subclass of Panel, and you want it to get all the Panels styling for the
46 element and the body, you leave the baseCls x-panel and use componentCls to add specific styling for this
47 component.</p>
48 </div></div></div><div id="config-cls" class="member ni"><a href="Ext.AbstractComponent.html#config-cls" rel="config-cls" 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-cls" class="viewSource">view source</a></div><a name="cls"></a><a name="config-cls"></a><a href="Ext.AbstractComponent.html#" rel="config-cls" class="cls expand">cls</a><span> : String</span></div><div class="description"><div class="short">An optional extra CSS class that will be added to this component's Element (defaults to '').  This can be
49 useful for ...</div><div class="long"><p>An optional extra CSS class that will be added to this component's Element (defaults to '').  This can be
50 useful for adding customized styles to the component or any of its children using standard CSS rules.</p>
51 </div></div></div><div id="config-componentCls" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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
52 via styling.</p>
53 </div><div class="long"><p>CSS Class to be added to a components root level element to give distinction to it
54 via styling.</p>
55 </div></div></div><div id="config-disabledCls" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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>
56 </div><div class="long"><p>CSS class to add when the Component is disabled. Defaults to 'x-item-disabled'.</p>
57 </div></div></div><div id="config-overCls" class="member ni"><a href="Ext.AbstractComponent.html#config-overCls" rel="config-overCls" 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-overCls" class="viewSource">view source</a></div><a name="overCls"></a><a name="config-overCls"></a><a href="Ext.AbstractComponent.html#" rel="config-overCls" class="cls expand">overCls</a><span> : String</span></div><div class="description"><div class="short">An optional extra CSS class that will be added to this component's Element when the mouse moves
58 over the Element, and...</div><div class="long"><p>An optional extra CSS class that will be added to this component's Element when the mouse moves
59 over the Element, and removed when the mouse moves out. (defaults to '').  This can be
60 useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules.</p>
61 </div></div></div><div id="config-styleHtmlCls" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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.
62 Defaults to 'x-html'</p>
63 </div><div class="long"><p>The class that is added to the content target when you set styleHtmlContent to true.
64 Defaults to 'x-html'</p>
65 </div></div></div><h4 class="cfgGroup">Other Configs</h4><div id="config-autoEl" class="member f ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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
66 encapsulate this Component.
67
68
69 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.AbstractComponent.html#getEl" rel="Ext.AbstractComponent#getEl" class="docClass">Element</a> which will
70 encapsulate this Component.</p>
71
72
73 <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>,
74 this defaults to <b><tt>'div'</tt></b>. The more complex Sencha classes use a more complex
75 DOM structure specified by their own <a href="Ext.AbstractComponent.html#renderTpl" rel="Ext.AbstractComponent#renderTpl" class="docClass">renderTpl</a>s.</p>
76
77
78 <p>This is intended to allow the developer to create application-specific utility Components encapsulated by
79 different DOM elements. Example usage:</p>
80
81
82 <pre><code>{
83     xtype: 'component',
84     autoEl: {
85         tag: 'img',
86         src: 'http://www.example.com/example.jpg'
87     }
88 }, {
89     xtype: 'component',
90     autoEl: {
91         tag: 'blockquote',
92         html: 'autoEl is cool!'
93     }
94 }, {
95     xtype: 'container',
96     autoEl: 'ul',
97     cls: 'ux-unordered-list',
98     items: {
99         xtype: 'component',
100         autoEl: 'li',
101         html: 'First list item'
102     }
103 }
104 </code></pre>
105
106 </div></div></div><div id="config-autoRender" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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
107 of using renderTo in th...</div><div class="long"><p>This config is intended mainly for <a href="Ext.AbstractComponent.html#floating" rel="Ext.AbstractComponent#floating" class="docClass">floating</a> Components which may or may not be shown. Instead
108 of using <a href="Ext.AbstractComponent.html#renderTo" rel="Ext.AbstractComponent#renderTo" class="docClass">renderTo</a> in the configuration, and rendering upon construction, this allows a Component
109 to render itself upon first <i><a href="Ext.AbstractComponent.html#show" rel="Ext.AbstractComponent#show" class="docClass">show</a></i>.</p>
110
111
112 <p>Specify as <code>true</code> to have this Component render to the document body upon first show.</p>
113
114
115 <p>Specify as an element, or the ID of an element to have this Component render to a specific element upon first show.</p>
116
117
118 <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>
119
120 </div></div></div><div id="config-autoShow" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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.
121 This config option may only be used for floating components o...</div><div class="long"><p>True to automatically show the component upon creation.
122 This config option may only be used for <a href="Ext.AbstractComponent.html#floating" rel="Ext.AbstractComponent#floating" class="docClass">floating</a> components or components
123 that use <a href="Ext.AbstractComponent.html#autoRender" rel="Ext.AbstractComponent#autoRender" class="docClass">autoRender</a>. Defaults to <tt>false</tt>.</p>
124 </div></div></div><div id="config-baseCls" class="member ni"><a href="Ext.AbstractComponent.html#config-baseCls" rel="config-baseCls" 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-baseCls" class="viewSource">view source</a></div><a name="baseCls"></a><a name="config-baseCls"></a><a href="Ext.AbstractComponent.html#" rel="config-baseCls" class="cls expand">baseCls</a><span> : String</span></div><div class="description"><div class="short">The base CSS class to apply to this components's element. This will also be prepended to
125 elements within this compone...</div><div class="long"><p>The base CSS class to apply to this components's element. This will also be prepended to
126 elements within this component like Panel's body will get a class x-panel-body. This means
127 that if you create a subclass of Panel, and you want it to get all the Panels styling for the
128 element and the body, you leave the baseCls x-panel and use componentCls to add specific styling for this
129 component.</p>
130 </div></div></div><div id="config-border" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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
131 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
132 it can be a CSS style specification for each style, for example: '10 5 3 10'.</p>
133 </div></div></div><div id="config-cls" class="member ni"><a href="Ext.AbstractComponent.html#config-cls" rel="config-cls" 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-cls" class="viewSource">view source</a></div><a name="cls"></a><a name="config-cls"></a><a href="Ext.AbstractComponent.html#" rel="config-cls" class="cls expand">cls</a><span> : String</span></div><div class="description"><div class="short">An optional extra CSS class that will be added to this component's Element (defaults to '').  This can be
134 useful for ...</div><div class="long"><p>An optional extra CSS class that will be added to this component's Element (defaults to '').  This can be
135 useful for adding customized styles to the component or any of its children using standard CSS rules.</p>
136 </div></div></div><div id="config-componentCls" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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
137 via styling.</p>
138 </div><div class="long"><p>CSS Class to be added to a components root level element to give distinction to it
139 via styling.</p>
140 </div></div></div><div id="config-componentLayout" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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
141 the Component's layout manager...</div><div class="long"><p>The sizing and positioning of a Component's internal Elements is the responsibility of
142 the Component's layout manager which sizes a Component's internal structure in response to the Component being sized.</p>
143
144
145 <p>Generally, developers will not use this configuration as all provided Components which need their internal
146 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>
147
148
149 <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
150 which simply sizes the Component's encapsulating element to the height and width specified in the <a href="Ext.AbstractComponent.html#setSize" rel="Ext.AbstractComponent#setSize" class="docClass">setSize</a> method.</p>
151
152 </div></div></div><div id="config-contentEl" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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
153 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
154 for this component.</p>
155
156
157 <ul>
158 <li><b>Description</b> :
159 <div class="sub-desc">This config option is used to take an existing HTML element and place it in the layout element
160 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>
161 <li><b>Notes</b> :
162 <div class="sub-desc">The specified HTML element is appended to the layout element of the component <i>after any configured
163 <a href="Ext.AbstractComponent.html#html" rel="Ext.AbstractComponent#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.AbstractComponent.html#render" rel="Ext.AbstractComponent#render" class="docClass">render</a> event is fired.</div>
164 <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>
165 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>
166 <div class="sub-desc">Add either the <code>x-hidden</code> or the <code>x-hide-display</code> CSS class to
167 prevent a brief flicker of the content before it is rendered to the panel.</div></li>
168 </ul>
169
170 </div></div></div><div id="config-data" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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.AbstractComponent.html#tpl" rel="Ext.AbstractComponent#tpl" class="docClass">tpl</a></code> to
171 update the content area of the Component.</p>
172 </div><div class="long"><p>The initial set of data to apply to the <code><a href="Ext.AbstractComponent.html#tpl" rel="Ext.AbstractComponent#tpl" class="docClass">tpl</a></code> to
173 update the content area of the Component.</p>
174 </div></div></div><div id="config-disabled" class="member ni"><a href="Ext.AbstractComponent.html#config-disabled" rel="config-disabled" 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-disabled" class="viewSource">view source</a></div><a name="disabled"></a><a name="config-disabled"></a><a href="Ext.AbstractComponent.html#" rel="config-disabled" class="cls expand">disabled</a><span> : Boolean</span></div><div class="description"><div class="short"><p>Defaults to false.</p>
175 </div><div class="long"><p>Defaults to false.</p>
176 </div></div></div><div id="config-disabledCls" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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>
177 </div><div class="long"><p>CSS class to add when the Component is disabled. Defaults to 'x-item-disabled'.</p>
178 </div></div></div><div id="config-draggable" class="member ni"><a href="Ext.AbstractComponent.html#config-draggable" rel="config-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-cfg-draggable" class="viewSource">view source</a></div><a name="draggable"></a><a name="config-draggable"></a><a href="Ext.AbstractComponent.html#" rel="config-draggable" class="cls expand">draggable</a><span> : Boolean</span></div><div class="description"><div class="short"><p>Allows the component to be dragged.</p>
179 </div><div class="long"><p>Allows the component to be dragged.</p>
180 </div></div></div><div id="config-floating" class="member ni"><a href="Ext.AbstractComponent.html#config-floating" rel="config-floating" 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-floating" class="viewSource">view source</a></div><a name="floating"></a><a name="config-floating"></a><a href="Ext.AbstractComponent.html#" rel="config-floating" class="cls expand">floating</a><span> : Boolean</span></div><div class="description"><div class="short"><p>Create the Component as a floating and use absolute positioning.
181 Defaults to false.</p>
182 </div><div class="long"><p>Create the Component as a floating and use absolute positioning.
183 Defaults to false.</p>
184 </div></div></div><div id="config-frame" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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
185 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
186 provide a graphical rounded frame around the Component content.</p>
187
188
189 <p>This is only necessary when running on outdated, or non standard-compliant browsers such as Microsoft's Internet Explorer
190 prior to version 9 which do not support rounded corners natively.</p>
191
192
193 <p>The extra space taken up by this framing is available from the read only property <a href="Ext.AbstractComponent.html#frameSize" rel="Ext.AbstractComponent#frameSize" class="docClass">frameSize</a>.</p>
194
195 </div></div></div><div id="config-height" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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>
196 </div><div class="long"><p>The height of this component in pixels.</p>
197 </div></div></div><div id="config-hidden" class="member ni"><a href="Ext.AbstractComponent.html#config-hidden" rel="config-hidden" 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-hidden" class="viewSource">view source</a></div><a name="hidden"></a><a name="config-hidden"></a><a href="Ext.AbstractComponent.html#" rel="config-hidden" class="cls expand">hidden</a><span> : Boolean</span></div><div class="description"><div class="short"><p>Defaults to false.</p>
198 </div><div class="long"><p>Defaults to false.</p>
199 </div></div></div><div id="config-hideMode" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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.
200 Values may be
201 'display' : The...</div><div class="long"><p>A String which specifies how this Component's encapsulating DOM element will be hidden.
202 Values may be<div class="mdetail-params"><ul>
203 <li><code>'display'</code> : The Component will be hidden using the <code>display: none</code> style.</li>
204 <li><code>'visibility'</code> : The Component will be hidden using the <code>visibility: hidden</code> style.</li>
205 <li><code>'offsets'</code> : The Component will be hidden by absolutely positioning it out of the visible area of the document. This
206 is useful when a hidden Component must maintain measurable dimensions. Hiding using <code>display</code> results
207 in a Component having zero dimensions.</li></ul></div>
208 Defaults to <code>'display'</code>.</p>
209 </div></div></div><div id="config-html" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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
210 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
211 content (defaults to ''). The HTML content is added after the component is rendered,
212 so the document will not contain this HTML at the time the <a href="Ext.AbstractComponent.html#render" rel="Ext.AbstractComponent#render" class="docClass">render</a> event is fired.
213 This content is inserted into the body <i>before</i> any configured <a href="Ext.AbstractComponent.html#contentEl" rel="Ext.AbstractComponent#contentEl" class="docClass">contentEl</a> is appended.</p>
214 </div></div></div><div id="config-id" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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).
215
216
217 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.AbstractComponent.html#getId" rel="Ext.AbstractComponent#getId" class="docClass">auto-assigned id</a>).</p>
218
219
220 <p>It should not be necessary to use this configuration except for singleton objects in your application.
221 Components created with an id may be accessed globally using <a href="Ext.html#getCmp" rel="Ext#getCmp" class="docClass">Ext.getCmp</a>.</p>
222
223
224 <p>Instead of using assigned ids, use the <a href="Ext.AbstractComponent.html#itemId" rel="Ext.AbstractComponent#itemId" class="docClass">itemId</a> config, and <a href="Ext.ComponentQuery.html" rel="Ext.ComponentQuery" class="docClass">ComponentQuery</a> which
225 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>
226 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>
227
228
229 <p>Note that this id will also be used as the element id for the containing HTML element
230 that is rendered to the page for this component. This allows you to write id-based CSS
231 rules to style the specific instance of this component uniquely, and also to select
232 sub-elements using this component's id as the parent.</p>
233
234
235 <p><b>Note</b>: to avoid complications imposed by a unique <tt>id</tt> also see <code><a href="Ext.AbstractComponent.html#itemId" rel="Ext.AbstractComponent#itemId" class="docClass">itemId</a></code>.</p>
236
237
238 <p><b>Note</b>: to access the container of a Component see <code><a href="Ext.AbstractComponent.html#ownerCt" rel="Ext.AbstractComponent#ownerCt" class="docClass">ownerCt</a></code>.</p>
239
240 </div></div></div><div id="config-itemId" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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
241 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
242 when no object reference is available.  Instead of using an <code><a href="Ext.AbstractComponent.html#id" rel="Ext.AbstractComponent#id" class="docClass">id</a></code> with
243 <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
244 <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
245 <code>itemId</code>'s or <tt><a href="Ext.AbstractComponent.html#id" rel="Ext.AbstractComponent#id" class="docClass">id</a></tt>'s. Since <code>itemId</code>'s are an index to the
246 container's internal MixedCollection, the <code>itemId</code> is scoped locally to the container --
247 avoiding potential conflicts with <a href="Ext.ComponentManager.html" rel="Ext.ComponentManager" class="docClass">Ext.ComponentManager</a> which requires a <b>unique</b>
248 <code><a href="Ext.AbstractComponent.html#id" rel="Ext.AbstractComponent#id" class="docClass">id</a></code>.</p>
249
250
251 <pre><code>var c = new Ext.panel.Panel({ //
252     <a href="Ext.Component.html#height" rel="Ext.Component#height" class="docClass">height</a>: 300,
253     <a href="Ext.AbstractComponent.html#renderTo" rel="Ext.AbstractComponent#renderTo" class="docClass">renderTo</a>: document.body,
254     <a href="Ext.container.Container.html#layout" rel="Ext.container.Container#layout" class="docClass">layout</a>: 'auto',
255     <a href="Ext.container.Container.html#items" rel="Ext.container.Container#items" class="docClass">items</a>: [
256         {
257             itemId: 'p1',
258             <a href="Ext.panel.Panel.html#title" rel="Ext.panel.Panel#title" class="docClass">title</a>: 'Panel 1',
259             <a href="Ext.Component.html#height" rel="Ext.Component#height" class="docClass">height</a>: 150
260         },
261         {
262             itemId: 'p2',
263             <a href="Ext.panel.Panel.html#title" rel="Ext.panel.Panel#title" class="docClass">title</a>: 'Panel 2',
264             <a href="Ext.Component.html#height" rel="Ext.Component#height" class="docClass">height</a>: 150
265         }
266     ]
267 })
268 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>
269 p2 = p1.<a href="Ext.AbstractComponent.html#ownerCt" rel="Ext.AbstractComponent#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
270 </code></pre>
271
272
273 <p>Also see <tt><a href="Ext.AbstractComponent.html#id" rel="Ext.AbstractComponent#id" class="docClass">id</a></tt>, <code><a href="Ext.AbstractComponent.html#query" rel="Ext.AbstractComponent#query" class="docClass">query</a></code>, <code><a href="Ext.AbstractComponent.html#down" rel="Ext.AbstractComponent#down" class="docClass">down</a></code> and <code><a href="Ext.AbstractComponent.html#child" rel="Ext.AbstractComponent#child" class="docClass">child</a></code>.</p>
274
275
276 <p><b>Note</b>: to access the container of an item see <tt><a href="Ext.AbstractComponent.html#ownerCt" rel="Ext.AbstractComponent#ownerCt" class="docClass">ownerCt</a></tt>.</p>
277
278 </div></div></div><div id="config-listeners" class="member inherited"><a href="Ext.AbstractComponent.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.AbstractComponent.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
279 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
280 object during initialization.  This should be a valid listeners config object as specified in the
281 <a href="Ext.AbstractComponent.html#addListener" rel="Ext.AbstractComponent#addListener" class="docClass">addListener</a> example for attaching multiple handlers at once.</p></p>
282
283 <br><p><b><u>DOM events from ExtJs <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a></u></b></p>
284
285
286 <br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
287
288
289 <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
290 <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
291 events directly from a child element of a Component, we need to specify the <code>element</code> option to
292 identify the Component property to add a DOM listener to:</p>
293
294 <pre><code>new Ext.panel.Panel({
295     width: 400,
296     height: 200,
297     dockedItems: [{
298         xtype: 'toolbar'
299     }],
300     listeners: {
301         click: {
302             element: 'el', //bind to the underlying el property on the panel
303             fn: function(){ console.log('click el'); }
304         },
305         dblclick: {
306             element: 'body', //bind to the underlying body property on the panel
307             fn: function(){ console.log('dblclick body'); }
308         }
309     }
310 });
311 </code></pre>
312
313
314 <p></p></p>
315 </div></div></div><div id="config-loader" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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
316 content for this Component.</p>
317 </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
318 content for this Component.</p>
319 </div></div></div><div id="config-margin" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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
320 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
321 it can be a CSS style specification for each style, for example: '10 5 3 10'.</p>
322 </div></div></div><div id="config-maxHeight" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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.
323
324
325 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>
326
327
328 <p><b>Warning:</b> This will override any size management applied by layout managers.</p>
329
330 </div></div></div><div id="config-maxWidth" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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.
331
332
333 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>
334
335
336 <p><b>Warning:</b> This will override any size management applied by layout managers.</p>
337
338 </div></div></div><div id="config-minHeight" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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.
339
340
341 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>
342
343
344 <p><b>Warning:</b> This will override any size management applied by layout managers.</p>
345
346 </div></div></div><div id="config-minWidth" class="member ni"><a href="Ext.AbstractComponent.html#config-minWidth" rel="config-minWidth" 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-minWidth" class="viewSource">view source</a></div><a name="minWidth"></a><a name="config-minWidth"></a><a href="Ext.AbstractComponent.html#" rel="config-minWidth" class="cls expand">minWidth</a><span> : Number</span></div><div class="description"><div class="short">The minimum value in pixels which this Component will set its width to.
347
348
349 Warning: This will override any size manage...</div><div class="long"><p>The minimum value in pixels which this Component will set its width to.</p>
350
351
352 <p><b>Warning:</b> This will override any size management applied by layout managers.</p>
353
354 </div></div></div><div id="config-overCls" class="member ni"><a href="Ext.AbstractComponent.html#config-overCls" rel="config-overCls" 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-overCls" class="viewSource">view source</a></div><a name="overCls"></a><a name="config-overCls"></a><a href="Ext.AbstractComponent.html#" rel="config-overCls" class="cls expand">overCls</a><span> : String</span></div><div class="description"><div class="short">An optional extra CSS class that will be added to this component's Element when the mouse moves
355 over the Element, and...</div><div class="long"><p>An optional extra CSS class that will be added to this component's Element when the mouse moves
356 over the Element, and removed when the mouse moves out. (defaults to '').  This can be
357 useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules.</p>
358 </div></div></div><div id="config-padding" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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
359 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
360 it can be a CSS style specification for each style, for example: '10 5 3 10'.</p>
361 </div></div></div><div id="config-plugins" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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
362 requirement for a ...</div><div class="long"><p>An object or array of objects that will provide custom functionality for this component.  The only
363 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>.
364 When a component is created, if any plugins are available, the component will call the init method on each
365 plugin, passing a reference to itself.  Each plugin can then call methods or respond to events on the
366 component as needed to provide its functionality.</p>
367 </div></div></div><div id="config-renderSelectors" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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
368 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
369 created by the render process.</p>
370
371 <p>After the Component's internal structure is rendered according to the <a href="Ext.AbstractComponent.html#renderTpl" rel="Ext.AbstractComponent#renderTpl" class="docClass">renderTpl</a>, this object is iterated through,
372 and the found Elements are added as properties to the Component using the <code>renderSelector</code> property name.</p>
373
374 <p>For example, a Component which rendered an image, and description into its element might use the following properties
375 coded into its prototype:</p>
376
377 <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;',
378
379 renderSelectors: {
380     image: 'img.x-image-component-img',
381     descEl: 'div.x-image-component-desc'
382 }
383 </code></pre>
384
385 <p>After rendering, the Component would have a property <code>image</code> referencing its child <code>img</code> Element,
386 and a property <code>descEl</code> referencing the <code>div</code> Element which contains the description.</p>
387 </div></div></div><div id="config-renderTo" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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
388 will be rendered into.
389
390
391
392 Not...</div><div class="long"><p>Specify the id of the element, a DOM element or an existing Element that this component
393 will be rendered into.</p>
394
395
396 <div><ul>
397 <li><b>Notes</b> : <ul>
398 <div class="sub-desc">Do <u>not</u> use this option if the Component is to be a child item of
399 a <a href="Ext.container.Container.html" rel="Ext.container.Container" class="docClass">Container</a>. It is the responsibility of the
400 <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>
401 to render and manage its child items.</div>
402 <div class="sub-desc">When using this config, a call to render() is not required.</div>
403 </ul></li>
404 </ul></div>
405
406
407 <p>See <code><a href="Ext.AbstractComponent.html#render" rel="Ext.AbstractComponent#render" class="docClass">render</a></code> also.</p>
408
409 </div></div></div><div id="config-renderTpl" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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
410 encapsulating Element.
411
412
413 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
414 encapsulating <a href="Ext.AbstractComponent.html#getEl" rel="Ext.AbstractComponent#getEl" class="docClass">Element</a>.</p>
415
416
417 <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>
418 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
419 with no internal structure; they render their <a href="Ext.AbstractComponent.html#getEl" rel="Ext.AbstractComponent#getEl" class="docClass">Element</a> empty. The more specialized ExtJS and Touch classes
420 which use a more complex DOM structure, provide their own template definitions.</p>
421
422
423 <p>This is intended to allow the developer to create application-specific utility Components with customized
424 internal structure.</p>
425
426
427 <p>Upon rendering, any created child elements may be automatically imported into object properties using the
428 <a href="Ext.AbstractComponent.html#renderSelectors" rel="Ext.AbstractComponent#renderSelectors" class="docClass">renderSelectors</a> option.</p>
429
430 </div></div></div><div id="config-saveBuffer" class="member inherited"><a href="Ext.AbstractComponent.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.AbstractComponent.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
431 a short period. Defaults to 100.</p>
432 </div><div class="long"><p>A buffer to be applied if many state events are fired within
433 a short period. Defaults to 100.</p>
434 </div></div></div><div id="config-stateEvents" class="member inherited"><a href="Ext.AbstractComponent.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.AbstractComponent.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
435 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
436 save its state (defaults to none). <code>stateEvents</code> may be any type
437 of event supported by this object, including browser or custom events
438 (e.g., <tt>['click', 'customerchange']</tt>).</p>
439
440
441 <p>See <code><a href="Ext.AbstractComponent.html#stateful" rel="Ext.AbstractComponent#stateful" class="docClass">stateful</a></code> for an explanation of saving and
442 restoring object state.</p>
443
444 </div></div></div><div id="config-stateId" class="member inherited"><a href="Ext.AbstractComponent.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.AbstractComponent.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.
445
446 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>
447
448 <p>See <a href="Ext.AbstractComponent.html#stateful" rel="Ext.AbstractComponent#stateful" class="docClass">stateful</a> for an explanation of saving and restoring state.</p>
449
450 </div></div></div><div id="config-stateful" class="member inherited"><a href="Ext.AbstractComponent.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.AbstractComponent.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
451 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
452 internal properties from a saved state on startup. The object must have
453 a <code><a href="Ext.AbstractComponent.html#stateId" rel="Ext.AbstractComponent#stateId" class="docClass">stateId</a></code> for state to be managed. 
454 Auto-generated ids are not guaranteed to be stable across page loads and 
455 cannot be relied upon to save and restore the same state for a object.<p>
456 <p>For state saving to work, the state manager's provider must have been
457 set to an implementation of <a href="Ext.state.Provider.html" rel="Ext.state.Provider" class="docClass">Ext.state.Provider</a> which overrides the
458 <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>
459 methods to save and recall name/value pairs. A built-in implementation,
460 <a href="Ext.state.CookieProvider.html" rel="Ext.state.CookieProvider" class="docClass">Ext.state.CookieProvider</a> is available.</p>
461 <p>To set the state provider for the current page:</p>
462 <pre><code>Ext.state.Manager.setProvider(new Ext.state.CookieProvider({
463     expires: new Date(new Date().getTime()+(1000*60*60*24*7)), //7 days from now
464 }));
465 </code></pre>
466 <p>A stateful object attempts to save state when one of the events
467 listed in the <code><a href="Ext.AbstractComponent.html#stateEvents" rel="Ext.AbstractComponent#stateEvents" class="docClass">stateEvents</a></code> configuration fires.</p>
468 <p>To save state, a stateful object first serializes its state by
469 calling <b><code><a href="Ext.AbstractComponent.html#getState" rel="Ext.AbstractComponent#getState" class="docClass">getState</a></code></b>. By default, this function does
470 nothing. The developer must provide an implementation which returns an
471 object hash which represents the restorable state of the object.</p>
472 <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>
473 which uses the configured <a href="Ext.state.Provider.html" rel="Ext.state.Provider" class="docClass">Ext.state.Provider</a> to save the object
474 keyed by the <code><a href="stateId.html" rel="stateId" class="docClass">stateId</a></code></p>.
475 <p>During construction, a stateful object attempts to <i>restore</i>
476 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
477 <code><a href="Ext.AbstractComponent.html#stateId" rel="Ext.AbstractComponent#stateId" class="docClass">stateId</a></code></p>
478 <p>The resulting object is passed to <b><code><a href="Ext.AbstractComponent.html#applyState" rel="Ext.AbstractComponent#applyState" class="docClass">applyState</a></code></b>.
479 The default implementation of <code><a href="Ext.AbstractComponent.html#applyState" rel="Ext.AbstractComponent#applyState" class="docClass">applyState</a></code> simply copies
480 properties into the object, but a developer may override this to support
481 more behaviour.</p>
482 <p>You can perform extra processing on state save and restore by attaching
483 handlers to the <a href="Ext.AbstractComponent.html#beforestaterestore" rel="Ext.AbstractComponent#beforestaterestore" class="docClass">beforestaterestore</a>, <a href="Ext.AbstractComponent.html#staterestore" rel="Ext.AbstractComponent#staterestore" class="docClass">staterestore</a>,
484 <a href="Ext.AbstractComponent.html#beforestatesave" rel="Ext.AbstractComponent#beforestatesave" class="docClass">beforestatesave</a> and <a href="Ext.AbstractComponent.html#statesave" rel="Ext.AbstractComponent#statesave" class="docClass">statesave</a> events.</p>
485
486 </div></div></div><div id="config-style" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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
487 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
488 <a href="Ext.core.Element.html#applyStyles" rel="Ext.core.Element#applyStyles" class="docClass">Ext.core.Element.applyStyles</a>.</p>
489
490 <pre><code>        new Ext.panel.Panel({
491             title: 'Some Title',
492             renderTo: Ext.getBody(),
493             width: 400, height: 300,
494             layout: 'form',
495             items: [{
496                 xtype: 'textarea',
497                 style: {
498                     width: '95%',
499                     marginBottom: '10px'
500                 }
501             },
502             new Ext.button.Button({
503                 text: 'Send',
504                 minWidth: '100',
505                 style: {
506                     marginBottom: '10px'
507                 }
508             })
509             ]
510         });
511      </code></pre>
512
513 </div></div></div><div id="config-styleHtmlCls" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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.
514 Defaults to 'x-html'</p>
515 </div><div class="long"><p>The class that is added to the content target when you set styleHtmlContent to true.
516 Defaults to 'x-html'</p>
517 </div></div></div><div id="config-styleHtmlContent" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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).
518 Defaults to false.</p>
519 </div><div class="long"><p>True to automatically style the html inside the content target of this component (body for panels).
520 Defaults to false.</p>
521 </div></div></div><div id="config-tpl" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="config-tpl" class="cls expand">tpl</a><span> : Mixed</span></div><div class="description"><div class="short">An Ext.Template, Ext.XTemplate
522 or an array of strings to form an Ext.XTemplate.
523 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>
524 or an array of strings to form an <a href="Ext.XTemplate.html" rel="Ext.XTemplate" class="docClass">Ext.XTemplate</a>.
525 Used in conjunction with the <code><a href="Ext.AbstractComponent.html#data" rel="Ext.AbstractComponent#data" class="docClass">data</a></code> and
526 <code><a href="Ext.AbstractComponent.html#tplWriteMode" rel="Ext.AbstractComponent#tplWriteMode" class="docClass">tplWriteMode</a></code> configurations.</p>
527 </div></div></div><div id="config-tplWriteMode" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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
528 updating the content area of the Component. Defaults to 'overwrite'
529 (see Ext.X...</div><div class="long"><p>The Ext.(X)Template method to use when
530 updating the content area of the Component. Defaults to <code>'overwrite'</code>
531 (see <code><a href="Ext.XTemplate.html#overwrite" rel="Ext.XTemplate#overwrite" class="docClass">Ext.XTemplate.overwrite</a></code>).</p>
532 </div></div></div><div id="config-ui" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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>
533 </div><div class="long"><p>A set style for a component. Can be a string or an Array of multiple strings (UIs)</p>
534 </div></div></div><div id="config-width" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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>
535 </div><div class="long"><p>The width of this component in pixels.</p>
536 </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-draggable" class="member f ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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>
537 </div><div class="long"><p>Read-only property indicating whether or not the component can be dragged</p>
538 </div></div></div><div id="property-frameSize" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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
539 to ...</div><div class="long"><p>Read-only property indicating the width of any framing elements which were added within the encapsulating element
540 to provide graphical, rounded borders. See the <a href="Ext.AbstractComponent.html#frame" rel="Ext.AbstractComponent#frame" class="docClass">frame</a> config.</p>
541
542
543 <p> This is an object containing the frame width in pixels for all four sides of the Component containing
544 the following properties:</p>
545
546
547 <div class="mdetail-params"><ul>
548 <li><code>top</code> The width of the top framing element in pixels.</li>
549 <li><code>right</code> The width of the right framing element in pixels.</li>
550 <li><code>bottom</code> The width of the bottom framing element in pixels.</li>
551 <li><code>left</code> The width of the left framing element in pixels.</li>
552 </ul></div>
553
554 </div></div></div><div id="property-hasActiveFx" class="member inherited"><a href="Ext.AbstractComponent.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.AbstractComponent.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
555 Returns thq current animation if this object has any effects actively ...</div><div class="long"><p>@deprecated 4.0 Replaced by <a href="Ext.AbstractComponent.html#getActiveAnimation" rel="Ext.AbstractComponent#getActiveAnimation" class="docClass">getActiveAnimation</a>
556 Returns thq current animation if this object has any effects actively running or queued, else returns false.</p>
557 </div></div></div><div id="property-maskOnDisable" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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.
558 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.
559 By default this is set to true which means that every component gets a mask when its disabled.
560 Components like FieldContainer, FieldSet, Field, Button, Tab override this property to false
561 since they want to implement custom disable logic.</p>
562 </div></div></div><div id="property-ownerCt" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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
563 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
564 this Component is added to a Container).  Read-only.</p>
565
566 <p><b>Note</b>: to access items within the Container see <tt><a href="Ext.AbstractComponent.html#itemId" rel="Ext.AbstractComponent#itemId" class="docClass">itemId</a></tt>.</p>
567
568 </div></div></div><div id="property-rendered" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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>
569 </div><div class="long"><p>Read-only property indicating whether or not the component has been rendered.</p>
570 </div></div></div><div id="property-stopFx" class="member inherited"><a href="Ext.AbstractComponent.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.AbstractComponent.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
571 any additional effects that ...</div><div class="long"><p>Stops any running effects and clears this object's internal effects queue if it contains
572 any additional effects that haven't started yet.</p>
573 </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-AbstractComponent" class="member f ni"><a href="Ext.AbstractComponent.html#method-AbstractComponent" rel="method-AbstractComponent" 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-constructor" class="viewSource">view source</a></div><a name="AbstractComponent"></a><a name="method-AbstractComponent"></a><a href="Ext.AbstractComponent.html#" rel="method-AbstractComponent" class="cls expand">AbstractComponent</a> : void</div><div class="description"><div class="short"><p>&nbsp;</p></div><div class="long">
574 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
575 </li></ul></div></div></div><div id="method-addClass" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-addClass" class="cls expand">addClass</a>(
576 <span class="pre">String cls</span>)
577  : Ext.Component</div><div class="description"><div class="short"><p>@deprecated 4.0 Replaced by {link:#addCls}
578 Adds a CSS class to the top level element representing this component.</p>
579 </div><div class="long"><p>@deprecated 4.0 Replaced by {link:#addCls}
580 Adds a CSS class to the top level element representing this component.</p>
581 <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>
582 </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>
583 </li></ul></div></div></div><div id="method-addCls" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-addCls" class="cls expand">addCls</a>(
584 <span class="pre">String cls</span>)
585  : Ext.Component</div><div class="description"><div class="short"><p>Adds a CSS class to the top level element representing this component.</p>
586 </div><div class="long"><p>Adds a CSS class to the top level element representing this component.</p>
587 <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>
588 </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>
589 </li></ul></div></div></div><div id="method-addClsWithUI" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-addClsWithUI" class="cls expand">addClsWithUI</a>(
590 <span class="pre">String/Array cls</span>)
591  : void</div><div class="description"><div class="short"><p>Adds a cls to the uiCls array, which will also call <a href="Ext.AbstractComponent.html#addUIClsToElement" rel="Ext.AbstractComponent#addUIClsToElement" class="docClass">addUIClsToElement</a> and adds
592 to all elements of this component.</p>
593 </div><div class="long"><p>Adds a cls to the uiCls array, which will also call <a href="Ext.AbstractComponent.html#addUIClsToElement" rel="Ext.AbstractComponent#addUIClsToElement" class="docClass">addUIClsToElement</a> and adds
594 to all elements of this component.</p>
595 <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>
596 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
597 </li></ul></div></div></div><div id="method-addEvents" class="member inherited"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-addEvents" class="cls expand">addEvents</a>(
598 <span class="pre">Object/String o, String </span>)
599  : void</div><div class="description"><div class="short"><p>Adds the specified events to the list of events which this Observable may fire.</p>
600 </div><div class="long"><p>Adds the specified events to the list of events which this Observable may fire.</p>
601 <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>
602 or the first event name string if multiple event names are being passed as separate parameters.</p>
603 </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.
604 Usage:</p>
605
606 <pre><code>this.addEvents('storeloaded', 'storecleared');
607 </code></pre>
608
609 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
610 </li></ul></div></div></div><div id="method-addListener" class="member inherited"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-addListener" class="cls expand">addListener</a>(
611 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
612  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object.</p>
613 </div><div class="long"><p>Appends an event handler to this object.</p>
614 <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>
615 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes.</p>
616 </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.
617 <b>If omitted, defaults to the object which fired the event.</b></p>
618 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.
619 properties. This may contain any of the following properties:<ul>
620 <li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
621 <b>If omitted, defaults to the object which fired the event.</b></div></li>
622 <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>
623 <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>
624 <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
625 by the specified number of milliseconds. If the event fires again within that time, the original
626 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
627 <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>
628 if the event was bubbled up from a child Observable.</div></li>
629 <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>
630 The name of a Component property which references an element to add a listener to.</p>
631
632 <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
633 will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:
634 <pre><code>new Ext.panel.Panel({
635     title: 'The title',
636     listeners: {
637         click: this.handlePanelClick,
638         element: 'body'
639     }
640 });
641 </code></pre></p>
642
643
644 <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>
645
646
647 <p></div></li>
648 </ul><br></p>
649
650 <p>
651 <b>Combining Options</b><br>
652 Using the options argument, it is possible to combine different types of listeners:<br>
653 <br>
654 A delayed, one-time listener.
655 <pre><code>myPanel.on('hide', this.handleClick, this, {
656 single: true,
657 delay: 100
658 });</code></pre>
659 <p>
660 <b>Attaching multiple handlers in 1 call</b><br>
661 The method also allows for a single argument to be passed which is a config object containing properties
662 which specify multiple events. For example:
663 <pre><code>myGridPanel.on({
664     cellClick: this.onCellClick,
665     mouseover: this.onMouseOver,
666     mouseout: this.onMouseOut,
667     scope: this // Important. Ensure "this" is correct during handler execution
668 });
669 </code></pre>.
670 <p>
671
672 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
673 </li></ul></div></div></div><div id="method-addManagedListener" class="member inherited"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-addManagedListener" class="cls expand">addManagedListener</a>(
674 <span class="pre">Observable/Element item, Object/String ename, Function fn, Object scope, Object opt</span>)
675  : void</div><div class="description"><div class="short"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
676 is destroyed.
677
678 </div><div class="long"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
679 is destroyed.
680
681 <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>
682 </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>
683 </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
684 is the handler function.</p>
685 </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
686 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
687 </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
688 is the <a href="Ext.util.Observable.html#addListener" rel="Ext.util.Observable#addListener" class="docClass">addListener</a> options.</p>
689 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
690 </li></ul></div></div></div><div id="method-addStateEvents" class="member inherited"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-addStateEvents" class="cls expand">addStateEvents</a>(
691 <span class="pre">String/Array events</span>)
692  : void</div><div class="description"><div class="short"><p>Add events that will trigger the state to be saved.</p>
693 </div><div class="long"><p>Add events that will trigger the state to be saved.</p>
694 <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>
695 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
696 </li></ul></div></div></div><div id="method-afterComponentLayout" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-afterComponentLayout" class="cls expand">afterComponentLayout</a>(
697 <span class="pre">Number adjWidth, Number adjHeight, Boolean isSetSize, Ext.Component layoutOwner</span>)
698  : void</div><div class="description"><div class="short"><p>&nbsp;</p></div><div class="long">
699 <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>
700 </div></li><li><span class="pre">adjHeight</span> : Number<div class="sub-desc"><p>The box-adjusted height that was set</p>
701 </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>
702 </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>
703 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
704 </li></ul></div></div></div><div id="method-animate" class="member inherited"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-animate" class="cls expand">animate</a>(
705 <span class="pre">Object config</span>)
706  : Object</div><div class="description"><div class="short">Perform custom animation on this object.
707 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>
708 <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.
709 It performs animated transitions of certain properties of this object over a specified timeline.</p>
710 <p>The sole parameter is an object which specifies start property values, end property values, and properties which
711 describe the timeline. Of the properties listed below, only <b><code>to</code></b> is mandatory.</p>
712 <p>Properties include<ul>
713 <li><code>from</code> <div class="sub-desc">An object which specifies start values for the properties being animated.
714 If not supplied, properties are animated from current settings. The actual properties which may be animated depend upon
715 ths object being animated. See the sections below on Element and Component animation.<div></li>
716 <li><code>to</code> <div class="sub-desc">An object which specifies end values for the properties being animated.</div></li>
717 <li><code>duration</code><div class="sub-desc">The duration <b>in milliseconds</b> for which the animation will run.</div></li>
718 <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>
719 <li>ease</li>
720 <li>easeIn</li>
721 <li>easeOut</li>
722 <li>easeInOut</li>
723 <li>backIn</li>
724 <li>backOut</li>
725 <li>elasticIn</li>
726 <li>elasticOut</li>
727 <li>bounceIn</li>
728 <li>bounceOut</li>
729 </ul></code></div></li>
730 <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.
731 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>
732 <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
733 to inject behaviour at either the <code>beforeanimate</code> event or the <code>afteranimate</code> event.</div></li>
734 </ul></p>
735 <h3>Animating an <a href="Ext.core.Element.html" rel="Ext.core.Element" class="docClass">Element</a></h3>
736 When animating an Element, the following properties may be specified in <code>from</code>, <code>to</code>, and <code>keyframe</code> objects:<ul>
737 <li><code>x</code> <div class="sub-desc">The page X position in pixels.</div></li>
738 <li><code>y</code> <div class="sub-desc">The page Y position in pixels</div></li>
739 <li><code>left</code> <div class="sub-desc">The element's CSS <code>left</code> value. Units must be supplied.</div></li>
740 <li><code>top</code> <div class="sub-desc">The element's CSS <code>top</code> value. Units must be supplied.</div></li>
741 <li><code>width</code> <div class="sub-desc">The element's CSS <code>width</code> value. Units must be supplied.</div></li>
742 <li><code>height</code> <div class="sub-desc">The element's CSS <code>height</code> value. Units must be supplied.</div></li>
743 <li><code>scrollLeft</code> <div class="sub-desc">The element's <code>scrollLeft</code> value.</div></li>
744 <li><code>scrollTop</code> <div class="sub-desc">The element's <code>scrollLeft</code> value.</div></li>
745 <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>
746 </ul>
747 <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
748 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
749 directly animate certain properties of Components.</b></p>
750 <h3>Animating a <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Component</a></h3>
751 When animating an Element, the following properties may be specified in <code>from</code>, <code>to</code>, and <code>keyframe</code> objects:<ul>
752 <li><code>x</code> <div class="sub-desc">The Component's page X position in pixels.</div></li>
753 <li><code>y</code> <div class="sub-desc">The Component's page Y position in pixels</div></li>
754 <li><code>left</code> <div class="sub-desc">The Component's <code>left</code> value in pixels.</div></li>
755 <li><code>top</code> <div class="sub-desc">The Component's <code>top</code> value in pixels.</div></li>
756 <li><code>width</code> <div class="sub-desc">The Component's <code>width</code> value in pixels.</div></li>
757 <li><code>width</code> <div class="sub-desc">The Component's <code>width</code> value in pixels.</div></li>
758 <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
759 of the animation. <i>Use sparingly as laying out on every intermediate size change is an expensive operation</i>.</div></li>
760 </ul>
761 <p>For example, to animate a Window to a new size, ensuring that its internal layout, and any shadow is correct:</p>
762 <pre><code>myWindow = Ext.create('Ext.window.Window', {
763     title: 'Test Component animation',
764     width: 500,
765     height: 300,
766     layout: {
767         type: 'hbox',
768         align: 'stretch'
769     },
770     items: [{
771         title: 'Left: 33%',
772         margins: '5 0 5 5',
773         flex: 1
774     }, {
775         title: 'Left: 66%',
776         margins: '5 5 5 5',
777         flex: 2
778     }]
779 });
780 myWindow.show();
781 myWindow.header.el.on('click', function() {
782     myWindow.animate({
783         to: {
784             width: (myWindow.getWidth() == 500) ? 700 : 500,
785             height: (myWindow.getHeight() == 300) ? 400 : 300,
786         }
787     });
788 });
789 </code></pre>
790 <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
791 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>
792
793 <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>
794 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>this</p>
795 </li></ul></div></div></div><div id="method-applyState" class="member inherited"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-applyState" class="cls expand">applyState</a>(
796 <span class="pre">Object state</span>)
797  : void</div><div class="description"><div class="short">Applies the state to the object. This should be overridden in subclasses to do
798 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
799 more complex state operations. By default it applies the state properties onto
800 the current object.</p>
801 <h3 class="pa">Parameters</h3><ul><li><span class="pre">state</span> : Object<div class="sub-desc"><p>The state</p>
802 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
803 </li></ul></div></div></div><div id="method-beforeComponentLayout" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-beforeComponentLayout" class="cls expand">beforeComponentLayout</a>(
804 <span class="pre">Number adjWidth, Number adjHeight, Boolean isSetSize, Ext.Component layoutOwner</span>)
805  : void</div><div class="description"><div class="short">Occurs before componentLayout is run. Returning false from this method will prevent the componentLayout
806 from being ex...</div><div class="long"><p>Occurs before componentLayout is run. Returning false from this method will prevent the componentLayout
807 from being executed.</p>
808 <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>
809 </div></li><li><span class="pre">adjHeight</span> : Number<div class="sub-desc"><p>The box-adjusted height that was set</p>
810 </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>
811 </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>
812 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
813 </li></ul></div></div></div><div id="method-capture" class="member inherited"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-capture" class="cls expand">capture</a>(
814 <span class="pre">Observable o, Function fn, [Object scope]</span>)
815  : void</div><div class="description"><div class="short">Starts capture on the specified Observable. All events will be passed
816 to the supplied function with the event name + ...</div><div class="long"><p>Starts capture on the specified Observable. All events will be passed
817 to the supplied function with the event name + standard signature of the event
818 <b>before</b> the event is fired. If the supplied function returns false,
819 the event will not fire.</p>
820 <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>
821 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The function to call when an event is fired.</p>
822 </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>
823 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
824 </li></ul></div></div></div><div id="method-clearListeners" class="member inherited"><a href="Ext.AbstractComponent.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.AbstractComponent.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>
825 </div><div class="long"><p>Removes all listeners for this object including the managed listeners</p>
826 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
827 </li></ul></div></div></div><div id="method-clearManagedListeners" class="member inherited"><a href="Ext.AbstractComponent.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.AbstractComponent.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>
828 </div><div class="long"><p>Removes all managed listeners for this object.</p>
829 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
830 </li></ul></div></div></div><div id="method-destroy" class="member ni"><a href="Ext.AbstractComponent.html#method-destroy" rel="method-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-method-destroy" class="viewSource">view source</a></div><a name="destroy"></a><a name="method-destroy"></a><a href="Ext.AbstractComponent.html#" rel="method-destroy" class="cls expand">destroy</a> : void</div><div class="description"><div class="short"><p>Destroys the Component.</p>
831 </div><div class="long"><p>Destroys the Component.</p>
832 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
833 </li></ul></div></div></div><div id="method-disable" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-disable" class="cls expand">disable</a>(
834 <span class="pre">Boolean silent</span>)
835  : void</div><div class="description"><div class="short"><p>Disable the component.</p>
836 </div><div class="long"><p>Disable the component.</p>
837 <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>
838 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
839 </li></ul></div></div></div><div id="method-doAutoRender" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-doAutoRender" class="cls expand">doAutoRender</a> : void</div><div class="description"><div class="short">Handles autoRender.
840 Floating Components may have an ownerCt. If they are asking to be constrained, constrain them wit...</div><div class="long"><p>Handles autoRender.
841 Floating Components may have an ownerCt. If they are asking to be constrained, constrain them within that
842 ownerCt, and have their z-index managed locally. Floating Components are always rendered to document.body</p>
843 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
844 </li></ul></div></div></div><div id="method-doComponentLayout" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-doComponentLayout" class="cls expand">doComponentLayout</a>(
845 <span class="pre">Object width, Object height, Object isSetSize, Object ownerCt</span>)
846  : 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
847 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
848 layout to be recalculated.</p>
849 <h3 class="pa">Parameters</h3><ul><li><span class="pre">width</span> : Object<div class="sub-desc">
850 </div></li><li><span class="pre">height</span> : Object<div class="sub-desc">
851 </div></li><li><span class="pre">isSetSize</span> : Object<div class="sub-desc">
852 </div></li><li><span class="pre">ownerCt</span> : Object<div class="sub-desc">
853 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.container.Container</span>&nbsp; &nbsp;<p>this</p>
854 </li></ul></div></div></div><div id="method-enable" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-enable" class="cls expand">enable</a>(
855 <span class="pre">Boolean silent</span>)
856  : void</div><div class="description"><div class="short"><p>Enable the component</p>
857 </div><div class="long"><p>Enable the component</p>
858 <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>
859 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
860 </li></ul></div></div></div><div id="method-enableBubble" class="member inherited"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-enableBubble" class="cls expand">enableBubble</a>(
861 <span class="pre">String/Array events</span>)
862  : void</div><div class="description"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
863 this.getBubbleTarget() if present....</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling
864 <code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>
865
866
867 <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
868 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
869 access the required target more quickly.</p>
870
871
872 <p>Example:</p>
873
874
875 <pre><code>Ext.override(Ext.form.field.Base, {
876 //  Add functionality to Field&#39;s initComponent to enable the change event to bubble
877 initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
878     this.enableBubble('change');
879 }),
880
881 //  We know that we want Field&#39;s events to bubble directly to the FormPanel.
882 getBubbleTarget : function() {
883     if (!this.formPanel) {
884         this.formPanel = this.findParentByType('form');
885     }
886     return this.formPanel;
887 }
888 });
889
890 var myForm = new Ext.formPanel({
891 title: 'User Details',
892 items: [{
893     ...
894 }],
895 listeners: {
896     change: function() {
897         // Title goes red if form has been modified.
898         myForm.header.setStyle('color', 'red');
899     }
900 }
901 });
902 </code></pre>
903
904 <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>
905 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
906 </li></ul></div></div></div><div id="method-findLayoutController" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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
907 ...</div><div class="long"><p>This method finds the topmost active layout who's processing will eventually determine the size and position of this
908 Component.<p>
909 <p>This method is useful when dynamically adding Components into Containers, and some processing must take place after the
910 final sizing and positioning of the Component has been performed.</p>
911
912 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
913 </li></ul></div></div></div><div id="method-fireEvent" class="member inherited"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-fireEvent" class="cls expand">fireEvent</a>(
914 <span class="pre">String eventName, Object... args</span>)
915  : Boolean</div><div class="description"><div class="short">Fires the specified event with the passed parameters (minus the event name).
916
917
918 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>
919
920
921 <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>)
922 by calling <a href="Ext.AbstractComponent.html#enableBubble" rel="Ext.AbstractComponent#enableBubble" class="docClass">enableBubble</a>.</p>
923
924 <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>
925 </div></li><li><span class="pre">args</span> : Object...<div class="sub-desc"><p>Variable number of parameters are passed to handlers.</p>
926 </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>
927 </li></ul></div></div></div><div id="method-getActiveAnimation" class="member inherited"><a href="Ext.AbstractComponent.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.AbstractComponent.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>
928 </div><div class="long"><p>Returns thq current animation if this object has any effects actively running or queued, else returns false.</p>
929 <h3 class="pa">Returns</h3><ul><li><span class="pre">Mixed</span>&nbsp; &nbsp;<p>anim if element has active effects, else false</p>
930 </li></ul></div></div></div><div id="method-getBubbleTarget" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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>
931 </div><div class="long"><p>Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy.</p>
932 <h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.container.Container</span>&nbsp; &nbsp;<p>the Container which owns this Component.</p>
933 </li></ul></div></div></div><div id="method-getEl" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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>
934 </div><div class="long"><p>Retrieves the top level element representing this component.</p>
935 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
936 </li></ul></div></div></div><div id="method-getHeight" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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>
937 </div><div class="long"><p>Gets the current height of the component's underlying element.</p>
938 <h3 class="pa">Returns</h3><ul><li><span class="pre">Number</span>&nbsp; &nbsp;
939 </li></ul></div></div></div><div id="method-getId" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-getId" class="cls expand">getId</a> : void</div><div class="description"><div class="short"><p>Retrieves the id of this component.
940 Will autogenerate an id if one has not already been set.</p>
941 </div><div class="long"><p>Retrieves the id of this component.
942 Will autogenerate an id if one has not already been set.</p>
943 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
944 </li></ul></div></div></div><div id="method-getInsertPosition" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-getInsertPosition" class="cls expand">getInsertPosition</a>(
945 <span class="pre">String/Number/Element/HTMLElement position</span>)
946  : HTMLElement</div><div class="description"><div class="short">This function takes the position argument passed to onRender and returns a
947 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
948 DOM element that you can use in the insertBefore.</p>
949 <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
950 to put this component before.</p>
951 </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>
952 </li></ul></div></div></div><div id="method-getLoader" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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>
953 </div><div class="long"><p>Gets the <a href="Ext.ComponentLoader.html" rel="Ext.ComponentLoader" class="docClass">Ext.ComponentLoader</a> for this Component.</p>
954 <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>
955 </li></ul></div></div></div><div id="method-getPlugin" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-getPlugin" class="cls expand">getPlugin</a>(
956 <span class="pre">Object pluginId</span>)
957  : Ext.AbstractPlugin</div><div class="description"><div class="short"><p>Retrieves a plugin by its pluginId which has been bound to this
958 component.</p>
959 </div><div class="long"><p>Retrieves a plugin by its pluginId which has been bound to this
960 component.</p>
961 <h3 class="pa">Parameters</h3><ul><li><span class="pre">pluginId</span> : Object<div class="sub-desc">
962 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.AbstractPlugin</span>&nbsp; &nbsp;<p>pluginInstance</p>
963 </li></ul></div></div></div><div id="method-getSize" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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>
964 </div><div class="long"><p>Gets the current size of the component's underlying element.</p>
965 <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>
966 </li></ul></div></div></div><div id="method-getState" class="member inherited"><a href="Ext.AbstractComponent.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.AbstractComponent.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,
967 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,
968 it should be overridden in subclasses to implement methods for getting the state.</p>
969 <h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>The current state</p>
970 </li></ul></div></div></div><div id="method-getStateId" class="member inherited"><a href="Ext.AbstractComponent.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.AbstractComponent.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>
971 </div><div class="long"><p>Gets the state id for this object.</p>
972 <h3 class="pa">Returns</h3><ul><li><span class="pre">String</span>&nbsp; &nbsp;<p>The state id, null if not found.</p>
973 </li></ul></div></div></div><div id="method-getWidth" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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>
974 </div><div class="long"><p>Gets the current width of the component's underlying element.</p>
975 <h3 class="pa">Returns</h3><ul><li><span class="pre">Number</span>&nbsp; &nbsp;
976 </li></ul></div></div></div><div id="method-getXTypes" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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
977 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
978 available xtypes, see the <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a> header.</p>
979
980
981 <p><b>If using your own subclasses, be aware that a Component must register its own xtype
982 to participate in determination of inherited xtypes.</b></p>
983
984
985 <p>Example usage:</p>
986
987
988 <pre><code>var t = new Ext.form.field.Text();
989 alert(t.getXTypes());  // alerts 'component/field/textfield'
990 </code></pre>
991
992 <h3 class="pa">Returns</h3><ul><li><span class="pre">String</span>&nbsp; &nbsp;<p>The xtype hierarchy string</p>
993 </li></ul></div></div></div><div id="method-hasListener" class="member inherited"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-hasListener" class="cls expand">hasListener</a>(
994 <span class="pre">String eventName</span>)
995  : Boolean</div><div class="description"><div class="short"><p>Checks to see if this object has any listeners for a specified event</p>
996 </div><div class="long"><p>Checks to see if this object has any listeners for a specified event</p>
997 <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>
998 </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>
999 </li></ul></div></div></div><div id="method-hasUICls" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-hasUICls" class="cls expand">hasUICls</a>(
1000 <span class="pre">String cls</span>)
1001  : void</div><div class="description"><div class="short"><p>Checks if there is currently a specified uiCls</p>
1002 </div><div class="long"><p>Checks if there is currently a specified uiCls</p>
1003 <h3 class="pa">Parameters</h3><ul><li><span class="pre">cls</span> : String<div class="sub-desc"><p>The cls to check</p>
1004 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1005 </li></ul></div></div></div><div id="method-is" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-is" class="cls expand">is</a>(
1006 <span class="pre">String selector</span>)
1007  : Boolean</div><div class="description"><div class="short"><p>Tests whether this Component matches the selector string.</p>
1008 </div><div class="long"><p>Tests whether this Component matches the selector string.</p>
1009 <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>
1010 </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>
1011 </li></ul></div></div></div><div id="method-isDescendantOf" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-isDescendantOf" class="cls expand">isDescendantOf</a>(
1012 <span class="pre">Ext.Container container</span>)
1013  : Boolean</div><div class="description"><div class="short"><p>Determines whether this component is the descendant of a particular container.</p>
1014 </div><div class="long"><p>Determines whether this component is the descendant of a particular container.</p>
1015 <h3 class="pa">Parameters</h3><ul><li><span class="pre">container</span> : Ext.Container<div class="sub-desc">
1016 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>isDescendant</p>
1017 </li></ul></div></div></div><div id="method-isDisabled" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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>
1018 </div><div class="long"><p>Method to determine whether this Component is currently disabled.</p>
1019 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>the disabled state of this Component.</p>
1020 </li></ul></div></div></div><div id="method-isDraggable" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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>
1021 </div><div class="long"><p>Method to determine whether this Component is draggable.</p>
1022 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>the draggable state of this component.</p>
1023 </li></ul></div></div></div><div id="method-isDroppable" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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>
1024 </div><div class="long"><p>Method to determine whether this Component is droppable.</p>
1025 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>the droppable state of this component.</p>
1026 </li></ul></div></div></div><div id="method-isFloating" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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>
1027 </div><div class="long"><p>Method to determine whether this Component is floating.</p>
1028 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>the floating state of this component.</p>
1029 </li></ul></div></div></div><div id="method-isHidden" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.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>
1030 </div><div class="long"><p>Method to determine whether this Component is currently set to hidden.</p>
1031 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>the hidden state of this Component.</p>
1032 </li></ul></div></div></div><div id="method-isVisible" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-isVisible" class="cls expand">isVisible</a>(
1033 <span class="pre">Boolean deep</span>)
1034  : Boolean</div><div class="description"><div class="short"><p>Returns true if this component is visible.</p>
1035 </div><div class="long"><p>Returns true if this component is visible.</p>
1036 <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
1037 parent Containers to determine whether this Component is truly visible to the user.</p></p>
1038
1039 <p>Generally, to determine whether a Component is hidden, the no argument form is needed. For example
1040 when creating dynamically laid out UIs in a hidden Container before showing them.</p>
1041
1042 </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>
1043 </li></ul></div></div></div><div id="method-isXType" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-isXType" class="cls expand">isXType</a>(
1044 <span class="pre">String xtype, [Boolean shallow]</span>)
1045  : 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
1046 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
1047 from the xtype (default) or whether it is directly of the xtype specified (shallow = true).</p>
1048
1049
1050 <p><b>If using your own subclasses, be aware that a Component must register its own xtype
1051 to participate in determination of inherited xtypes.</b></p>
1052
1053
1054 <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>
1055
1056
1057 <p>Example usage:</p>
1058
1059
1060 <pre><code>var t = new Ext.form.field.Text();
1061 var isText = t.isXType('textfield');        // true
1062 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>
1063 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
1064 </code></pre>
1065
1066 <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>
1067 </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
1068 the default), or true to check whether this Component is directly of the specified xtype.</p>
1069 </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>
1070 </li></ul></div></div></div><div id="method-nextNode" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-nextNode" class="cls expand">nextNode</a>(
1071 <span class="pre">String selector, Object includeSelf</span>)
1072  : void</div><div class="description"><div class="short">Returns the next node in the Component tree in tree traversal order.
1073
1074
1075 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>
1076
1077
1078 <p>Note that this is not limited to siblings, and if invoked upon a node with no matching siblings, will
1079 walk the tree to attempt to find a match. Contrast with <a href="Ext.AbstractComponent.html#pnextSibling" rel="Ext.AbstractComponent#pnextSibling" class="docClass">pnextSibling</a>.</p>
1080
1081 <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>
1082 </div></li><li><span class="pre">includeSelf</span> : Object<div class="sub-desc">
1083 </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>
1084 </li></ul></div></div></div><div id="method-nextSibling" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-nextSibling" class="cls expand">nextSibling</a>(
1085 <span class="pre">String selector</span>)
1086  : void</div><div class="description"><div class="short">Returns the next sibling of this Component.
1087
1088
1089 Optionally selects the next sibling which matches the passed ComponentQ...</div><div class="long"><p>Returns the next sibling of this Component.</p>
1090
1091
1092 <p>Optionally selects the next sibling which matches the passed <a href="Ext.ComponentQuery.html" rel="Ext.ComponentQuery" class="docClass">ComponentQuery</a> selector.</p>
1093
1094
1095 <p>May also be refered to as <code><b>next()</b></code></p>
1096
1097
1098 <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.AbstractComponent.html#nextNode" rel="Ext.AbstractComponent#nextNode" class="docClass">nextNode</a></p>
1099
1100 <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>
1101 </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>
1102 </li></ul></div></div></div><div id="method-observe" class="member inherited"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-observe" class="cls expand">observe</a>(
1103 <span class="pre">Function c, Object listeners</span>)
1104  : void</div><div class="description"><div class="short">Sets observability on the passed class constructor.
1105
1106 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>
1107
1108 <p>This makes any event fired on any instance of the passed class also fire a single event through
1109 the <strong>class</strong> allowing for central handling of events on many instances at once.</p>
1110
1111 <p>Usage:</p>
1112
1113 <pre><code>Ext.util.Observable.observe(Ext.data.Connection);
1114 Ext.data.Connection.on('beforerequest', function(con, options) {
1115     console.log('Ajax request made to ' + options.url);
1116 });
1117 </code></pre>
1118 <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>
1119 </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.AbstractComponent.html#addListener" rel="Ext.AbstractComponent#addListener" class="docClass">addListener</a>.</p>
1120 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1121 </li></ul></div></div></div><div id="method-on" class="member inherited"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-on" class="cls expand">on</a>(
1122 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
1123  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object (shorthand for <a href="Ext.AbstractComponent.html#addListener" rel="Ext.AbstractComponent#addListener" class="docClass">addListener</a>.)</p>
1124 </div><div class="long"><p>Appends an event handler to this object (shorthand for <a href="Ext.AbstractComponent.html#addListener" rel="Ext.AbstractComponent#addListener" class="docClass">addListener</a>.)</p>
1125 <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>
1126 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes</p>
1127 </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.
1128 <b>If omitted, defaults to the object which fired the event.</b></p>
1129 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.</p>
1130 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1131 </li></ul></div></div></div><div id="method-previousNode" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-previousNode" class="cls expand">previousNode</a>(
1132 <span class="pre">String selector, Object includeSelf</span>)
1133  : void</div><div class="description"><div class="short">Returns the previous node in the Component tree in tree traversal order.
1134
1135
1136 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>
1137
1138
1139 <p>Note that this is not limited to siblings, and if invoked upon a node with no matching siblings, will
1140 walk the tree in reverse order to attempt to find a match. Contrast with <a href="Ext.AbstractComponent.html#previousSibling" rel="Ext.AbstractComponent#previousSibling" class="docClass">previousSibling</a>.</p>
1141
1142 <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>
1143 </div></li><li><span class="pre">includeSelf</span> : Object<div class="sub-desc">
1144 </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>
1145 </li></ul></div></div></div><div id="method-previousSibling" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-previousSibling" class="cls expand">previousSibling</a>(
1146 <span class="pre">String selector</span>)
1147  : void</div><div class="description"><div class="short">Returns the previous sibling of this Component.
1148
1149
1150 Optionally selects the previous sibling which matches the passed Co...</div><div class="long"><p>Returns the previous sibling of this Component.</p>
1151
1152
1153 <p>Optionally selects the previous sibling which matches the passed <a href="Ext.ComponentQuery.html" rel="Ext.ComponentQuery" class="docClass">ComponentQuery</a> selector.</p>
1154
1155
1156 <p>May also be refered to as <code><b>prev()</b></code></p>
1157
1158
1159 <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.AbstractComponent.html#previousNode" rel="Ext.AbstractComponent#previousNode" class="docClass">previousNode</a></p>
1160
1161 <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>
1162 </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>
1163 </li></ul></div></div></div><div id="method-relayEvents" class="member inherited"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-relayEvents" class="cls expand">relayEvents</a>(
1164 <span class="pre">Object origin, Array events, Object prefix</span>)
1165  : 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>
1166 </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>
1167 <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>
1168 </div></li><li><span class="pre">events</span> : Array<div class="sub-desc"><p>Array of event names to relay.</p>
1169 </div></li><li><span class="pre">prefix</span> : Object<div class="sub-desc">
1170 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1171 </li></ul></div></div></div><div id="method-releaseCapture" class="member inherited"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-releaseCapture" class="cls expand">releaseCapture</a>(
1172 <span class="pre">Observable o</span>)
1173  : void</div><div class="description"><div class="short"><p>Removes <b>all</b> added captures from the Observable.</p>
1174 </div><div class="long"><p>Removes <b>all</b> added captures from the Observable.</p>
1175 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to release</p>
1176 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1177 </li></ul></div></div></div><div id="method-removeCls" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-removeCls" class="cls expand">removeCls</a>(
1178 <span class="pre">Object className</span>)
1179  : Ext.Component</div><div class="description"><div class="short"><p>Removes a CSS class from the top level element representing this component.</p>
1180 </div><div class="long"><p>Removes a CSS class from the top level element representing this component.</p>
1181 <h3 class="pa">Parameters</h3><ul><li><span class="pre">className</span> : Object<div class="sub-desc">
1182 </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>
1183 </li></ul></div></div></div><div id="method-removeClsWithUI" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-removeClsWithUI" class="cls expand">removeClsWithUI</a>(
1184 <span class="pre">String/Array cls</span>)
1185  : void</div><div class="description"><div class="short">Removes a cls to the uiCls array, which will also call removeUIClsToElement and removes
1186 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.AbstractComponent.html#removeUIClsToElement" rel="Ext.AbstractComponent#removeUIClsToElement" class="docClass">removeUIClsToElement</a> and removes
1187 it from all elements of this component.</p>
1188 <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>
1189 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1190 </li></ul></div></div></div><div id="method-removeListener" class="member inherited"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-removeListener" class="cls expand">removeListener</a>(
1191 <span class="pre">String eventName, Function handler, [Object scope]</span>)
1192  : void</div><div class="description"><div class="short"><p>Removes an event handler.</p>
1193 </div><div class="long"><p>Removes an event handler.</p>
1194 <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>
1195 </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.AbstractComponent.html#addListener" rel="Ext.AbstractComponent#addListener" class="docClass">addListener</a> call.</b></p>
1196 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
1197 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1198 </li></ul></div></div></div><div id="method-removeManagedListener" class="member inherited"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-removeManagedListener" class="cls expand">removeManagedListener</a>(
1199 <span class="pre">Observable|Element item, Object|String ename, Function fn, Object scope</span>)
1200  : void</div><div class="description"><div class="short"><p>Removes listeners that were added by the <a href="Ext.AbstractComponent.html#mon" rel="Ext.AbstractComponent#mon" class="docClass">mon</a> method.</p>
1201 </div><div class="long"><p>Removes listeners that were added by the <a href="Ext.AbstractComponent.html#mon" rel="Ext.AbstractComponent#mon" class="docClass">mon</a> method.</p>
1202 <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>
1203 </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>
1204 </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
1205 is the handler function.</p>
1206 </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
1207 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
1208 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1209 </li></ul></div></div></div><div id="method-resumeEvents" class="member inherited"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-resumeEvents" class="cls expand">resumeEvents</a> : void</div><div class="description"><div class="short">Resume firing events. (see suspendEvents)
1210 If events were suspended using the queueSuspended parameter, then all
1211 event...</div><div class="long"><p>Resume firing events. (see <a href="Ext.AbstractComponent.html#suspendEvents" rel="Ext.AbstractComponent#suspendEvents" class="docClass">suspendEvents</a>)
1212 If events were suspended using the <code><b>queueSuspended</b></code> parameter, then all
1213 events fired during event suspension will be sent to any listeners now.</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-sequenceFx" class="member inherited"><a href="Ext.AbstractComponent.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.AbstractComponent.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
1216 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
1217 run in sequence.  This is the opposite of <a href="Ext.AbstractComponent.html#syncFx" rel="Ext.AbstractComponent#syncFx" class="docClass">syncFx</a>.</p>
1218 <h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.core.Element</span>&nbsp; &nbsp;<p>The Element</p>
1219 </li></ul></div></div></div><div id="method-setDisabled" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-setDisabled" class="cls expand">setDisabled</a>(
1220 <span class="pre">Boolean disabled</span>)
1221  : void</div><div class="description"><div class="short"><p>Enable or disable the component.</p>
1222 </div><div class="long"><p>Enable or disable the component.</p>
1223 <h3 class="pa">Parameters</h3><ul><li><span class="pre">disabled</span> : Boolean<div class="sub-desc">
1224 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1225 </li></ul></div></div></div><div id="method-setDocked" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-setDocked" class="cls expand">setDocked</a>(
1226 <span class="pre">Object dock, Object layoutParent</span>)
1227  : Component</div><div class="description"><div class="short">Sets the dock position of this component in its parent panel. Note that
1228 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
1229 this only has effect if this item is part of the dockedItems collection
1230 of a parent that has a DockLayout (note that any Panel has a DockLayout
1231 by default)</p>
1232 <h3 class="pa">Parameters</h3><ul><li><span class="pre">dock</span> : Object<div class="sub-desc">
1233 </div></li><li><span class="pre">layoutParent</span> : Object<div class="sub-desc">
1234 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Component</span>&nbsp; &nbsp;<p>this</p>
1235 </li></ul></div></div></div><div id="method-setHeight" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-setHeight" class="cls expand">setHeight</a>(
1236 <span class="pre">Number height</span>)
1237  : Ext.Component</div><div class="description"><div class="short"><p>Sets the height of the component.  This method fires the <a href="Ext.AbstractComponent.html#resize" rel="Ext.AbstractComponent#resize" class="docClass">resize</a> event.</p>
1238 </div><div class="long"><p>Sets the height of the component.  This method fires the <a href="Ext.AbstractComponent.html#resize" rel="Ext.AbstractComponent#resize" class="docClass">resize</a> event.</p>
1239 <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>
1240 <li>A Number specifying the new height in the <a href="Ext.AbstractComponent.html#getEl" rel="Ext.AbstractComponent#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>
1241 <li>A String used to set the CSS height style.</li>
1242 <li><i>undefined</i> to leave the height unchanged.</li>
1243 </ul></div></p>
1244 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>this</p>
1245 </li></ul></div></div></div><div id="method-setLoading" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-setLoading" class="cls expand">setLoading</a>(
1246 <span class="pre">Boolean/Object/String load, Boolean targetEl</span>)
1247  : 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>
1248 </div><div class="long"><p>This method allows you to show or hide a LoadMask on top of this component.</p>
1249 <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
1250 that will be passed to the LoadMask constructor, or a message String to show. False to
1251 hide the current LoadMask.</p>
1252 </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.
1253 For example, setting this to true on a Panel will cause only the body to be masked. (defaults to false)</p>
1254 </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>
1255 </li></ul></div></div></div><div id="method-setPosition" class="member ni"><a href="Ext.AbstractComponent.html#method-setPosition" rel="method-setPosition" 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-setPosition" class="viewSource">view source</a></div><a name="setPosition"></a><a name="method-setPosition"></a><a href="Ext.AbstractComponent.html#" rel="method-setPosition" class="cls expand">setPosition</a>(
1256 <span class="pre">Number left, Number top</span>)
1257  : 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.
1258 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.AbstractComponent.html#setPagePosition" rel="Ext.AbstractComponent#setPagePosition" class="docClass">setPagePosition</a>.
1259 This method fires the <a href="Ext.AbstractComponent.html#move" rel="Ext.AbstractComponent#move" class="docClass">move</a> event.</p>
1260 <h3 class="pa">Parameters</h3><ul><li><span class="pre">left</span> : Number<div class="sub-desc"><p>The new left</p>
1261 </div></li><li><span class="pre">top</span> : Number<div class="sub-desc"><p>The new top</p>
1262 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>this</p>
1263 </li></ul></div></div></div><div id="method-setSize" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-setSize" class="cls expand">setSize</a>(
1264 <span class="pre">Mixed width, Mixed height</span>)
1265  : 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
1266 either width ...</div><div class="long"><p>Sets the width and height of this Component. This method fires the <a href="Ext.AbstractComponent.html#resize" rel="Ext.AbstractComponent#resize" class="docClass">resize</a> event. This method can accept
1267 either width and height as separate arguments, or you can pass a size object like <code>{width:10, height:20}</code>.</p>
1268 <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>
1269 <li>A Number specifying the new width in the <a href="Ext.AbstractComponent.html#getEl" rel="Ext.AbstractComponent#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>
1270 <li>A String used to set the CSS width style.</li>
1271 <li>A size object in the format <code>{width: widthValue, height: heightValue}</code>.</li>
1272 <li><code>undefined</code> to leave the width unchanged.</li>
1273 </ul></div></p>
1274 </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).
1275 This may be one of:<div class="mdetail-params"><ul>
1276 <li>A Number specifying the new height in the <a href="Ext.AbstractComponent.html#getEl" rel="Ext.AbstractComponent#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>
1277 <li>A String used to set the CSS height style. Animation may <b>not</b> be used.</li>
1278 <li><code>undefined</code> to leave the height unchanged.</li>
1279 </ul></div></p>
1280 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>this</p>
1281 </li></ul></div></div></div><div id="method-setUI" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-setUI" class="cls expand">setUI</a>(
1282 <span class="pre">String ui</span>)
1283  : 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
1284 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
1285 loop through any uiCls set on the component and rename them so they include the new UI</p>
1286 <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>
1287 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1288 </li></ul></div></div></div><div id="method-setVisible" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-setVisible" class="cls expand">setVisible</a>(
1289 <span class="pre">Boolean visible</span>)
1290  : Ext.Component</div><div class="description"><div class="short"><p>Convenience function to hide or show this component by boolean.</p>
1291 </div><div class="long"><p>Convenience function to hide or show this component by boolean.</p>
1292 <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>
1293 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>this</p>
1294 </li></ul></div></div></div><div id="method-setWidth" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-setWidth" class="cls expand">setWidth</a>(
1295 <span class="pre">Number width</span>)
1296  : Ext.Component</div><div class="description"><div class="short"><p>Sets the width of the component.  This method fires the <a href="Ext.AbstractComponent.html#resize" rel="Ext.AbstractComponent#resize" class="docClass">resize</a> event.</p>
1297 </div><div class="long"><p>Sets the width of the component.  This method fires the <a href="Ext.AbstractComponent.html#resize" rel="Ext.AbstractComponent#resize" class="docClass">resize</a> event.</p>
1298 <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>
1299 <li>A Number specifying the new width in the <a href="Ext.AbstractComponent.html#getEl" rel="Ext.AbstractComponent#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>
1300 <li>A String used to set the CSS width style.</li>
1301 </ul></div></p>
1302 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>this</p>
1303 </li></ul></div></div></div><div id="method-stopAnimation" class="member inherited"><a href="Ext.AbstractComponent.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.AbstractComponent.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
1304 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.AbstractComponent.html#stopAnimation" rel="Ext.AbstractComponent#stopAnimation" class="docClass">stopAnimation</a>
1305 Stops any running effects and clears this object's internal effects queue if it contains
1306 any additional effects that haven't started yet.</p>
1307 <h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.core.Element</span>&nbsp; &nbsp;<p>The Element</p>
1308 </li></ul></div></div></div><div id="method-suspendEvents" class="member inherited"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-suspendEvents" class="cls expand">suspendEvents</a>(
1309 <span class="pre">Boolean queueSuspended</span>)
1310  : void</div><div class="description"><div class="short"><p>Suspend the firing of all events. (see <a href="Ext.AbstractComponent.html#resumeEvents" rel="Ext.AbstractComponent#resumeEvents" class="docClass">resumeEvents</a>)</p>
1311 </div><div class="long"><p>Suspend the firing of all events. (see <a href="Ext.AbstractComponent.html#resumeEvents" rel="Ext.AbstractComponent#resumeEvents" class="docClass">resumeEvents</a>)</p>
1312 <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
1313 after the <a href="Ext.AbstractComponent.html#resumeEvents" rel="Ext.AbstractComponent#resumeEvents" class="docClass">resumeEvents</a> call instead of discarding all suspended events;</p>
1314 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1315 </li></ul></div></div></div><div id="method-syncFx" class="member inherited"><a href="Ext.AbstractComponent.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.AbstractComponent.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
1316 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
1317 run concurrently.  This is the opposite of <a href="Ext.AbstractComponent.html#sequenceFx" rel="Ext.AbstractComponent#sequenceFx" class="docClass">sequenceFx</a>.</p>
1318 <h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.core.Element</span>&nbsp; &nbsp;<p>The Element</p>
1319 </li></ul></div></div></div><div id="method-un" class="member inherited"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-un" class="cls expand">un</a>(
1320 <span class="pre">String eventName, Function handler, [Object scope]</span>)
1321  : void</div><div class="description"><div class="short"><p>Removes an event handler (shorthand for <a href="Ext.AbstractComponent.html#removeListener" rel="Ext.AbstractComponent#removeListener" class="docClass">removeListener</a>.)</p>
1322 </div><div class="long"><p>Removes an event handler (shorthand for <a href="Ext.AbstractComponent.html#removeListener" rel="Ext.AbstractComponent#removeListener" class="docClass">removeListener</a>.)</p>
1323 <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>
1324 </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.AbstractComponent.html#addListener" rel="Ext.AbstractComponent#addListener" class="docClass">addListener</a> call.</b></p>
1325 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
1326 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1327 </li></ul></div></div></div><div id="method-up" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-up" class="cls expand">up</a>(
1328 <span class="pre">String selector</span>)
1329  : Container</div><div class="description"><div class="short">Walks up the ownerCt axis looking for an ancestor Container which matches
1330 the passed simple selector.
1331
1332
1333 Example:
1334 var ...</div><div class="long"><p>Walks up the <code>ownerCt</code> axis looking for an ancestor Container which matches
1335 the passed simple selector.</p>
1336
1337
1338 <p>Example:
1339 <pre><code>var owningTabPanel = grid.up('tabpanel');
1340 </code></pre>
1341
1342 <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>
1343 </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>
1344 </li></ul></div></div></div><div id="method-update" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="method-update" class="cls expand">update</a>(
1345 <span class="pre">Mixed htmlOrData, [Boolean loadScripts], [Function callback]</span>)
1346  : void</div><div class="description"><div class="short"><p>Update the content area of a component.</p>
1347 </div><div class="long"><p>Update the content area of a component.</p>
1348 <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
1349 then it will use this argument as data to populate the template.
1350 If this component was not configured with a template, the components
1351 content area will be updated via <a href="Ext.core.Element.html" rel="Ext.core.Element" class="docClass">Ext.core.Element</a> update</p>
1352 </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>
1353 </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>
1354 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1355 </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 ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="event-activate" class="cls expand">activate</a>(
1356 <span class="pre">Ext.Component this</span>)
1357 </div><div class="description"><div class="short"><p>Fires after a Component has been visually activated.</p>
1358 </div><div class="long"><p>Fires after a Component has been visually activated.</p>
1359 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
1360 </div></li></ul></div></div></div><div id="event-added" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="event-added" class="cls expand">added</a>(
1361 <span class="pre">Ext.Component this, Ext.container.Container container, Number pos</span>)
1362 </div><div class="description"><div class="short"><p>Fires after a Component had been added to a Container.</p>
1363 </div><div class="long"><p>Fires after a Component had been added to a Container.</p>
1364 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
1365 </div></li><li><span class="pre">container</span> : Ext.container.Container<div class="sub-desc"><p>Parent Container</p>
1366 </div></li><li><span class="pre">pos</span> : Number<div class="sub-desc"><p>position of Component</p>
1367 </div></li></ul></div></div></div><div id="event-afterrender" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="event-afterrender" class="cls expand">afterrender</a>(
1368 <span class="pre">Ext.Component this</span>)
1369 </div><div class="description"><div class="short">Fires after the component rendering is finished.
1370
1371
1372 The afterrender event is fired after this Component has been rende...</div><div class="long"><p>Fires after the component rendering is finished.</p>
1373
1374
1375 <p>The afterrender event is fired after this Component has been <a href="Ext.AbstractComponent.html#rendered" rel="Ext.AbstractComponent#rendered" class="docClass">rendered</a>, been postprocesed
1376 by any afterRender method defined for the Component.</p>
1377
1378 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
1379 </div></li></ul></div></div></div><div id="event-beforeactivate" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="event-beforeactivate" class="cls expand">beforeactivate</a>(
1380 <span class="pre">Ext.Component this</span>)
1381 </div><div class="description"><div class="short">Fires before a Component has been visually activated.
1382 Returning false from an event listener can prevent the activate...</div><div class="long"><p>Fires before a Component has been visually activated.
1383 Returning false from an event listener can prevent the activate
1384 from occurring.</p>
1385 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
1386 </div></li></ul></div></div></div><div id="event-beforedeactivate" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="event-beforedeactivate" class="cls expand">beforedeactivate</a>(
1387 <span class="pre">Ext.Component this</span>)
1388 </div><div class="description"><div class="short">Fires before a Component has been visually deactivated.
1389 Returning false from an event listener can prevent the deacti...</div><div class="long"><p>Fires before a Component has been visually deactivated.
1390 Returning false from an event listener can prevent the deactivate
1391 from occurring.</p>
1392 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
1393 </div></li></ul></div></div></div><div id="event-beforedestroy" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="event-beforedestroy" class="cls expand">beforedestroy</a>(
1394 <span class="pre">Ext.Component this</span>)
1395 </div><div class="description"><div class="short"><p>Fires before the component is <a href="Ext.AbstractComponent.html#destroy" rel="Ext.AbstractComponent#destroy" class="docClass">destroy</a>ed. Return false from an event handler to stop the <a href="Ext.AbstractComponent.html#destroy" rel="Ext.AbstractComponent#destroy" class="docClass">destroy</a>.</p>
1396 </div><div class="long"><p>Fires before the component is <a href="Ext.AbstractComponent.html#destroy" rel="Ext.AbstractComponent#destroy" class="docClass">destroy</a>ed. Return false from an event handler to stop the <a href="Ext.AbstractComponent.html#destroy" rel="Ext.AbstractComponent#destroy" class="docClass">destroy</a>.</p>
1397 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
1398 </div></li></ul></div></div></div><div id="event-beforehide" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="event-beforehide" class="cls expand">beforehide</a>(
1399 <span class="pre">Ext.Component this</span>)
1400 </div><div class="description"><div class="short"><p>Fires before the component is hidden when calling the <a href="Ext.AbstractComponent.html#hide" rel="Ext.AbstractComponent#hide" class="docClass">hide</a> method.
1401 Return false from an event handler to stop the hide.</p>
1402 </div><div class="long"><p>Fires before the component is hidden when calling the <a href="Ext.AbstractComponent.html#hide" rel="Ext.AbstractComponent#hide" class="docClass">hide</a> method.
1403 Return false from an event handler to stop the hide.</p>
1404 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
1405 </div></li></ul></div></div></div><div id="event-beforerender" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="event-beforerender" class="cls expand">beforerender</a>(
1406 <span class="pre">Ext.Component this</span>)
1407 </div><div class="description"><div class="short"><p>Fires before the component is <a href="Ext.AbstractComponent.html#rendered" rel="Ext.AbstractComponent#rendered" class="docClass">rendered</a>. Return false from an
1408 event handler to stop the <a href="Ext.AbstractComponent.html#render" rel="Ext.AbstractComponent#render" class="docClass">render</a>.</p>
1409 </div><div class="long"><p>Fires before the component is <a href="Ext.AbstractComponent.html#rendered" rel="Ext.AbstractComponent#rendered" class="docClass">rendered</a>. Return false from an
1410 event handler to stop the <a href="Ext.AbstractComponent.html#render" rel="Ext.AbstractComponent#render" class="docClass">render</a>.</p>
1411 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
1412 </div></li></ul></div></div></div><div id="event-beforeshow" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="event-beforeshow" class="cls expand">beforeshow</a>(
1413 <span class="pre">Ext.Component this</span>)
1414 </div><div class="description"><div class="short"><p>Fires before the component is shown when calling the <a href="Ext.AbstractComponent.html#show" rel="Ext.AbstractComponent#show" class="docClass">show</a> method.
1415 Return false from an event handler to stop the show.</p>
1416 </div><div class="long"><p>Fires before the component is shown when calling the <a href="Ext.AbstractComponent.html#show" rel="Ext.AbstractComponent#show" class="docClass">show</a> method.
1417 Return false from an event handler to stop the show.</p>
1418 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
1419 </div></li></ul></div></div></div><div id="event-beforestaterestore" class="member inherited"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="event-beforestaterestore" class="cls expand">beforestaterestore</a>(
1420 <span class="pre">Ext.state.Stateful this, Object state</span>)
1421 </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>
1422 </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>
1423 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.state.Stateful<div class="sub-desc">
1424 </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
1425 event is not vetoed, then the state object is passed to <b><tt>applyState</tt></b>. By default,
1426 that simply copies property values into this object. The method maybe overriden to
1427 provide custom state restoration.</p>
1428 </div></li></ul></div></div></div><div id="event-beforestatesave" class="member inherited"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="event-beforestatesave" class="cls expand">beforestatesave</a>(
1429 <span class="pre">Ext.state.Stateful this, Object state</span>)
1430 </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>
1431 </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>
1432 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.state.Stateful<div class="sub-desc">
1433 </div></li><li><span class="pre">state</span> : Object<div class="sub-desc"><p>The hash of state values. This is determined by calling
1434 <b><tt>getState()</tt></b> on the object. This method must be provided by the
1435 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>
1436 has a null implementation.</p>
1437 </div></li></ul></div></div></div><div id="event-deactivate" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="event-deactivate" class="cls expand">deactivate</a>(
1438 <span class="pre">Ext.Component this</span>)
1439 </div><div class="description"><div class="short"><p>Fires after a Component has been visually deactivated.</p>
1440 </div><div class="long"><p>Fires after a Component has been visually deactivated.</p>
1441 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
1442 </div></li></ul></div></div></div><div id="event-destroy" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="event-destroy" class="cls expand">destroy</a>(
1443 <span class="pre">Ext.Component this</span>)
1444 </div><div class="description"><div class="short"><p>Fires after the component is <a href="Ext.AbstractComponent.html#destroy" rel="Ext.AbstractComponent#destroy" class="docClass">destroy</a>ed.</p>
1445 </div><div class="long"><p>Fires after the component is <a href="Ext.AbstractComponent.html#destroy" rel="Ext.AbstractComponent#destroy" class="docClass">destroy</a>ed.</p>
1446 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
1447 </div></li></ul></div></div></div><div id="event-disable" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="event-disable" class="cls expand">disable</a>(
1448 <span class="pre">Ext.Component this</span>)
1449 </div><div class="description"><div class="short"><p>Fires after the component is disabled.</p>
1450 </div><div class="long"><p>Fires after the component is disabled.</p>
1451 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
1452 </div></li></ul></div></div></div><div id="event-enable" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="event-enable" class="cls expand">enable</a>(
1453 <span class="pre">Ext.Component this</span>)
1454 </div><div class="description"><div class="short"><p>Fires after the component is enabled.</p>
1455 </div><div class="long"><p>Fires after the component is enabled.</p>
1456 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
1457 </div></li></ul></div></div></div><div id="event-hide" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="event-hide" class="cls expand">hide</a>(
1458 <span class="pre">Ext.Component this</span>)
1459 </div><div class="description"><div class="short"><p>Fires after the component is hidden.
1460 Fires after the component is hidden when calling the <a href="Ext.AbstractComponent.html#hide" rel="Ext.AbstractComponent#hide" class="docClass">hide</a> method.</p>
1461 </div><div class="long"><p>Fires after the component is hidden.
1462 Fires after the component is hidden when calling the <a href="Ext.AbstractComponent.html#hide" rel="Ext.AbstractComponent#hide" class="docClass">hide</a> method.</p>
1463 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
1464 </div></li></ul></div></div></div><div id="event-move" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="event-move" class="cls expand">move</a>(
1465 <span class="pre">Ext.Component this, Number x, Number y</span>)
1466 </div><div class="description"><div class="short"><p>Fires after the component is moved.</p>
1467 </div><div class="long"><p>Fires after the component is moved.</p>
1468 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
1469 </div></li><li><span class="pre">x</span> : Number<div class="sub-desc"><p>The new x position</p>
1470 </div></li><li><span class="pre">y</span> : Number<div class="sub-desc"><p>The new y position</p>
1471 </div></li></ul></div></div></div><div id="event-removed" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="event-removed" class="cls expand">removed</a>(
1472 <span class="pre">Ext.Component this, Ext.container.Container ownerCt</span>)
1473 </div><div class="description"><div class="short"><p>Fires when a component is removed from an Ext.container.Container</p>
1474 </div><div class="long"><p>Fires when a component is removed from an Ext.container.Container</p>
1475 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
1476 </div></li><li><span class="pre">ownerCt</span> : Ext.container.Container<div class="sub-desc"><p>Container which holds the component</p>
1477 </div></li></ul></div></div></div><div id="event-render" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="event-render" class="cls expand">render</a>(
1478 <span class="pre">Ext.Component this</span>)
1479 </div><div class="description"><div class="short"><p>Fires after the component markup is <a href="Ext.AbstractComponent.html#rendered" rel="Ext.AbstractComponent#rendered" class="docClass">rendered</a>.</p>
1480 </div><div class="long"><p>Fires after the component markup is <a href="Ext.AbstractComponent.html#rendered" rel="Ext.AbstractComponent#rendered" class="docClass">rendered</a>.</p>
1481 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
1482 </div></li></ul></div></div></div><div id="event-resize" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="event-resize" class="cls expand">resize</a>(
1483 <span class="pre">Ext.Component this, Number adjWidth, Number adjHeight</span>)
1484 </div><div class="description"><div class="short"><p>Fires after the component is resized.</p>
1485 </div><div class="long"><p>Fires after the component is resized.</p>
1486 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
1487 </div></li><li><span class="pre">adjWidth</span> : Number<div class="sub-desc"><p>The box-adjusted width that was set</p>
1488 </div></li><li><span class="pre">adjHeight</span> : Number<div class="sub-desc"><p>The box-adjusted height that was set</p>
1489 </div></li></ul></div></div></div><div id="event-show" class="member ni"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="event-show" class="cls expand">show</a>(
1490 <span class="pre">Ext.Component this</span>)
1491 </div><div class="description"><div class="short"><p>Fires after the component is shown when calling the <a href="Ext.AbstractComponent.html#show" rel="Ext.AbstractComponent#show" class="docClass">show</a> method.</p>
1492 </div><div class="long"><p>Fires after the component is shown when calling the <a href="Ext.AbstractComponent.html#show" rel="Ext.AbstractComponent#show" class="docClass">show</a> method.</p>
1493 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
1494 </div></li></ul></div></div></div><div id="event-staterestore" class="member inherited"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="event-staterestore" class="cls expand">staterestore</a>(
1495 <span class="pre">Ext.state.Stateful this, Object state</span>)
1496 </div><div class="description"><div class="short"><p>Fires after the state of the object is restored.</p>
1497 </div><div class="long"><p>Fires after the state of the object is restored.</p>
1498 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.state.Stateful<div class="sub-desc">
1499 </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
1500 to <b><tt>applyState</tt></b>. By default, that simply copies property values into this
1501 object. The method maybe overriden to provide custom state restoration.</p>
1502 </div></li></ul></div></div></div><div id="event-statesave" class="member inherited"><a href="Ext.AbstractComponent.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.AbstractComponent.html#" rel="event-statesave" class="cls expand">statesave</a>(
1503 <span class="pre">Ext.state.Stateful this, Object state</span>)
1504 </div><div class="description"><div class="short"><p>Fires after the state of the object is saved to the configured state provider.</p>
1505 </div><div class="long"><p>Fires after the state of the object is saved to the configured state provider.</p>
1506 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.state.Stateful<div class="sub-desc">
1507 </div></li><li><span class="pre">state</span> : Object<div class="sub-desc"><p>The hash of state values. This is determined by calling
1508 <b><tt>getState()</tt></b> on the object. This method must be provided by the
1509 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>
1510 has a null implementation.</p>
1511 </div></li></ul></div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>