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