| Package | mx.effects.effectClasses |
| Class | public class AnimatePropertyInstance |
| Inheritance | AnimatePropertyInstance  TweenEffectInstance EffectInstance EventDispatcher Object |
Every effect class that is a subclass of the TweenEffect class supports the following events:
tweenEnd: Dispatched when the tween effect ends. tweenUpdate: Dispatched every time a TweenEffect
class calculates a new value.The event object passed to the event listener for these events is of type TweenEvent.
The TweenEvent class defines the property value, which contains
the tween value calculated by the effect.
For the AnimateProperty effect,
the TweenEvent.value property contains a Number between the values of
the AnimateProperty.fromValue and
AnimateProperty.toValue properties, for the target
property specified by AnimateProperty.property.
See also
| Property | Defined by | ||
|---|---|---|---|
 | className : String
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 | |
| duration : Number
Duration of the effect in milliseconds.
| EffectInstance | |
| easingFunction : Function
The easing function for the animation.
| TweenEffectInstance | |
| effect : Effect | EffectInstance | |
| fromValue : Number
The starting value of the property for the effect.
| AnimatePropertyInstance | ||
| isStyle : Boolean = false
If
true, the property attribute is a style and you
set it by using the setStyle() method. | AnimatePropertyInstance | ||
| playheadTime : Number
The current position of the effect, in milliseconds.
| TweenEffectInstance | |
| property : String
The name of the property on the target to animate.
| AnimatePropertyInstance | ||
| propertyChanges : PropertyChanges | EffectInstance | |
| prototype : Object
[static]
A reference to the prototype object of a class or function object.
| Object | |
| repeatCount : int | EffectInstance | |
| repeatDelay : int | EffectInstance | |
| roundValue : Boolean = false
If
true, round off the interpolated tweened value
to the nearest integer. | AnimatePropertyInstance | ||
| startDelay : int | EffectInstance | |
| suspendBackgroundProcessing : Boolean | EffectInstance | |
| target : Object | EffectInstance | |
| toValue : Number
The ending value for the effect.
| AnimatePropertyInstance | ||
| triggerEvent : Event | EffectInstance | |
| tween : Tween
The Tween object, which determines the animation.
| TweenEffectInstance | |
| Method | Defined by | ||
|---|---|---|---|
|
AnimatePropertyInstance(target:Object)
Constructor.
| AnimatePropertyInstance | ||
|
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 | |
|
end():void
Interrupts an effect that is currently playing,
and immediately jumps to the end of the effect.
| TweenEffectInstance | |
|
finishEffect():void
Called by the
end() method when the effect
finishes playing. | EffectInstance | |
|
finishRepeat():void
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 | |
|
initEffect(event:Event):void
This method is called if the effect was triggered by the EffectManager.
| EffectInstance | |
|
onTweenEnd(value:Object):void
Callback method that is called when the target should be updated
by the effect for the last time.
| TweenEffectInstance | |
|
onTweenUpdate(value:Object):void
Callback method that is called when the target should be updated
by the effect.
| TweenEffectInstance | |
|
pause():void
Pauses the effect until you call the
resume() method. | EffectInstance | |
|
play():void
Plays the effect instance on the target.
| EffectInstance | |
|
Removes a listener from the EventDispatcher object.
| EventDispatcher | |
|
resume():void
Resumes the effect after it has been paused
by a call to the
pause() method. | EffectInstance | |
|
reverse():void
Plays the effect in reverse, starting from the current position of the effect.
| EffectInstance | |
|
Advances the effect to the specified position.
| TweenEffectInstance | |
|
Sets the availability of a dynamic property for loop operations.
| Object | |
|
startEffect():void
Plays the effect instance on the target after the
startDelay period
has elapsed. | EffectInstance | |
|
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 | |
| fromValue | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic var fromValue:NumberThe starting value of the property for the effect. The default value is the target's current property value.
| isStyle | property |
public var isStyle:Boolean = false
If true, the property attribute is a style and you
set it by using the setStyle() method.
The default value is false.
| property | property |
public var property:StringThe name of the property on the target to animate. This attribute is required.
| roundValue | property |
public var roundValue:Boolean = false
If true, round off the interpolated tweened value
to the nearest integer.
This property is useful if the property you are animating
is an int or uint.
The default value is false.
| toValue | property |
public var toValue:NumberThe ending value for the effect. The default value is the target's current property value.
| AnimatePropertyInstance | () | constructor |
public function AnimatePropertyInstance(target:Object)Constructor.
Parameterstarget:Object — The Object to animate with this effect.
|