Apache Flex (FlexJS) 0.7.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
Effect

Package | org.apache.flex.effects
Class | public class Effect
Inheritance | Effect EventDispatcher flash.events.EventDispatcher
Implements | IEffect
Subclasses | Parallel, Sequence, Tween

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

Effect is the base class for effects in FlexJS.

Public Properties

| Property | Defined By
--- | --- | ---
|  | duration : Number Duration of the animation, in milliseconds. | Effect

Public Methods

| Method | Defined By
--- | --- | ---
|  | Effect() Constructor. | Effect
|  | captureEndValues():void | Effect
|  | captureStartValues():void | Effect
|  | pause():void Pauses the effect until you call the resume() method. | Effect
|  | play():void Stops the tween, ending it without dispatching an event or calling the Tween's endFunction or onTweenEnd(). | Effect
|  | resume():void Resumes the effect after it has been paused by a call to the pause() method. | Effect
|  | reverse():void Plays the effect in reverse, starting from the current position of the effect. | Effect
|  | stop():void Stops the tween, ending it without dispatching an event or calling the Tween's endFunction or onTweenEnd(). | Effect

Public Constants

| Constant | Defined By
--- | --- | ---
|  | EFFECT_END : String = effectEnd [static] The Effect.EFFECT_END constant defines the value of the event object's type property for a effectEnd event. | Effect
|  | EFFECT_START : String = effectStart [static] The Effect.EFFECT_START constant defines the value of the event object's type property for a effectStart event. | Effect
|  | EFFECT_STOP : String = effectStop [static] The Effect.EFFECT_STOP constant defines the value of the event object's type property for a effectStop event. | Effect

Property Detail

duration | property

`duration:Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Duration of the animation, in milliseconds.

Implementation
`public function get duration():Number`
`public function set duration(value:Number):void`
Constructor Detail

Effect | () | Constructor

`public function Effect()`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Constructor.

Method Detail

captureEndValues | () | method

`public function captureEndValues():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

captureStartValues | () | method |

`public function captureStartValues():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

pause | () | method |

`public function pause():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Pauses the effect until you call the `resume()` method.

play | () | method |

`public function play():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Stops the tween, ending it without dispatching an event or calling the Tween's endFunction or `onTweenEnd()`.

resume | () | method |

`public function resume():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Resumes the effect after it has been paused by a call to the `pause()` method.

reverse | () | method |

`public function reverse():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Plays the effect in reverse, starting from the current position of the effect.

stop | () | method |

`public function stop():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Stops the tween, ending it without dispatching an event or calling the Tween's endFunction or `onTweenEnd()`.

Constant Detail

EFFECT_END | Constant

`public static const EFFECT_END:String = effectEnd`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The `Effect.EFFECT_END` constant defines the value of the event object's `type` property for a `effectEnd` 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.

EFFECT_START | Constant |

`public static const EFFECT_START:String = effectStart`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The `Effect.EFFECT_START` constant defines the value of the event object's `type` property for a `effectStart` 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.

EFFECT_STOP | Constant |

`public static const EFFECT_STOP:String = effectStop`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The `Effect.EFFECT_STOP` constant defines the value of the event object's `type` property for a `effectStop` 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.

Mon Sep 5 2016, 07:19 AM -07:00