mx.effects

# EffectManager - AS3 Flex

Package | mx.effects
Class | public class EffectManager
Inheritance | EffectManager EventDispatcher Object

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.

Learn more

About effects
Using MX effects
Handling MX effect events
About transitions

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | 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
|  | dispatchEvent(event:Event):Boolean Dispatches an event into the event flow. | EventDispatcher
|  | endEffectsForTarget(target:IUIComponent):void [static] Immediately ends any effects currently playing on a target. | EffectManager
|  | hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event. | EventDispatcher
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object. | EventDispatcher
|  | resumeEventHandling():void [static] Allows the EffectManager class to resume processing events after a call to the suspendEventHandling() method. | EffectManager
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | 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
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns the string representation of the specified object. | Object
|  | valueOf():Object Returns the primitive value of the specified object. | Object
|  | willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | EventDispatcher

Events
Click for more information on events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | activate | [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher
|  | deactivate | [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher

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.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00