| Package | spark.effects |
| Class | public class AddAction |
| Inheritance | AddAction  Effect flash.events.EventDispatcher |
| 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
Hide MXML SyntaxThe <s:AddAction> tag
inherits all of the tag attributes of its superclass,
and adds the following tag attributes:
Show MXML Syntax
<s:AddAction
Properties
id="ID"
index="-1"
position="index"
relativeTo=""
/>
See also
| Property | Defined By | ||
|---|---|---|---|
 | className : String [read-only]
The name of the effect class, such as "Fade". | Effect | |
| customFilter : 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 : 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 | |
| Method | Defined By | ||
|---|---|---|---|
AddAction(target:Object = null)
Constructor. | AddAction | ||
| captureEndValues():void
Captures the current values of the relevant properties
on the effect's targets and saves them as end values. | Effect | |
| captureMoreStartValues(targets:Array):void
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 | |
| captureStartValues():void
Captures the current values of the relevant properties
on the effect's targets. | Effect | |
| createInstance(target:Object = null):IEffectInstance
Creates a single effect instance and initializes it. | Effect | |
| createInstances(targets:Array = null):Array
Takes an Array of target objects and invokes the
createInstance() method on each target. | Effect | |
| deleteInstance(instance:IEffectInstance):void
Removes event listeners from an instance
and removes it from the list of instances. | Effect | |
| end(effectInstance:IEffectInstance = null):void
Interrupts an effect that is currently playing,
and jumps immediately to the end of the effect. | Effect | |
| getAffectedProperties():Array
Returns an Array of Strings, where each String is the name
of a property changed by this effect. | Effect | |
| pause():void
Pauses the effect until you call the resume() method. | Effect | |
| play(targets:Array = null, playReversedFromEnd:Boolean = false):Array
Begins playing the effect. | Effect | |
| resume():void
Resumes the effect after it has been paused
by a call to the pause() method. | Effect | |
| reverse():void
Plays the effect in reverse, if the effect is currently playing,
starting from the current position of the effect. | Effect | |
| stop():void
Stops the effect, leaving the effect targets in their current state. | Effect | |
| 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 | ||
| 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.
See also
| 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.
| AddAction | () | Constructor |
public function AddAction(target:Object = null)| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Constructor.
Parameterstarget:Object (default = null) |
| AFTER | Constant |
public static const AFTER:String = after| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Constant used to specify the position to add the item relative to the
object specified by the relativeTo property.
See also
| BEFORE | Constant |
public static const BEFORE:String = before| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Constant used to specify the position to add the item relative to the
object specified by the relativeTo property.
See also
| FIRST_CHILD | Constant |
public static const FIRST_CHILD:String = firstChild| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Constant used to specify the position to add the item relative to the
object specified by the relativeTo property.
See also
| INDEX | Constant |
public static const INDEX:String = index| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Constant used to specify the position to add the item relative to the
object specified by the relativeTo property.
See also
| LAST_CHILD | Constant |
public static const LAST_CHILD:String = lastChild| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Constant used to specify the position to add the item relative to the
object specified by the relativeTo property.
See also