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