Package | spark.effects.supportClasses |
Class | public class AnimateInstance |
Inheritance | AnimateInstance EffectInstance EventDispatcher Object |
Implements | IAnimationTarget |
Subclasses | AnimateColorInstance, AnimateFilterInstance, AnimateTransformInstance, AnimateTransitionShaderInstance, FadeInstance, ResizeInstance |
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
Related API Elements
Property | Defined By | ||
---|---|---|---|
className : String [read-only]
The name of the effect class, such as "FadeInstance". | EffectInstance | ||
constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | ||
disableLayout : Boolean
If true, the effect disables layout on its
targets' parent containers, setting the containers autoLayout
property to false, and also disables any layout constraints on the
target objects. | AnimateInstance | ||
duration : Number
The duration of the effect, in milliseconds. | EffectInstance | ||
easer : IEaser
The easing behavior for this effect. | AnimateInstance | ||
effect : IEffect
The IEffect object that created this IEffectInstance object. | EffectInstance | ||
effectTargetHost : mx.effects:IEffectTargetHost
A property that lets you access the target
list-based control of a data effect. | EffectInstance | ||
hideFocusRing : Boolean
Determines whether the effect should hide
the focus ring when starting the effect. | EffectInstance | ||
interpolator : IInterpolator
The interpolator used by this effect to calculate values between
the start and end values of a property. | AnimateInstance | ||
motionPaths : Vector.<MotionPath>
A Vector of MotionPath objects, each of which holds the
name of a property being animated and the values that the property
takes during the animation. | AnimateInstance | ||
playheadTime : Number [override]
Current time position of the effect. | AnimateInstance | ||
propertyChanges : PropertyChanges
Specifies the PropertyChanges object containing
the start and end values for the set of properties
relevant to the effect's targets. | EffectInstance | ||
prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | ||
repeatBehavior : String
The behavior of a repeating effect, which means an effect
with repeatCount equal to either 0 or > 1. | AnimateInstance | ||
repeatCount : int
Number of times to repeat the effect. | EffectInstance | ||
repeatDelay : int
Amount of time, in milliseconds,
to wait before repeating the effect. | EffectInstance | ||
startDelay : int
Amount of time, in milliseconds,
to wait before starting the effect. | EffectInstance | ||
suspendBackgroundProcessing : Boolean
If true, blocks all background processing
while the effect is playing. | EffectInstance | ||
target : Object
The UIComponent object to which this effect is applied. | EffectInstance | ||
triggerEvent : Event
The event, if any, which triggered the playing of the effect. | EffectInstance |
Property | Defined By | ||
---|---|---|---|
autoRemoveTarget : Boolean = false
If true, the effect retains its target
during a transition and removes it when finished. | AnimateInstance | ||
playCount : int = 0
Number of times that the instance has been played. | EffectInstance |
Method | Defined By | ||
---|---|---|---|
AnimateInstance(target:Object)
Constructor. | AnimateInstance | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | ||
Dispatches an event into the event flow. | EventDispatcher | ||
Interrupts an effect instance that is currently playing,
and jumps immediately to the end of the effect. | EffectInstance | ||
Called by the end() method when the effect
finishes playing. | EffectInstance | ||
Called after each iteration of a repeated effect finishes playing. | EffectInstance | ||
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | ||
Indicates whether an object has a specified property defined. | Object | ||
This method is called if the effect was triggered by the EffectManager. | EffectInstance | ||
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | ||
Pauses the effect until you call the resume() method. | EffectInstance | ||
Plays the effect instance on the target. | EffectInstance | ||
Indicates whether the specified property exists and is enumerable. | Object | ||
Removes a listener from the EventDispatcher object. | EventDispatcher | ||
Resumes the effect after it has been paused
by a call to the pause() method. | EffectInstance | ||
Plays the effect in reverse, starting from
the current position of the effect. | EffectInstance | ||
Sets the availability of a dynamic property for loop operations. | Object | ||
Plays the effect instance on the target after the
startDelay period has elapsed. | EffectInstance | ||
Stops the effect, leaving the target in its current state. | EffectInstance | ||
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | ||
Returns the string representation of the specified object. | Object | ||
Returns the primitive value of the specified object. | Object | ||
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher |
autoRemoveTarget | property |
protected var autoRemoveTarget:Boolean = false
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
If true
, the effect retains its target
during a transition and removes it when finished.
This capability applies specifically to effects like
Fade which act on targets that go away at the end of the
transition and removes the need to supply a RemoveAction or similar
effect to manually keep the item around and remove it when the
transition completes.
To use this capability, subclasses
should set this variable to true
and also expose the parent
property in their affectedProperties
Array so
that the effect instance has enough information about the target
and container to do the job.
disableLayout | property |
public var disableLayout:Boolean
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
If true
, the effect disables layout on its
targets' parent containers, setting the containers autoLayout
property to false, and also disables any layout constraints on the
target objects. These properties are restored when the effect
finishes.
easer | property |
easer:IEaser
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
The easing behavior for this effect. This IEaser object is used to convert the elapsed fraction of the animation into an eased fraction, which is then used to calculate the value at that eased elapsed fraction.
Note that it is possible to have easing at both the effect
level and the Keyframe level (where Keyframes hold the values/times
used in the MotionPath structures).
These easing behaviors build on each other.
The easer
controls the easing of the overall effect.
The Keyframe controls the easing in any particular interval of the animation.
By default, the easing for Animate is non-linear (Sine(.5)).
The easing for Keyframes is linear. If you desire an effect with easing
at the keyframe level instead, you can set the easing of the
effect to linear, and then set the easing specifically on the Keyframes.
Implementation
public function get easer():IEaser
public function set easer(value:IEaser):void
interpolator | property |
interpolator:IInterpolator
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
The interpolator used by this effect to calculate values between
the start and end values of a property.
By default, the NumberInterpolator class handles interpolation
or, in the case of the start
and end values being Arrays or Vectors, by the
MultiValueInterpolator class.
Interpolation of other types, or of Numbers that should be interpolated
differently, such as uint
values that hold color
channel information, can be handled by supplying a different
interpolator.
Implementation
public function get interpolator():IInterpolator
public function set interpolator(value:IInterpolator):void
motionPaths | property |
motionPaths:Vector.<MotionPath>
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
A Vector of MotionPath objects, each of which holds the
name of a property being animated and the values that the property
takes during the animation.
This Vector takes precedence over
any properties declared in subclasses of Animate.
For example, if this Array is set directly on a Move effect,
then any properties of the Move effect, such as xFrom
, are ignored.
Implementation
public function get motionPaths():Vector.<MotionPath>
public function set motionPaths(value:Vector.<MotionPath>):void
playheadTime | property |
playheadTime:Number
[override] Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
Current time position of the effect.
This property has a value between 0 and the total duration,
which includes the Effect's startDelay
,
repeatCount
, and repeatDelay
.
Implementation
override public function get playheadTime():Number
override public function set playheadTime(value:Number):void
repeatBehavior | property |
repeatBehavior:String
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
The behavior of a repeating effect, which means an effect
with repeatCount
equal to either 0 or > 1. This
value should be either RepeatBehavior.LOOP
, which means the animation
repeats in the same order each time, or RepeatBehavior.REVERSE
,
which means the animation reverses direction on each iteration.
Implementation
public function get repeatBehavior():String
public function set repeatBehavior(value:String):void
AnimateInstance | () | Constructor |
Mon Nov 28 2011, 06:48 AM -08:00