Adobe® Flex® 4 Language Reference
Show Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
mx.effects.effectClasses 
TweenEffectInstance 
Packagemx.effects.effectClasses
Classpublic class TweenEffectInstance
InheritanceTweenEffectInstance Inheritance EffectInstance Inheritance EventDispatcher Inheritance Object
Subclasses AnimatePropertyInstance, BlurInstance, DissolveInstance, FadeInstance, GlowInstance, MoveInstance, PauseInstance, ResizeInstance, RotateInstance, SeriesEffectInstance, ZoomInstance

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The TweenEffectInstance class implements the instance class for the TweenEffect. Flex creates an instance of this class when it plays a TweenEffect; you do not create one yourself.

See also



Public Properties
 PropertyDefined By
 InheritedclassName : String
[read-only] The name of the effect class, such as "FadeInstance".
EffectInstance
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 Inheritedduration : Number
The duration of the effect, in milliseconds.
EffectInstance
  easingFunction : Function
The easing function for the animation.
TweenEffectInstance
 Inheritedeffect : IEffect
The IEffect object that created this IEffectInstance object.
EffectInstance
 InheritedeffectTargetHost : mx.effects:IEffectTargetHost
A property that lets you access the target list-based control of a data effect.
EffectInstance
 InheritedhideFocusRing : Boolean
Determines whether the effect should hide the focus ring when starting the effect.
EffectInstance
  playheadTime : Number
[override] Current time position of the effect.
TweenEffectInstance
 InheritedpropertyChanges : PropertyChanges
Specifies the PropertyChanges object containing the start and end values for the set of properties relevant to the effect's targets.
EffectInstance
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 InheritedrepeatCount : int
Number of times to repeat the effect.
EffectInstance
 InheritedrepeatDelay : int
Amount of time, in milliseconds, to wait before repeating the effect.
EffectInstance
 InheritedstartDelay : int
Amount of time, in milliseconds, to wait before starting the effect.
EffectInstance
 InheritedsuspendBackgroundProcessing : Boolean
If true, blocks all background processing while the effect is playing.
EffectInstance
 Inheritedtarget : Object
The UIComponent object to which this effect is applied.
EffectInstance
 InheritedtriggerEvent : Event
The event, if any, which triggered the playing of the effect.
EffectInstance
  tween : mx.effects:Tween
The Tween object, which determines the animation.
TweenEffectInstance
Protected Properties
 PropertyDefined By
 InheritedplayCount : int = 0
Number of times that the instance has been played.
EffectInstance
Public Methods
 MethodDefined By
  
Constructor.
TweenEffectInstance
 Inherited
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
 Inherited
Dispatches an event into the event flow.
EventDispatcher
  
[override] Interrupts an effect that is currently playing, and immediately jumps to the end of the effect.
TweenEffectInstance
 Inherited
Called by the end() method when the effect finishes playing.
EffectInstance
 Inherited
Called after each iteration of a repeated effect finishes playing.
EffectInstance
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
This method is called if the effect was triggered by the EffectManager.
EffectInstance
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
  
Callback method that is called when the target should be updated by the effect for the last time.
TweenEffectInstance
  
Callback method that is called when the target should be updated by the effect.
TweenEffectInstance
 Inherited
Pauses the effect until you call the resume() method.
EffectInstance
 Inherited
Plays the effect instance on the target.
EffectInstance
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
Resumes the effect after it has been paused by a call to the pause() method.
EffectInstance
 Inherited
Plays the effect in reverse, starting from the current position of the effect.
EffectInstance
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Plays the effect instance on the target after the startDelay period has elapsed.
EffectInstance
 Inherited
Stops the effect, leaving the target in its current state.
EffectInstance
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Protected Methods
 MethodDefined By
  
createTween(listener:Object, startValue:Object, endValue:Object, duration:Number = -1, minFps:Number = -1):mx.effects:Tween
Creates a Tween instance, assigns it the start, end, and duration values.
TweenEffectInstance
Events
 Event Summary Defined By
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
Property Detail

