Packagecom.bourre.load
Classpublic class QueueLoaderEvent
InheritanceQueueLoaderEvent Inheritance LoaderEvent Inheritance BasicEvent Inheritance flash.events.Event

Player version: Flash Player 9.0
Language version: ActionScript 3.0

An event object which carry a QueueLoader value.



Public Properties
 PropertyDefined by
 Inheritedtarget : Object
The source object of this event
BasicEvent
 Inheritedtype : String
The type of this event
BasicEvent
Protected Properties
 PropertyDefined by
 Inherited_oTarget : Object
The source object of this event, redefined to provide write access
BasicEvent
 Inherited_sType : String
The type of the event, redefined to provide write access
BasicEvent
Public Methods
 MethodDefined by
  
QueueLoaderEvent(type:String, ql:QueueLoader, errorMessage:String = "")
Creates a new QueueLoaderEvent object.
QueueLoaderEvent
 Inherited
clone():Event
Clone the event
BasicEvent
 Inherited
getErrorMessage():String
Returns the error message carried by this event.
LoaderEvent
  
Returns the current loader object carried by this queue loader event.
QueueLoaderEvent
  
getName():String
Returns the current loader named carried by this queue loader event.
QueueLoaderEvent
  
getPerCent():Number
Returns the loading progression value of current object carried by this queue loader event.
QueueLoaderEvent
  
Returns the queue object carried by this event.
QueueLoaderEvent
 Inherited
getTarget():Object
Returns the current source of this event object.
BasicEvent
 Inherited
getType():String
Returns the type of this event, which generally correspond to the name of the called function on the listener.
BasicEvent
 Inherited
setErrorMessage(errorMessage:String = ""):void
Sets the error message to be carried by this event.
LoaderEvent
 Inherited
setTarget(oTarget:Object):void
Defines the new source object of this event.
BasicEvent
 Inherited
setType(en:String):void
Defines the new event type for this event object.
BasicEvent
 Inherited
toString():String
Returns the string representation of this instance.
BasicEvent
Public Constants
 ConstantDefined by
  onItemLoadInitEVENT : String = "onItemLoadInit"
[static] Defines the value of the type property of the event object for a onItemLoadInit event.
QueueLoaderEvent
  onItemLoadStartEVENT : String = "onItemLoadStart"
[static] Defines the value of the type property of the event object for a onItemLoadStart event.
QueueLoaderEvent
  onLoadErrorEVENT : String = "onLoadError"
[static] Defines the value of the type property of the event object for a onLoadError event.
QueueLoaderEvent
  onLoadInitEVENT : String = "onLoadInit"
[static] Defines the value of the type property of the event object for a onLoadInit event.
QueueLoaderEvent
  onLoadProgressEVENT : String = "onLoadProgress"
[static] Defines the value of the type property of the event object for a onLoadProgress event.
QueueLoaderEvent
  onLoadStartEVENT : String = "onLoadStart"
[static] Defines the value of the type property of the event object for a onLoadStart event.
QueueLoaderEvent
  onLoadTimeOutEVENT : String = "onLoadTimeOut"
[static] Defines the value of the type property of the event object for a onLoadTimeOut event.
QueueLoaderEvent
Constructor detail
QueueLoaderEvent()constructor
public function QueueLoaderEvent(type:String, ql:QueueLoader, errorMessage:String = "")

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Creates a new QueueLoaderEvent object.

Parameters
type:String — Name of the event type
 
ql:QueueLoader — Queue loader object carried by this event
 
errorMessage:String (default = "") — (optional) Error message carried by this event
Method detail
getLoader()method
public override function getLoader():Loader

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns the current loader object carried by this queue loader event.

Returns
Loader — The current loader object carried by this queue loader event.
getName()method 
public override function getName():String

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns the current loader named carried by this queue loader event.

Returns
String — The current loader named carried by this queue loader event.
getPerCent()method 
public override function getPerCent():Number

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns the loading progression value of current object carried by this queue loader event.

Returns
Number — The loading progression value of current object carried by this queue loader event.
getQueue()method 
public function getQueue():QueueLoader

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns the queue object carried by this event.

Returns
QueueLoader — The queue value carried by this event.
Constant detail
onItemLoadInitEVENTconstant
public static const onItemLoadInitEVENT:String = "onItemLoadInit"

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Defines the value of the type property of the event object for a onItemLoadInit event.

The properties of the event object have the following values:

PropertyValue
type Dispatched event type
MethodValue
getLoader() The current loader object
getName() The current loader identifier
getErrorMessage() The loader identifier
onItemLoadStartEVENTconstant 
public static const onItemLoadStartEVENT:String = "onItemLoadStart"

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Defines the value of the type property of the event object for a onItemLoadStart event.

The properties of the event object have the following values:

PropertyValue
type Dispatched event type
MethodValue
getQueue() The queue loader object
getLoader() The current loader object
getName() The current loader identifier
getErrorMessage() The loader identifier
onLoadErrorEVENTconstant 
public static const onLoadErrorEVENT:String = "onLoadError"

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Defines the value of the type property of the event object for a onLoadError event.

The properties of the event object have the following values:

PropertyValue
type Dispatched event type
MethodValue
getQueue() The queue loader object
getLoader() The current loader object
getName() The current loader identifier
getErrorMessage() The loader identifier
onLoadInitEVENTconstant 
public static const onLoadInitEVENT:String = "onLoadInit"

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Defines the value of the type property of the event object for a onLoadInit event.

The properties of the event object have the following values:

PropertyValue
type Dispatched event type
MethodValue
getQueue() The queue loader object
getLoader() The current loader object
getName() The current loader identifier
getErrorMessage() The loader identifier
onLoadProgressEVENTconstant 
public static const onLoadProgressEVENT:String = "onLoadProgress"

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Defines the value of the type property of the event object for a onLoadProgress event.

The properties of the event object have the following values:

PropertyValue
type Dispatched event type
MethodValue
getQueue() The queue loader object
getLoader() The current loader object
getName() The current loader identifier
getErrorMessage() The loader identifier
onLoadStartEVENTconstant 
public static const onLoadStartEVENT:String = "onLoadStart"

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Defines the value of the type property of the event object for a onLoadStart event.

The properties of the event object have the following values:

PropertyValue
type Dispatched event type
MethodValue
getQueue() The queue loader object
getLoader() The current loader object
getName() The current loader identifier
getErrorMessage() The loader identifier
onLoadTimeOutEVENTconstant 
public static const onLoadTimeOutEVENT:String = "onLoadTimeOut"

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Defines the value of the type property of the event object for a onLoadTimeOut event.

The properties of the event object have the following values:

PropertyValue
type Dispatched event type
MethodValue
getQueue() The queue loader object
getLoader() The current loader object
getName() The current loader identifier
getErrorMessage() The loader identifier