| Package | ch.capi.events |
| Class | public class MassLoadEvent |
| Inheritance | MassLoadEvent  flash.events.Event |
| Property | Defined By | ||
|---|---|---|---|
| closeEvent : Event [read-only]
Defines the event that occured when the file was closed. | MassLoadEvent | ||
| loadedIndex : int [read-only]
Defines the index of the file in the loaded queue. | MassLoadEvent | ||
| loadManager : ILoadManager [read-only]
Defines the ILoadManager being loaded. | MassLoadEvent | ||
| priority : int
The priority of the file. | MassLoadEvent | ||
| queueIndex : int [read-only]
Defines the index of the file in the loading queue. | MassLoadEvent | ||
| staticIndex : int
Defines the index of the file. | MassLoadEvent | ||
| Method | Defined By | ||
|---|---|---|---|
MassLoadEvent(type:String, file:ILoadManager = null, closeEvent:Event = null, staticIndex:int = -1, queueIndex:int = -1, loadedIndex:int = -1, priority:int = 0)
Creates a new MassLoadEvent object. | MassLoadEvent | ||
clone():Event
Creates a copy of the MassLoadEvent object and sets the value of each property to match that of the original. | MassLoadEvent | ||
Retrieves the ILoadManager as ILoadableFile. | MassLoadEvent | ||
isError():Boolean
Get if an error has occured during the download of the specified file. | MassLoadEvent | ||
isLoadableFile():Boolean
Checks if the contained ILoadManager is a ILoadableFile. | MassLoadEvent | ||
toString():String
Returns the MassLoadEvent in a String. | MassLoadEvent | ||
| Constant | Defined By | ||
|---|---|---|---|
| FILE_CLOSE : String = fileClose [static]
Event when the loading of a file stops. | MassLoadEvent | ||
| FILE_OPEN : String = fileOpen [static]
Event when the loading of a file starts. | MassLoadEvent | ||
| FILE_PROGRESS : String = fileProgress [static]
Event when the loading of a file progresses. | MassLoadEvent | ||
| closeEvent | property |
closeEvent:Event [read-only] Defines the event that occured when the file was closed.
public function get closeEvent():Event| loadedIndex | property |
loadedIndex:int [read-only]
Defines the index of the file in the loaded queue. It indicates how many files
have been loaded before the loadManager.
public function get loadedIndex():int| loadManager | property |
loadManager:ILoadManager [read-only]
Defines the ILoadManager being loaded.
public function get loadManager():ILoadManagerSee also
| priority | property |
priority:int [read-write]
The priority of the file. If the file wasn't loaded in a PriorityMassLoader
this value will be 0.
public function get priority():int public function set priority(value:int):void| queueIndex | property |
queueIndex:int [read-only] Defines the index of the file in the loading queue.
public function get queueIndex():intSee also
| staticIndex | property |
staticIndex:int [read-write]
Defines the index of the file. The index is unique for a ILoadableFile
in a specific IMassLoader. The file may be removed before the
event is dispatched. If the index is not known, this property is -1.
public function get staticIndex():int public function set staticIndex(value:int):voidSee also
| MassLoadEvent | () | Constructor |
public function MassLoadEvent(type:String, file:ILoadManager = null, closeEvent:Event = null, staticIndex:int = -1, queueIndex:int = -1, loadedIndex:int = -1, priority:int = 0)
Creates a new MassLoadEvent object.
type:String — The type.
| |
file:ILoadManager (default = null) | |
closeEvent:Event (default = null)Event dispatched to close the file. This event is cloned before beeing stored.
| |
staticIndex:int (default = -1) | |
queueIndex:int (default = -1) | |
loadedIndex:int (default = -1) | |
priority:int (default = 0) |
| clone | () | method |
override public function clone():Event
Creates a copy of the MassLoadEvent object and sets the value of each property to match that of the original.
Event — The cloned Event.
|
| getFile | () | method |
public function getFile():ILoadableFile
Retrieves the ILoadManager as ILoadableFile.
ILoadableFile — The ILoadManager as ILoadableFile.
|
Error If — the ILoadManager is not a ILoadableFile.
|
See also
| isError | () | method |
public function isError():Boolean
Get if an error has occured during the download of the specified file. If the error event is a
IOErrorEvent or a SecurityErrorEvent, then the value true is
returned.
Boolean — true if there was an error. A FILE_OPEN event always return false.
|
See also
| isLoadableFile | () | method |
public function isLoadableFile():Boolean
Checks if the contained ILoadManager is a ILoadableFile.
Boolean — true if the ILoadManager is a ILoadableFile.
|
| toString | () | method |
override public function toString():String
Returns the MassLoadEvent in a String.
String — A String containing the MassLoadEvent properties values.
|
| FILE_CLOSE | Constant |
public static const FILE_CLOSE:String = fileCloseEvent when the loading of a file stops.
| FILE_OPEN | Constant |
public static const FILE_OPEN:String = fileOpenEvent when the loading of a file starts.
| FILE_PROGRESS | Constant |
public static const FILE_PROGRESS:String = fileProgressEvent when the loading of a file progresses.