Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
IAnimationTarget

Package | spark.effects.animation
Interface | public interface IAnimationTarget
Implementors | AnimateInstance, AnimationTarget

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The IAnimationTarget interface is implemented by classes that support the events for an Animation instance.

See also

spark.effects.animation.Animation

Public Methods

| Method | Defined By
--- | --- | ---
|  | animationEnd(animation:Animation):void Called when an Animation instance ends. | IAnimationTarget
|  | animationRepeat(animation:Animation):void Called when an Animation instance repeats. | IAnimationTarget
|  | animationStart(animation:Animation):void Called when an Animation instance starts. | IAnimationTarget
|  | animationStop(animation:Animation):void Called when an Animation instance stops. | IAnimationTarget
|  | animationUpdate(animation:Animation):void Called during every update of an Animation instance. | IAnimationTarget

Method Detail

animationEnd | () | method

`public function animationEnd(animation:Animation):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Called when an Animation instance ends.

Parameters

| `animation:Animation` — The Animation object.

animationRepeat | () | method |

`public function animationRepeat(animation:Animation):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Called when an Animation instance repeats. The Animation instance must have a `repeatCount` equal to 0 (infinitely repeating) or a value greater than 1.

Parameters

| `animation:Animation` — The Animation object.

animationStart | () | method |

`public function animationStart(animation:Animation):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Called when an Animation instance starts. If there is a `startDelay` on the Animation, this function is called after that delay.

Parameters

| `animation:Animation` — The Animation object.

animationStop | () | method |

`public function animationStop(animation:Animation):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Called when an Animation instance stops. This is different than `animationEnd()` method, which is called when the animation ends, automatically setting the end values of the targets. The `animationStop()` method is called when an animation is stopped where it's at. Handling this event allows necessary cleanup when the animation is interrupted.

Parameters

| `animation:Animation` — The Animation object.

animationUpdate | () | method |

`public function animationUpdate(animation:Animation):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Called during every update of an Animation instance. If an implementation class is listening to an Animation specifically to be able to do something after the Animation values are calculated for a given time, this is the function in which those values should be used. The other methods in this interface are more informational. They tell the listeners when the Animation starts, stops, or repeats. This method is called when values have been calculated and something can be done with them.

Parameters

| `animation:Animation` — The Animation object.

Sun Mar 5 2017, 03:42 PM +11:00