IModuleInfo - Adobe ActionScript® 3 (AS3 Flex) API 参考

包	mx.modules
接口	public interface IModuleInfo extends IEventDispatcher

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

作为特殊模块句柄的接口。在此接口中，可以查询模块状态、获得模块内部 factory 以及加载或卸载模块。

公共属性

	属性		由以下参数定义
		data : Object 与给定 URL 的 singleton IModuleInfo 关联的用户数据。	IModuleInfo
		error : Boolean [只读] 如果加载模块期间发生错误，则标志显示为 true。	IModuleInfo
		factory : IFlexModuleFactory [只读] 模块中定义的 IFlexModuleFactory 实现。	IModuleInfo
		loaded : Boolean [只读] 如果已对此模块调用 load() 方法，则标志显示为 true。	IModuleInfo
		ready : Boolean [只读] 如果可以充分加载模块以获得其关联 IFlexModuleFactory 实现的句柄以及调用其 create() 方法，则标志显示为 true。	IModuleInfo
		setup : Boolean [只读] 如果可以充分加载模块以获得其关联 IFlexModuleFactory 实现的句柄以及调用其 info() 方法，则标志显示为 true。	IModuleInfo
		url : String [只读] 与此模块关联的 URL（如“MyImageModule.swf”或“http://somedomain.com/modules/MyImageModule.swf”）。	IModuleInfo

公共方法

隐藏继承的公共方法

显示继承的公共方法

	方法		由以下参数定义
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void 使用 EventDispatcher 对象注册事件侦听器对象，以使侦听器能够接收事件通知。	IEventDispatcher
		dispatchEvent(event:Event):Boolean 将事件调度到事件流中。	IEventDispatcher
		hasEventListener(type:String):Boolean 检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。	IEventDispatcher
		load(applicationDomain:ApplicationDomain = null, securityDomain:SecurityDomain = null, bytes:ByteArray = null, moduleFactory:IFlexModuleFactory = null):void 请求加载该模块。	IModuleInfo
		publish(factory:IFlexModuleFactory):void 将接口发布到 ModuleManager。	IModuleInfo
		release():void 将当前的引用释放到模块中。	IModuleInfo
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void 从 EventDispatcher 对象中删除侦听器。	IEventDispatcher
		unload():void 卸载模块。	IModuleInfo
		willTrigger(type:String):Boolean 检查是否用此 EventDispatcher 对象或其任何祖代为指定事件类型注册了事件侦听器。	IEventDispatcher

事件

单击此处了解有关事件的更多信息

	摘要	由以下参数定义
error	加载模块期间发生错误时，由支持 ModuleInfo 调度。	IModuleInfo
progress	加载模块时由支持 ModuleInfo 以固定间隔调度。	IModuleInfo
ready	充分加载该模块以调用 IModuleInfo.factory() 方法和 IFlexModuleFactory.create() 方法时，由支持 ModuleInfo 调度。	IModuleInfo
setup	充分加载该模块以调用 IModuleInfo.factory() 方法和 IFlexModuleFactory.info() 方法时，由支持 ModuleInfo 调度。	IModuleInfo
unload	卸载模块数据时由支持 ModuleInfo 调度。	IModuleInfo

属性详细信息

data

属性

data:Object

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

与给定 URL 的 singleton IModuleInfo 关联的用户数据。

实现
public function get data():Object
public function set data(value:Object):void

error

属性

error:Boolean [只读]

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

如果加载模块期间发生错误，则标志显示为 true。

ModuleManager 调度 ModuleEvent.ERROR 事件时此标志为 true。

实现
public function get error():Boolean

factory

属性

factory:IFlexModuleFactory [只读]

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

模块中定义的 IFlexModuleFactory 实现。只有在调用 ModuleEvent.SETUP 事件（或 IModuleInfo.setup() 方法返回 true）后，它才会显示为非 null。此时可以调用 IFlexModuleFactory.info() 方法。一旦调度 ModuleEvent.READY 事件（或 IModuleInfo.ready() 方法返回 true），就可以调用 IFlexModuleFactory.create() 方法。

