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