Packagemx.events
Classpublic class TweenEvent
InheritanceTweenEvent Inheritance flash.events.Event

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

See also

mx.effects.TweenEffect
mx.effects.Tween


Public Properties
 PropertyDefined by
  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
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
valueproperty
public var 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.

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

See also

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

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_ENDconstant
public static const TWEEN_END:String = "tweenEnd"

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.

See also

TWEEN_STARTconstant 
public static const TWEEN_START:String = "tweenStart"

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_UPDATEconstant 
public static const TWEEN_UPDATE:String = "tweenUpdate"

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.