/**
* @class Ext.fx.Anim
- *
+ *
* This class manages animation for a specific {@link #target}. The animation allows
* animation of various properties on the target, such as size, position, color and others.
- *
+ *
* ## Starting Conditions
* The starting conditions for the animation are provided by the {@link #from} configuration.
* Any/all of the properties in the {@link #from} configuration can be specified. If a particular
* property is not defined, the starting value for that property will be read directly from the target.
- *
+ *
* ## End Conditions
* The ending conditions for the animation are provided by the {@link #to} configuration. These mark
* the final values once the animations has finished. The values in the {@link #from} can mirror
* those in the {@link #to} configuration to provide a starting point.
- *
+ *
* ## Other Options
* - {@link #duration}: Specifies the time period of the animation.
* - {@link #easing}: Specifies the easing of the animation.
* - {@link #iterations}: Allows the animation to repeat a number of times.
* - {@link #alternate}: Used in conjunction with {@link #iterations}, reverses the direction every second iteration.
- *
+ *
* ## Example Code
- *
+ *
+ * @example
* var myComponent = Ext.create('Ext.Component', {
* renderTo: document.body,
* width: 200,
* height: 200,
* style: 'border: 1px solid red;'
* });
- *
- * new Ext.fx.Anim({
+ *
+ * Ext.create('Ext.fx.Anim', {
* target: myComponent,
* duration: 1000,
* from: {
@@ -54,14 +72,25 @@ Ext.define('Ext.fx.Anim', {
/* End Definitions */
isAnimation: true,
- /**
+
+ /**
+ * @cfg {Function} callback
+ * A function to be run after the animation has completed.
+ */
+
+ /**
+ * @cfg {Function} scope
+ * The scope that the {@link #callback} function will be called with
+ */
+
+ /**
* @cfg {Number} duration
* Time in milliseconds for a single animation to last. Defaults to 250. If the {@link #iterations} property is
* specified, then each animate will take the same duration for each iteration.
*/
duration: 250,
- /**
+ /**
* @cfg {Number} delay
* Time to delay before starting the animation. Defaults to 0.
*/
@@ -70,16 +99,16 @@ Ext.define('Ext.fx.Anim', {
/* private used to track a delayed starting time */
delayStart: 0,
- /**
+ /**
* @cfg {Boolean} dynamic
* 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.
*/
dynamic: false,
- /**
+ /**
* @cfg {String} easing
This describes how the intermediate values used during a transition will be calculated. It allows for a transition to change
-speed over its duration.
+speed over its duration.
-backIn
-backOut
@@ -93,13 +122,17 @@ speed over its duration.
-elasticOut
-cubic-bezier(x1, y1, x2, y2)
-Note that cubic-bezier will create a custom easing curve following the CSS3 transition-timing-function specification `{@link http://www.w3.org/TR/css3-transitions/#transition-timing-function_tag}`. The four values specify points P1 and P2 of the curve
-as (x1, y1, x2, y2). All values must be in the range [0, 1] or the definition is invalid.
+Note that cubic-bezier will create a custom easing curve following the CSS3 [transition-timing-function][0]
+specification. The four values specify points P1 and P2 of the curve as (x1, y1, x2, y2). All values must
+be in the range [0, 1] or the definition is invalid.
+
+[0]: http://www.w3.org/TR/css3-transitions/#transition-timing-function_tag
+
* @markdown
*/
easing: 'ease',
- /**
+ /**
* @cfg {Object} keyframes
* Animation keyframes follow the CSS3 Animation configuration pattern. 'from' is always considered '0%' and 'to'
* is considered '100%'.<b>Every keyframe declaration must have a keyframe rule for 0% and 100%, possibly defined using
@@ -124,73 +157,73 @@ keyframes : {
</code></pre>
*/
- /**
+ /**
* @private
*/
damper: 1,
- /**
+ /**
* @private
*/
bezierRE: /^(?:cubic-)?bezier\(([^,]+),([^,]+),([^,]+),([^\)]+)\)/,
- /**
+ /**
* Run the animation from the end to the beginning
* Defaults to false.
* @cfg {Boolean} reverse
*/
reverse: false,
- /**
+ /**
* Flag to determine if the animation has started
* @property running
- * @type boolean
+ * @type Boolean
*/
running: false,
- /**
+ /**
* Flag to determine if the animation is paused. Only set this to true if you need to
* keep the Anim instance around to be unpaused later; otherwise call {@link #end}.
* @property paused
- * @type boolean
+ * @type Boolean
*/
paused: false,
- /**
+ /**
* Number of times to execute the animation. Defaults to 1.
- * @cfg {int} iterations
+ * @cfg {Number} iterations
*/
iterations: 1,
- /**
+ /**
* Used in conjunction with iterations to reverse the animation each time an iteration completes.
* @cfg {Boolean} alternate
* Defaults to false.
*/
alternate: false,
- /**
+ /**
* Current iteration the animation is running.
* @property currentIteration
- * @type int
+ * @type Number
*/
currentIteration: 0,
- /**
+ /**
* Starting time of the animation.
* @property startTime
* @type Date
*/
startTime: 0,
- /**
+ /**
* Contains a cache of the interpolators to be used.
* @private
* @property propHandlers
* @type Object
*/
- /**
+ /**
* @cfg {String/Object} target
* The {@link Ext.fx.target.Target} to apply the animation to. This should only be specified when creating an Ext.fx.Anim directly.
* The target does not need to be a {@link Ext.fx.target.Target} instance, it can be the underlying object. For example, you can
@@ -198,7 +231,7 @@ keyframes : {
* automatically.
*/
- /**
+ /**
* @cfg {Object} from
* An object containing property/value pairs for the beginning of the animation. If not specified, the current state of the
* Ext.fx.target will be used. For example:
@@ -211,7 +244,7 @@ from : {
</code></pre>
*/
- /**
+ /**
* @cfg {Object} to
* An object containing property/value pairs for the end of the animation. For example:
<pre><code>
@@ -225,7 +258,9 @@ from : {
// @private
constructor: function(config) {
- var me = this;
+ var me = this,
+ curve;
+
config = config || {};
// If keyframes are passed, they really want an Animator instead.
if (config.keyframes) {
@@ -245,27 +280,27 @@ from : {
if (!me.easingFn) {
me.easingFn = String(me.easing).match(me.bezierRE);
if (me.easingFn && me.easingFn.length == 5) {
- var curve = me.easingFn;
- me.easingFn = Ext.fx.cubicBezier(+curve[1], +curve[2], +curve[3], +curve[4]);
+ curve = me.easingFn;
+ me.easingFn = Ext.fx.CubicBezier.cubicBezier(+curve[1], +curve[2], +curve[3], +curve[4]);
}
}
me.id = Ext.id(null, 'ext-anim-');
Ext.fx.Manager.addAnim(me);
me.addEvents(
- /**
+ /**
* @event beforeanimate
* Fires before the animation starts. A handler can return false to cancel the animation.
* @param {Ext.fx.Anim} this
*/
'beforeanimate',
- /**
+ /**
* @event afteranimate
* Fires when the animation is complete.
* @param {Ext.fx.Anim} this
* @param {Date} startTime
*/
'afteranimate',
- /**
+ /**
* @event lastframe
* Fires when the animation's last frame has been set.
* @param {Ext.fx.Anim} this
@@ -280,7 +315,7 @@ from : {
return me;
},
- /**
+ /**
* @private
* Helper to the target
*/
@@ -288,8 +323,8 @@ from : {
return Ext.fx.Manager.items.get(this.id).setAttr(this.target, attr, value);
},
- /*
- * @private
+ /**
+ * @private
* Set up the initial currentAttrs hash.
*/
initAttrs: function() {
@@ -322,8 +357,8 @@ from : {
me.currentAttrs = out;
},
- /*
- * @private
+ /**
+ * @private
* Fires beforeanimate and sets the running flag.
*/
start: function(startTime) {
@@ -356,8 +391,8 @@ from : {
}
},
- /*
- * @private
+ /**
+ * @private
* Calculate attribute value at the passed timestamp.
* @returns a hash of the new attributes.
*/
@@ -388,8 +423,8 @@ from : {
return ret;
},
- /*
- * @private
+ /**
+ * @private
* Perform lastFrame cleanup and handle iterations
* @returns a hash of the new attributes.
*/
@@ -415,8 +450,8 @@ from : {
}
},
- /*
- * Fire afteranimate event and end the animation. Usually called automatically when the
+ /**
+ * Fire afteranimate event and end the animation. Usually called automatically when the
* animation reaches its final frame, but can also be called manually to pre-emptively
* stop and destroy the running animation.
*/
@@ -431,4 +466,6 @@ from : {
});
// Set flag to indicate that Fx is available. Class might not be available immediately.
Ext.enableFx = true;
-