ch.capi.net.app.ApplicationMassLoader

Public Properties

	Property		Defined By
		alwaysDispatchProgressEvent : Boolean = true Defines if the progress event should be dispatched each time or only when all the number of specified parallel files are being loaded.	MassLoader
		bytesLoaded : uint [read-only] Defines the bytes that have been loaded.	MassLoader
		bytesTotal : uint [read-only] Defines the total bytes to load.	MassLoader
		closeEvent : Event [read-only] Defines the event that happend to close the MassLoader (Event.CLOSE or Event.COMPLETE).	MassLoader
		currentPriority : int [read-only] Defines the current priority of the files that are being loaded.	PriorityMassLoader
		defaultPriority : int = 0 Defines the default priority to use for the addFile method.	PriorityMassLoader
		dispatchGlobalEvents : Boolean Defines if the global events must be dispatched or not.	GlobalEventDispatcher
		loadByPriority : Boolean Defines if the loading is done by priority.	PriorityMassLoader
		loaded : Boolean [read-only] Defines if the ILoadManager operation is complete.	MassLoader
		loadInfo : ILoadInfo [read-only] Defines the ILoadInfo object linked to the IMassLoader.	MassLoader
		loadPolicy : ILoadPolicy Defines the ILoadPolicy to use.	MassLoader
		nextFileToLoad : ILoadManager [read-only] Defines the next file that will be extracted from the queue to be loaded.	MassLoader
		numFiles : uint [read-only] Defines the total of the files in the MassLoader.	MassLoader
		numFilesLoaded : uint [read-only] Defines the number of files loaded.	MassLoader
		numFilesLoading : uint [read-only] Defines the number of files being currently loaded.	MassLoader
		numFilesOpen : uint [read-only] Defines the number of files being currently open.	MassLoader
		numFilesToLoad : uint [read-only] Defines the number of files to load.	MassLoader
		parallelFiles : uint Defines the number of files that will be loaded simultaneously.	MassLoader
		stateIdle : Boolean [read-only] Defines if the MassLoader is idle.	MassLoader
		stateLoading : Boolean [read-only] Defines if the MassLoader is loading.	MassLoader

	Property	Defined By
		files : IList [read-only] Defines all the files that must be loaded.	MassLoader
		filesLoading : IList [read-only] Defines the files that are currently being loaded.	MassLoader
		filesQueue : IDataStructure Defines the data structure to use for the file enqueuing.	MassLoader

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		ApplicationMassLoader(parallelFiles:uint = 0, loadByPriority:Boolean = false) Creates a new ApplicationMassLoader object.	ApplicationMassLoader
		addAll(context:IApplicationContext):Array Add all the ApplicationFile objects that are in a specified ApplicationContext in the loading queue.	ApplicationMassLoader
		addApplicationFile(file:ApplicationFile):void Add the specified ApplicationFile and its dependencies.	ApplicationMassLoader
		addFile(file:ILoadManager):void Add the specified file in the loading queue with the default priority.	PriorityMassLoader
		addGlobalFiles(context:IApplicationContext):void Add the global ApplicationFile in the loading queue.	ApplicationMassLoader
		addPrioritizedFile(file:ILoadManager, priority:int = 0):void Add a file with a specific priority in the loading queue.	PriorityMassLoader
		clear():void Clear the loading queues and files priorities.	PriorityMassLoader
		dispatchEvent(evt:Event):Boolean Dispatches the specified Event through the listeners.	GlobalEventDispatcher
		getFileCount():uint Get the number of files to be loaded.	MassLoader
		getFilePriority(file:ILoadManager):int Retreives the priority of a ILoadManager object.	PriorityMassLoader
		getFiles():Array Get the files that will be loaded.	MassLoader
		getFilesAtPriority(priority:int):Array Defines the files to be loaded at the specified priority.	PriorityMassLoader
		getStaticIndexOf(file:ILoadManager):int Retrieves the static index of the specified ILoadManager.	MassLoader
		hasFile(file:ILoadManager):Boolean Retrieves if a file is contained in the loading queue.	MassLoader
		load(file:Object, context:IApplicationContext = null, withGlobalFiles:Boolean = false):ApplicationFile Starts the loading of the specified file.	ApplicationMassLoader
		removeFile(file:ILoadManager):void Removes the specified file from the loading queue.	PriorityMassLoader
		setFilePriority(file:ILoadManager, priority:int):void Set a file priority of a ILoadManager object.	PriorityMassLoader
		start():Boolean Starts downloading data from the specified ILoadManager objects.	MassLoader
		stop():void Stops the load operation in progress.	MassLoader
		toString():String Lists all the files contained in this PriorityMassLoader in a String.	PriorityMassLoader

Protected Methods

