com.bourre.load.QueueLoader

	Property	Defined by
		_currentLoader : Loader Current loader used when queue starts loading process.	QueueLoader
		_q : Queue Store the loader elements.	QueueLoader
		_sPrefixURL : String	AbstractLoader
		_sURL : String	AbstractLoader

Public Methods

	Method		Defined by
		QueueLoader() Creates new `QueueLoader` instance.	QueueLoader
		add(loader:Loader, name:String, url:URLRequest = null, context:LoaderContext = null):Boolean Adds passed-in loader in loading queue.	QueueLoader
		addASyncCommandListener(listener:ASyncCommandListener, ... rest):Boolean Adds the passed-in command listener object as listener for this command events.	AbstractLoader
		addEventListener(type:String, listener:Object, ... rest):Boolean Adds an event listener for the specified event type.	AbstractLoader
		addListener(listener:LoaderListener):Boolean Adds the passed-in listener as listener for all events dispatched by this event broadcaster.	AbstractLoader
		clear():void Clears all items from queue.	QueueLoader
		execute(e:Event = null):void Execute the request according to the current command data.	AbstractLoader
		fireCommandEndEvent():void Fires the `onCommandEnd` event to the listeners of this command.	AbstractLoader
		fireOnLoadErrorEvent(message:String = ""):void Dispatches event when an error occur.	AbstractLoader
		fireOnLoadInitEvent():void Dispatches event when the loading is finished.	AbstractLoader
		fireOnLoadProgressEvent():void Dispatches event during loading progression.	AbstractLoader
		fireOnLoadStartEvent():void Dispatches event when the loading starts.	AbstractLoader
		fireOnLoadTimeOut():void	AbstractLoader
		getBytesLoaded():uint Returns the number of bytes loaded.	AbstractLoader
		getBytesTotal():uint Returns the total number of bytes to load.	AbstractLoader
		getContent():Object Returns loaded content.	AbstractLoader
		getCurrentLoader():Loader Returns the loader used when queue starts loading process.	QueueLoader
		getName():String Returns the loader identifier.	AbstractLoader
		getPerCent():Number Returns a percentage of bytes loaded and total bytes to load.	AbstractLoader
		getStrategy():LoadStrategy Returns loading strategy used by the loader.	AbstractLoader
		getTimeOut():Number Returns the loading timeout limit	AbstractLoader
		getURL():URLRequest Returns the URL used by this loader.	AbstractLoader
		isAntiCache():Boolean Returns `true` if 'anticache' system is on.	AbstractLoader
		isEmpty():Boolean Returns `true` if queue is empty.	QueueLoader
		isLoaded():Boolean Returns `true` if all bytes are loaded.	AbstractLoader
		isRunning():Boolean Returns `true` if this object is running.	AbstractLoader
		load(url:URLRequest = null, context:LoaderContext = null):void Starts loading the entire queue elements.	QueueLoader
		loadNextEntry():void Process next element in queue.	QueueLoader
		onLoaderLoadError(e:LoaderEvent, ... rest):void Triggered when an error occur Fires event type : `QueueLoaderEvent.onLoadErrorEVENT`	QueueLoader
		onLoaderLoadInit(e:LoaderEvent, ... rest):void Triggered when a loader ( in queue ) is finished.	QueueLoader
		onLoaderLoadProgress(e:LoaderEvent, ... rest):void Triggered during loading progression Fires event type : `QueueLoaderEvent.onLoadProgress`	QueueLoader
		onLoaderLoadStart(e:LoaderEvent, ... rest):void Triggered when a loader ( in queue ) starts loading.	QueueLoader
		onLoaderLoadTimeOut(e:LoaderEvent, ... rest):void Triggered when a timeout limit occur Fires event type : `QueueLoaderEvent.onLoadTimeOutEVENT`	QueueLoader
		prefixURL(sURL:String):void Adds prefix to URL passed to the loader instance.	AbstractLoader
		release():void Releases instance and all registered listeners.	QueueLoader
		removeASyncCommandListener(listener:ASyncCommandListener):Boolean Removes the passed-in command listener object as listener for this command events.	AbstractLoader
		removeEventListener(type:String, listener:Object):Boolean Removes the passed-in listener for listening the specified event.	AbstractLoader
		removeListener(listener:LoaderListener):Boolean Removes the passed-in listener object from this event broadcaster.	AbstractLoader
		run():void Starts the asynchronous process of this runnable object.	AbstractLoader
		setAntiCache(b:Boolean):void Sets the 'anticache' system to `true` to add timestamp value to the loaded URL.	AbstractLoader
		setContent(content:Object):void Uses to replace this loader content.	AbstractLoader
		setName(sName:String):void Sets the loader identifier.	AbstractLoader
		setTimeOut(n:Number):void Sets a loading timeout limit.	AbstractLoader
		setURL(url:URLRequest):void Defined from which the URL will be loaded.	AbstractLoader
		size():uint Returns the number of elements in this queue (its cardinality).	QueueLoader
		toArray():Array Returns an array containing all the elements in this queue.	QueueLoader

	Method	Defined by
		_processQueue():void Checks if there is a next element to load.	QueueLoader
		addListeners():void Registers listeners for current loader in queue.	QueueLoader
		fireEvent(e:Event):void Dispatched passed-in event to all registered listeners.	AbstractLoader
		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.	QueueLoader
		onInitialize():void	AbstractLoader
		removeListeners():void Unregisters listeners for current loader in queue.	QueueLoader
		setListenerType(type:Class):void Defines the type of listeners this event broadcaster support.	AbstractLoader

