mx.effects.effectClasses.DissolveInstance (Livecycle)

Package	mx.effects.effectClasses
Class	public class DissolveInstance
Inheritance	DissolveInstance TweenEffectInstance EffectInstance EventDispatcher Object

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.

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
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		duration : Number Duration of the effect in milliseconds.	EffectInstance
		easingFunction : Function The easing function for the animation.	TweenEffectInstance
		effect : Effect	EffectInstance
		playheadTime : Number [read-only] The current position of the effect, in milliseconds.	TweenEffectInstance
		propertyChanges : PropertyChanges	EffectInstance
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		repeatCount : int	EffectInstance
		repeatDelay : int	EffectInstance
		startDelay : int	EffectInstance
		suspendBackgroundProcessing : Boolean	EffectInstance
		target : Object	EffectInstance
		targetArea : RoundedRectangle The area of the target to play the effect upon.	DissolveInstance
		triggerEvent : Event	EffectInstance
		tween : Tween The Tween object, which determines the animation.	TweenEffectInstance

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		DissolveInstance(target:Object) Constructor.	DissolveInstance
		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
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		end():void 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
		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
		initEffect(event:Event):void This method is called if the effect was triggered by the EffectManager.	EffectInstance
		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
		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
		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.	EffectInstance
		reverse():void Plays the effect in reverse, starting from the current position of the effect.	EffectInstance
		seek(playheadTime:Number):void Advances the effect to the specified position.	TweenEffectInstance
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		startEffect():void Plays the effect instance on the target after the startDelay period has elapsed.	EffectInstance
		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

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

Events

Hide Inherited Events

Show Inherited Events

	Event		Summary	Defined By
		activate	Dispatched when Flash Player gains operating system focus and becomes active.	EventDispatcher
		deactivate	Dispatched when Flash Player loses operating system focus and is becoming inactive.	EventDispatcher

Property Detail

alphaFrom

property

public var alphaFrom:Number

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

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

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

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.

Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/common/langref/mx/effects/effectClasses/DissolveInstance.html

Livecycle ES API Reference	All Packages \| All Classes \| Language Elements \| Index \| Appendixes \| Frames No Frames
DissolveInstance	Properties \| Methods \| Events