| Package | mx.effects.effectClasses |
| Class | public class CompositeEffectInstance |
| Inheritance | CompositeEffectInstance  EffectInstance flash.events.EventDispatcher |
| Subclasses | ParallelInstance, SequenceInstance |
| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
See also
| Property | Defined By | ||
|---|---|---|---|
 | className : String [read-only]
The name of the effect class, such as "FadeInstance". | EffectInstance | |
| duration : Number
The duration of the effect, in milliseconds. | EffectInstance | |
| effect : IEffect
The IEffect object that created this IEffectInstance object. | EffectInstance | |
| effectTargetHost : IEffectTargetHost
A property that lets you access the target
list-based control of a data effect. | EffectInstance | |
| hideFocusRing : Boolean
Determines whether the effect should hide
the focus ring when starting the effect. | EffectInstance | |
| playheadTime : Number [override]
Current time position of the effect. | CompositeEffectInstance | ||
| propertyChanges : PropertyChanges
Specifies the PropertyChanges object containing
the start and end values for the set of properties
relevant to the effect's targets. | EffectInstance | |
| repeatCount : int
Number of times to repeat the effect. | EffectInstance | |
| repeatDelay : int
Amount of time, in milliseconds,
to wait before repeating the effect. | EffectInstance | |
| startDelay : int
Amount of time, in milliseconds,
to wait before starting the effect. | EffectInstance | |
| suspendBackgroundProcessing : Boolean
If true, blocks all background processing
while the effect is playing. | EffectInstance | |
| target : Object
The UIComponent object to which this effect is applied. | EffectInstance | |
| triggerEvent : Event
The event, if any, which triggered the playing of the effect. | EffectInstance | |
| Method | Defined By | ||
|---|---|---|---|
CompositeEffectInstance(target:Object)
Constructor. | CompositeEffectInstance | ||
addChildSet(childSet:Array):void
Adds a new set of child effects to this Composite effect. | CompositeEffectInstance | ||
| end():void
Interrupts an effect instance that is currently playing,
and jumps immediately to the end of the effect. | EffectInstance | |
| 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 | |
| initEffect(event:Event):void
This method is called if the effect was triggered by the EffectManager. | EffectInstance | |
| pause():void
Pauses the effect until you call the resume() method. | EffectInstance | |
| play():void
Plays the effect instance on the target. | EffectInstance | |
| 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 | |
| startEffect():void
Plays the effect instance on the target after the
startDelay period has elapsed. | EffectInstance | |
| stop():void
Stops the effect, leaving the target in its current state. | EffectInstance | |
| Method | Defined By | ||
|---|---|---|---|
onEffectEnd(childEffect:IEffectInstance):void
Called each time one of the child effects has finished playing. | CompositeEffectInstance | ||
| playheadTime | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesplayheadTime:Number[override] | Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Current time position of the effect.
This property has a value between 0 and the total duration,
which includes the Effect's startDelay,
repeatCount, and repeatDelay.
public function get playheadTime():Number public function set playheadTime(value:Number):void| CompositeEffectInstance | () | Constructor |
public function CompositeEffectInstance(target:Object)| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Constructor.
Parameterstarget:Object — This argument is ignored for Composite effects.
It is included only for consistency with other types of effects.
|
| addChildSet | () | method |
public function addChildSet(childSet:Array):void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Adds a new set of child effects to this Composite effect. A Sequence effect plays each child effect set one at a time, in the order that it is added. A Parallel effect plays all child effect sets simultaneously; the order in which they are added doesn't matter.
Parameters
childSet:Array — Array of child effects to be added
to the CompositeEffect.
|
| onEffectEnd | () | method |
protected function onEffectEnd(childEffect:IEffectInstance):void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Called each time one of the child effects has finished playing. Subclasses must implement this function.
Parameters
childEffect:IEffectInstance — child effect.
|