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

Package | spark.effects.supportClasses
Class | public class FadeInstance
Inheritance | FadeInstance AnimateInstance EffectInstance flash.events.EventDispatcher

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The FadeInstance class implements the instance class for the Fade effect. Flex creates an instance of this class when it plays a Fade effect; you do not create one yourself.

See also

spark.effects.Fade

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | alphaFrom : Number Initial value of the alpha property, between 0.0 and 1.0, where 0.0 means transparent and 1.0 means fully opaque. | FadeInstance
|  | alphaTo : Number Final value of the alpha property, between 0.0 and 1.0, where 0.0 means transparent and 1.0 means fully opaque. | FadeInstance
|  | className : String [read-only] The name of the effect class, such as "FadeInstance". | EffectInstance
|  | disableLayout : Boolean If true, the effect disables layout on its targets' parent containers, setting the containers autoLayout property to false, and also disables any layout constraints on the target objects. | AnimateInstance
|  | duration : Number The duration of the effect, in milliseconds. | EffectInstance
|  | easer : IEaser The easing behavior for this effect. | AnimateInstance
|  | effect : IEffect The IEffect object that created this IEffectInstance object. | EffectInstance
|  | effectTargetHost : IEffectTargetHost A property that lets you access the target list-based control of a data effect. | EffectInstance
|  | hideFocusRing : Boolean Determines whether the effect should hide the focus ring when starting the effect. | EffectInstance
|  | interpolator : IInterpolator The interpolator used by this effect to calculate values between the start and end values of a property. | AnimateInstance
|  | motionPaths : Vector.<MotionPath> A Vector of MotionPath objects, each of which holds the name of a property being animated and the values that the property takes during the animation. | AnimateInstance
|  | playheadTime : Number [override] Current time position of the effect. | AnimateInstance
|  | propertyChanges : PropertyChanges Specifies the PropertyChanges object containing the start and end values for the set of properties relevant to the effect's targets. | EffectInstance
|  | repeatBehavior : String The behavior of a repeating effect, which means an effect with repeatCount equal to either 0 or > 1. | AnimateInstance
|  | repeatCount : int Number of times to repeat the effect. | EffectInstance
|  | repeatDelay : int Amount of time, in milliseconds, to wait before repeating the effect. | EffectInstance
|  | startDelay : int Amount of time, in milliseconds, to wait before starting the effect. | EffectInstance
|  | suspendBackgroundProcessing : Boolean If true, blocks all background processing while the effect is playing. | EffectInstance
|  | target : Object The UIComponent object to which this effect is applied. | EffectInstance
|  | triggerEvent : Event The event, if any, which triggered the playing of the effect. | EffectInstance

Protected Properties
Hide Inherited Protected Properties
Show Inherited Protected Properties

| Property | Defined By
--- | --- | ---
|  | autoRemoveTarget : Boolean = false If true, the effect retains its target during a transition and removes it when finished. | AnimateInstance
|  | playCount : int = 0 Number of times that the instance has been played. | EffectInstance

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | FadeInstance(target:Object) Constructor. | FadeInstance
|  | end():void Interrupts an effect instance that is currently playing, and jumps immediately to the end of the effect. | EffectInstance
|  | finishEffect():void Called by the end() method when the effect finishes playing. | EffectInstance
|  | finishRepeat():void Called after each iteration of a repeated effect finishes playing. | EffectInstance
|  | initEffect(event:Event):void This method is called if the effect was triggered by the EffectManager. | EffectInstance
|  | pause():void Pauses the effect until you call the resume() method. | EffectInstance
|  | play():void Plays the effect instance on the target. | EffectInstance
|  | resume():void Resumes the effect after it has been paused by a call to the pause() method. | EffectInstance
|  | reverse():void Plays the effect in reverse, starting from the current position of the effect. | EffectInstance
|  | startEffect():void Plays the effect instance on the target after the startDelay period has elapsed. | EffectInstance
|  | stop():void Stops the effect, leaving the target in its current state. | EffectInstance

Property Detail

alphaFrom | property

`public var alphaFrom:Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Initial value of the `alpha` property, between 0.0 and 1.0, where 0.0 means transparent and 1.0 means fully opaque.

If the effect causes the target component to disappear, the default value is the current value of the target's `alpha` property. If the effect causes the target component to appear, the default value is 0.0.

alphaTo | property |

`public var alphaTo:Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Final value of the `alpha` property, between 0.0 and 1.0, where 0.0 means transparent and 1.0 means fully opaque.

If the effect causes the target component to disappear, the default value is 0.0. If the effect causes the target component to appear, the default value is the current value of the target's `alpha` property.

Constructor Detail

FadeInstance | () | Constructor

`public function FadeInstance(target:Object)`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Constructor.

Parameters

| `target:Object` — The Object to animate with this effect.

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