| Package | mx.effects |
| Class | public class CompositeEffect |
| Inheritance | CompositeEffect  Effect flash.events.EventDispatcher |
| Subclasses | Parallel, Sequence |
| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
<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 SyntaxThe 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 [read-only]
The name of the effect class, such as "Fade". | Effect | |
| compositeDuration : Number [read-only]
Returns the duration of this effect as defined by the duration of
all child effects. | CompositeEffect | ||
| 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 | |
| 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 [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 | |
| 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 | |
| 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 | |
| Method | Defined By | ||
|---|---|---|---|
CompositeEffect(target:Object = null)
Constructor. | CompositeEffect | ||
Adds a new child effect to this composite effect. | CompositeEffect | ||
| 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 | |
| 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 | |
| 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 | |
| children | property |
children:Array| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
An Array containing the child effects of this CompositeEffect.
public function get children():Array public function set children(value:Array):void| compositeDuration | property |
compositeDuration:Number [read-only] | Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Returns the duration of this effect as defined by the duration of all child effects. This takes into account the startDelay and repetition info for all child effects, along with their durations, and returns the appropriate result.
public function get compositeDuration():Number| CompositeEffect | () | Constructor |
public function CompositeEffect(target:Object = null)| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Constructor.
Parameterstarget:Object (default = null) |
| addChild | () | method |
public function addChild(childEffect:IEffect):void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Adds 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.
Parameters
childEffect:IEffect — Child effect to be added
to the composite effect.
|