Packagecom.bourre.load
Classpublic class XMLLoaderEvent
InheritanceXMLLoaderEvent Inheritance LoaderEvent Inheritance BasicEvent Inheritance flash.events.Event

Player version: Flash Player 9.0
Language version: ActionScript 3.0

The XMLLoaderEvent class represents the event object passed to the event listener for XMLLoader events.

See also

XMLLoader


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
  
XMLLoaderEvent(type:String, xl:XMLLoader, errorMessage:String = "")
Creates a new XMLLoaderEvent object.
XMLLoaderEvent
 Inherited
clone():Event
Clone the event
BasicEvent
 Inherited
getErrorMessage():String
Returns the error message carried by this event.
LoaderEvent
 Inherited
Returns the loader object carried by this event.
LoaderEvent
 Inherited
getName():String
Returns the loader named carried by this event.
LoaderEvent
 Inherited
getPerCent():Number
Returns the loading progression value of object carried by this event.
LoaderEvent
 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
  
getXML():XML
Returns the file content object carried by this event.
XMLLoaderEvent
  
Returns the xml file loader object carried by this event.
XMLLoaderEvent
 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
  onLoadErrorEVENT : String = "onLoadError"
[static] Defines the value of the type property of the event object for a onLoadError event.
XMLLoaderEvent
  onLoadInitEVENT : String = "onLoadInit"
[static] Defines the value of the type property of the event object for a onLoadInit event.
XMLLoaderEvent
  onLoadProgressEVENT : String = "onLoadProgress"
[static] Defines the value of the type property of the event object for a onLoadProgress event.
XMLLoaderEvent
  onLoadStartEVENT : String = "onLoadStart"
[static] Defines the value of the type property of the event object for a onLoadStart event.
XMLLoaderEvent
  onLoadTimeOutEVENT : String = "onLoadTimeOut"
[static] Defines the value of the type property of the event object for a onLoadTimeOut event.
XMLLoaderEvent
Constructor detail
XMLLoaderEvent()constructor
public function XMLLoaderEvent(type:String, xl:XMLLoader, errorMessage:String = "")

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Creates a new XMLLoaderEvent object.

Parameters
type:String — Name of the event type
 
xl:XMLLoader — XMLLoader object carried by this event
 
errorMessage:String (default = "") — (optional) Error message carried by this event
Method detail
getXML()method
public function getXML():XML

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns the file content object carried by this event.

Returns
XML — The file content value carried by this event.
getXMLLoader()method 
public function getXMLLoader():XMLLoader

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns the xml file loader object carried by this event.

Returns
XMLLoader — The xml file loader value carried by this event.
Constant detail
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
getFileLoader() The loader object
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
getXMLLoader() The loader object
getXML() The loaded file content
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
getXMLLoader() The loader object
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
getXMLLoader() The loader object
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
getXMLLoader() The loader object