AddActionInstance

Package	spark.effects.supportClasses
Class	public class AddActionInstance
Inheritance	AddActionInstance ActionEffectInstance EffectInstance EventDispatcher Object

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

The AddActionInstance class implements the instance class for the AddAction effect. Flex creates an instance of this class when it plays an AddAction effect; you do not create one yourself.

Related API Elements

spark.effects.AddAction

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 : mx.effects: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
		index : int = -1 The index of the child within the parent.	AddActionInstance
		playheadTime : Number Current time position of the effect.	EffectInstance
		position : String The position of the child in the display list, relative to the object specified by the relativeTo property.	AddActionInstance
		propertyChanges : PropertyChanges Specifies the PropertyChanges object containing the start and end values for the set of properties relevant to the effect's targets.	EffectInstance
		relativeTo : DisplayObjectContainer The location where the child component is added.	AddActionInstance
		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

Protected Properties

	Property		Defined By
		playCount : int = 0 Number of times that the instance has been played.	EffectInstance
		playedAction : Boolean = false Indicates whether the effect has been played (true), or not (false).	ActionEffectInstance

Public Methods

	Method		Defined By
		AddActionInstance(target:Object) Constructor.	AddActionInstance
		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
		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
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		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

Protected Methods

	Method		Defined By
		getStartValue():* Returns the starting state value that was saved by the saveStartValue() method.	ActionEffectInstance
		saveStartValue():* Subclasses implement this method to save the starting state before the effect plays.	ActionEffectInstance

Events

Click for more information on events

	Event		Summary	Defined By
		activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
		deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher

Property Detail

index

property

public var index:int = -1

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

The index of the child within the parent. A value of -1 means add the child as the last child of the parent.

position

property

public var position:String

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

The position of the child in the display list, relative to the object specified by the relativeTo property. Valid values are AddAction.BEFORE, AddAction.AFTER, AddAction.FIRST_CHILD, AddAction.LAST_CHILD, and AddAction.INDEX, where AddAction.INDEX specifies the use of the index property to determine the position of the child.

relativeTo

property

public var relativeTo:DisplayObjectContainer

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

The location where the child component is added. By default, Flex determines this value from the AddChild property definition in the view state definition.

Constructor Detail