实现
public function get factory():IFlexModuleFactory

loaded

属性

loaded:Boolean [只读]

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

如果已针对该模块调用 load() 方法，则标志显示为 true。

实现
public function get loaded():Boolean

ready

属性

ready:Boolean [只读]

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

如果可以充分加载模块以获得其关联 IFlexModuleFactory 实现的句柄以及调用其 create() 方法，则标志显示为 true。

ModuleManager 调度 ModuleEvent.READY 事件时，此标志为 true。

实现
public function get ready():Boolean

setup

属性

setup:Boolean [只读]

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

如果可以充分加载模块以获得其关联 IFlexModuleFactory 实现的句柄以及调用其 info() 方法，则标志显示为 true。

ModuleManager 调度 ModuleEvent.SETUP 事件时，此标志为 true。

实现
public function get setup():Boolean

url

属性

url:String [只读]

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

与此模块关联的 URL（如“MyImageModule.swf”或“http://somedomain.com/modules/MyImageModule.swf”）。URL 可以是本地的也可以是远程的，但如果是远程的，则必须在模块域和加载它的应用程序之间建立信任关系。

实现
public function get url():String

方法详细信息

load

()

方法

 public function load(applicationDomain:ApplicationDomain = null, securityDomain:SecurityDomain = null, bytes:ByteArray = null, moduleFactory:IFlexModuleFactory = null):void

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

请求加载该模块。如果已加载该模块，则调用不起任何作用。否则，会开始加载模块，并在加载过程中调度 progress 事件。

参数

	`applicationDomain:ApplicationDomain` (default = `null`) — 正在其中执行代码的当前应用程序域。

	`securityDomain:SecurityDomain` (default = `null`) — 当前安全性“沙箱”。

	`bytes:ByteArray` (default = `null`) — 一个 ByteArray 对象。ByteArray 应该包含代表已编译 Module 的 SWF 文件的字节数。可以使用 URLLoader 类获得 ByteArray 对象。如果指定了此参数，则将从 ByteArray 加载模块。如果此参数为 null，则将从 url 属性中指定的 url 加载模块。

	`moduleFactory:IFlexModuleFactory` (default = `null`) — 调用者的 moduleFactory。moduleFactory 的一个用途是确定已加载模块的父样式管理器。

publish

()

方法

public function publish(factory:IFlexModuleFactory):void

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

将接口发布到 ModuleManager。这允许具有 String 句柄的 factory 中存在延迟（或去耦）subscriptions。使用以 publish:// 开始的 URL 来引用以此方式发布的 factory。

参数

factory:IFlexModuleFactory — 实现模块的 IFlexModuleFactory 接口的类。

release

()

方法

public function release():void

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

将当前的引用释放到模块中。这样不会卸载该模块，除非该模块没有其它打开的引用，并且 ModuleManager 设置为仅包括限制数目的加载模块。

unload

()

方法

public function unload():void

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

卸载模块。如果模块中存在未完成的定义引用，则 Flash Player 和 AIR 都不会完全卸载此模块，而是将其作为垃圾回收。

事件详细信息

error

事件

事件对象类型: mx.events.ModuleEvent
属性 ModuleEvent.type = mx.events.ModuleEvent.ERROR

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

加载模块期间发生错误时，由支持 ModuleInfo 调度。

下载模块出错时调度。ModuleEvent.ERROR 常量可为 error 事件定义事件对象的 type 属性值。

事件对象的属性有下列值：

属性	值
`bubbles`	false
`bytesLoaded`	空
`bytesTotal`	空
`cancelable`	false
`currentTarget`	用于定义处理该事件的事件侦听器的对象。例如，如果您使用 `myButton.addEventListener()` 注册某个事件侦听器，则 myButton 为 `currentTarget` 的值。
`errorText`	错误消息。
`target`	调度该事件的 Object；它不一定是侦听该事件的 Object。使用 `currentTarget` 属性始终可以访问侦听事件的 Object。

progress

事件

