docs/api/Ext.fx.Anim.html

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