LoadEvent

Kind of class:public class
Package:org.casalib.events
Inherits from:ProgressEvent
Known subclasses:
Dispatched by:
Version:04/19/09
Author:Aaron Clinger
Classpath:org.casalib.events.LoadEvent
File last modified:Sunday, 19 April 2009, 22:49:47
An event dispatched during loading.

Summary


Constructor
  • LoadEvent (type:String, bubbles:Boolean = false, cancelable:Boolean = false)
    • Creates a new LoadEvent.
Constants
Instance properties
  • progress : Percent
    • The percent that the requested file has loaded.
  • attempts : uint
    • The number of additional times the file has attempted to load.
  • retries : uint
    • The number of additional load retries the class will attempt before failing.
  • Bps : int
    • The current download speed of the requested file in bytes per second.
  • time : uint
    • The current time duration in milliseconds the load has taken.
  • latency : uint
    • The time in milliseconds that the server took to respond.
  • httpStatus : uint
    • The HTTP status code returned by the server; or 0 if no status has/can been received or the load is a stream.
Instance methods

Constructor

LoadEvent

public function LoadEvent (
type:String, bubbles:Boolean = false, cancelable:Boolean = false)

Creates a new LoadEvent.
Parameters:
type :
The type of event.
bubbles :
Determines whether the Event object participates in the bubbling stage of the event flow.
cancelable:
Determines whether the Event object can be canceled.

Constants

COMPLETE

public static const COMPLETE:String = 'complete'
(read)

PROGRESS

public static const PROGRESS:String = 'progress'
(read)

START

public static const START:String = 'start'
(read)

STOP

public static const STOP:String = 'stop'
(read)

Instance properties

attempts

public attempts:uint
(read,write)

The number of additional times the file has attempted to load.

Bps

public Bps:int
(read,write)

The current download speed of the requested file in bytes per second.

httpStatus

public httpStatus:uint
(read,write)

The HTTP status code returned by the server; or 0 if no status has/can been received or the load is a stream.

latency

public latency:uint
(read,write)

The time in milliseconds that the server took to respond.

progress

public progress:Percent
(read,write)

The percent that the requested file has loaded.

retries

public retries:uint
(read,write)

The number of additional load retries the class will attempt before failing.

time

public time:uint
(read,write)

The current time duration in milliseconds the load has taken.

Instance methods

clone

override public function clone (
) : Event

Returns:
  • Duplicates an instance of the event.
Overrides:
  • ProgressEvent.clone

toString

override public function toString (
) : String

Returns:
  • A string containing all the properties of the event.
Overrides:
  • ProgressEvent.toString