Packagemx.events
Classpublic class ResourceEvent
InheritanceResourceEvent Inheritance flash.events.ProgressEvent

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The ResourceEvent class represents an Event object that is dispatched when the ResourceManager loads the resource bundles in a resource module by calling the loadResourceModule() method.

See also

mx.resources.ResourceManager


Public Properties
 PropertyDefined By
  errorText : String
The error message if the type is ERROR; otherwise, it is null.
ResourceEvent
Public Methods
 MethodDefined By
  
ResourceEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bytesLoaded:uint = 0, bytesTotal:uint = 0, errorText:String = null)
Constructor.
ResourceEvent
Public Constants
 ConstantDefined By
  COMPLETE : String = complete
[static] Dispatched when the resource module SWF file has finished loading.
ResourceEvent
  ERROR : String = error
[static] Dispatched when there is an error loading the resource module SWF file.
ResourceEvent
  PROGRESS : String = progress
[static] Dispatched when the resource module SWF file is loading.
ResourceEvent
Property Detail
errorTextproperty
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 ERROR; otherwise, it is null.

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

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Constructor.

Parameters
type:String — The value of the type property of the event object. Possible values are:
  • "progress" (ResourceEvent.PROGRESS)
  • "complete" (ResourceEvent.COMPLETE)
  • "error" (ResourceEvent.ERROR)
 
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.
 
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 ultimately be loaded if the loading process succeeds.
 
errorText:String (default = null) — The error message of the error when type is ResourceEvent.ERROR.
Constant Detail
COMPLETEConstant
public static const COMPLETE:String = complete

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Dispatched when the resource module SWF file has finished loading. The ResourceEvent.COMPLETE 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:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe 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 currentTarget.
errorTextEmpty
targetThe object that dispatched the event; it is not always the object listening for the event. Use the currentTarget property to always access the object that listens for the event.

ERRORConstant 
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 loading the resource module SWF file. The ResourceEvent.ERROR constant defines the value of the type property of the event object for a error event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
bytesLoadedEmpty
bytesTotalEmpty
cancelablefalse
currentTargetThe object that defines the event listener that handles the event. For example, if you use the myButton.addEventListener() method to register an event listener, myButton is the value of currentTarget.
errorText
targetThe object that dispatched the event; it is not always the object that is listening for the event. Use the currentTarget property to always access the object that listens for the event.

PROGRESSConstant 
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 resource module SWF file is loading. The ResourceEvent.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:

PropertyValue
bubblesfalse
bytesLoadedThe number of bytes loaded.
bytesTotalThe total number of bytes to load.
cancelablefalse
currentTargetThe object that defines the event listener that handles the event. For example, if you use the myButton.addEventListener() method to register an event listener, myButton is the value of currentTarget.
errorText
targetThe object that dispatched the event; it is not always the object that listens for the event. Use the currentTarget property to always access the object that is listening for the event.