Packagemx.effects.effectClasses
Classpublic class ActionEffectInstance
InheritanceActionEffectInstance Inheritance EffectInstance Inheritance flash.events.EventDispatcher
Subclasses AddActionInstance, AddChildActionInstance, AddItemActionInstance, CallActionInstance, RemoveActionInstance, RemoveChildActionInstance, RemoveItemActionInstance, SetActionInstance, SetPropertyActionInstance, SetStyleActionInstance, UnconstrainItemActionInstance

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The ActionEffectInstance class is the superclass for all action effect instance classes.



Public Properties
 PropertyDefined By
 InheritedclassName : String
[read-only] The name of the effect class, such as "FadeInstance".
EffectInstance
 Inheritedduration : Number
The duration of the effect, in milliseconds.
EffectInstance
 Inheritedeffect : IEffect
The IEffect object that created this IEffectInstance object.
EffectInstance
 InheritedeffectTargetHost : IEffectTargetHost
A property that lets you access the target list-based control of a data effect.
EffectInstance
 InheritedhideFocusRing : Boolean
Determines whether the effect should hide the focus ring when starting the effect.
EffectInstance
 InheritedplayheadTime : Number
Current time position of the effect.
EffectInstance
 InheritedpropertyChanges : PropertyChanges
Specifies the PropertyChanges object containing the start and end values for the set of properties relevant to the effect's targets.
EffectInstance
 InheritedrepeatCount : int
Number of times to repeat the effect.
EffectInstance
 InheritedrepeatDelay : int
Amount of time, in milliseconds, to wait before repeating the effect.
EffectInstance
 InheritedstartDelay : int
Amount of time, in milliseconds, to wait before starting the effect.
EffectInstance
 InheritedsuspendBackgroundProcessing : Boolean
If true, blocks all background processing while the effect is playing.
EffectInstance
 Inheritedtarget : Object
The UIComponent object to which this effect is applied.
EffectInstance
 InheritedtriggerEvent : Event
The event, if any, which triggered the playing of the effect.
EffectInstance
Protected Properties
 PropertyDefined By
 InheritedplayCount : 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
 MethodDefined By
  
ActionEffectInstance(target:Object)
Constructor.
ActionEffectInstance
 Inherited
end():void
Interrupts an effect instance that is currently playing, and jumps immediately to the end of the effect.
EffectInstance
 Inherited
Called by the end() method when the effect finishes playing.
EffectInstance
 Inherited
Called after each iteration of a repeated effect finishes playing.
EffectInstance
 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
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
Plays the effect instance on the target after the startDelay period has elapsed.
EffectInstance
 Inherited
stop():void
Stops the effect, leaving the target in its current state.
EffectInstance
Protected Methods
 MethodDefined By
  
Returns the starting state value that was saved by the saveStartValue() method.
ActionEffectInstance
  
Subclasses implement this method to save the starting state before the effect plays.
ActionEffectInstance
Property Detail
playedActionproperty
protected var playedAction:Boolean = false

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Indicates whether the effect has been played (true), or not (false).

The play() method sets this property to true after the effect plays; you do not set it directly.

Constructor Detail
ActionEffectInstance()Constructor
public function ActionEffectInstance(target:Object)

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Constructor.

Parameters
target:Object — The Object to animate with this effect.
Method Detail
getStartValue()method
protected function getStartValue():*

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Returns the starting state value that was saved by the saveStartValue() method.

Returns
* — Returns the starting state value.
saveStartValue()method 
protected function saveStartValue():*

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Subclasses implement this method to save the starting state before the effect plays.

Returns
* — Returns the starting state value.