Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / docs / api / Ext.fx.Animator.html
1 <!DOCTYPE html><html><head><title>Ext.fx.Animator | 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.fx.Animator',
13         docClass: 'Ext.fx.Animator',
14         docReq: 'Ext.fx.Animator',
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 = 'Animator.html#Ext-fx.Animator';
33     clsInfo = {"methods":["addEvents","addListener","addManagedListener","capture","clearListeners","clearManagedListeners","enableBubble","fireEvent","hasListener","observe","on","relayEvents","releaseCapture","removeListener","removeManagedListener","resumeEvents","suspendEvents","un"],"cfgs":["delay","duration","dynamic","easing","iterations","keyframes","listeners","target"],"properties":["currentIteration","keyframeStep","paused","running"],"events":["afteranimate","beforeanimate","keyframe"],"subclasses":[]};
34     Ext.onReady(function() {
35         Ext.create('Docs.classPanel');
36     });
37 </script><div id="top-block" class="top-block"><h1 id="clsTitle" class="cls"><a href="../source/Animator.html#Ext-fx.Animator" target="_blank">Ext.fx.Animator</a></h1></div><div id="docContent"><div id="doc-overview-content"><div class="lft"><pre class="subclasses"><h4>Mixins</h4><div class="mixin"><a href="Ext.util.Observable.html" rel="Ext.util.Observable" class="cls docClass">Ext.util.Observable</a></div></pre><p>Animation instance</p>
38
39 <p>This class is used to run keyframe based animations, which follows the CSS3 based animation structure.
40 Keyframe animations differ from typical from/to animations in that they offer the ability to specify values
41 at various points throughout the animation.</p>
42
43 <p><strong>Using Keyframes</strong>
44 The <a href="Ext.fx.Animator.html#keyframes" rel="Ext.fx.Animator#keyframes" class="docClass">keyframes</a> option is the most important part of specifying an animation when using this
45 class. A key frame is a point in a particular animation. We represent this as a percentage of the
46 total animation duration. At each key frame, we can specify the target values at that time. Note that
47 you <em>must</em> specify the values at 0% and 100%, the start and ending values. There is also a <a href="keyframe.html" rel="keyframe" class="docClass">keyframe</a>
48 event that fires after each key frame is reached.</p>
49
50 <p><strong>Example Usage</strong>
51 In the example below, we modify the values of the element at each fifth throughout the animation.</p>
52
53 <pre class="prettyprint"><code>Ext.create('Ext.fx.Animator', {
54     target: Ext.getBody().createChild({
55         style: {
56             width: '100px',
57             height: '100px',
58             'background-color': 'red'
59         }
60     }),
61     duration: 10000, // 10 seconds
62     keyframes: {
63         0: {
64             opacity: 1,
65             backgroundColor: 'FF0000'
66         },
67         20: {
68             x: 30,
69             opacity: 0.5    
70         },
71         40: {
72             x: 130,
73             backgroundColor: '0000FF'    
74         },
75         60: {
76             y: 80,
77             opacity: 0.3    
78         },
79         80: {
80             width: 200,
81             y: 200    
82         },
83         100: {
84             opacity: 1,
85             backgroundColor: '00FF00'
86         }
87     }
88 });
89 </code></pre>
90 <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">Other Configs</h4><div id="config-delay" class="member f ni"><a href="Ext.fx.Animator.html#config-delay" rel="config-delay" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.fx.Animator.html" class="definedIn docClass">Ext.fx.Animator</a><br/><a href="../source/Animator.html#Ext-fx.Animator-cfg-delay" class="viewSource">view source</a></div><a name="delay"></a><a name="config-delay"></a><a href="Ext.fx.Animator.html#" rel="config-delay" class="cls expand">delay</a><span> : Number</span></div><div class="description"><div class="short"><p>Time to delay before starting the animation. Defaults to 0.</p>
91 </div><div class="long"><p>Time to delay before starting the animation. Defaults to 0.</p>
92 </div></div></div><div id="config-duration" class="member ni"><a href="Ext.fx.Animator.html#config-duration" rel="config-duration" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.fx.Animator.html" class="definedIn docClass">Ext.fx.Animator</a><br/><a href="../source/Animator.html#Ext-fx.Animator-cfg-duration" class="viewSource">view source</a></div><a name="duration"></a><a name="config-duration"></a><a href="Ext.fx.Animator.html#" rel="config-duration" class="cls expand">duration</a><span> : Number</span></div><div class="description"><div class="short"><p>Time in milliseconds for the animation to last. Defaults to 250.</p>
93 </div><div class="long"><p>Time in milliseconds for the animation to last. Defaults to 250.</p>
94 </div></div></div><div id="config-dynamic" class="member ni"><a href="Ext.fx.Animator.html#config-dynamic" rel="config-dynamic" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.fx.Animator.html" class="definedIn docClass">Ext.fx.Animator</a><br/><a href="../source/Animator.html#Ext-fx.Animator-cfg-dynamic" class="viewSource">view source</a></div><a name="dynamic"></a><a name="config-dynamic"></a><a href="Ext.fx.Animator.html#" rel="config-dynamic" class="cls expand">dynamic</a><span> : Boolean</span></div><div class="description"><div class="short">Currently only for Component Animation: Only set a component's outer element size bypassing layouts.  Set to true to ...</div><div class="long"><p>Currently only for Component Animation: Only set a component's outer element size bypassing layouts.  Set to true to do full layouts for every frame of the animation.  Defaults to false.</p>
95 </div></div></div><div id="config-easing" class="member ni"><a href="Ext.fx.Animator.html#config-easing" rel="config-easing" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.fx.Animator.html" class="definedIn docClass">Ext.fx.Animator</a><br/><a href="../source/Animator.html#Ext-fx.Animator-cfg-easing" class="viewSource">view source</a></div><a name="easing"></a><a name="config-easing"></a><a href="Ext.fx.Animator.html#" rel="config-easing" class="cls expand">easing</a><span> : String</span></div><div class="description"><div class="short">This describes how the intermediate values used during a transition will be calculated. It allows for a transition to...</div><div class="long"><p>This describes how the intermediate values used during a transition will be calculated. It allows for a transition to change
96 speed over its duration.</p>
97
98 <ul>
99 <li>backIn</li>
100 <li>backOut</li>
101 <li>bounceIn</li>
102 <li>bounceOut</li>
103 <li>ease</li>
104 <li>easeIn</li>
105 <li>easeOut</li>
106 <li>easeInOut</li>
107 <li>elasticIn</li>
108 <li>elasticOut</li>
109 <li>cubic-bezier(x1, y1, x2, y2)</li>
110 </ul>
111
112
113 <p>Note that cubic-bezier will create a custom easing curve following the CSS3 transition-timing-function specification <code><a href="http://www.w3.org/TR/css3-transitions/#transition-timing-function_tag" rel="http://www.w3.org/TR/css3-transitions/#transition-timing-function_tag" class="docClass">http://www.w3.org/TR/css3-transitions/.transition-timing-function_tag</a></code>. The four values specify points P1 and P2 of the curve
114 as (x1, y1, x2, y2). All values must be in the range [0, 1] or the definition is invalid.</p>
115 </div></div></div><div id="config-iterations" class="member ni"><a href="Ext.fx.Animator.html#config-iterations" rel="config-iterations" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.fx.Animator.html" class="definedIn docClass">Ext.fx.Animator</a><br/><a href="../source/Animator.html#Ext-fx.Animator-cfg-iterations" class="viewSource">view source</a></div><a name="iterations"></a><a name="config-iterations"></a><a href="Ext.fx.Animator.html#" rel="config-iterations" class="cls expand">iterations</a><span> : Number</span></div><div class="description"><div class="short"><p>Number of times to execute the animation. Defaults to 1.</p>
116 </div><div class="long"><p>Number of times to execute the animation. Defaults to 1.</p>
117 </div></div></div><div id="config-keyframes" class="member ni"><a href="Ext.fx.Animator.html#config-keyframes" rel="config-keyframes" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.fx.Animator.html" class="definedIn docClass">Ext.fx.Animator</a><br/><a href="../source/Animator.html#Ext-fx.Animator-cfg-keyframes" class="viewSource">view source</a></div><a name="keyframes"></a><a name="config-keyframes"></a><a href="Ext.fx.Animator.html#" rel="config-keyframes" class="cls expand">keyframes</a><span> : Object</span></div><div class="description"><div class="short">Animation keyframes follow the CSS3 Animation configuration pattern. 'from' is always considered '0%' and 'to'
118 is con...</div><div class="long"><p>Animation keyframes follow the CSS3 Animation configuration pattern. 'from' is always considered '0%' and 'to'
119 is considered '100%'.<b>Every keyframe declaration must have a keyframe rule for 0% and 100%, possibly defined using
120 "from" or "to"</b>.  A keyframe declaration without these keyframe selectors is invalid and will not be available for
121 animation.  The keyframe declaration for a keyframe rule consists of properties and values. Properties that are unable to
122 be animated are ignored in these rules, with the exception of 'easing' which can be changed at each keyframe. For example:</p>
123
124 <pre><code>keyframes : {
125     '0%': {
126         left: 100
127     },
128     '40%': {
129         left: 150
130     },
131     '60%': {
132         left: 75
133     },
134     '100%': {
135         left: 100
136     }
137 }
138  </code></pre>
139
140 </div></div></div><div id="config-listeners" class="member inherited"><a href="Ext.fx.Animator.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.fx.Animator.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
141 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
142 object during initialization.  This should be a valid listeners config object as specified in the
143 <a href="Ext.fx.Animator.html#addListener" rel="Ext.fx.Animator#addListener" class="docClass">addListener</a> example for attaching multiple handlers at once.</p></p>
144
145 <br><p><b><u>DOM events from ExtJs <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a></u></b></p>
146
147
148 <br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
149
150
151 <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
152 <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
153 events directly from a child element of a Component, we need to specify the <code>element</code> option to
154 identify the Component property to add a DOM listener to:</p>
155
156 <pre><code>new Ext.panel.Panel({
157     width: 400,
158     height: 200,
159     dockedItems: [{
160         xtype: 'toolbar'
161     }],
162     listeners: {
163         click: {
164             element: 'el', //bind to the underlying el property on the panel
165             fn: function(){ console.log('click el'); }
166         },
167         dblclick: {
168             element: 'body', //bind to the underlying body property on the panel
169             fn: function(){ console.log('dblclick body'); }
170         }
171     }
172 });
173 </code></pre>
174
175
176 <p></p></p>
177 </div></div></div><div id="config-target" class="member ni"><a href="Ext.fx.Animator.html#config-target" rel="config-target" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.fx.Animator.html" class="definedIn docClass">Ext.fx.Animator</a><br/><a href="../source/Animator.html#Ext-fx.Animator-cfg-target" class="viewSource">view source</a></div><a name="target"></a><a name="config-target"></a><a href="Ext.fx.Animator.html#" rel="config-target" class="cls expand">target</a><span> : Ext.fx.target</span></div><div class="description"><div class="short">The Ext.fx.target to apply the animation to.  If not specified during initialization, this can be passed to the apply...</div><div class="long"><p>The Ext.fx.target to apply the animation to.  If not specified during initialization, this can be passed to the applyAnimator
178 method to apply the same animation to many targets.</p>
179 </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-currentIteration" class="member f ni"><a href="Ext.fx.Animator.html#property-currentIteration" rel="property-currentIteration" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.fx.Animator.html" class="definedIn docClass">Ext.fx.Animator</a><br/><a href="../source/Animator.html#Ext-fx.Animator-property-currentIteration" class="viewSource">view source</a></div><a name="currentIteration"></a><a name="property-currentIteration"></a><a href="Ext.fx.Animator.html#" rel="property-currentIteration" class="cls expand">currentIteration</a><span> : int</span></div><div class="description"><div class="short"><p>Current iteration the animation is running.</p>
180 </div><div class="long"><p>Current iteration the animation is running.</p>
181 </div></div></div><div id="property-keyframeStep" class="member ni"><a href="Ext.fx.Animator.html#property-keyframeStep" rel="property-keyframeStep" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.fx.Animator.html" class="definedIn docClass">Ext.fx.Animator</a><br/><a href="../source/Animator.html#Ext-fx.Animator-property-keyframeStep" class="viewSource">view source</a></div><a name="keyframeStep"></a><a name="property-keyframeStep"></a><a href="Ext.fx.Animator.html#" rel="property-keyframeStep" class="cls expand">keyframeStep</a><span> : Number</span></div><div class="description"><div class="short"><p>Current keyframe step of the animation.</p>
182 </div><div class="long"><p>Current keyframe step of the animation.</p>
183 </div></div></div><div id="property-paused" class="member ni"><a href="Ext.fx.Animator.html#property-paused" rel="property-paused" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.fx.Animator.html" class="definedIn docClass">Ext.fx.Animator</a><br/><a href="../source/Animator.html#Ext-fx.Animator-property-paused" class="viewSource">view source</a></div><a name="paused"></a><a name="property-paused"></a><a href="Ext.fx.Animator.html#" rel="property-paused" class="cls expand">paused</a><span> : boolean</span></div><div class="description"><div class="short">Flag to determine if the animation is paused. Only set this to true if you need to
184 keep the Anim instance around to b...</div><div class="long"><p>Flag to determine if the animation is paused. Only set this to true if you need to
185 keep the Anim instance around to be unpaused later; otherwise call <a href="Ext.fx.Animator.html#end" rel="Ext.fx.Animator#end" class="docClass">end</a>.</p>
186 </div></div></div><div id="property-running" class="member ni"><a href="Ext.fx.Animator.html#property-running" rel="property-running" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.fx.Animator.html" class="definedIn docClass">Ext.fx.Animator</a><br/><a href="../source/Animator.html#Ext-fx.Animator-property-running" class="viewSource">view source</a></div><a name="running"></a><a name="property-running"></a><a href="Ext.fx.Animator.html#" rel="property-running" class="cls expand">running</a><span> : boolean</span></div><div class="description"><div class="short"><p>Flag to determine if the animation has started</p>
187 </div><div class="long"><p>Flag to determine if the animation has started</p>
188 </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-addEvents" class="member f inherited"><a href="Ext.fx.Animator.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.fx.Animator.html#" rel="method-addEvents" class="cls expand">addEvents</a>(
189 <span class="pre">Object/String o, String </span>)
190  : void</div><div class="description"><div class="short"><p>Adds the specified events to the list of events which this Observable may fire.</p>
191 </div><div class="long"><p>Adds the specified events to the list of events which this Observable may fire.</p>
192 <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>
193 or the first event name string if multiple event names are being passed as separate parameters.</p>
194 </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.
195 Usage:</p>
196
197 <pre><code>this.addEvents('storeloaded', 'storecleared');
198 </code></pre>
199
200 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
201 </li></ul></div></div></div><div id="method-addListener" class="member inherited"><a href="Ext.fx.Animator.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.fx.Animator.html#" rel="method-addListener" class="cls expand">addListener</a>(
202 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
203  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object.</p>
204 </div><div class="long"><p>Appends an event handler to this object.</p>
205 <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>
206 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes.</p>
207 </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.
208 <b>If omitted, defaults to the object which fired the event.</b></p>
209 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.
210 properties. This may contain any of the following properties:<ul>
211 <li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
212 <b>If omitted, defaults to the object which fired the event.</b></div></li>
213 <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>
214 <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>
215 <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
216 by the specified number of milliseconds. If the event fires again within that time, the original
217 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
218 <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>
219 if the event was bubbled up from a child Observable.</div></li>
220 <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>
221 The name of a Component property which references an element to add a listener to.</p>
222
223 <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
224 will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:
225 <pre><code>new Ext.panel.Panel({
226     title: 'The title',
227     listeners: {
228         click: this.handlePanelClick,
229         element: 'body'
230     }
231 });
232 </code></pre></p>
233
234
235 <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>
236
237
238 <p></div></li>
239 </ul><br></p>
240
241 <p>
242 <b>Combining Options</b><br>
243 Using the options argument, it is possible to combine different types of listeners:<br>
244 <br>
245 A delayed, one-time listener.
246 <pre><code>myPanel.on('hide', this.handleClick, this, {
247 single: true,
248 delay: 100
249 });</code></pre>
250 <p>
251 <b>Attaching multiple handlers in 1 call</b><br>
252 The method also allows for a single argument to be passed which is a config object containing properties
253 which specify multiple events. For example:
254 <pre><code>myGridPanel.on({
255     cellClick: this.onCellClick,
256     mouseover: this.onMouseOver,
257     mouseout: this.onMouseOut,
258     scope: this // Important. Ensure "this" is correct during handler execution
259 });
260 </code></pre>.
261 <p>
262
263 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
264 </li></ul></div></div></div><div id="method-addManagedListener" class="member inherited"><a href="Ext.fx.Animator.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.fx.Animator.html#" rel="method-addManagedListener" class="cls expand">addManagedListener</a>(
265 <span class="pre">Observable/Element item, Object/String ename, Function fn, Object scope, Object opt</span>)
266  : void</div><div class="description"><div class="short"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
267 is destroyed.
268
269 </div><div class="long"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
270 is destroyed.
271
272 <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>
273 </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>
274 </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
275 is the handler function.</p>
276 </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
277 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
278 </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
279 is the <a href="Ext.util.Observable.html#addListener" rel="Ext.util.Observable#addListener" class="docClass">addListener</a> options.</p>
280 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
281 </li></ul></div></div></div><div id="method-capture" class="member inherited"><a href="Ext.fx.Animator.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.fx.Animator.html#" rel="method-capture" class="cls expand">capture</a>(
282 <span class="pre">Observable o, Function fn, [Object scope]</span>)
283  : void</div><div class="description"><div class="short">Starts capture on the specified Observable. All events will be passed
284 to the supplied function with the event name + ...</div><div class="long"><p>Starts capture on the specified Observable. All events will be passed
285 to the supplied function with the event name + standard signature of the event
286 <b>before</b> the event is fired. If the supplied function returns false,
287 the event will not fire.</p>
288 <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>
289 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The function to call when an event is fired.</p>
290 </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>
291 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
292 </li></ul></div></div></div><div id="method-clearListeners" class="member inherited"><a href="Ext.fx.Animator.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.fx.Animator.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>
293 </div><div class="long"><p>Removes all listeners for this object including the managed listeners</p>
294 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
295 </li></ul></div></div></div><div id="method-clearManagedListeners" class="member inherited"><a href="Ext.fx.Animator.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.fx.Animator.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>
296 </div><div class="long"><p>Removes all managed listeners for this object.</p>
297 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
298 </li></ul></div></div></div><div id="method-enableBubble" class="member inherited"><a href="Ext.fx.Animator.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.fx.Animator.html#" rel="method-enableBubble" class="cls expand">enableBubble</a>(
299 <span class="pre">String/Array events</span>)
300  : void</div><div class="description"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
301 this.getBubbleTarget() if present....</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling
302 <code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>
303
304
305 <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
306 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
307 access the required target more quickly.</p>
308
309
310 <p>Example:</p>
311
312
313 <pre><code>Ext.override(Ext.form.field.Base, {
314 //  Add functionality to Field&#39;s initComponent to enable the change event to bubble
315 initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
316     this.enableBubble('change');
317 }),
318
319 //  We know that we want Field&#39;s events to bubble directly to the FormPanel.
320 getBubbleTarget : function() {
321     if (!this.formPanel) {
322         this.formPanel = this.findParentByType('form');
323     }
324     return this.formPanel;
325 }
326 });
327
328 var myForm = new Ext.formPanel({
329 title: 'User Details',
330 items: [{
331     ...
332 }],
333 listeners: {
334     change: function() {
335         // Title goes red if form has been modified.
336         myForm.header.setStyle('color', 'red');
337     }
338 }
339 });
340 </code></pre>
341
342 <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>
343 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
344 </li></ul></div></div></div><div id="method-fireEvent" class="member inherited"><a href="Ext.fx.Animator.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.fx.Animator.html#" rel="method-fireEvent" class="cls expand">fireEvent</a>(
345 <span class="pre">String eventName, Object... args</span>)
346  : Boolean</div><div class="description"><div class="short">Fires the specified event with the passed parameters (minus the event name).
347
348
349 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>
350
351
352 <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>)
353 by calling <a href="Ext.fx.Animator.html#enableBubble" rel="Ext.fx.Animator#enableBubble" class="docClass">enableBubble</a>.</p>
354
355 <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>
356 </div></li><li><span class="pre">args</span> : Object...<div class="sub-desc"><p>Variable number of parameters are passed to handlers.</p>
357 </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>
358 </li></ul></div></div></div><div id="method-hasListener" class="member inherited"><a href="Ext.fx.Animator.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.fx.Animator.html#" rel="method-hasListener" class="cls expand">hasListener</a>(
359 <span class="pre">String eventName</span>)
360  : Boolean</div><div class="description"><div class="short"><p>Checks to see if this object has any listeners for a specified event</p>
361 </div><div class="long"><p>Checks to see if this object has any listeners for a specified event</p>
362 <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>
363 </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>
364 </li></ul></div></div></div><div id="method-observe" class="member inherited"><a href="Ext.fx.Animator.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.fx.Animator.html#" rel="method-observe" class="cls expand">observe</a>(
365 <span class="pre">Function c, Object listeners</span>)
366  : void</div><div class="description"><div class="short">Sets observability on the passed class constructor.
367
368 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>
369
370 <p>This makes any event fired on any instance of the passed class also fire a single event through
371 the <strong>class</strong> allowing for central handling of events on many instances at once.</p>
372
373 <p>Usage:</p>
374
375 <pre><code>Ext.util.Observable.observe(Ext.data.Connection);
376 Ext.data.Connection.on('beforerequest', function(con, options) {
377     console.log('Ajax request made to ' + options.url);
378 });
379 </code></pre>
380 <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>
381 </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.fx.Animator.html#addListener" rel="Ext.fx.Animator#addListener" class="docClass">addListener</a>.</p>
382 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
383 </li></ul></div></div></div><div id="method-on" class="member inherited"><a href="Ext.fx.Animator.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.fx.Animator.html#" rel="method-on" class="cls expand">on</a>(
384 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
385  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object (shorthand for <a href="Ext.fx.Animator.html#addListener" rel="Ext.fx.Animator#addListener" class="docClass">addListener</a>.)</p>
386 </div><div class="long"><p>Appends an event handler to this object (shorthand for <a href="Ext.fx.Animator.html#addListener" rel="Ext.fx.Animator#addListener" class="docClass">addListener</a>.)</p>
387 <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>
388 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes</p>
389 </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.
390 <b>If omitted, defaults to the object which fired the event.</b></p>
391 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.</p>
392 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
393 </li></ul></div></div></div><div id="method-relayEvents" class="member inherited"><a href="Ext.fx.Animator.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.fx.Animator.html#" rel="method-relayEvents" class="cls expand">relayEvents</a>(
394 <span class="pre">Object origin, Array events, Object prefix</span>)
395  : 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>
396 </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>
397 <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>
398 </div></li><li><span class="pre">events</span> : Array<div class="sub-desc"><p>Array of event names to relay.</p>
399 </div></li><li><span class="pre">prefix</span> : Object<div class="sub-desc">
400 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
401 </li></ul></div></div></div><div id="method-releaseCapture" class="member inherited"><a href="Ext.fx.Animator.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.fx.Animator.html#" rel="method-releaseCapture" class="cls expand">releaseCapture</a>(
402 <span class="pre">Observable o</span>)
403  : void</div><div class="description"><div class="short"><p>Removes <b>all</b> added captures from the Observable.</p>
404 </div><div class="long"><p>Removes <b>all</b> added captures from the Observable.</p>
405 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to release</p>
406 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
407 </li></ul></div></div></div><div id="method-removeListener" class="member inherited"><a href="Ext.fx.Animator.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.fx.Animator.html#" rel="method-removeListener" class="cls expand">removeListener</a>(
408 <span class="pre">String eventName, Function handler, [Object scope]</span>)
409  : void</div><div class="description"><div class="short"><p>Removes an event handler.</p>
410 </div><div class="long"><p>Removes an event handler.</p>
411 <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>
412 </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.fx.Animator.html#addListener" rel="Ext.fx.Animator#addListener" class="docClass">addListener</a> call.</b></p>
413 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
414 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
415 </li></ul></div></div></div><div id="method-removeManagedListener" class="member inherited"><a href="Ext.fx.Animator.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.fx.Animator.html#" rel="method-removeManagedListener" class="cls expand">removeManagedListener</a>(
416 <span class="pre">Observable|Element item, Object|String ename, Function fn, Object scope</span>)
417  : void</div><div class="description"><div class="short"><p>Removes listeners that were added by the <a href="Ext.fx.Animator.html#mon" rel="Ext.fx.Animator#mon" class="docClass">mon</a> method.</p>
418 </div><div class="long"><p>Removes listeners that were added by the <a href="Ext.fx.Animator.html#mon" rel="Ext.fx.Animator#mon" class="docClass">mon</a> method.</p>
419 <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>
420 </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>
421 </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
422 is the handler function.</p>
423 </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
424 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
425 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
426 </li></ul></div></div></div><div id="method-resumeEvents" class="member inherited"><a href="Ext.fx.Animator.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.fx.Animator.html#" rel="method-resumeEvents" class="cls expand">resumeEvents</a> : void</div><div class="description"><div class="short">Resume firing events. (see suspendEvents)
427 If events were suspended using the queueSuspended parameter, then all
428 event...</div><div class="long"><p>Resume firing events. (see <a href="Ext.fx.Animator.html#suspendEvents" rel="Ext.fx.Animator#suspendEvents" class="docClass">suspendEvents</a>)
429 If events were suspended using the <code><b>queueSuspended</b></code> parameter, then all
430 events fired during event suspension will be sent to any listeners now.</p>
431 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
432 </li></ul></div></div></div><div id="method-suspendEvents" class="member inherited"><a href="Ext.fx.Animator.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.fx.Animator.html#" rel="method-suspendEvents" class="cls expand">suspendEvents</a>(
433 <span class="pre">Boolean queueSuspended</span>)
434  : void</div><div class="description"><div class="short"><p>Suspend the firing of all events. (see <a href="Ext.fx.Animator.html#resumeEvents" rel="Ext.fx.Animator#resumeEvents" class="docClass">resumeEvents</a>)</p>
435 </div><div class="long"><p>Suspend the firing of all events. (see <a href="Ext.fx.Animator.html#resumeEvents" rel="Ext.fx.Animator#resumeEvents" class="docClass">resumeEvents</a>)</p>
436 <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
437 after the <a href="Ext.fx.Animator.html#resumeEvents" rel="Ext.fx.Animator#resumeEvents" class="docClass">resumeEvents</a> call instead of discarding all suspended events;</p>
438 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
439 </li></ul></div></div></div><div id="method-un" class="member inherited"><a href="Ext.fx.Animator.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.fx.Animator.html#" rel="method-un" class="cls expand">un</a>(
440 <span class="pre">String eventName, Function handler, [Object scope]</span>)
441  : void</div><div class="description"><div class="short"><p>Removes an event handler (shorthand for <a href="Ext.fx.Animator.html#removeListener" rel="Ext.fx.Animator#removeListener" class="docClass">removeListener</a>.)</p>
442 </div><div class="long"><p>Removes an event handler (shorthand for <a href="Ext.fx.Animator.html#removeListener" rel="Ext.fx.Animator#removeListener" class="docClass">removeListener</a>.)</p>
443 <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>
444 </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.fx.Animator.html#addListener" rel="Ext.fx.Animator#addListener" class="docClass">addListener</a> call.</b></p>
445 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
446 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
447 </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-afteranimate" class="member f ni"><a href="Ext.fx.Animator.html#event-afteranimate" rel="event-afteranimate" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.fx.Animator.html" class="definedIn docClass">Ext.fx.Animator</a><br/><a href="../source/Animator.html#Ext-fx.Animator-event-afteranimate" class="viewSource">view source</a></div><a name="afteranimate"></a><a name="event-afteranimate"></a><a href="Ext.fx.Animator.html#" rel="event-afteranimate" class="cls expand">afteranimate</a>(
448 <span class="pre">Ext.fx.Animator this, Date startTime</span>)
449 </div><div class="description"><div class="short"><p>Fires when the animation is complete.</p>
450 </div><div class="long"><p>Fires when the animation is complete.</p>
451 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.fx.Animator<div class="sub-desc">
452 </div></li><li><span class="pre">startTime</span> : Date<div class="sub-desc">
453 </div></li></ul></div></div></div><div id="event-beforeanimate" class="member ni"><a href="Ext.fx.Animator.html#event-beforeanimate" rel="event-beforeanimate" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.fx.Animator.html" class="definedIn docClass">Ext.fx.Animator</a><br/><a href="../source/Animator.html#Ext-fx.Animator-event-beforeanimate" class="viewSource">view source</a></div><a name="beforeanimate"></a><a name="event-beforeanimate"></a><a href="Ext.fx.Animator.html#" rel="event-beforeanimate" class="cls expand">beforeanimate</a>(
454 <span class="pre">Ext.fx.Animator this</span>)
455 </div><div class="description"><div class="short"><p>Fires before the animation starts. A handler can return false to cancel the animation.</p>
456 </div><div class="long"><p>Fires before the animation starts. A handler can return false to cancel the animation.</p>
457 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.fx.Animator<div class="sub-desc">
458 </div></li></ul></div></div></div><div id="event-keyframe" class="member ni"><a href="Ext.fx.Animator.html#event-keyframe" rel="event-keyframe" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.fx.Animator.html" class="definedIn docClass">Ext.fx.Animator</a><br/><a href="../source/Animator.html#Ext-fx.Animator-event-keyframe" class="viewSource">view source</a></div><a name="keyframe"></a><a name="event-keyframe"></a><a href="Ext.fx.Animator.html#" rel="event-keyframe" class="cls expand">keyframe</a>(
459 <span class="pre">Ext.fx.Animator this, Number keyframe</span>)
460 </div><div class="description"><div class="short"><p>Fires at each keyframe.</p>
461 </div><div class="long"><p>Fires at each keyframe.</p>
462 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.fx.Animator<div class="sub-desc">
463 </div></li><li><span class="pre">keyframe</span> : Number<div class="sub-desc"><p>step number</p>
464 </div></li></ul></div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>