| Package | mx.effects |
| Class | public class EffectInstance |
| Inheritance | EffectInstance  EventDispatcher Object |
| Subclasses | ActionEffectInstance, CompositeEffectInstance, MaskEffectInstance, SoundEffectInstance, TweenEffectInstance |
Effect developers must create an instance class for their custom effects.
See also
| 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
Duration of the effect in milliseconds.
| EffectInstance | ||
| effect : Effect
The Effect object that created this EffectInstance object.
| EffectInstance | ||
| playheadTime : Number
[read-only]
Current position in time of the effect.
| EffectInstance | ||
| propertyChanges : PropertyChanges
Specifies the PropertyChanges object containing the start and end values for
the set of properties relevant to the effect's targets.
| EffectInstance | ||
| prototype : Object
[static]
A reference to the prototype object of a class or function object.
| Object | |
| repeatCount : int = 1
Number of times to repeat the effect.
| EffectInstance | ||
| repeatDelay : int = 0
Amount of time, in milliseconds, to wait before repeating the effect.
| EffectInstance | ||
| startDelay : int = 0
Amount of time, in milliseconds, to wait before starting the effect.
| EffectInstance | ||
| suspendBackgroundProcessing : Boolean = false
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 | ||
| Method | Defined by | ||
|---|---|---|---|
|
EffectInstance(target:Object)
Constructor.
| EffectInstance | ||
|
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 | |
|
Interrupts an effect instance that is currently playing,
and jumps immediately to the end of the effect.
| EffectInstance | ||
|
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 | |
|
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 | ||
|
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 | |
| className | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesclassName:String [read-only]
The name of the effect class, such as "FadeInstance".
This is a short or "unqualified" class name
that does not include the package name.
If you need the qualified name, use the
getQualifiedClassName() method
in the flash.utils package.
public function get className():String
| duration | property |
duration:Number [read-write]Duration of the effect in milliseconds.
The default value is 500.
public function get duration():Number
public function set duration(value:Number):void
| effect | property |
public var effect:EffectThe Effect object that created this EffectInstance object.
| playheadTime | property |
playheadTime:Number [read-only]
Current position in time of the effect.
This property has a value between 0 and the actual duration
(which includes the value of the startDelay,
repeatCount, and repeatDelay properties).
public function get playheadTime():Number
| propertyChanges | property |
public var propertyChanges:PropertyChanges
Specifies the PropertyChanges object containing the start and end values for
the set of properties relevant to the effect's targets.
This property is only set if the captureStartValues() method
was called on the effect that created this effect instance.
You often use the propertyChanges property
to create an effect that is used as part of a transition.
Flex automatically calls the captureStartValues() method
when it starts a transition. Within your override of
the Effectinstance.play() method,
you can examine the information within the
propertyChanges() method to initialize the start and end
values of the effect.
See also
| repeatCount | property |
public var repeatCount:int = 1Number of times to repeat the effect. Possible values are any integer greater than or equal to 0.
The default value is 1.
See also
| repeatDelay | property |
public var repeatDelay:int = 0Amount of time, in milliseconds, to wait before repeating the effect.
The default value is 0.
See also
| startDelay | property |
public var startDelay:int = 0
Amount of time, in milliseconds, to wait before starting the effect.
Possible values are any int greater than or equal to 0. If the effect
is repeated by using the repeatCount property, the startDelay property is
applied only the first time the effect is played.
The default value is 0.
| suspendBackgroundProcessing | property |
public var suspendBackgroundProcessing:Boolean = false
If true, blocks all background processing
while the effect is playing.
Background processing includes measurement, layout, and
processing responses that have arrived from the server.
The default value is false.
See also
| target | property |
| triggerEvent | property |
public var triggerEvent:EventThe event, if any, which triggered the playing of the effect. This property is useful when an effect is assigned to multiple triggering events.
If the effect was played programmatically by a call to the
play() method,
rather than being triggered by an event,
this property is null.
| EffectInstance | () | constructor |
public function EffectInstance(target:Object)Constructor.
Parameterstarget:Object — UIComponent object to animate with this effect.
|
| end | () | method |
public function end():void
Interrupts an effect instance that is currently playing,
and jumps immediately to the end of the effect. This method is
invoked by a call to the Effect.end() method.
As part of its implementation, it calls the
finishEffect() method.
The effect instance dispatches an effectEnd event
when you call this method as part of ending the effect.
In a subclass of EffectInstance, you can
optionally override this method. As part of your override, you should
call the super.end() method from the end of your
override, after your logic.
See also
| finishEffect | () | method |
public function finishEffect():void
Called by the end() method when the effect
finishes playing.
This function dispatches an endEffect event
for the effect target.
You do not have to override this method in a subclass. You do not need to call this method when using effects, but you may need to call it if you create an effect subclass.
See also
| finishRepeat | () | method |
public function finishRepeat():voidCalled after each iteration of a repeated effect finishes playing.
You do not have to override this method in a subclass. You do not need to call this method when using effects.
| initEffect | () | method |
public function initEffect(event:Event):void
This method is called if the effect was triggered by the EffectManager.
This base class version saves the event that triggered the effect
in the triggerEvent property.
Each subclass should override this method.
event:Event — The Event object that was dispatched to trigger
the effect.
For example, if the trigger was a mouseDownEffect, the event
would be a MouseEvent with type equal to MouseEvent.MOUSEDOWN.
|
| pause | () | method |
public function pause():void
Pauses the effect until you call the resume() method.
| play | () | method |
public function play():void
Plays the effect instance on the target. Call the startEffect()
method instead to make an effect start playing on an EffectInstance.
In a subclass of EffectInstance, you must override this method.
The override must call the super.play() method
so that an effectStart event is dispatched from the target.
See also
| resume | () | method |
public function resume():void
Resumes the effect after it has been paused
by a call to the pause() method.
| reverse | () | method |
public function reverse():voidPlays the effect in reverse, starting from the current position of the effect.
| startEffect | () | method |
public function startEffect():void
Plays the effect instance on the target after the startDelay period
has elapsed. Called by the Effect class. Use this function instead of
the play() method when starting an EffectInstance.