Packagecom.bourre.load
Classpublic class XMLLoader
InheritanceXMLLoader Inheritance FileLoader Inheritance AbstractLoader
SubclassesContextLoader

Player version: Flash Player 9.0
Language version: ActionScript 3.0

The XMLLoader class allow to load xml content.


Example 
  
  var loader : XMLLoader = new XMLLoader(  );
  loader.addEventListener( XMLLoader.onLoadInitEVENT, onLoaded );
  loader.load( new URLRequest( "content.xml" );


Protected Properties
 PropertyDefined by
 Inherited_sPrefixURL : String
AbstractLoader
 Inherited_sURL : String
AbstractLoader
Public Methods
 MethodDefined by
  
XMLLoader()
Creates new XMLLoader instance.
XMLLoader
 Inherited
addASyncCommandListener(listener:ASyncCommandListener, ... rest):Boolean
Adds the passed-in command listener object as listener for this command events.
AbstractLoader
 Inherited
addEventListener(type:String, listener:Object, ... rest):Boolean
Adds an event listener for the specified event type.
AbstractLoader
 Inherited
addListener(listener:LoaderListener):Boolean
Adds the passed-in listener as listener for all events dispatched by this event broadcaster.
AbstractLoader
 Inherited
execute(e:Event = null):void
Execute the request according to the current command data.
AbstractLoader
 Inherited
fireCommandEndEvent():void
Fires the onCommandEnd event to the listeners of this command.
AbstractLoader
 Inherited
fireOnLoadErrorEvent(message:String = ""):void
Dispatches event when an error occur.
AbstractLoader
 Inherited
fireOnLoadInitEvent():void
Dispatches event when the loading is finished.
AbstractLoader
 Inherited
fireOnLoadProgressEvent():void
Dispatches event during loading progression.
AbstractLoader
 Inherited
fireOnLoadStartEvent():void
Dispatches event when the loading starts.
AbstractLoader
 Inherited
fireOnLoadTimeOut():void
AbstractLoader
 Inherited
getBytesLoaded():uint
Returns the number of bytes loaded.
AbstractLoader
 Inherited
getBytesTotal():uint
Returns the total number of bytes to load.
AbstractLoader
 Inherited
getContent():Object
Returns loaded content.
AbstractLoader
 Inherited
getName():String
Returns the loader identifier.
AbstractLoader
 Inherited
getPerCent():Number
Returns a percentage of bytes loaded and total bytes to load.
AbstractLoader
 Inherited
getStrategy():LoadStrategy
Returns loading strategy used by the loader.
AbstractLoader
 Inherited
getTimeOut():Number
Returns the loading timeout limit
AbstractLoader
 Inherited
getURL():URLRequest
Returns the URL used by this loader.
AbstractLoader
  
getXML():XML
Returns xml content.
XMLLoader
 Inherited
isAntiCache():Boolean
Returns true if 'anticache' system is on.
AbstractLoader
 Inherited
isLoaded():Boolean
Returns true if all bytes are loaded.
AbstractLoader
 Inherited
isRunning():Boolean
Returns true if this object is running.
AbstractLoader
 Inherited
load(url:URLRequest = null, context:LoaderContext = null):void
Loads content.
AbstractLoader
 Inherited
prefixURL(sURL:String):void
Adds prefix to URL passed to the loader instance.
AbstractLoader
 Inherited
release():void
Releases instance and all registered listeners.
AbstractLoader
 Inherited
removeASyncCommandListener(listener:ASyncCommandListener):Boolean
Removes the passed-in command listener object as listener for this command events.
AbstractLoader
 Inherited
removeEventListener(type:String, listener:Object):Boolean
Removes the passed-in listener for listening the specified event.
AbstractLoader
 Inherited
removeListener(listener:LoaderListener):Boolean
Removes the passed-in listener object from this event broadcaster.
AbstractLoader
 Inherited
run():void
Starts the asynchronous process of this runnable object.
AbstractLoader
 Inherited
setAntiCache(b:Boolean):void
Sets the 'anticache' system to true to add timestamp value to the loaded URL.
AbstractLoader
 Inherited
setContent(content:Object):void
Uses to replace this loader content.
AbstractLoader
 Inherited
setDataFormat(dataFormat:String):void
Sets how the downloaded data is received.
FileLoader
 Inherited
setName(sName:String):void
Sets the loader identifier.
AbstractLoader
 Inherited
setTimeOut(n:Number):void
Sets a loading timeout limit.
AbstractLoader
 Inherited
setURL(url:URLRequest):void
Defined from which the URL will be loaded.
AbstractLoader
Protected Methods
 MethodDefined by
 Inherited
fireEvent(e:Event):void
Dispatched passed-in event to all registered listeners.
AbstractLoader
 Inherited
fireEventType(type:String, errorMessage:String = ""):void
Dispatches event using passed-in type and optional error message.
AbstractLoader
  
getLoaderEvent(type:String, errorMessage:String = ""):LoaderEvent
Returns a loader event for current loader instance.
XMLLoader
 Inherited
onInitialize():void
AbstractLoader
 Inherited
setListenerType(type:Class):void
Defines the type of listeners this event broadcaster support.
AbstractLoader
Events
 EventSummaryDefined by
  
onLoadError
Dispatched when an error occurs during loading.XMLLoader
 Inherited
onLoadError
Dispatched when an error occurs during loading.FileLoader
 Inherited
onLoadError
Dispatched when an error occurs during loading.AbstractLoader
  
onLoadInit
Dispatched when loading is finished.XMLLoader
 Inherited
onLoadInit
Dispatched when loading is finished.FileLoader
 Inherited
onLoadInit
Dispatched when loading is finished.AbstractLoader
  
onLoadProgress
Dispatched during loading progression.XMLLoader
 Inherited
onLoadProgress
Dispatched during loading progression.FileLoader
 Inherited
onLoadProgress
Dispatched during loading progression.AbstractLoader
  
onLoadStart
Dispatched when loader starts loading.XMLLoader
 Inherited
onLoadStart
Dispatched when loader starts loading.FileLoader
 Inherited
onLoadStart
Dispatched when loader starts loading.AbstractLoader
  
onLoadTimeOut
Dispatched when a timeout occurs during loading.XMLLoader
 Inherited
onLoadTimeOut
Dispatched when a timeout occurs during loading.FileLoader
 Inherited
onLoadTimeOut
Dispatched when a timeout occurs during loading.AbstractLoader
Public Constants
 ConstantDefined by
 InheritedBINARY : String = "binary"
[static] Specifies that downloaded data is received as raw binary data.
FileLoader
 InheritedTEXT : String = "text"
[static] Specifies that downloaded data is received as text.
FileLoader
 InheritedVARIABLES : String = "variables"
[static] Specifies that downloaded data is received as URL-encoded variables.
FileLoader
Constructor detail
XMLLoader()constructor
public function XMLLoader()

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Creates new XMLLoader instance.

Method detail
getLoaderEvent()method
protected override function getLoaderEvent(type:String, errorMessage:String = ""):LoaderEvent

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns a loader event for current loader instance.

Parameters
type:String — Event type to dispatch
 
errorMessage:String (default = "")

Returns
LoaderEvent — A loader event for current loader instance.
getXML()method 
public function getXML():XML

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns xml content.

Returns
XML — XML content
Event detail
onLoadErrorevent 
Event object type: com.bourre.load.XMLLoaderEvent
XMLLoaderEvent.type property = com.bourre.load.XMLLoaderEvent.onLoadErrorEVENT

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Dispatched when an error occurs during loading.

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
onLoadInitevent  
Event object type: com.bourre.load.XMLLoaderEvent
XMLLoaderEvent.type property = com.bourre.load.XMLLoaderEvent.onLoadInitEVENT

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Dispatched when loading is finished.

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
onLoadProgressevent  
Event object type: com.bourre.load.XMLLoaderEvent
XMLLoaderEvent.type property = com.bourre.load.XMLLoaderEvent.onLoadProgressEVENT

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Dispatched during loading progression.

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
onLoadStartevent  
Event object type: com.bourre.load.XMLLoaderEvent
XMLLoaderEvent.type property = com.bourre.load.XMLLoaderEvent.onLoadStartEVENT

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Dispatched when loader starts loading.

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
onLoadTimeOutevent  
Event object type: com.bourre.load.XMLLoaderEvent
XMLLoaderEvent.type property = com.bourre.load.XMLLoaderEvent.onLoadTimeOutEVENT

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Dispatched when a timeout occurs during loading.

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



Submit Feedback
LowRA API documentation 2008- 2009
Licensed under the MOZILLA PUBLIC LICENSE, Version 1.1
mer. févr. 25 2009, 9:22 AM GMT+01:00