mx.effects.Dissolve - Adobe® Flex® 4 Language Reference (Flex 4)

Package	mx.effects
Class	public class Dissolve
Inheritance	Dissolve TweenEffect Effect EventDispatcher Object

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Animate the component from transparent to opaque, or from opaque to transparent. When the Dissolve effect is played, it does the following:

When the effect begins, it creates an opaque rectangle. The rectangle floats above the target component, its color matches the Dissolve.color property, and its alpha property is initially set to (1.0 - Dissolve.alphaFrom).
As the effect plays, the alpha property of the rectangle animates from (1.0 - alphaFrom) to (1.0 - alphaTo). As the rectangle becomes more and more opaque, the content underneath it gradually disappears.
When the effect finishes, the rectangle is destroyed.

When the target object is a Container, the Dissolve effect applies to the content area inside the container. The content area is the region where the container's background color is visible.

Note: To use the Dissolve effect with the creationCompleteEffect trigger of a DataGrid control, you must define the data provider of the control inline using a child tag of the DataGrid control, or using data binding. This issue is a result of the data provider not being set until the creationComplete event is dispatched. Therefore, when the effect starts playing, Flex has not completed the sizing of the DataGrid control.

MXML Syntax expanded

Hide MXML Syntax

The <mx:Dissolve> tag inherits the tag attributes of its superclass, and adds the following tag attributes:

  <mx:Dissolve
    id="ID"
    alphaFrom="val"
    alphaTo="val"
    color="val"
  />

View the examples

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.	Dissolve
		alphaTo : Number Final transparency level between 0.0 and 1.0, where 0.0 means transparent and 1.0 means fully opaque.	Dissolve
		className : String [read-only] The name of the effect class, such as "Fade".	Effect
		color : uint = 0xFFFFFFFF Hex value that represents the color of the floating rectangle that the effect displays over the target object.	Dissolve
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		customFilter : mx.effects:EffectTargetFilter Specifies a custom filter object, of type EffectTargetFilter, used by the effect to determine the targets on which to play the effect.	Effect
		duration : Number Duration of the effect in milliseconds.	Effect
		easingFunction : Function = null The easing function for the animation.	TweenEffect
		effectTargetHost : mx.effects:IEffectTargetHost A property that lets you access the target list-based control of a data effect.	Effect
		filter : String Specifies an algorithm for filtering targets for an effect.	Effect
		hideFocusRing : Boolean Determines whether the effect should hide the focus ring when starting the effect.	Effect
		instanceClass : Class An object of type Class that specifies the effect instance class class for this effect class.	Effect
		isPlaying : Boolean [read-only] A read-only flag which is true if any instances of the effect are currently playing, and false if none are.	Effect
		perElementOffset : Number Additional delay, in milliseconds, for effect targets after the first target of the effect.	Effect
		playheadTime : Number Current time position of the effect.	Effect
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		relevantProperties : Array An Array of property names to use when performing filtering.	Effect
		relevantStyles : Array An Array of style names to use when performing filtering.	Effect
		repeatCount : int = 1 Number of times to repeat the effect.	Effect
		repeatDelay : int = 0 Amount of time, in milliseconds, to wait before repeating the effect.	Effect
		startDelay : int = 0 Amount of time, in milliseconds, to wait before starting the effect.	Effect
		suspendBackgroundProcessing : Boolean = false If true, blocks all background processing while the effect is playing.	Effect
		target : Object The object to which this effect is applied.	Effect
		targetArea : RoundedRectangle The area of the target to play the effect upon.	Dissolve
		targets : Array An Array of objects that are targets for the effect.	Effect
		triggerEvent : Event The Event object passed to this Effect by the EffectManager when an effect is triggered, or null if the effect is not being played by the EffectManager.	Effect

Protected Properties

Hide Inherited Protected Properties