easingFunction

property
public var easingFunction:Function

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The easing function for the animation. By default, effects use the same easing function as the TweenEffect class.

See also

playheadTime

property 
playheadTime:Number[override]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

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

tween

property 
public var tween:mx.effects:Tween

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The Tween object, which determines the animation. To create an effect, you must create a Tween instance in the override of the EffectInstance.play() method and assign it to the tween property. Use the createTween() method to create your Tween object.

Constructor Detail

TweenEffectInstance

()Constructor
public function TweenEffectInstance(target:Object)

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Constructor.

Parameters
target:Object — The Object to animate with this effect.
Method Detail

createTween

()method
protected function createTween(listener:Object, startValue:Object, endValue:Object, duration:Number = -1, minFps:Number = -1):mx.effects:Tween

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Creates a Tween instance, assigns it the start, end, and duration values. If an easing function has been specified, then it is assigned to the Tween instance. The Tween instance is assigned event listeners for the TweenEvents: tweenStart, tweenUpdate, and tweenEnd. Typically, you call this method from your override of the EffectInstance.play() method which effectively starts the animation timer.

Parameters

listener:Object — Object that is notified at each interval of the animation. You typically pass the this keyword as the value. The listener must define the onTweenUpdate() method and optionally the onTweenEnd() method. The onTweenUpdate() method is invoked for each interval of the animation, and the onTweenEnd() method is invoked just after the animation finishes.
 
startValue:Object — Initial value(s) of the animation. Either a number or an Array of numbers. If a number is passed, the Tween interpolates between this number and the number passed in the endValue parameter. If an Array of numbers is passed, each number in the Array is interpolated.
 
endValue:Object — Final value(s) of the animation. The type of this argument must match the startValue parameter.
 
duration:Number (default = -1) — Duration of the animation, in milliseconds.
 
minFps:Number (default = -1) — Minimum number of times that the onTweenUpdate() method should be called every second. The tween code tries to call the onTweenUpdate() method as frequently as possible (up to 100 times per second). However, if the frequency falls below minFps, the duration of the animation automatically increases. As a result, an animation that temporarily freezes (because it is not getting any CPU cycles) begins again where it left off, instead of suddenly jumping ahead.

Returns
mx.effects:Tween — The newly created Tween instance.

end

()method 
override public function end():void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Interrupts an effect that is currently playing, and immediately jumps to the end of the effect. Calls the Tween.endTween() method on the tween property. This method implements the method of the superclass.

If you create a subclass of TweenEffectInstance, you can optionally override this method.

The effect dispatches the effectEnd event.

See also

onTweenEnd

()method 
public function onTweenEnd(value:Object):void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Callback method that is called when the target should be updated by the effect for the last time. The Tween class passes Tween.endValue as the value of the value argument. The value argument can be either a Number or an Array of Numbers.

Overriding this function is optional. You must also call the super version of this method from the end of your override, super.onTweenEnd(val), after your logic.

Parameters

value:Object — The value of the value argument is an interpolated value determined by the Tween.startValue property, Tween.endValue property, and interpolation function specified by the implementation of the effect in its play() method. The play() method uses these values to create a Tween object that plays the effect over a time period. The value argument can be either a Number or an Array of Numbers.

onTweenUpdate

()method 
public function onTweenUpdate(value:Object):void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Callback method that is called when the target should be updated by the effect. The Tween class uses the easing function and the Tween.startValue, Tween.endValue and Tween.duration properties to calculate the value of the value argument. The value argument can be either a Number or an Array of Numbers.

All subclasses must override this method. It is not necessary to call the super version of this function when overriding this method.

Parameters

value:Object — The value of the value argument is an interpolated value determined by the Tween.startValue property, Tween.endValue property, and interpolation function specified by the implementation of the effect in its play() method. The play() method uses these values to create a Tween object that plays the effect over a time period. The value argument can be either a Number or an Array of Numbers.