| Package | mx.modules |
| Interface | public interface IModuleInfo extends flash.events.IEventDispatcher |
| Property | Defined by | ||
|---|---|---|---|
| data : Object
User data that can be associated with the singleton IModuleInfo
for a given URL.
| IModuleInfo | ||
| error : Boolean [read-only]
A flag that is
true if there was an error
during module loading. | IModuleInfo | ||
| factory : IFlexModuleFactory
[read-only]
The IFlexModuleFactory implementation defined in the module.
| IModuleInfo | ||
| loaded : Boolean [read-only]
A flag that is
true if the load()
method has been called on this module. | IModuleInfo | ||
| ready : Boolean [read-only]
A flag that is
true if the module is sufficiently loaded
to get a handle to its associated IFlexModuleFactory implementation
and call its create() method. | IModuleInfo | ||
| setup : Boolean [read-only]
A flag that is
true if the module is sufficiently loaded
to get a handle to its associated IFlexModuleFactory implementation
and call its info() method. | IModuleInfo | ||
| url : String [read-only]
The URL associated with this module (for example, "MyImageModule.swf" or
"http://somedomain.com/modules/MyImageModule.swf".
| IModuleInfo | ||
| Method | Defined by | ||
|---|---|---|---|
|
load(applicationDomain:ApplicationDomain = null, securityDomain:SecurityDomain = null, bytes:ByteArray = null):void
Requests that the module be loaded.
| IModuleInfo | ||
|
publish(factory:IFlexModuleFactory):void
Publishes an interface to the ModuleManager.
| IModuleInfo | ||
|
release():void
Releases the current reference to the module.
| IModuleInfo | ||
|
unload():void
Unloads the module.
| IModuleInfo | ||
| Event | Summary | Defined by | ||
|---|---|---|---|---|
| Dispatched by the backing ModuleInfo if there was an error during module loading. | IModuleInfo | |||
| Dispatched by the backing ModuleInfo at regular intervals while the module is being loaded. | IModuleInfo | |||
Dispatched by the backing ModuleInfo once the module is sufficiently
loaded to call the IModuleInfo.factory() method and the
IFlexModuleFactory.create() method. | IModuleInfo | |||
Dispatched by the backing ModuleInfo once the module is sufficiently
loaded to call the IModuleInfo.factory() method and
the IFlexModuleFactory.info() method. | IModuleInfo | |||
| Dispatched by the backing ModuleInfo when the module data is unloaded. | IModuleInfo | |||
| data | property |
data:Object [read-write]User data that can be associated with the singleton IModuleInfo for a given URL.
Implementation public function get data():Object
public function set data(value:Object):void
| error | property |
error:Boolean [read-only]
A flag that is true if there was an error
during module loading.
This flag is true when the ModuleManager dispatches the
ModuleEvent.ERROR event.
public function get error():Boolean
| factory | property |
factory:IFlexModuleFactory [read-only]
The IFlexModuleFactory implementation defined in the module.
This will only be non-null after the
ModuleEvent.SETUP event has been dispatched
(or the IModuleInfo.setup() method returns true).
At this point, the IFlexModuleFactory.info() method can be called.
Once a ModuleEvent.READY event is dispatched
(or the IModuleInfo.ready() method returns true),
it is possible to call the IFlexModuleFactory.create() method.
public function get factory():IFlexModuleFactory
| loaded | property |
loaded:Boolean [read-only]
A flag that is true if the load()
method has been called on this module.
public function get loaded():Boolean
| ready | property |
ready:Boolean [read-only]
A flag that is true if the module is sufficiently loaded
to get a handle to its associated IFlexModuleFactory implementation
and call its create() method.
This flag is true when the ModuleManager dispatches the
ModuleEvent.READY event.
public function get ready():Boolean
| setup | property |
setup:Boolean [read-only]
A flag that is true if the module is sufficiently loaded
to get a handle to its associated IFlexModuleFactory implementation
and call its info() method.
This flag is true when the ModuleManager dispatches the
ModuleEvent.SETUP event.
public function get setup():Boolean
| url | property |
url:String [read-only]The URL associated with this module (for example, "MyImageModule.swf" or "http://somedomain.com/modules/MyImageModule.swf". The URL can be local or remote, but if it is remote, you must establish a trust between the module's domain and the application that loads it.
Implementation public function get url():String
| load | () | method |
public function load(applicationDomain:ApplicationDomain = null, securityDomain:SecurityDomain = null, bytes:ByteArray = null):void
Requests that the module be loaded. If the module is already loaded,
the call does nothing. Otherwise, the module begins loading and dispatches
progress events as loading proceeds.
applicationDomain:ApplicationDomain (default = null) |
|
securityDomain:SecurityDomain (default = null) |
|
bytes:ByteArray (default = null) |
| publish | () | method |
public function publish(factory:IFlexModuleFactory):void
Publishes an interface to the ModuleManager. This allows late (or decoupled)
subscriptions to factories with a String handle. Use a URL that starts with
publish:// to reference factories that are published in this manner.
factory:IFlexModuleFactory — The class that implements the module's IFlexModuleFactory interface.
|
See also
| release | () | method |
public function release():voidReleases the current reference to the module. This does not unload the module unless there are no other open references to it and the ModuleManager is set up to have only a limited number of loaded modules.
See also
| unload | () | method |
public function unload():voidUnloads the module. Flash Player and AIR will not fully unload and garbage collect this module if there are any outstanding references to definitions inside the module.
| error | event |
mx.events.ModuleEvent
mx.events.ModuleEvent.ERROR
Dispatched by the backing ModuleInfo if there was an error during module loading.
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 | event |
mx.events.ModuleEvent
mx.events.ModuleEvent.PROGRESS
Dispatched by the backing ModuleInfo at regular intervals while the module is being loaded.
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 | event |
mx.events.ModuleEvent
mx.events.ModuleEvent.READY
Dispatched by the backing ModuleInfo once the module is sufficiently
loaded to call the IModuleInfo.factory() method and the
IFlexModuleFactory.create() method.
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 | event |
mx.events.ModuleEvent
mx.events.ModuleEvent.SETUP
Dispatched by the backing ModuleInfo once the module is sufficiently
loaded to call the IModuleInfo.factory() method and
the IFlexModuleFactory.info() method.
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 | event |
mx.events.ModuleEvent
mx.events.ModuleEvent.UNLOAD
Dispatched by the backing ModuleInfo when the module data is unloaded.
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. |