A ProgressEvent object is dispatched when a load operation has begun or a socket has received data. These events are usually generated when images or data are loaded into an application. There are two types of progress events: ProgressEvent.PROGRESS and ProgressEvent.SOCKET_DATA.


Inherited from Event.


Can be created with method new:

Lib.Media.Events.ProgressEvent.new(type, bubbles, cancelable, bytesLoaded, bytesTotal)

Creates an Event object that contains information about progress events. Event objects are passed as parameters to event listeners.

type - The type of the event. Possible values are:ProgressEvent.PROGRESS, ProgressEvent.SOCKET_DATA

bubbles - (default = false) - Determines whether the Event object participates in the bubbling stage of the event flow.

cancelable - (default = false) - Determines whether the Event object can be canceled.

bytesLoaded - (default = 0) - The number of items or bytes loaded at the time the listener processes the event.

bytesTotal - (default = 0) - The total number of items or bytes that will be loaded if the loading process succeeds.


Created ProgressEvent object has properties:

bytesLoaded

The number of items or bytes loaded when the listener processes the event.

bytesTotal

The total number of items or bytes that will be loaded if the loading process succeeds.


methods:

clone()

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

toString()

Returns a string that contains all the properties of the ProgressEvent object.


Event types:

Lib.Media.Events.ProgressEvent.PROGRESS

Defines the value of the type property of a progress event object.

Lib.Media.Events.ProgressEvent.SOCKET_DATA

Defines the value of the type property of a socketData event object.

Created with the Personal Edition of HelpNDoc: Full-featured Kindle eBooks generator