Show Inherited Protected Methods

	Method		Defined By
		addLoadableFile(file:ILoadableFile, priority:int):void Add the specified ILoadableFile to the queue within the priority.	ApplicationMassLoader
		createMassLoadEvent(file:ILoadManager, type:String, evt:Event = null):MassLoadEvent Creates a MassLoadEvent based on the specified ILoadManager.	PriorityMassLoader
		getFileQueueIndex(file:ILoadManager):int Retrieves the index of a file in the loading queue (if the loading of the specified file has been started).	MassLoader
		isComplete():Boolean Defines if the massive loading is complete.	MassLoader
		loadFile(file:ILoadManager):Boolean Start the loading of a file.	MassLoader
		loadNextFile():ILoadManager Start the loading of the next file.	MassLoader
		onClose(evt:Event):void Event.CLOSE listener.	MassLoader
		onComplete(evt:Event):void Event.COMPLETE listener.	MassLoader
		onIOError(evt:IOErrorEvent):void IOErrorEvent.IO_ERROR listener.	MassLoader
		onOpen(evt:Event):void Event.OPEN listener.	MassLoader
		onProgress(evt:ProgressEvent):void ProgressEvent.PROGRESS listener.	MassLoader
		onSecurityError(evt:SecurityErrorEvent):void SecurityError.SECURITY_ERROR listener.	MassLoader
		processClosePolicy(file:ILoadManager, closeEvent:Event):ILoadManager Processes the loading policy on the currently closed file.	MassLoader
		processOpenPolicy(file:ILoadManager):ILoadManager Process the loading policy on the currently file that is being open.	MassLoader
		registerTo(file:ILoadManager):void Register the MassLoader to the specified ILoadManager object's events.	MassLoader
		sortFiles(a:ILoadManager, b:ILoadManager):int Determines which file must be loaded first.	PriorityMassLoader
		startLoading():void Start the loading of the files.	PriorityMassLoader
		unregisterFrom(file:ILoadManager):void Unregister the MassLoader from the specified ILoadManager object's events.	MassLoader
		updateBytes():void Updates the bytesLoaded and bytesTotal values.	MassLoader

Summary	Defined By
close	Dispatched when the download operation stops.	MassLoader
complete	Dispatched after all the data is received.	MassLoader
fileClose	Dispatched when the loading of a ILoadManager is closed (eg when the loading is complete or an error has occured).	MassLoader
fileOpen	Dispatched when the MassLoader starts the loading of a file.	MassLoader
fileProgress	Dispatched when the loading of a ILoadManager progresses.	MassLoader
globalAfter	Dispatched after an event is dispatched.	GlobalEventDispatcher
globalBefore	Dispatched before an event is dispatched.	GlobalEventDispatcher
open	Dispatched when the download operation commences following a call to the MassLoader.start() method.	MassLoader
priorityChanged	Dispatched when the loading of files with a lower priority starts.	PriorityMassLoader
progress	Dispatched when data is received as the download operation progresses.	MassLoader

Constructor Detail

ApplicationMassLoader

()

Constructor

public function ApplicationMassLoader(parallelFiles:uint = 0, loadByPriority:Boolean = false)

Creates a new ApplicationMassLoader object.

Parameters

	`parallelFiles:uint` (default = `0`) — Defines how many file to load at the same time. This value will affect the loading only if the `loadByPriority` property is `false`.

	`loadByPriority:Boolean` (default = `false`) — Defines if the `ApplicationMassLoader` must load the files by priority.

Method Detail

addAll

()

method

public function addAll(context:IApplicationContext):Array

Add all the ApplicationFile objects that are in a specified ApplicationContext in the loading queue.

Parameters

context:IApplicationContext — The IApplicationContext.

Returns

Array — An Array containing all the ApplicationFile added to the loading queue.

See also

ApplicationContext.enumerateRoots()

addApplicationFile

()

method

public function addApplicationFile(file:ApplicationFile):void

Add the specified ApplicationFile and its dependencies.

Parameters

file:ApplicationFile — The ApplicationFile to add.

addGlobalFiles

()

method

public function addGlobalFiles(context:IApplicationContext):void

Add the global ApplicationFile in the loading queue.

Parameters

context:IApplicationContext — The IApplicationContext.

addLoadableFile

()

method

protected function addLoadableFile(file:ILoadableFile, priority:int):void

Add the specified ILoadableFile to the queue within the priority. If the ILoadableFile is already in the loading queue, then it checks if the priority must be udpated or not.

Parameters

	`file:ILoadableFile` — The `ILoadableFile`.

	`priority:int` — The priority.

load

()

method

public function load(file:Object, context:IApplicationContext = null, withGlobalFiles:Boolean = false):ApplicationFile

Starts the loading of the specified file. If the file isn't an ApplicationFile then the toString() method will be used to retrieve it from the specified ApplicationContext.

Parameters

	`file:Object` — The `ApplicationFile` object or the name of the `ApplicationFile`. If this param is a `String`, then the `IApplicationContext` must be specified.

	`context:IApplicationContext` (default = `null`) — The `IApplicationContext` to retrieve the `ApplicationFile` and global files.

	`withGlobalFiles:Boolean` (default = `false`) — Tells the `ApplicationMassLoader` to automatically add the `ApplicationFile` that are noted as global (`IApplicationContext` must be specified).

Returns

ApplicationFile — The ApplicationFile being loaded.

Throws

IllegalOperationError If — the ApplicationmassLoader is currently loading.

Sun Apr 18 2010, 12:21 PM +02:00

Masapi 2.0 - http://masapi.googlecode.com - r185	All Packages \| All Classes \| Index \| Frames No Frames
ApplicationMassLoader	Properties \| Methods \| Events

Package	ch.capi.net.app
Class	public class ApplicationMassLoader
Inheritance	ApplicationMassLoader PriorityMassLoader MassLoader GlobalEventDispatcher flash.events.EventDispatcher
Implements	IMassLoader