Packagech.capi.events
Classpublic class MassLoadEvent
InheritanceMassLoadEvent Inheritance flash.events.Event

Represents an event occuring during a massloading.



Public Properties
 PropertyDefined by
  closeEvent : Event
[read-only] Defines the event that occured when the file was closed.
MassLoadEvent
  file : ILoadManager
[read-only] Defines the file being loaded.
MassLoadEvent
Public Methods
 MethodDefined by
  
MassLoadEvent(type:String, file:ILoadManager = null, closeEvent:Event = null)
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
  
isError():Boolean
Get if an error has occured during the download of the specified file.
MassLoadEvent
Public Constants
 ConstantDefined 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
Property detail
closeEventproperty
closeEvent:Event  [read-only]

Defines the event that occured when the file was closed.

Implementation
    public function get closeEvent():Event
fileproperty 
file:ILoadManager  [read-only]

Defines the file being loaded.

Implementation
    public function get file():ILoadManager
Constructor detail
MassLoadEvent()constructor
public function MassLoadEvent(type:String, file:ILoadManager = null, closeEvent:Event = null)

Creates a new MassLoadEvent object.

Parameters
type:String — The type.
 
file:ILoadManager (default = null) — The file being loaded.
 
closeEvent:Event (default = null) — The Event dispatched to close the file. This event is cloned before beeing stored.
Method detail
clone()method
public override function clone():Event

Creates a copy of the MassLoadEvent object and sets the value of each property to match that of the original.

Returns
Event — The cloned Event.
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.

Returns
Booleantrue if there was an error. A FILE_OPEN event always return false.

See also

Constant detail
FILE_CLOSEconstant
public static const FILE_CLOSE:String = "fileClose"

Event when the loading of a file stops.

FILE_OPENconstant 
public static const FILE_OPEN:String = "fileOpen"

Event when the loading of a file starts.