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

TweenEvent  - AS3 Flex

Packagemx.events
Classpublic class TweenEvent
InheritanceTweenEvent Inheritance Event Inheritance Object

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

Represents event objects that are specific to Flex tween effects. Flex effects dispatch two types of tween events:
  • tweenUpdate
  • tweenEnd

More examples

Learn more

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
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
  value : Object
For a tweenStart or tweenUpdate event, the value passed to the onTweenUpdate() method; for a tweenEnd event, the value passed to the onTweenEnd() method.
TweenEvent
Public Methods
 MethodDefined By
  
TweenEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, value:Object = null)
Constructor.
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
  TWEEN_END : String = "tweenEnd"
[static] The TweenEvent.TWEEN_END constant defines the value of the event object's type property for a tweenEnd event.
TweenEvent
  TWEEN_START : String = "tweenStart"
[static] The TweenEvent.TWEEN_START constant defines the value of the event object's type property for a tweenStart event.
TweenEvent
  TWEEN_UPDATE : String = "tweenUpdate"
[static] The TweenEvent.TWEEN_UPDATE constant defines the value of the event object's type property for a tweenUpdate event.
TweenEvent
Property Detail

value

property
public var value:Object

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

For a tweenStart or tweenUpdate event, the value passed to the onTweenUpdate() method; for a tweenEnd event, the value passed to the onTweenEnd() method.

For the exact value of this property, see the instance class for each tween effect.

Related API Elements

Constructor Detail

TweenEvent

()Constructor
public function TweenEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, value:Object = null)

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

Constructor.

Parameters
type:String — The event type; indicates the action that caused the event.
 
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.
 
value:Object (default = null) — For a tweenStart or tweenUpdate event, the value passed to the onTweenUpdate() method; for a tweenEnd event, the value passed to the onTweenEnd() method.
Constant Detail

TWEEN_END

Constant
public static const TWEEN_END:String = "tweenEnd"

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

The TweenEvent.TWEEN_END constant defines the value of the event object's type property for a tweenEnd event.

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.
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.
valueThe value passed to the onTweenEnd() method.

Related API Elements

TWEEN_START

Constant 
public static const TWEEN_START:String = "tweenStart"

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

The TweenEvent.TWEEN_START constant defines the value of the event object's type property for a tweenStart event.

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.
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.
valueThe value passed to the onTweenUpdate() method.

TWEEN_UPDATE

Constant 
public static const TWEEN_UPDATE:String = "tweenUpdate"

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

The TweenEvent.TWEEN_UPDATE constant defines the value of the event object's type property for a tweenUpdate event.

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.
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.
valueThe value passed to the onTweenUpdate() method.