(Preview)
| Package | mx.effects.effectClasses |
| Class | public class PauseInstance |
| Inheritance | PauseInstance  TweenEffectInstance EffectInstance EventDispatcher Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Related API Elements
Public Properties
Hide Inherited Public Properties
Show Inherited 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 | |
| easingFunction : Function
The easing function for the animation. | TweenEffectInstance | |
| 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 | |
| eventName : String
Name of event that Pause is waiting on before ending. | PauseInstance | ||
| hideFocusRing : Boolean
Determines whether the effect should hide
the focus ring when starting the effect. | EffectInstance | |
| playheadTime : Number [override]
Current time position of the effect. | TweenEffectInstance | |
| propertyChanges : PropertyChanges
Specifies the PropertyChanges object containing
the start and end values for the set of properties
relevant to the effect's targets. | EffectInstance | |
| 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 | |
| tween : mx.effects:Tween
The Tween object, which determines the animation. | TweenEffectInstance | |
Protected Properties
Public Methods
| Method | Defined By | ||
|---|---|---|---|
PauseInstance(target:Object)
Constructor. | PauseInstance | ||
| 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 | |
|
Dispatches an event into the event flow. | EventDispatcher | |
| [override]
Interrupts an effect that is currently playing,
and immediately jumps to the end of the effect. | TweenEffectInstance | |
|
Called by the end() method when the effect
finishes playing. | EffectInstance | |
|
Called after each iteration of a repeated effect finishes playing. | EffectInstance | |
|
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 | |
|
This method is called if the effect was triggered by the EffectManager. | EffectInstance | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Callback method that is called when the target should be updated
by the effect for the last time. | TweenEffectInstance | |
|
Callback method that is called when the target should be updated
by the effect. | TweenEffectInstance | |
|
Pauses the effect until you call the resume() method. | EffectInstance | |
|
Plays the effect instance on the target. | EffectInstance | |
|
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. | EffectInstance | |
|
Plays the effect in reverse, starting from
the current position of the effect. | EffectInstance | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Plays the effect instance on the target after the
startDelay period has elapsed. | EffectInstance | |
|
Stops the effect, leaving the target in its current state. | EffectInstance | |
|
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
Property Detail
eventName | property |
public var eventName:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Name of event that Pause is waiting on before ending.
This parameter must be used in conjunction with the
target property, which must be of type
IEventDispatcher; all events must originate
from some dispatcher.
Listening for eventName is also related to the
duration property, which acts as a timeout for the
event. If the event is not received in the time period specified
by duration, the effect will end, regardless.
This property is optional; the default action is to play without waiting for any event.
Constructor Detail
PauseInstance | () | Constructor |
Wed Nov 21 2018, 06:34 AM -08:00