Packagech.capi.net
Interfacepublic interface IMassLoader extends ILoadManager, flash.events.IEventDispatcher
ImplementorsApplicationMassLoader, MassLoader, PriorityMassLoader

Represents a massive loader. This interface represents objects that manages the loading of many files.

See also

LoadableFileFactory
CompositeMassLoader


Public Properties
 PropertyDefined by
 InheritedbytesLoaded : uint
Defines the bytes that have been loaded.
ILoadManager
 InheritedbytesTotal : uint
Defines the total bytes to load.
ILoadManager
 InheritedcloseEvent : Event
Defines the event that happend to close the file (Event.CLOSE, Event.COMPLETE, ...).
ILoadManager
  loadInfo : ILoadInfo
[read-only] Defines the ILoadInfo object linked to the IMassLoader.
IMassLoader
  loadPolicy : ILoadPolicy
Defines the ILoadPolicy to use.
IMassLoader
  parallelFiles : uint
Defines the number of files that will be loaded simultaneously.
IMassLoader
 InheritedstateIdle : Boolean
Defines if the ILoadManager is idle.
ILoadManager
 InheritedstateLoading : Boolean
Defines if the ILoadManager is loading.
ILoadManager
 InheriteduseCache : Boolean
Defines if the ILoadManager can use the cache or not.
ILoadManager
Public Methods
 MethodDefined by
  
addFile(file:ILoadManager):void
Add a file to the loading queue.
IMassLoader
  
clear():void
Empty the loading queue.
IMassLoader
  
getFileCount():uint
Get the number of files to be loaded.
IMassLoader
  
getFiles():Array
Get the files that will be loaded.
IMassLoader
  
Removes a file from the loading queue.
IMassLoader
 Inherited
start():void
Starts downloading data from the specified URL.
ILoadManager
 Inherited
stop():void
Stops the load operation in progress.
ILoadManager
Events
 EventSummaryDefined by
 Inherited Dispatched when the download operation stops.ILoadManager
 Inherited Dispatched after all the received data is received.ILoadManager
   Dispatched when the loading of a ILoadManager is closed (eg when the loading is complete or an error has occured).IMassLoader
   Dispatched when the IMassLoader starts the loading of a file.IMassLoader
 Inherited Dispatched when the download operation commences following a call to the ILoadManager.load() method.ILoadManager
 Inherited Dispatched when data is received as the download operation progresses.ILoadManager
Property detail
loadInfoproperty
loadInfo:ILoadInfo  [read-only]

Defines the ILoadInfo object linked to the IMassLoader.

Implementation
    public function get loadInfo():ILoadInfo
loadPolicyproperty 
loadPolicy:ILoadPolicy  [read-write]

Defines the ILoadPolicy to use.

Implementation
    public function get loadPolicy():ILoadPolicy
    public function set loadPolicy(value:ILoadPolicy):void
parallelFilesproperty 
parallelFiles:uint  [read-write]

Defines the number of files that will be loaded simultaneously. If the value is changed during a load process, this won't affect it.

Implementation
    public function get parallelFiles():uint
    public function set parallelFiles(value:uint):void
Method detail
addFile()method
public function addFile(file:ILoadManager):void

Add a file to the loading queue.

Parameters
file:ILoadManager — The file to add.

See also

clear()method 
public function clear():void

Empty the loading queue.

getFileCount()method 
public function getFileCount():uint

Get the number of files to be loaded.

Returns
uint — The number of file to load.
getFiles()method 
public function getFiles():Array

Get the files that will be loaded.

Returns
Array — An Array containing the files to load.
removeFile()method 
public function removeFile(file:ILoadManager):void

Removes a file from the loading queue.

Parameters
file:ILoadManager — The file to remove.
Event detail
fileCloseevent 
Event object type: ch.capi.events.MassLoadEvent

Dispatched when the loading of a ILoadManager is closed (eg when the loading is complete or an error has occured).

fileOpenevent  
Event object type: ch.capi.events.MassLoadEvent

Dispatched when the IMassLoader starts the loading of a file. This event is dispatched just before the ILoadManager.start() method is called.