Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
ModuleEvent

Package | mx.events
Class | public class ModuleEvent
Inheritance | ModuleEvent flash.events.ProgressEvent

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The ModuleEvent class represents the event object passed to the event listener for events related to dynamically-loaded modules.

Public Properties

| Property | Defined By
--- | --- | ---
|  | errorText : String The error message if the type is ModuleEvent.ERROR; otherwise, it is null. | ModuleEvent
|  | module : IModuleInfo [read-only] The target, which is an instance of an interface for a particular module. | ModuleEvent

Public Methods

| Method | Defined By
--- | --- | ---
|  | ModuleEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bytesLoaded:uint = 0, bytesTotal:uint = 0, errorText:String = null, module:IModuleInfo = null) Constructor. | ModuleEvent

Public Constants

| Constant | Defined By
--- | --- | ---
|  | ERROR : String = error [static] Dispatched when there is an error downloading the module. | ModuleEvent
|  | PROGRESS : String = progress [static] Dispatched when the module is in the process of downloading. | ModuleEvent
|  | READY : String = ready [static] Dispatched when the module has finished downloading. | ModuleEvent
|  | SETUP : String = setup [static] Dispatched when enough of a module has been downloaded that you can get information about the module. | ModuleEvent
|  | UNLOAD : String = unload [static] Dispatched when the module is unloaded. | ModuleEvent

Property Detail

errorText | property

`public var errorText:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The error message if the type is `ModuleEvent.ERROR`; otherwise, it is `null`.

module | property |

`module:IModuleInfo` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The `target`, which is an instance of an interface for a particular module.

Implementation
`public function get module():IModuleInfo`
Constructor Detail

ModuleEvent | () | Constructor

`public function ModuleEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bytesLoaded:uint = 0, bytesTotal:uint = 0, errorText:String = null, module:IModuleInfo = null)`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Constructor.

Parameters

| `type:String` — The type of event. Possible values are: "progress" (`ModuleEvent.PROGRESS`); "ready" (`ModuleEvent.READY`); "setup" (`ModuleEvent.SETUP`); "error" (`ModuleEvent.ERROR`); "unload" (`ModuleEvent.UNLOAD`);
| `bubbles:Boolean` (default = `false`)`` — Determines whether the Event object participates in the bubbling stage of the event flow.
| `cancelable:Boolean` (default = `false`)`` — Determines whether the Event object can be cancelled during event propagation.
| `bytesLoaded:uint` (default = `0`)`` — The number of bytes loaded at the time the listener processes the event.
| `bytesTotal:uint` (default = `0`)`` — The total number of bytes that will be loaded if the loading process succeeds.
| `errorText:String` (default = `null`)`` — The error message when the event type is `ModuleEvent.ERROR`.
| `module:IModuleInfo` (default = `null`)`` — An instance of an interface for a particular module. .

Constant Detail

ERROR | Constant

`public static const ERROR:String = error`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Dispatched when there is an error downloading the module. The `ModuleEvent.ERROR` constant defines the value of the `type` property of the event object for an `error` event.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`bytesLoaded` | Empty
`bytesTotal` | Empty
`cancelable` | false
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`errorText` | The error message.
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

PROGRESS | Constant |

`public static const PROGRESS:String = progress`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Dispatched when the module is in the process of downloading. This module is dispatched at regular intervals during the download process. The `ModuleEvent.PROGRESS` constant defines the value of the `type` property of the event object for a `progress` event.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`bytesLoaded` | The number of bytes loaded.
`bytesTotal` | The total number of bytes to load.
`cancelable` | false
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`errorText` | Empty
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

READY | Constant |

`public static const READY:String = ready`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Dispatched when the module has finished downloading. The `ModuleEvent.READY` constant defines the value of the `type` property of the event object for a `complete` event.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`bytesLoaded` | The number of bytes loaded.
`bytesTotal` | The total number of bytes to load.
`cancelable` | false
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`errorText` | Empty
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

SETUP | Constant |

`public static const SETUP:String = setup`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Dispatched when enough of a module has been downloaded that you can get information about the module. You do this by calling the `IFlexModuleFactory.info()` method on the module. The `ModuleEvent.SETUP` constant defines the value of the `type` property of the event object for a `setup` event.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`bytesLoaded` | Empty
`bytesTotal` | Empty
`cancelable` | false
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`errorText` | An error message.
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

UNLOAD | Constant |

`public static const UNLOAD:String = unload`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Dispatched when the module is unloaded. The `ModuleEvent.UNLOAD` constant defines the value of the `type` property of the event object for an `unload` event.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`bytesLoaded` | Empty
`bytesTotal` | Empty
`cancelable` | false
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`errorText` | An error message.
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

Wed Nov 15 2017, 09:50 AM +01:00