| Package | mx.effects |
| Class | public class CompositeEffect |
| Inheritance | CompositeEffect  Effect EventDispatcher Object |
| Subclasses | Parallel, Sequence |
<mx:Parallel>
and <mx:Sequence> MXML tags.
Flex supports two methods to combine, or composite, effects:
parallel and sequence.
When you combine multiple effects in parallel,
the effects play at the same time.
When you combine multiple effects in sequence,
one effect must complete before the next effect starts.
You can create a composite effect in MXML, as the following example shows:
<mx:Parallel id="WipeRightUp">
<mx:children>
<mx:WipeRight duration="1000"/>
<mx:WipeUp duration="1000"/>
</mx:children>
</mx:Parallel>
<mx:VBox id="myBox" hideEffect="WipeRightUp">
<mx:TextArea id="aTextArea" text="hello"/>
</mx:VBox>
The <mx:children> tag is optional.
Starting a composite effect in ActionScript is usually a five-step process:
myFadeEffect = new mx.effects.Fade(target);
duration,
on the individual effect objects.mySequenceEffect = new mx.effects.Sequence();
addChild() method for each
of the effect objects; for example:
mySequenceEffect.addChild(myFadeEffect);
play() method;
for example:
mySequenceEffect.play();
Hide MXML Syntax
The CompositeEffect class adds the following tag attributes, and all the subclasses of the CompositeEffect class inherit these tag attributes:
Show MXML Syntax
<mx:tagname>
<mx:children>
<!-- Specify child effect tags -->
</mx:children>
</mx:tagname>
Default MXML Propertychildren
| Property | Defined by | ||
|---|---|---|---|
| children : Array
An Array containing the child effects of this CompositeEffect.
| CompositeEffect | ||
 | className : String
The name of the effect class, such as
"Fade". | Effect | |
| constructor : Object
A reference to the class object or constructor function for a given object instance.
| Object | |
| 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 | |
| filter : String
Specifies an algorithm for filtering targets for an 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 | |
| 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 UIComponent object to which this effect is applied.
| Effect | |
| targets : Array
An Array of UIComponent objects that are targets for the effect.
| Effect | |
| Method | Defined by | ||
|---|---|---|---|
|
CompositeEffect(target:Object = null)
Constructor.
| CompositeEffect | ||
|
Adds a new child effect to this composite effect.
| CompositeEffect | ||
|
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 | |
|
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 | |
|
Takes an Array of target objects and invokes the
createInstance() method on each target. | Effect | |
|
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 | |
|
Returns an Array of Strings, where each String is the name
of a property that is changed by this effect.
| Effect | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event.
| EventDispatcher | |
|
pause():void
Pauses the effect until you call the
resume() method. | Effect | |
|
Begins playing the effect.
| Effect | |
|
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 | |
|
Sets the availability of a dynamic property for loop operations.
| Object | |
|
Returns the string representation of the specified object.
| Object | |
|
Returns the primitive value of the specified object.
| Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type.
| EventDispatcher | |
| children | property |
public var children:ArrayAn Array containing the child effects of this CompositeEffect.
| CompositeEffect | () | constructor |
public function CompositeEffect(target:Object = null)Constructor.
Parameterstarget:Object (default = null) |
| addChild | () | method |
public function addChild(childEffect:Effect):voidAdds a new child effect to this composite effect. A Sequence effect plays each child effect one at a time, in the order that they were added. A Parallel effect plays all child effects simultaneously; the order in which they are added does not matter.
ParameterschildEffect:Effect — Child effect to be added
to the composite effect.
|