mx.events.ModuleEvent (Flex™ 2 Language Reference

	Property	Defined by
		bubbles : Boolean Indicates whether an event is a bubbling event.	Event
		bytesLoaded : Number The number of items or bytes loaded when the listener processes the event.	ProgressEvent
		bytesTotal : Number The total number of items or bytes that will be loaded if the loading process succeeds.	ProgressEvent
		cancelable : Boolean Indicates whether the behavior associated with the event can be prevented.	Event
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		currentTarget : Object The object that is actively processing the Event object with an event listener.	Event
		ERROR : String = "error" [static] Dispatched when there is an error downloading the module.	ModuleEvent
		errorText : String The error message if the type is `ModuleEvent.ERROR`; otherwise, it is `null`.	ModuleEvent
		eventPhase : uint The current phase in the event flow.	Event
		module : IModuleInfo [read-only] The `target`, which is an instance of an interface for a particular module.	ModuleEvent
		PROGRESS : String = "progress" [static] Dispatched when the module is in the process of downloading.	ModuleEvent
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		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
		target : Object The event target.	Event
		type : String The type of event.	Event
		UNLOAD : String = "unload" [static] Dispatched when the module is unloaded.	ModuleEvent

	Method	Defined by
		ModuleEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bytesLoaded:uint = 0, bytesTotal:uint = 0, errorText:String = null) Constructor.	ModuleEvent
		clone():Event Creates a copy of the ProgressEvent object and sets each property's value to match that of the original.	ProgressEvent
		formatToString(className:String, ... arguments):String A utility function for implementing the `toString()` method in your custom Event class.	Event
		isDefaultPrevented():Boolean Checks whether `preventDefault()` has been called on the event.	Event
		preventDefault():void Cancels an event's default behavior if that behavior can be canceled.	Event
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.	Event
		stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.	Event
		toString():String Returns a string that contains all the properties of the ProgressEvent object.	ProgressEvent
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

	Constant		Defined by
		ACTIVATE : String = "activate" [static] Defines the value of the `type` property of an `activate` event object.	Event
		ADDED : String = "added" [static] Defines the value of the `type` property of an `added` event object.	Event
		ADDED_TO_STAGE : String = "addedToStage" [static] Defines the value of the `type` property of an `addedToStage` event object.	Event
		CANCEL : String = "cancel" [static] Defines the value of the `type` property of a `cancel` event object.	Event
		CHANGE : String = "change" [static] Defines the value of the `type` property of a `change` event object.	Event
		CLOSE : String = "close" [static] Defines the value of the `type` property of a `close` event object.	Event
		CLOSING : String = "closing" [static] Defines the value of the `type` property of a `closing` event object.	Event
		COMPLETE : String = "complete" [static] Defines the value of the `type` property of a `complete` event object.	Event
		CONNECT : String = "connect" [static] Defines the value of the `type` property of a `connect` event object.	Event
		DEACTIVATE : String = "deactivate" [static] Defines the value of the `type` property of a `deactivate` event object.	Event
		DOM_INITIALIZE : String = "domInitialize" [static] Defines the value of the `type` property of a `domInitialize` event object.	Event
		ENTER_FRAME : String = "enterFrame" [static] Defines the value of the `type` property of an `enterFrame` event object.	Event
		FULLSCREEN : String = "fullScreen" [static] Defines the value of the `type` property of a `fullScreen` event object.	Event
		HTML_BOUNDS_CHANGE : String = "htmlBoundsChange" [static] Defines the value of the `type` property of an `htmlBoundsChange` event object.	Event
		HTML_RENDER : String = "htmlRender" [static] Defines the value of the `type` property of an `htmlRender` event object.	Event
		ID3 : String = "id3" [static] Defines the value of the `type` property of an `id3` event object.	Event
		INIT : String = "init" [static] Defines the value of the `type` property of an `init` event object.	Event
		LOCATION_CHANGE : String = "locationChange" [static] Defines the value of the `type` property of a `locationChange` event object.	Event
		MOUSE_LEAVE : String = "mouseLeave" [static] Defines the value of the `type` property of a `mouseLeave` event object.	Event
		NETWORK_CHANGE : String = "networkChange" [static] Defines the value of the `type` property of a `networkChange` event object.	Event
		OPEN : String = "open" [static] Defines the value of the `type` property of an `open` event object.	Event
		REMOVED : String = "removed" [static] Defines the value of the `type` property of a `removed` event object.	Event
		REMOVED_FROM_STAGE : String = "removedFromStage" [static] Defines the value of the `type` property of a `removedFromStage` event object.	Event
		RENDER : String = "render" [static] Defines the value of the `type` property of a `render` event object.	Event
		RESIZE : String = "resize" [static] Defines the value of the `type` property of a `resize` event object.	Event
		SCROLL : String = "scroll" [static] Defines the value of the `type` property of a `scroll` event object.	Event
		SELECT : String = "select" [static] Defines the value of the `type` property of a `select` event object.	Event
		SOCKET_DATA : String = "socketData" [static] Defines the value of the `type` property of a `socketData` event object.	ProgressEvent
		SOUND_COMPLETE : String = "soundComplete" [static] Defines the value of the `type` property of a `soundComplete` event object.	Event
		TAB_CHILDREN_CHANGE : String = "tabChildrenChange" [static] Defines the value of the `type` property of a `tabChildrenChange` event object.	Event
		TAB_ENABLED_CHANGE : String = "tabEnabledChange" [static] Defines the value of the `type` property of a `tabEnabledChange` event object.	Event
		TAB_INDEX_CHANGE : String = "tabIndexChange" [static] Defines the value of the `type` property of a `tabIndexChange` event object.	Event

Property detail

ERROR

property

public static var 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.

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.

Implementation
public function get module():IModuleInfo

PROGRESS

property

public static var 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

property

public static var 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

property

public static var 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

property

public static var 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.

Constructor detail

ModuleEvent

()

constructor

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

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`.

Adobe^® Flex™ 2 Language Reference	All Packages \| All Classes \| Language Elements \| Index \| Appendixes \| Frames No Frames
Class ModuleEvent	Properties \| Methods \| Constants

Package	mx.events
Class	public class ModuleEvent
Inheritance	ModuleEvent ProgressEvent Event Object