Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
TweenEvent

Package | mx.events
Class | public class TweenEvent
Inheritance | TweenEvent flash.events.Event

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`

See also

mx.effects.TweenEffect
mx.effects.Tween

Public Properties

| Property | Defined 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

| Method | Defined By
--- | --- | ---
|  | TweenEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, value:Object = null) Constructor. | TweenEvent

Public Constants

| Constant | Defined 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.

See also

mx.effects.effectClasses.ActionEffectInstance
mx.effects.effectClasses.BlurInstance
mx.effects.effectClasses.DissolveInstance
mx.effects.effectClasses.FadeInstance
mx.effects.effectClasses.GlowInstance
mx.effects.effectClasses.MaskEffectInstance
mx.effects.effectClasses.MoveInstance
mx.effects.effectClasses.ResizeInstance
mx.effects.effectClasses.RotateInstance
mx.effects.effectClasses.ZoomInstance
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:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`currentTarget` | The 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`.
`target` | The 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.
`value` | The value passed to the `onTweenEnd()` method.

See also

mx.effects.Effect
mx.effects.TweenEffect
mx.events.EffectEvent

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:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`currentTarget` | The 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`.
`target` | The 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.
`value` | The 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:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`currentTarget` | The 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`.
`target` | The 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.
`value` | The value passed to the `onTweenUpdate()` method.

Sun Mar 5 2017, 03:42 PM +11:00