mx.effects.effectClasses.CompositeEffectInstance (Flex 3)

Public Properties

	Property		Defined By
		className : String [read-only] The name of the effect class, such as "FadeInstance".	EffectInstance
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		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 [read-only] Current position in time of the effect.	EffectInstance
		propertyChanges : PropertyChanges Specifies the PropertyChanges object containing the start and end values for the set of properties relevant to the effect's targets.	EffectInstance
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		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

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		CompositeEffectInstance(target:Object) Constructor.	CompositeEffectInstance
		addChildSet(childSet:Array):void Adds a new set of child effects to this Composite effect.	CompositeEffectInstance
		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
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		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
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		initEffect(event:Event):void This method is called if the effect was triggered by the EffectManager.	EffectInstance
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		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
		pause():void Pauses the effect until you call the resume() method.	EffectInstance
		play():void Plays the effect instance on the target.	EffectInstance
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void 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.	EffectInstance
		reverse():void Plays the effect in reverse, starting from the current position of the effect.	EffectInstance
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		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
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

	Method	Defined By
		onEffectEnd(childEffect:IEffectInstance):void Called each time one of the child effects has finished playing.	CompositeEffectInstance

	Event	Summary	Defined By
		activate	Dispatched when Flash Player or an AIR application gains operating system focus and becomes active.	EventDispatcher
		deactivate	Dispatched when Flash Player or an AIR application 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

ActionScript 3.0 Language and Components Reference	All Packages \| All Classes \| Language Elements \| Index \| Appendixes \| Conventions \| Frames No Frames
CompositeEffectInstance	Properties \| Methods \| Events

Package	mx.effects.effectClasses
Class	public class CompositeEffectInstance
Inheritance	CompositeEffectInstance EffectInstance EventDispatcher Object
Subclasses	ParallelInstance, SequenceInstance