Package | mx.effects.effectClasses |
Class | public class AnimatePropertyInstance |
Inheritance | AnimatePropertyInstance TweenEffectInstance EffectInstance flash.events.EventDispatcher |
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
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 [read-only]
The name of the effect class, such as "FadeInstance". | EffectInstance | ||
duration : Number
The duration of the effect, in milliseconds. | EffectInstance | ||
easingFunction : Function
The easing function for the animation. | TweenEffectInstance | ||
effect : IEffect
The IEffect object that created this IEffectInstance object. | EffectInstance | ||
effectTargetHost : IEffectTargetHost
A property that lets you access the target
list-based control of a data effect. | EffectInstance | ||
fromValue : Number
The starting value of the property for the effect. | AnimatePropertyInstance | ||
hideFocusRing : Boolean
Determines whether the effect should hide
the focus ring when starting the effect. | EffectInstance | ||
isStyle : Boolean = false
If true, the property attribute is a style and you
set it by using the setStyle() method. | AnimatePropertyInstance | ||
playheadTime : Number [override]
Current time position of the effect. | TweenEffectInstance | ||
property : String
The name of the property on the target to animate. | AnimatePropertyInstance | ||
propertyChanges : PropertyChanges
Specifies the PropertyChanges object containing
the start and end values for the set of properties
relevant to the effect's targets. | EffectInstance | ||
repeatCount : int
Number of times to repeat the effect. | EffectInstance | ||
repeatDelay : int
Amount of time, in milliseconds,
to wait before repeating the effect. | EffectInstance | ||
roundValue : Boolean = false
If true, round off the interpolated tweened value
to the nearest integer. | AnimatePropertyInstance | ||
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 | ||
toValue : Number
The ending value for the effect. | AnimatePropertyInstance | ||
triggerEvent : Event
The event, if any, which triggered the playing of the effect. | EffectInstance | ||
tween : Tween
The Tween object, which determines the animation. | TweenEffectInstance |
Method | Defined By | ||
---|---|---|---|
AnimatePropertyInstance(target:Object)
Constructor. | AnimatePropertyInstance | ||
end():void [override]
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 | ||
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 | ||
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 | ||
startEffect():void
Plays the effect instance on the target after the
startDelay period has elapsed. | EffectInstance | ||
stop():void
Stops the effect, leaving the target in its current state. | EffectInstance |
fromValue | property |
public var fromValue:Number
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
The 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
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
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:String
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
The name of the property on the target to animate. This attribute is required.
roundValue | property |
public var roundValue:Boolean = false
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
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:Number
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
The ending value for the effect. The default value is the target's current property value.
AnimatePropertyInstance | () | Constructor |
public function AnimatePropertyInstance(target:Object)
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Constructor.
Parameterstarget:Object — The Object to animate with this effect.
|