A ProgressEvent object is dispatched when a load operation has begun or a
socket has received data. These events are usually generated when SWF
files, images or data are loaded into an application. There are two types
of progress events: ProgressEvent.PROGRESS
and
ProgressEvent.SOCKET_DATA
. Additionally, in AIR ProgressEvent
objects are dispatched when a data is sent to or from a child process using
the NativeProcess class.
Static variables
staticinlineread onlyPROGRESS:EventType<ProgressEvent> = "progress"
Defines the value of the type
property of a progress
event object.
This event has the following properties:
Property | Value |
---|---|
bubbles | false |
bytesLoaded | The number of items or bytes loaded at the time the listener processes the event. |
bytesTotal | The total number of items or bytes that ultimately will be loaded if the loading process succeeds. |
cancelable | false ; there is no default behavior to cancel. |
currentTarget | The object that is actively processing the Event object with an event listener. |
target | The object reporting progress. |
staticinlineread onlySOCKET_DATA:EventType<ProgressEvent> = "socketData"
Defines the value of the type
property of a socketData
event
object.
This event has the following properties:
Property | Value |
---|---|
bubbles | false |
cancelable | false ; there is no default behavior to cancel. |
currentTarget | The object that is actively processing the Event. |
bytesLoaded | The number of items or bytes loaded at the time the listener processes the event. |
bytesTotal | 0; this property is not used by socketData event objects. |
target | The socket reporting progress. |
staticinlineread onlySTANDARD_ERROR_DATA:EventType<ProgressEvent> = "standardErrorData"
Available on AIR, Android, Flash, HashLink, Linux, Neko, Windows, iOS, macOS
Defines the value of the type
property of a standardErrorData
event
object.
This event has the following properties:
Property | Value |
---|---|
bubbles | false |
cancelable | false ; there is no default behavior to cancel. |
currentTarget | The object that is actively processing the Event. |
bytesLoaded | The number of bytes of output data buffered by the NativeProcessObject.standardError due to this event. |
bytesTotal | 0; this property is not used by standardErrorData event objects. |
target | The NativeProcess object reporting output data. |
staticinlineread onlySTANDARD_OUTPUT_DATA:EventType<ProgressEvent> = "standardOutputData"
Available on AIR, Android, Flash, HashLink, Linux, Neko, Windows, iOS, macOS
Defines the value of the type
property of a standardOutputData
event
object.
This event has the following properties:
Property | Value |
---|---|
bubbles | false |
cancelable | false ; there is no default behavior to cancel. |
currentTarget | The object that is actively processing the Event. |
bytesLoaded | The number of bytes of output data buffered by the NativeProcessObject.standardOutput due to this event. |
bytesTotal | 0; this property is not used by standardOutputData event objects. |
target | The NativeProcess object reporting output data. |
Constructor
new(type:String, bubbles:Bool = false, cancelable:Bool = false, bytesLoaded:Float = 0, bytesTotal:Float = 0)
Creates an Event object that contains information about progress events. Event objects are passed as parameters to event listeners.
Parameters:
type | The type of the event. Possible values
are: |
---|---|
bubbles | Determines whether the Event object participates in the bubbling stage of the event flow. |
cancelable | Determines whether the Event object can be canceled. |
bytesLoaded | The number of items or bytes loaded at the time the listener processes the event. |
bytesTotal | The total number of items or bytes that will be loaded if the loading process succeeds. |
Variables
bytesTotal:Float
The total number of items or bytes that will be loaded if the loading process succeeds. If the progress event is dispatched/attached to a Socket object, the bytesTotal will always be 0 unless a value is specified in the bytesTotal parameter of the constructor. The actual number of bytes sent back or forth is not set and is up to the application developer.