ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
fl.transitions 

TweenEvent  - AS3 Flash

Packagefl.transitions
Classpublic class TweenEvent
InheritanceTweenEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9, AIR 1.0

The TweenEvent class represents events that are broadcast by the fl.transitions.Tween class.

Related API Elements



Public Properties
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
  position : Number = NaN
The value of the property controlled by the Tween, when the event occurred.
TweenEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
  time : Number = NaN
The time of the Tween when the event occurred.
TweenEvent
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
TweenEvent(type:String, time:Number, position:Number, bubbles:Boolean = false, cancelable:Boolean = false)
Constructor function for a TweenEvent object.
TweenEvent
 Inherited
Duplicates an instance of an Event subclass.
Event
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns a string containing all the properties of the Event object.
Event
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  MOTION_CHANGE : String = "motionChange"
[static] Indicates that the Tween has changed and the screen has been updated.
TweenEvent
  MOTION_FINISH : String = "motionFinish"
[static] Indicates that the Tween has reached the end and finished.
TweenEvent
  MOTION_LOOP : String = "motionLoop"
[static] Indicates that the Tween has restarted playing from the beginning in looping mode.
TweenEvent
  MOTION_RESUME : String = "motionResume"
[static] Indicates that the Tween has resumed playing after being paused.
TweenEvent
  MOTION_START : String = "motionStart"
[static] Indicates that the motion has started playing.
TweenEvent
  MOTION_STOP : String = "motionStop"
[static] Indicates that the Tween has been stopped with an explicit call to Tween.stop().
TweenEvent
Property Detail

position

property
public var position:Number = NaN

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9, AIR 1.0

The value of the property controlled by the Tween, when the event occurred.

time

property 
public var time:Number = NaN

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9, AIR 1.0

The time of the Tween when the event occurred.

Constructor Detail

TweenEvent

()Constructor
public function TweenEvent(type:String, time:Number, position:Number, bubbles:Boolean = false, cancelable:Boolean = false)

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9, AIR 1.0

Constructor function for a TweenEvent object.

Parameters
type:String — The event type; indicates the action that caused the event.
 
time:Number — The time within the duration of the animation.
 
position:Number — The frame of the tween.
 
bubbles:Boolean (default = false) — Specifies whether the event can bubble up the display list hierarchy.
 
cancelable:Boolean (default = false) — Specifies whether the behavior associated with the event can be prevented.
Constant Detail

MOTION_CHANGE

Constant
public static const MOTION_CHANGE:String = "motionChange"

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9, AIR 1.0

Indicates that the Tween has changed and the screen has been updated.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget property.
targetThe object that dispatched the event; it is not always the object listening for the event. Use the currentTarget property to always access the object listening for the event.
timeThe time of the Tween when the event occurred.
positionThe value of the property controlled by the Tween, when the event occurred.

MOTION_FINISH

Constant 
public static const MOTION_FINISH:String = "motionFinish"

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9, AIR 1.0

Indicates that the Tween has reached the end and finished.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget property.
targetThe object that dispatched the event; it is not always the object listening for the event. Use the currentTarget property to always access the object listening for the event.
timeThe time of the Tween when the event occurred.
positionThe value of the property controlled by the Tween, when the event occurred.

MOTION_LOOP

Constant 
public static const MOTION_LOOP:String = "motionLoop"

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9, AIR 1.0

Indicates that the Tween has restarted playing from the beginning in looping mode.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget property.
targetThe object that dispatched the event; it is not always the object listening for the event. Use the currentTarget property to always access the object listening for the event.
timeThe time of the Tween when the event occurred.
positionThe value of the property controlled by the Tween, when the event occurred.

MOTION_RESUME

Constant 
public static const MOTION_RESUME:String = "motionResume"

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9, AIR 1.0

Indicates that the Tween has resumed playing after being paused.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget property.
targetThe object that dispatched the event; it is not always the object listening for the event. Use the currentTarget property to always access the object listening for the event.
timeThe time of the Tween when the event occurred.
positionThe value of the property controlled by the Tween, when the event occurred.

MOTION_START

Constant 
public static const MOTION_START:String = "motionStart"

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9, AIR 1.0

Indicates that the motion has started playing.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget property.
targetThe object that dispatched the event; it is not always the object listening for the event. Use the currentTarget property to always access the object listening for the event.
timeThe time of the Tween when the event occurred.
positionThe value of the property controlled by the Tween, when the event occurred.

MOTION_STOP

Constant 
public static const MOTION_STOP:String = "motionStop"

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9, AIR 1.0

Indicates that the Tween has been stopped with an explicit call to Tween.stop().

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget property.
targetThe object that dispatched the event; it is not always the object listening for the event. Use the currentTarget property to always access the object listening for the event.
timeThe time of the Tween when the event occurred.
positionThe value of the property controlled by the Tween, when the event occurred.