事件对象类型: mx.events.ModuleEvent
属性 ModuleEvent.type = mx.events.ModuleEvent.PROGRESS

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

加载模块时由支持 ModuleInfo 以固定间隔调度。

下载模块的过程中调度。下载进程期间定期调度此模块。ModuleEvent.PROGRESS 常量可为 progress 事件定义事件对象的 type 属性值。

事件对象的属性有下列值：

属性	值
`bubbles`	false
`bytesLoaded`	加载的字节数。
`bytesTotal`	要加载的字节总数。
`cancelable`	false
`currentTarget`	用于定义处理该事件的事件侦听器的对象。例如，如果您使用 `myButton.addEventListener()` 注册某个事件侦听器，则 myButton 为 `currentTarget` 的值。
`errorText`	空
`target`	调度该事件的 Object；它不一定是侦听该事件的 Object。使用 `currentTarget` 属性始终可以访问侦听事件的 Object。

ready

事件

事件对象类型: mx.events.ModuleEvent
属性 ModuleEvent.type = mx.events.ModuleEvent.READY

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

充分加载该模块调用 IModuleInfo.factory() 方法和 IFlexModuleFactory.create() 方法时，由支持 ModuleInfo 调度。

模块完成下载时调度。ModuleEvent.READY 常量可为 complete 事件定义事件对象的 type 属性值。

事件对象的属性有下列值：

属性	值
`bubbles`	false
`bytesLoaded`	加载的字节数。
`bytesTotal`	要加载的字节总数。
`cancelable`	false
`currentTarget`	用于定义处理该事件的事件侦听器的对象。例如，如果您使用 `myButton.addEventListener()` 注册某个事件侦听器，则 myButton 为 `currentTarget` 的值。
`errorText`	空
`target`	调度该事件的 Object；它不一定是侦听该事件的 Object。使用 `currentTarget` 属性始终可以访问侦听事件的 Object。

setup

事件

事件对象类型: mx.events.ModuleEvent
属性 ModuleEvent.type = mx.events.ModuleEvent.SETUP

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

充分加载该模块以调用 IModuleInfo.factory() 方法和 IFlexModuleFactory.info() 方法时，由支持 ModuleInfo 调度。

已下载了足够的模块内容，您可以获得有关模块的信息时调度。您可以通过调用模块上的 IFlexModuleFactory.info() 方法来执行此操作。ModuleEvent.SETUP 常量可为 setup 事件定义事件对象的 type 属性值。

事件对象的属性有下列值：

属性	值
`bubbles`	false
`bytesLoaded`	空
`bytesTotal`	空
`cancelable`	false
`currentTarget`	用于定义处理该事件的事件侦听器的对象。例如，如果您使用 `myButton.addEventListener()` 注册某个事件侦听器，则 myButton 为 `currentTarget` 的值。
`errorText`	错误消息。
`target`	调度该事件的 Object；它不一定是侦听该事件的 Object。使用 `currentTarget` 属性始终可以访问侦听事件的 Object。

unload

事件

事件对象类型: mx.events.ModuleEvent
属性 ModuleEvent.type = mx.events.ModuleEvent.UNLOAD

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

卸载模块数据时由支持 ModuleInfo 调度。

卸载模块时调度。ModuleEvent.UNLOAD 常量可为 unload 事件定义事件对象的 type 属性值。

事件对象的属性有下列值：

属性	值
`bubbles`	false
`bytesLoaded`	空
`bytesTotal`	空
`cancelable`	false
`currentTarget`	用于定义处理该事件的事件侦听器的对象。例如，如果您使用 `myButton.addEventListener()` 注册某个事件侦听器，则 myButton 为 `currentTarget` 的值。
`errorText`	错误消息。
`target`	调度该事件的 Object；它不一定是侦听该事件的 Object。使用 `currentTarget` 属性始终可以访问侦听事件的 Object。

法律声明 | 在线隐私策略

IModuleInfo - AS3 Flex

类 x

data

error

factory

loaded

ready

setup

url

load

publish

release

unload

error

progress

ready

setup

unload