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

Package | mx.effects.effectClasses
Class | public class DissolveInstance
Inheritance | DissolveInstance TweenEffectInstance EffectInstance flash.events.EventDispatcher

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

Every effect class that is a subclass of the TweenEffect class supports the following events:

- `tweenEnd`: Dispatched when the tween effect ends.
- `tweenUpdate`: Dispatched every time a TweenEffect class calculates a new value.

The event object passed to the event listener for these events is of type TweenEvent. The TweenEvent class defines the property `value`, which contains the tween value calculated by the effect. For the Dissolve effect, the `TweenEvent.value` property contains a Number between the values of the `Dissolve.alphaFrom` and `Dissolve.alphaTo` properties.

See also

mx.effects.Dissolve
mx.events.TweenEvent

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | alphaFrom : Number Initial transparency level between 0.0 and 1.0, where 0.0 means transparent and 1.0 means fully opaque. | DissolveInstance
|  | alphaTo : Number Final transparency level between 0.0 and 1.0, where 0.0 means transparent and 1.0 means fully opaque. | DissolveInstance
|  | className : String [read-only] The name of the effect class, such as "FadeInstance". | EffectInstance
|  | color : uint = 0xFFFFFFFF Hex value that represents the color of the floating rectangle that the effect displays over the target object. | DissolveInstance
|  | duration : Number The duration of the effect, in milliseconds. | EffectInstance
|  | easingFunction : Function The easing function for the animation. | TweenEffectInstance
|  | 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
|  | playheadTime : Number [override] Current time position of the effect. | TweenEffectInstance
|  | propertyChanges : PropertyChanges Specifies the PropertyChanges object containing the start and end values for the set of properties relevant to the effect's targets. | EffectInstance
|  | 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
|  | targetArea : RoundedRectangle The area of the target to play the effect upon. | DissolveInstance
|  | triggerEvent : Event The event, if any, which triggered the playing of the effect. | EffectInstance
|  | tween : Tween The Tween object, which determines the animation. | TweenEffectInstance

Protected Properties
Hide Inherited Protected Properties
Show Inherited Protected Properties

| Property | Defined By
--- | --- | ---
|  | 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
--- | --- | ---
|  | DissolveInstance(target:Object) Constructor. | DissolveInstance
|  | end():void [override] Interrupts an effect that is currently playing, and immediately jumps to the end of the effect. | TweenEffectInstance
|  | 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
|  | onTweenEnd(value:Object):void Callback method that is called when the target should be updated by the effect for the last time. | TweenEffectInstance
|  | onTweenUpdate(value:Object):void Callback method that is called when the target should be updated by the effect. | TweenEffectInstance
|  | 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

Protected Methods
Show Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined By
--- | --- | ---
|  | createTween(listener:Object, startValue:Object, endValue:Object, duration:Number = -1, minFps:Number = -1):Tween Creates a Tween instance, assigns it the start, end, and duration values. | TweenEffectInstance

Property Detail

alphaFrom | property

`public var alphaFrom:Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Initial transparency level between 0.0 and 1.0, where 0.0 means transparent and 1.0 means fully opaque.

alphaTo | property |

`public var alphaTo:Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Final transparency level between 0.0 and 1.0, where 0.0 means transparent and 1.0 means fully opaque.

color | property |

`public var color:uint = 0xFFFFFFFF`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Hex value that represents the color of the floating rectangle that the effect displays over the target object. The default value is the color specified by the target component's `backgroundColor` style property, or 0xFFFFFF, if `backgroundColor` is not set.

targetArea | property |

`public var targetArea:RoundedRectangle`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The area of the target to play the effect upon. The dissolve overlay is drawn using this property's dimensions. UIComponents create an overlay over the entire component. Containers create an overlay over their content area, but not their chrome.

Constructor Detail

DissolveInstance | () | Constructor

`public function DissolveInstance(target:Object)`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Constructor.

Parameters

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

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