(Preview)
| Package | spark.effects |
| Class | public class AddAction |
| Inheritance | AddAction  Effect EventDispatcher Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
AddChild property of a view state definition.
You use an AddAction effect within a transition definition
to control when the view state change defined by an AddChild property
occurs during the transition.
MXML Syntax
Show MXML Syntax
Hide MXML SyntaxThe <s:AddAction> tag
inherits all of the tag attributes of its superclass,
and adds the following tag attributes:
<s:AddAction
Properties
id="ID"
index="-1"
position="index"
relativeTo=""
/>
Related API Elements
Public Properties
| Property | Defined By | ||
|---|---|---|---|
 | className : String [read-only]
The name of the effect class, such as "Fade". | Effect | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| customFilter : mx.effects:EffectTargetFilter
Specifies a custom filter object, of type EffectTargetFilter,
used by the effect to determine the targets
on which to play the effect. | Effect | |
| effectTargetHost : mx.effects:IEffectTargetHost
A property that lets you access the target list-based control
of a data effect. | Effect | |
| filter : String
Specifies an algorithm for filtering targets for an effect. | Effect | |
| hideFocusRing : Boolean
Determines whether the effect should hide the focus ring
when starting the effect. | Effect | |
| index : int = -1
The index of the child within the parent. | AddAction | ||
| instanceClass : Class
An object of type Class that specifies the effect
instance class class for this effect class. | Effect | |
| isPlaying : Boolean [read-only]
A read-only flag which is true if any instances of the effect
are currently playing, and false if none are. | Effect | |
| perElementOffset : Number
Additional delay, in milliseconds, for effect targets
after the first target of the effect. | Effect | |
| playheadTime : Number
Current time position of the effect. | Effect | |
| position : String = "index"
The position of the child in the display list, relative to the
object specified by the relativeTo property. | AddAction | ||
| relativeTo : DisplayObjectContainer
The location where the child component is added. | AddAction | ||
| relevantProperties : Array
An Array of property names to use when performing filtering. | Effect | |
| relevantStyles : Array
An Array of style names to use when performing filtering. | Effect | |
| repeatCount : int = 1
Number of times to repeat the effect. | Effect | |
| repeatDelay : int = 0
Amount of time, in milliseconds, to wait before repeating the effect. | Effect | |
| startDelay : int = 0
Amount of time, in milliseconds, to wait before starting the effect. | Effect | |
| suspendBackgroundProcessing : Boolean = false
If true, blocks all background processing
while the effect is playing. | Effect | |
| target : Object
The object to which this effect is applied. | Effect | |
| targets : Array
An Array of objects that are targets for the effect. | Effect | |
| triggerEvent : Event
The Event object passed to this Effect
by the EffectManager when an effect is triggered,
or null if the effect is not being
played by the EffectManager. | Effect | |
Protected Properties
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Constructor. | AddAction | ||
| 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 | |
|
Captures the current values of the relevant properties
on the effect's targets and saves them as end values. | Effect | |
|
Captures the current values of the relevant properties
of an additional set of targets
Flex uses this function when a data change
effect is run.
| Effect | |
|
Captures the current values of the relevant properties
on the effect's targets. | Effect | |
|
Creates a single effect instance and initializes it. | Effect | |
|
Takes an Array of target objects and invokes the
createInstance() method on each target. | Effect | |
|
Removes event listeners from an instance
and removes it from the list of instances. | Effect | |
|
Dispatches an event into the event flow. | EventDispatcher | |
|
Interrupts an effect that is currently playing,
and jumps immediately to the end of the effect. | Effect | |
|
Returns an Array of Strings, where each String is the name
of a property changed by this effect. | Effect | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Pauses the effect until you call the resume() method. | Effect | |
|
Begins playing the effect. | Effect | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Resumes the effect after it has been paused
by a call to the pause() method. | Effect | |
|
Plays the effect in reverse, if the effect is currently playing,
starting from the current position of the effect. | Effect | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Stops the effect, leaving the effect targets in their current state. | Effect | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
Protected Methods
Public Constants
| Constant | Defined By | ||
|---|---|---|---|
| AFTER : String = "after" [static]
Constant used to specify the position to add the item relative to the
object specified by the relativeTo property. | AddAction | ||
| BEFORE : String = "before" [static]
Constant used to specify the position to add the item relative to the
object specified by the relativeTo property. | AddAction | ||
| FIRST_CHILD : String = "firstChild" [static]
Constant used to specify the position to add the item relative to the
object specified by the relativeTo property. | AddAction | ||
| INDEX : String = "index" [static]
Constant used to specify the position to add the item relative to the
object specified by the relativeTo property. | AddAction | ||
| LAST_CHILD : String = "lastChild" [static]
Constant used to specify the position to add the item relative to the
object specified by the relativeTo property. | AddAction | ||
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.
The default value is -1.
position | property |
public var position:String = "index"| 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.
The default value is AddAction.INDEX.
Related API Elements
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
AddAction | () | Constructor |
Constant Detail
AFTER | Constant |
BEFORE | Constant |
FIRST_CHILD | Constant |
INDEX | Constant |
LAST_CHILD | Constant |
Wed Nov 21 2018, 06:34 AM -08:00