mx.events

# TweenEvent - AS3 Flex

Package | mx.events
Class | public class TweenEvent
Inheritance | TweenEvent Event 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

Manually dispatching events

Learn more

About Flex events

Related API Elements

mx.effects.TweenEffect
mx.effects.Tween

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | bubbles : Boolean [read-only] Indicates whether an event is a bubbling event. | Event
|  | cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented. | Event
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener. | Event
|  | eventPhase : uint [read-only] The current phase in the event flow. | Event
|  | target : Object [read-only] The event target. | Event
|  | type : 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
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | TweenEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, value:Object = null) Constructor. | TweenEvent
|  | clone():Event Duplicates an instance of an Event subclass. | Event
|  | formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes. | Event
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event. | Event
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | preventDefault():void Cancels an event's default behavior if that behavior can be canceled. | Event
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow. | Event
|  | stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. | Event
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns a string containing all the properties of the Event object. | Event
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants
Hide Inherited Public Constants
Show Inherited 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.

Related API Elements

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.

Related API Elements

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.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00