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

Package | org.apache.flex.effects
Class | public class Fade
Inheritance | Fade Tween Effect EventDispatcher flash.events.EventDispatcher
Implements | IDocument

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The Fade effect animates a UI component's alpha or opacity.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | activeTweens : Object [static] The list of tweens that are currently playing. | Tween
|  | alphaFrom : Number Starting alpha value. | Fade
|  | alphaTo : Number Ending alpha value. | Fade
|  | currentTime : Number = NaN [static] Used by effects to get the current effect time tick. | Tween
|  | duration : Number Duration of the animation, in milliseconds. | Effect
|  | easingFunction : Function [write-only] Sets the easing function for the animation. | Tween
|  | endValue : Number Final value of the animation. | Tween
|  | listener : Object Object that is notified at each interval of the animation. | Tween
|  | startValue : Number Initial value of the animation. | Tween
|  | target : String The target as the String id of a widget in an MXML Document. | Fade

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | Fade(target:IUIBase = null) Constructor. | Fade
|  | captureEndValues():void | Effect
|  | captureStartValues():void | Effect
|  | endTween():void Interrupt the tween, jump immediately to the end of the tween, and invoke the onTweenEnd() callback function. | Tween
|  | onTweenEnd(value:Number):void | Fade
|  | onTweenUpdate(value:Number):void | Fade
|  | pause():void [override] Pauses the effect until you call the resume() method. | Tween
|  | play():void [override] Stops the tween, ending it without dispatching an event or calling the Tween's endFunction or onTweenEnd(). | Tween
|  | resume():void [override] Resumes the effect after it has been paused by a call to the pause() method. | Tween
|  | reverse():void [override] Plays the effect in reverse, starting from the current position of the effect. | Tween
|  | seek(playheadTime:Number):void Advances the tween effect to the specified position. | Tween
|  | setDocument(document:Object, id:String = null):void | Fade
|  | stop():void [override] Stops the tween, ending it without dispatching an event or calling the Tween's endFunction or onTweenEnd(). | Tween

Public Constants
Hide Inherited Public Constants
Show Inherited 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
|  | TWEEN_END : String = tweenEnd [static] The Tween.TWEEN_END constant defines the value of the event object's type property for a tweenEnd event. | Tween
|  | TWEEN_START : String = tweenStart [static] The Tween.TWEEN_START constant defines the value of the event object's type property for a tweenStart event. | Tween
|  | TWEEN_UPDATE : String = tweenUpdate [static] The Tween.TWEEN_UPDATE constant defines the value of the event object's type property for a tweenUpdate event. | Tween

Property Detail

alphaFrom | property

`public var alphaFrom:Number`

Starting alpha value. If NaN, the current alpha value is used

alphaTo | property |

`public var alphaTo:Number`

Ending alpha value. If NaN, the current alpha value is not changed

target | property |

`public var target:String`

The target as the String id of a widget in an MXML Document.

Constructor Detail

Fade | () | Constructor

`public function Fade(target:IUIBase = null)`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Constructor.

Parameters

| `target:IUIBase` (default = `null`)`` — An object that will have its x and/or y property animated.

Method Detail

onTweenEnd | () | method

`public function onTweenEnd(value:Number):void`

Parameters

| `value:Number`

onTweenUpdate | () | method |

`public function onTweenUpdate(value:Number):void`

Parameters

| `value:Number`

setDocument | () | method |

`public function setDocument(document:Object, id:String = null):void`

Parameters

| `document:Object`
| `id:String` (default = `null`)``

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