Show Inherited Protected Properties

	Property		Defined By
		applyTransitionEndProperties : Boolean This flag controls whether the effect, when run in a transition, automatically applies the property values according to the end state, as opposed to leaving values as set by the effect itself.	Effect
		endValuesCaptured : Boolean = false A flag containing true if the end values of an effect have already been determined, or false if they should be acquired from the current properties of the effect targets when the effect runs.	Effect

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		Dissolve(target:Object = null) Constructor.	Dissolve
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	EventDispatcher
		captureEndValues():void Captures the current values of the relevant properties on the effect's targets and saves them as end values.	Effect
		captureMoreStartValues(targets:Array):void Captures the current values of the relevant properties of an additional set of targets Flex uses this function when a data change effect is run.	Effect
		captureStartValues():void Captures the current values of the relevant properties on the effect's targets.	Effect
		createInstance(target:Object = null):IEffectInstance Creates a single effect instance and initializes it.	Effect
		createInstances(targets:Array = null):Array Takes an Array of target objects and invokes the createInstance() method on each target.	Effect
		deleteInstance(instance:IEffectInstance):void Removes event listeners from an instance and removes it from the list of instances.	Effect
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		end(effectInstance:IEffectInstance = null):void Interrupts an effect that is currently playing, and jumps immediately to the end of the effect.	Effect
		getAffectedProperties():Array Returns an Array of Strings, where each String is the name of a property changed by this effect.	Effect
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		pause():void Pauses the effect until you call the resume() method.	Effect
		play(targets:Array = null, playReversedFromEnd:Boolean = false):Array Begins playing the effect.	Effect
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		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, if the effect is currently playing, starting from the current position of the effect.	Effect
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		stop():void Stops the effect, leaving the effect targets in their current state.	Effect
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Protected Methods

Hide Inherited Protected Methods

Show Inherited Protected Methods

	Method		Defined By
		applyValueToTarget(target:Object, property:String, value:*, props:Object):void Used internally by the Effect infrastructure.	Effect
		effectEndHandler(event:EffectEvent):void Called when an effect instance has finished playing.	Effect
		effectStartHandler(event:EffectEvent):void This method is called when the effect instance starts playing.	Effect
		effectStopHandler(event:EffectEvent):void Called when an effect instance has stopped by a call to the stop() method.	Effect
		filterInstance(propChanges:Array, target:Object):Boolean Determines the logic for filtering out an effect instance.	Effect
		getValueFromTarget(target:Object, property:String):* Called by the captureStartValues() method to get the value of a property from the target.	Effect
		initInstance(instance:IEffectInstance):void Copies properties of the effect to the effect instance.	Effect
		tweenEventHandler(event:mx.events:TweenEvent):void Called when the TweenEffect dispatches a TweenEvent.	TweenEffect

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher
effectEnd	Dispatched when one of the effect's instances finishes playing, either when the instance finishes playing or when the effect is interrupted by a call to the end() method.	Effect
effectStart	Dispatched when the effect starts playing.	Effect
effectStop	Dispatched when the effect has been stopped, which only occurs when the effect is interrupted by a call to the stop() method.	Effect
tweenEnd	Dispatched when the tween effect ends.	TweenEffect
tweenStart	Dispatched when the tween effect starts, which corresponds to the first call to the onTweenUpdate() method.	TweenEffect
tweenUpdate	Dispatched every time the tween effect updates the target.	TweenEffect

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.

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 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.

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.

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.

The default value is null.

Constructor Detail

Dissolve

()

Constructor

public function Dissolve(target:Object = null)

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Constructor.

Parameters

target:Object (default = null) — The Object to animate with this effect.

Examples How to use this example

DissolveEffectExample.mxml

<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate the Halo Dissolve effect. -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
        xmlns:s="library://ns.adobe.com/flex/spark"
        xmlns:mx="library://ns.adobe.com/flex/mx">

    <fx:Declarations>
        <mx:Dissolve id="dissolveOut" duration="1000" alphaFrom="1.0" alphaTo="0.0"/>
        <mx:Dissolve id="dissolveIn" duration="1000" alphaFrom="0.0" alphaTo="1.0"/>
    </fx:Declarations>

    <s:Panel title="Halo Dissolve Effect Example"
        width="95%" height="95%" >
        <s:HGroup left="20" right="20" top="20" bottom="20">

            <s:VGroup>
                <mx:Text text="Nokia 9930"
                    fontSize="14"
                    visible="{cb1.selected}"
                    hideEffect="{dissolveOut}" showEffect="{dissolveIn}"/>

                <mx:Image source="@Embed(source='assets/Nokia_6630.png')"
                    visible="{cb1.selected}"
                    hideEffect="{dissolveOut}" showEffect="{dissolveIn}"/>
            </s:VGroup>

            <s:VGroup height="100%" width="100%">
                <mx:Text width="100%" color="blue"
                    text="Use the Dissolve effect to show or hide the text, image, and button."/>

                <mx:Spacer height="100%"/>

                <mx:Button label="Purchase"
                    visible="{cb1.selected}"
                    hideEffect="{dissolveOut}" showEffect="{dissolveIn}"/>
            </s:VGroup>
        </s:HGroup>
        <s:CheckBox id="cb1" label="visible" selected="true" bottom="10" left="10"/>

    </s:Panel>
</s:Application>