Package | mx.events |
Class | public class ModuleEvent |
Inheritance | ModuleEvent flash.events.ProgressEvent |
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 |
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 |
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 |
errorText | property |
public var errorText:String
The error message if the type is ModuleEvent.ERROR
;
otherwise, it is null
.
module | property |
module:IModuleInfo
[read-only]
The target
, which is an instance of an
interface for a particular module.
public function get module():IModuleInfo
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)
Constructor.
Parameterstype:String — The type of event. Possible values are:
|
|
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 )
|
ERROR | constant |
public static const ERROR:String = "error"
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"
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"
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"
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"
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. |