IEffectInstance  - AS3 Flex

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.

The duration of the effect, in milliseconds.

The default value is 500.

The IEffect object that created this IEffectInstance object.

A property that lets you access the target list-based control of a data effect. This property enables an instance of an effect class to communicate with the list-based control on which the effect is playing.

Determines whether the effect should hide the focus ring when starting the effect. The effect target is responsible for the hiding the focus ring. Subclasses of the UIComponent class hide the focus ring automatically. If the effect target is not a subclass of the UIComponent class, you must add functionality to it to hide the focus ring.

Set this property to true to hide the focus ring during the effect.

For subclasses of Effect, the default value is false. For subclasses of MaskEffect, the default value is true.

Current time position of the effect. This property has a value between 0 and the total duration, which includes the Effect's startDelay, repeatCount, and repeatDelay.

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.

Related API Elements

Number of times to repeat the effect. Possible values are any integer greater than or equal to 0.

The default value is 1.

Related API Elements

Amount of time, in milliseconds, to wait before repeating the effect.

The default value is 0.

Related API Elements

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.

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.

Related API Elements

The UIComponent object to which this effect is applied.

Related API Elements

The 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.

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.

Related API Elements

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.

Related API Elements

Called 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.

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.

Parameters

Pauses the effect until you call the resume() method.

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.

Resumes the effect after it has been paused by a call to the pause() method.

Plays the effect in reverse, starting from the current position of the effect.

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.

Stops the effect, leaving the target in its current state. This method is invoked by a call to the Effect.stop() 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.