Package | mx.effects |
Class | public class Dissolve |
Inheritance | Dissolve TweenEffect Effect flash.events.EventDispatcher |
Dissolve.color
property,
and its alpha
property is initially set to
(1.0 - Dissolve.alphaFrom
).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 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.
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" />
See also
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
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 | ||
customFilter : 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 : 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
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 | ||
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 UIComponent 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 UIComponent 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 |
Method | Defined by | ||
---|---|---|---|
Dissolve(target:Object = null)
Constructor.
| Dissolve | ||
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
This function is used by Flex 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 | ||
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 that is changed by this effect.
| Effect | ||
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 | ||
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 | ||
stop():void
Stops the effect, leaving the effect targets in their current state.
| Effect |
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.
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
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
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.
The default value is null
.
Dissolve | () | constructor |
public function Dissolve(target:Object = null)
Constructor.
Parameterstarget:Object (default = null ) — The Object to animate with this effect.
|