Packagemx.effects.effectClasses
Classpublic class DissolveInstance
InheritanceDissolveInstance Inheritance TweenEffectInstance Inheritance EffectInstance Inheritance flash.events.EventDispatcher

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:

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
 PropertyDefined 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
 InheritedclassName : String
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
 Inheritedduration : Number
The duration of the effect, in milliseconds.
EffectInstance
 InheritedeasingFunction : Function
The easing function for the animation.
TweenEffectInstance
 Inheritedeffect : IEffect
The IEffect object that created this IEffectInstance object.
EffectInstance
 InheritedeffectTargetHost : IEffectTargetHost
A property that lets you access the target list-based control of a data effect.
EffectInstance
 InheritedhideFocusRing : Boolean
Determines whether the effect should hide the focus ring when starting the effect.
EffectInstance
 InheritedplayheadTime : Number
The current position of the effect, in milliseconds.
TweenEffectInstance
 InheritedpropertyChanges : PropertyChanges
Specifies the PropertyChanges object containing the start and end values for the set of properties relevant to the effect's targets.
EffectInstance
 InheritedrepeatCount : int
Number of times to repeat the effect.
EffectInstance
 InheritedrepeatDelay : int
Amount of time, in milliseconds, to wait before repeating the effect.
EffectInstance
 InheritedstartDelay : int
Amount of time, in milliseconds, to wait before starting the effect.
EffectInstance
 InheritedsuspendBackgroundProcessing : Boolean
If true, blocks all background processing while the effect is playing.
EffectInstance
 Inheritedtarget : Object
The UIComponent object to which this effect is applied.
EffectInstance
  targetArea : RoundedRectangle
The area of the target to play the effect upon.
DissolveInstance
 InheritedtriggerEvent : Event
The event, if any, which triggered the playing of the effect.
EffectInstance
 Inheritedtween : Tween
The Tween object, which determines the animation.
TweenEffectInstance
Public Methods
 MethodDefined by
  
DissolveInstance(target:Object)
Constructor.
DissolveInstance
 Inherited
end():void
Interrupts an effect that is currently playing, and immediately jumps to the end of the effect.
TweenEffectInstance
 Inherited
finishEffect():void
Called by the end() method when the effect finishes playing.
EffectInstance
 Inherited
finishRepeat():void
Called after each iteration of a repeated effect finishes playing.
EffectInstance
 Inherited
initEffect(event:Event):void
This method is called if the effect was triggered by the EffectManager.
EffectInstance
 Inherited
onTweenEnd(value:Object):void
Callback method that is called when the target should be updated by the effect for the last time.
TweenEffectInstance
 Inherited
onTweenUpdate(value:Object):void
Callback method that is called when the target should be updated by the effect.
TweenEffectInstance
 Inherited
pause():void
Pauses the effect until you call the resume() method.
EffectInstance
 Inherited
play():void
Plays the effect instance on the target.
EffectInstance
 Inherited
resume():void
Resumes the effect after it has been paused by a call to the pause() method.
EffectInstance
 Inherited
reverse():void
Plays the effect in reverse, starting from the current position of the effect.
EffectInstance
 Inherited
seek(playheadTime:Number):void
Advances the effect to the specified position.
TweenEffectInstance
 Inherited
startEffect():void
Plays the effect instance on the target after the startDelay period has elapsed.
EffectInstance
 Inherited
stop():void
Stops the effect, leaving the target in its current state.
EffectInstance
Protected Methods
 MethodDefined by
 Inherited
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
alphaFromproperty
public var alphaFrom:Number

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

alphaToproperty 
public var alphaTo:Number

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

colorproperty 
public var color:uint = 0xFFFFFFFF

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.

targetAreaproperty 
public var targetArea:RoundedRectangle

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)

Constructor.

Parameters
target:Object — The Object to animate with this effect.