Adobe Flex 2 Language Reference - collected by Jimbob | Back to MY RESOURCES


Packagemx.effects.effectClasses
Classpublic class CompositeEffectInstance
InheritanceCompositeEffectInstance Inheritance EffectInstance Inheritance EventDispatcher Inheritance Object
SubclassesParallelInstance, SequenceInstance

The CompositeEffectInstance class implements the instance class for the CompositeEffect class. Flex creates an instance of this class when it plays a CompositeEffect; you do not create one yourself.

See also

mx.effects.CompositeEffect


Public Properties
 PropertyDefined by
 InheritedclassName : String
The name of the effect class, such as "FadeInstance".
EffectInstance
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 Inheritedduration : Number
Duration of the effect in milliseconds.
EffectInstance
 Inheritedeffect : Effect
EffectInstance
 InheritedplayheadTime : Number
Current position in time of the effect.
EffectInstance
 InheritedpropertyChanges : PropertyChanges
EffectInstance
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 InheritedrepeatCount : int
EffectInstance
 InheritedrepeatDelay : int
EffectInstance
 InheritedstartDelay : int
EffectInstance
 InheritedsuspendBackgroundProcessing : Boolean
EffectInstance
 Inheritedtarget : Object
EffectInstance
 InheritedtriggerEvent : Event
EffectInstance
Public Methods
 MethodDefined by
  
Constructor.
CompositeEffectInstance
  
addChildSet(childSet:Array):void
Adds a new set of child effects to this Composite effect.
CompositeEffectInstance
 Inherited
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
 Inherited
Dispatches an event into the event flow.
EventDispatcher
 Inherited
end():void
Interrupts an effect instance that is currently playing, and jumps immediately to the end of the effect.
EffectInstance
 Inherited
finishEffect():void
Called by the end() method when the effect finishes playing.
EffectInstance
 Inherited
finishRepeat():void
Called after each iteration of a repeated effect finishes playing.
EffectInstance
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
initEffect(event:Event):void
This method is called if the effect was triggered by the EffectManager.
EffectInstance
  
onTweenEnd(value:Object):void
Used internally to keep track of the value of the playheadTime property.
CompositeEffectInstance
  
onTweenUpdate(value:Object):void
Used internally to keep track of the value of the playheadTime property.
CompositeEffectInstance
 Inherited
pause():void
Pauses the effect until you call the resume() method.
EffectInstance
 Inherited
play():void
Plays the effect instance on the target.
EffectInstance
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
resume():void
Resumes the effect after it has been paused by a call to the pause() method.
EffectInstance
 Inherited
reverse():void
Plays the effect in reverse, starting from the current position of the effect.
EffectInstance
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
startEffect():void
Plays the effect instance on the target after the startDelay period has elapsed.
EffectInstance
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Protected Methods
 MethodDefined by
  
onEffectEnd(childEffect:IEffectInstance):void
Called each time one of the child effects has finished playing.
CompositeEffectInstance
Events
 EventSummaryDefined by
 Inherited Dispatched when Flash Player gains operating system focus and becomes active.EventDispatcher
 Inherited Dispatched when Flash Player loses operating system focus and is becoming inactive.EventDispatcher
Constructor detail
CompositeEffectInstance()constructor
public function CompositeEffectInstance(target:Object)

Constructor.

Parameters
target:Object — This argument is ignored for Composite effects. It is included only for consistency with other types of effects.
Method detail
addChildSet()method
public function addChildSet(childSet:Array):void

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

Called each time one of the child effects has finished playing. Subclasses must implement this function.

Parameters
childEffect:IEffectInstance — child effect.
onTweenEnd()method 
public function onTweenEnd(value:Object):void

Used internally to keep track of the value of the playheadTime property.

Parameters
value:Object
onTweenUpdate()method 
public function onTweenUpdate(value:Object):void

Used internally to keep track of the value of the playheadTime property.

Parameters
value:Object





collected by Jimbob 2007.05