Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
EffectManager

Package | mx.effects
Class | public class EffectManager
Inheritance | EffectManager flash.events.EventDispatcher

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The EffectManager class listens for events, such as the `show` and `move` events, dispatched by objects in a Flex application. For each event, corresponding to an event trigger, it determines if there is an effect assigned to the object. If an effect is defined, it plays the effect.

Public Methods

| Method | Defined By
--- | --- | ---
|  | endEffectsForTarget(target:IUIComponent):void [static] Immediately ends any effects currently playing on a target. | EffectManager
|  | resumeEventHandling():void [static] Allows the EffectManager class to resume processing events after a call to the suspendEventHandling() method. | EffectManager
|  | suspendEventHandling():void [static] After this method is called, the EffectManager class ignores all events, and no effects are triggered, until a call to resumeEventHandling(). | EffectManager

Method Detail

endEffectsForTarget | () | method

`public static function endEffectsForTarget(target:IUIComponent):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Immediately ends any effects currently playing on a target.

Parameters

| `target:IUIComponent` — The target component on which to end all effects.

resumeEventHandling | () | method |

`public static function resumeEventHandling():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Allows the EffectManager class to resume processing events after a call to the `suspendEventHandling()` method. Used internally in conjunction with the `suspendEventHandling()` method so that an effect that is updating the screen does not cause another effect to be triggered.

suspendEventHandling | () | method |

`public static function suspendEventHandling():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

After this method is called, the EffectManager class ignores all events, and no effects are triggered, until a call to `resumeEventHandling()`. Used internally so that an effect that is updating the screen does not cause another effect to be triggered.

Sun Mar 5 2017, 03:42 PM +11:00