| Package | ch.capi.net |
| Interface | public interface IMassLoader extends ILoadManager , IGlobalEventDispatcher , IEventDispatcher |
| Implementors | ApplicationMassLoader, MassLoader, PriorityMassLoader |
See also
| Property | Defined By | ||
|---|---|---|---|
 | bytesLoaded : uint [read-only]
Defines the bytes that have been loaded. | ILoadManager | |
| bytesTotal : uint [read-only]
Defines the total bytes to load. | ILoadManager | |
| closeEvent : Event [read-only]
Defines the event that happend to close the file (Event.CLOSE, Event.COMPLETE, ...). | ILoadManager | |
| loaded : Boolean [read-only]
Defines if the ILoadManager operation is complete. | ILoadManager | |
| loadInfo : ILoadInfo [read-only]
Defines the ILoadInfo object linked to the IMassLoader. | IMassLoader | ||
| loadPolicy : ILoadPolicy
Defines the ILoadPolicy to use. | IMassLoader | ||
| numFiles : uint [read-only]
Defines the total of the files in the IMassLoader. | IMassLoader | ||
| numFilesLoaded : uint [read-only]
Defines the number of files loaded. | IMassLoader | ||
| numFilesLoading : uint [read-only]
Defines the number of files being currently loaded. | IMassLoader | ||
| numFilesOpen : uint [read-only]
Defines the number of files being currently open. | IMassLoader | ||
| numFilesToLoad : uint [read-only]
Defines the number of files to load. | IMassLoader | ||
| parallelFiles : uint
Defines the number of files that will be loaded simultaneously. | IMassLoader | ||
| stateIdle : Boolean [read-only]
Defines if the ILoadManager is idle. | ILoadManager | |
| stateLoading : Boolean [read-only]
Defines if the ILoadManager is loading. | ILoadManager | |
| Method | Defined 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 | ||
removeFile(file:ILoadManager):void
Removes a file from the loading queue. | IMassLoader | ||
| start():Boolean
Starts downloading data from the specified URL. | ILoadManager | |
| stop():void
Stops the load operation in progress. | ILoadManager | |
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| 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 | |||
| Dispatched when the loading of a ILoadManager progresses. | IMassLoader | |||
| loadInfo | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesloadInfo:ILoadInfo [read-only]
Defines the ILoadInfo object linked to the IMassLoader.
public function get loadInfo():ILoadInfo| loadPolicy | property |
loadPolicy:ILoadPolicy [read-write]
Defines the ILoadPolicy to use.
public function get loadPolicy():ILoadPolicy public function set loadPolicy(value:ILoadPolicy):void| numFiles | property |
numFiles:uint [read-only]
Defines the total of the files in the IMassLoader. This value will remain correct even
if files are added during the loading.
public function get numFiles():uint| numFilesLoaded | property |
numFilesLoaded:uint [read-only] Defines the number of files loaded. This value contains also the files that have not been loaded successfully.
public function get numFilesLoaded():uint| numFilesLoading | property |
numFilesLoading:uint [read-only]
Defines the number of files being currently loaded. This value does not take care if the
Event.OPEN event of each file has been launched. It is based on the
MassLoadEvent.FILE_OPEN event.
public function get numFilesLoading():uintSee also
| numFilesOpen | property |
numFilesOpen:uint [read-only]
Defines the number of files being currently open. This value is based on the files that
have sent the Event.OPEN event.
public function get numFilesOpen():uintSee also
| numFilesToLoad | property |
numFilesToLoad:uint [read-only] Defines the number of files to load. Once a file start its loading, it is no considered in this value anymore.
public function get numFilesToLoad():uint| parallelFiles | property |
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.
public function get parallelFiles():uint public function set parallelFiles(value:uint):void| addFile | () | method |
public function addFile(file:ILoadManager):void
Add a file to the loading queue. If the file is already in the loading queue,
then a flash.errors.IllegalOperationError will be thrown.
Parameters
file:ILoadManager — The file to add.
|
flash.errors:IllegalOperationError If — the file is already in the loading queue.
|
See also
| clear | () | method |
public function clear():voidEmpty the loading queue.
| getFileCount | () | method |
public function getFileCount():uintGet the number of files to be loaded.
Returnsuint — The number of file to load.
|
| getFiles | () | method |
public function getFiles():ArrayGet the files that will be loaded.
ReturnsArray — An Array containing the files to load.
|
| removeFile | () | method |
public function removeFile(file:ILoadManager):void
Removes a file from the loading queue. If the file is not in the loading queue,
then a flash.errors.IllegalOperationError will be thrown.
Parameters
file:ILoadManager — The file to remove.
|
flash.errors:IllegalOperationError If — the file is not in the loading queue.
|
| fileClose | Event |
ch.capi.events.MassLoadEventch.capi.events.MassLoadEvent.FILE_CLOSE
Dispatched when the loading of a ILoadManager is closed (eg when the loading is complete or
an error has occured).
| fileOpen | Event |
ch.capi.events.MassLoadEventch.capi.events.MassLoadEvent.FILE_OPEN
Dispatched when the IMassLoader starts the loading of a file. This event
is dispatched just before the ILoadManager.start() method is called.
| fileProgress | Event |
ch.capi.events.MassLoadEventch.capi.events.MassLoadEvent.FILE_PROGRESS
Dispatched when the loading of a ILoadManager progresses.