Summary	Defined by
onLoadError	Dispatched when an error occurs during loading.	AbstractLoader
onLoadInit	Dispatched when loading is finished.	AbstractLoader
onLoadProgress	Dispatched during loading progression.	AbstractLoader
onLoadStart	Dispatched when loader starts loading.	AbstractLoader
onLoadTimeOut	Dispatched when a timeout occurs during loading.	AbstractLoader

Property detail

_currentLoader

property

protected var _currentLoader:Loader

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Current loader used when queue starts loading process.

property

protected var _q:Queue

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Store the loader elements.

Constructor detail

QueueLoader

()

constructor

public function QueueLoader()

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Creates new QueueLoader instance.

Method detail

_processQueue

()

method

protected function _processQueue():void

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Checks if there is a next element to load.

add

()

method

public function add(loader:Loader, name:String, url:URLRequest = null, context:LoaderContext = null):Boolean

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Adds passed-in loader in loading queue.

Parameters

	`loader:Loader` — Concrete loader instance to add into queue

	`name:String` — An identifier for this loader. If name is `null` a auto generated id is defined; If name is `null url argument is ignored, so be sure to defined it directly within the passed-in loader.`

	`url:URLRequest` (default = `null`) — URL to load. Ignored if `name` is `null`

	`context:LoaderContext` (default = `null`) — (optional) Context to use for passed-in loader.

Returns

Boolean — true if loader was successfully added in queue.
( eq loader name is not null after identifier checking ).

Example
Complete sub loader definition

   
   var gl : GraphicLoader = new GraphicLoader( container );
   gl.setURL( new URLRequest( "logo.jpg" ) );
   
   var q : QueueLoader : new QueueLoader();
   q.add( gl );
   q.load();

Shorter var q : QueueLoader = new QueueLoader(); q.add( new GraphicLoader( container ), "logo", new URLRequest( "logo.jpg" ) ); q.load();

addListeners

()

method

protected function addListeners():void

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Registers listeners for current loader in queue.

clear

()

method

public function clear():void

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Clears all items from queue.

getCurrentLoader

()

method

public function getCurrentLoader():Loader

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Returns the loader used when queue starts loading process.

Returns

Loader — The loader used when queue starts loading process.

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.

isEmpty

()

method

public function isEmpty():Boolean

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Returns true if queue is empty.

Returns

Boolean — true if queue is empty.

load

()

method

public override function load(url:URLRequest = null, context:LoaderContext = null):void

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Starts loading the entire queue elements.

Arguments are ignored as url and context are defined for each element. Parameters

	`url:URLRequest` (default = `null`) — Ignored

	`context:LoaderContext` (default = `null`) — Ignored

See also

add()

loadNextEntry

()

method

public function loadNextEntry():void

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Process next element in queue.

onLoaderLoadError

()

method

public function onLoaderLoadError(e:LoaderEvent, ... rest):void

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Triggered when an error occur

Fires event type : QueueLoaderEvent.onLoadErrorEVENT

Parameters

	`e:LoaderEvent` — Event received

	`... rest`

onLoaderLoadInit

()

method

public function onLoaderLoadInit(e:LoaderEvent, ... rest):void

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Triggered when a loader ( in queue ) is finished.

Fires event type : QueueLoaderEvent.onItemLoadInitEVENT

Process next element in queue.

Parameters

	`e:LoaderEvent` — Event received

	`... rest` — Optional arguments

onLoaderLoadProgress

()

method

public function onLoaderLoadProgress(e:LoaderEvent, ... rest):void

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Triggered during loading progression

Fires event type : QueueLoaderEvent.onLoadProgress

Parameters

	`e:LoaderEvent` — Event received

	`... rest`

onLoaderLoadStart

()

method

public function onLoaderLoadStart(e:LoaderEvent, ... rest):void

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Triggered when a loader ( in queue ) starts loading.

Fires event type : QueueLoaderEvent.onItemLoadStartEVENT

Parameters

	`e:LoaderEvent` — Event received

	`... rest` — Optional arguments

onLoaderLoadTimeOut

()

method

public function onLoaderLoadTimeOut(e:LoaderEvent, ... rest):void

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Triggered when a timeout limit occur

Fires event type : QueueLoaderEvent.onLoadTimeOutEVENT

Parameters

	`e:LoaderEvent` — Event received

	`... rest`

release

()

method

public override function release():void

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Releases instance and all registered listeners.
Queue is clear.

removeListeners

()

method

protected function removeListeners():void

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Unregisters listeners for current loader in queue.

size

()

method

public function size():uint

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Returns the number of elements in this queue (its cardinality).

Returns

uint — Number of elements in this queue (its cardinality).

toArray

()

method

public function toArray():Array

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Returns an array containing all the elements in this queue. Obeys the general contract of the Collection.toArray method.

Returns

Array — Array containing all of the elements in this queue.

LowRA API Documentation	Annexes \| All Packages \| All Classes \| Index \| Frames No Frames
Class QueueLoader	Properties \| Methods \| Events

Package	com.bourre.load
Class	public class QueueLoader
Inheritance	QueueLoader AbstractLoader