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


Packagemx.effects.effectClasses
Classpublic class AddChildActionInstance
InheritanceAddChildActionInstance Inheritance ActionEffectInstance Inheritance EffectInstance Inheritance EventDispatcher Inheritance Object

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

See also

mx.effects.AddChildAction


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
  index : int = -1
The index of the child within the parent.
AddChildActionInstance
 InheritedplayheadTime : Number
Current position in time of the effect.
EffectInstance
  position : String
The position of the child component, relative to relativeTo, where it is added.
AddChildActionInstance
 InheritedpropertyChanges : PropertyChanges
EffectInstance
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  relativeTo : DisplayObjectContainer
The location where the child component is added.
AddChildActionInstance
 InheritedrepeatCount : int
EffectInstance
 InheritedrepeatDelay : int
EffectInstance
 InheritedstartDelay : int
EffectInstance
 InheritedsuspendBackgroundProcessing : Boolean
EffectInstance
 Inheritedtarget : Object
EffectInstance
 InheritedtriggerEvent : Event
EffectInstance
Protected Properties
 PropertyDefined by
 InheritedplayedAction : Boolean = false
Indicates whether the effect has been played (true), or not (false).
ActionEffectInstance
Public Methods
 MethodDefined by
  
Constructor.
AddChildActionInstance
 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
 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
 Inherited
Used internally to retrieve the values saved by the saveStartValue() method.
ActionEffectInstance
 Inherited
Subclasses implement this method to save the starting state before the effect plays.
ActionEffectInstance
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
Property detail
indexproperty
public var index:int = -1

The index of the child within the parent.

positionproperty 
public var position:String

The position of the child component, relative to relativeTo, where it is added.

relativeToproperty 
public var relativeTo:DisplayObjectContainer

The location where the child component is added.

Constructor detail
AddChildActionInstance()constructor
public function AddChildActionInstance(target:Object)

Constructor.

Parameters
target:Object — The Object to animate with this effect.





collected by Jimbob 2007.05