Packagech.capi.net
Interfacepublic interface ILoadManager extends IGlobalEventDispatcher , IEventDispatcher

Represents a load manager. This manager should be able to manage all the events related to the loading of a file.

See also

CompositeMassLoader

Public Properties
 PropertyDefined 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
  stateIdle : Boolean
[read-only] Defines if the ILoadManager is idle.
ILoadManager
  stateLoading : Boolean
[read-only] Defines if the ILoadManager is loading.
ILoadManager
Public Methods
 MethodDefined By
  
start():Boolean
Starts downloading data from the specified URL.
ILoadManager
  
stop():void
Stops the load operation in progress.
ILoadManager
Events
 Event Summary Defined By
  
close
Dispatched when the download operation stops.ILoadManager
  
complete
Dispatched after all the received data is received.ILoadManager
  
open
Dispatched when the download operation commences following a call to the ILoadManager.load() method.ILoadManager
  
progress
Dispatched when data is received as the download operation progresses.ILoadManager
Property Detail
bytesLoadedproperty
bytesLoaded:uint  [read-only]

Defines the bytes that have been loaded.


Implementation
    public function get bytesLoaded():uint
bytesTotalproperty 
bytesTotal:uint  [read-only]

Defines the total bytes to load.


Implementation
    public function get bytesTotal():uint
closeEventproperty 
closeEvent:Event  [read-only]

Defines the event that happend to close the file (Event.CLOSE, Event.COMPLETE, ...).


Implementation
    public function get closeEvent():Event
loadedproperty 
loaded:Boolean  [read-only]

Defines if the ILoadManager operation is complete. This value is true only if the data has been successfully loaded.


Implementation
    public function get loaded():Boolean
stateIdleproperty 
stateIdle:Boolean  [read-only]

Defines if the ILoadManager is idle.


Implementation
    public function get stateIdle():Boolean
stateLoadingproperty 
stateLoading:Boolean  [read-only]

Defines if the ILoadManager is loading.


Implementation
    public function get stateLoading():Boolean
Method Detail
start()method
public function start():Boolean

Starts downloading data from the specified URL.

Returns
Boolean — true if the loading has been started, false otherwise.

Throws
flash.errors:IllegalOperationError If — the ILoadManager is already loading.
stop()method 
public function stop():void

Stops the load operation in progress. Any load operation in progress is immediately terminated.


Throws
flash.errors:IllegalOperationError If — the ILoadManager is not loading.
Event Detail
close Event
Event Object Type: flash.events.Event
Event.type property = flash.events.Event.CLOSE

Dispatched when the download operation stops. This is following a call to the ILoadManager.stop() method.

complete Event  
Event Object Type: flash.events.Event
Event.type property = flash.events.Event.COMPLETE

Dispatched after all the received data is received.

open Event  
Event Object Type: flash.events.Event
Event.type property = flash.events.Event.OPEN

Dispatched when the download operation commences following a call to the ILoadManager.load() method.

progress Event  
Event Object Type: flash.events.ProgressEvent
ProgressEvent.type property = flash.events.ProgressEvent.PROGRESS

Dispatched when data is received as the download operation progresses.




Cedric Tabin - http://www.astorm.ch

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