Main Page | Packages | Class Tree | Index | Help

xp.events

class ProgressEvent

Object
  |
  +--xp.events.Event
        |
        +--xp.events.ProgressEvent


class ProgressEvent
extends Event

Broadcast Triggered while content is loading.

Notifies listeners of the progress of loading content. Flash has two different loading API - MovieClipLoader and Loader. XPComponents mediates between the two and presents a single constent event API regardless of which API is being used to load content.


Author:
ProWin Computers Ltd. - Rob Edgar

Version:
3.0.0.000

See also:


Field Summary


bytesLoaded: Number
The current bytes loaded.


bytesTotal: Number
The total bytes that will be loaded.


container: Object
The container or owner control of the content.


content: Object
The content being loaded.


errorCode: String
If the load fails the error code if any will be set here.


eventName: String
The name of the event. One of loadError,loadStart,loadInit,loadProgress,loadComplete


subtype
Deprecated. 

Fields inherited from class xp.events.Event

bubbles, cancel, currentTarget, handled, target, type

Constructor

public
ProgressEvent ( eventName: String, container: Object, content: Object, bytesLoaded: Number, bytesTotal: Number, errorCode: String)
Constructs a new progress event



Field Documentation

bytesLoaded

var bytesLoaded: Number
The current bytes loaded.

bytesTotal

var bytesTotal: Number
The total bytes that will be loaded.

container

var container: Object
The container or owner control of the content.

content

var content: Object
The content being loaded.

errorCode

var errorCode: String
If the load fails the error code if any will be set here.

If set one of "URLNotFound" or "LoadNeverCompleted"

eventName

var eventName: String
The name of the event. One of loadError,loadStart,loadInit,loadProgress,loadComplete

subtype

var subtype
Deprecated. 


Constructor Documentation

ProgressEvent

public function ProgressEvent(eventName: String,
 container: Object,
 content: Object,
 bytesLoaded: Number,
 bytesTotal: Number,
 errorCode: String)
Constructs a new progress event

Parameters:
eventName
The name of the event.
container
The container or owner control of the content.
content
The content being loaded.
bytesLoaded
The current bytes loaded.
bytesTotal
The total bytes that will be loaded.
errorCode
If the load fails the error code if any will be set here.

The documentation was generated from the following file:


Generated on 10/30/2005 9:34:02 PM by AS2Doc