Package | flash.events |
Class | public class ProgressEvent |
Inheritance | ProgressEvent Event Object |
Language version: | ActionScript 3.0 |
Runtime version: |
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.
See also
Property | Defined by | ||
---|---|---|---|
bubbles : Boolean
Indicates whether an event is a bubbling event.
| Event | ||
bytesLoaded : Number
The number of items or bytes loaded when the listener processes the event.
| ProgressEvent | ||
bytesTotal : Number
The total number of items or bytes that will be loaded if the loading process succeeds.
| ProgressEvent | ||
cancelable : Boolean
Indicates whether the behavior associated with the event can be prevented.
| Event | ||
constructor : Object
A reference to the class object or constructor function for a given object instance.
| Object | ||
currentTarget : Object
The object that is actively processing the Event object with an event listener.
| Event | ||
eventPhase : uint
The current phase in the event flow.
| Event | ||
prototype : Object
[static]
A reference to the prototype object of a class or function object.
| Object | ||
target : Object
The event target.
| Event | ||
type : String
The type of event.
| Event |
Method | Defined by | ||
---|---|---|---|
ProgressEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bytesLoaded:Number = 0, bytesTotal:Number = 0)
Creates an Event object that contains information about progress events.
| ProgressEvent | ||
Creates a copy of the ProgressEvent object and sets each property's value to match that of the original.
| ProgressEvent | ||
A utility function for implementing the
toString() method in custom
ActionScript 3.0 Event classes. | Event | ||
Indicates whether an object has a specified property defined.
| Object | ||
Checks whether the
preventDefault() method has been called on the event. | Event | ||
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter.
| Object | ||
Cancels an event's default behavior if that behavior can be canceled.
| Event | ||
Indicates whether the specified property exists and is enumerable.
| Object | ||
Sets the availability of a dynamic property for loop operations.
| Object | ||
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow.
| Event | ||
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow.
| Event | ||
Returns the string representation of this object, formatted according to locale-specific conventions.
| Object | ||
Returns a string that contains all the properties of the ProgressEvent object.
| ProgressEvent | ||
Returns the primitive value of the specified object.
| Object |
Constant | Defined by | ||
---|---|---|---|
ACTIVATE : String = "activate" [static]
The
ACTIVATE constant defines the value of the type property of an activate event object. | Event | ||
ADDED : String = "added" [static]
The
Event.ADDED constant defines the value of the type property of
an added event object. | Event | ||
ADDED_TO_STAGE : String = "addedToStage" [static]
The
Event.ADDED_TO_STAGE constant defines the value of the type
property of an addedToStage event object. | Event | ||
BROWSER_ZOOM_CHANGE : String = "browserZoomChange" [static]
The
Event.BROWSER_ZOOM_CHANGE constant defines the value of the type
property of an browserZoomChange event object. | Event | ||
CANCEL : String = "cancel" [static]
The
Event.CANCEL constant defines the value of the type property of a cancel event object. | Event | ||
CHANGE : String = "change" [static]
The
Event.CHANGE constant defines the value of the type property of a change event object. | Event | ||
CHANNEL_MESSAGE : String = "channelMessage" [static]
The
Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object. | Event | ||
CHANNEL_STATE : String = "channelState" [static]
The
Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object. | Event | ||
CLEAR : String = "clear" [static]
The
Event.CLEAR constant defines the value of the type property
of a clear event object. | Event | ||
CLOSE : String = "close" [static]
The
Event.CLOSE constant defines the value of the type property of a close event object. | Event | ||
CLOSING : String = "closing" [static]
The
Event.CLOSING constant defines the value of the
type property of a closing event object. | Event | ||
COMPLETE : String = "complete" [static]
The
Event.COMPLETE constant defines the value of the type property of a complete event object. | Event | ||
CONNECT : String = "connect" [static]
The
Event.CONNECT constant defines the value of the type property of a connect event object. | Event | ||
CONTEXT3D_CREATE : String = "context3DCreate" [static]
The
Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object. | Event | ||
COPY : String = "copy" [static]
Defines the value of the
type property of a copy event object. | Event | ||
CUT : String = "cut" [static]
Defines the value of the
type property of a cut event object. | Event | ||
DEACTIVATE : String = "deactivate" [static]
The
Event.DEACTIVATE constant defines the value of the type property of a deactivate event object. | Event | ||
DISPLAYING : String = "displaying" [static]
The
Event.DISPLAYING constant defines the value of the type property of a displaying event object. | Event | ||
ENTER_FRAME : String = "enterFrame" [static]
The
Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object. | Event | ||
EXIT_FRAME : String = "exitFrame" [static]
The
Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object. | Event | ||
EXITING : String = "exiting" [static]
The
Event.EXITING constant defines the value of the type property of an exiting event object. | Event | ||
FRAME_CONSTRUCTED : String = "frameConstructed" [static]
The
Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object. | Event | ||
FRAME_LABEL : String = "frameLabel" [static]
The
Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object. | Event | ||
FULLSCREEN : String = "fullScreen" [static]
The
Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object. | Event | ||
HTML_BOUNDS_CHANGE : String = "htmlBoundsChange" [static]
The
Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object. | Event | ||
HTML_DOM_INITIALIZE : String = "htmlDOMInitialize" [static]
The
Event.HTML_DOM_INITIALIZE constant defines the value of the type property
of an htmlDOMInitialize event object. | Event | ||
HTML_RENDER : String = "htmlRender" [static]
The
Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object. | Event | ||
ID3 : String = "id3" [static]
The
Event.ID3 constant defines the value of the type property of an id3 event object. | Event | ||
INIT : String = "init" [static]
The
Event.INIT constant defines the value of the type property of an init event object. | Event | ||
LOCATION_CHANGE : String = "locationChange" [static]
The
Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object. | Event | ||
MOUSE_LEAVE : String = "mouseLeave" [static]
The
Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object. | Event | ||
NETWORK_CHANGE : String = "networkChange" [static]
The
Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object. | Event | ||
OPEN : String = "open" [static]
The
Event.OPEN constant defines the value of the type property of an open event object. | Event | ||
PASTE : String = "paste" [static]
The
Event.PASTE constant defines the value of the type property of a paste event object. | Event | ||
PREPARING : String = "preparing" [static]
The
Event.PREPARING constant defines the value of the type property of a preparing event object. | Event | ||
PROGRESS : String = "progress" [static]
Defines the value of the
type property of a progress event object. | ProgressEvent | ||
REMOVED : String = "removed" [static]
The
Event.REMOVED constant defines the value of the type property of
a removed event object. | Event | ||
REMOVED_FROM_STAGE : String = "removedFromStage" [static]
The
Event.REMOVED_FROM_STAGE constant defines the value of the type
property of a removedFromStage event object. | Event | ||
RENDER : String = "render" [static]
The
Event.RENDER constant defines the value of the type property of a render event object. | Event | ||
RESIZE : String = "resize" [static]
The
Event.RESIZE constant defines the value of the type property of a resize event object. | Event | ||
SCROLL : String = "scroll" [static]
The
Event.SCROLL constant defines the value of the type property of a scroll event object. | Event | ||
SELECT : String = "select" [static]
The
Event.SELECT constant defines the value of the type property of a select event object. | Event | ||
SELECT_ALL : String = "selectAll" [static]
The
Event.SELECT_ALL constant defines the value of the type property of a selectAll event object. | Event | ||
SOCKET_DATA : String = "socketData" [static]
Defines the value of the
type property of a socketData event object. | ProgressEvent | ||
SOUND_COMPLETE : String = "soundComplete" [static]
The
Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object. | Event | ||
STANDARD_ERROR_CLOSE : String = "standardErrorClose" [static]
The
Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object. | Event | ||
STANDARD_ERROR_DATA : String = "standardErrorData" [static]
Defines the value of the
type property of a standardErrorData event object. | ProgressEvent | ||
STANDARD_INPUT_CLOSE : String = "standardInputClose" [static]
The
Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object. | Event | ||
STANDARD_INPUT_PROGRESS : String = "standardInputProgress" [static]
Defines the value of the
type property of a standardInputProgress event object. | ProgressEvent | ||
STANDARD_OUTPUT_CLOSE : String = "standardOutputClose" [static]
The
Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object. | Event | ||
STANDARD_OUTPUT_DATA : String = "standardOutputData" [static]
Defines the value of the
type property of a standardOutputData event object. | ProgressEvent | ||
SUSPEND : String = "suspend" [static]
The
Event.SUSPEND constant defines the value of the type property of an suspend event object. | Event | ||
TAB_CHILDREN_CHANGE : String = "tabChildrenChange" [static]
The
Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object. | Event | ||
TAB_ENABLED_CHANGE : String = "tabEnabledChange" [static]
The
Event.TAB_ENABLED_CHANGE constant defines the value of the type
property of a tabEnabledChange event object. | Event | ||
TAB_INDEX_CHANGE : String = "tabIndexChange" [static]
The
Event.TAB_INDEX_CHANGE constant defines the value of the
type property of a tabIndexChange event object. | Event | ||
TEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange" [static]
The
Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object. | Event | ||
TEXTURE_READY : String = "textureReady" [static]
The
Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object. | Event | ||
UNLOAD : String = "unload" [static]
The
Event.UNLOAD constant defines the value of the type property of an unload event object. | Event | ||
USER_IDLE : String = "userIdle" [static]
The
Event.USER_IDLE constant defines the value of the type property of a userIdle event object. | Event | ||
USER_PRESENT : String = "userPresent" [static]
The
Event.USER_PRESENT constant defines the value of the type property of a userPresent event object. | Event | ||
VIDEO_FRAME : String = "videoFrame" [static]
The
Event.VIDEO_FRAME constant defines the value of the
type property of a videoFrame event object. | Event | ||
WORKER_STATE : String = "workerState" [static]
The
Event.WORKER_STATE constant defines the value of the type property of a workerState event object. | Event |
bytesLoaded | property |
bytesLoaded:Number
[read-write]
Language version: | ActionScript 3.0 |
Runtime version: |
The number of items or bytes loaded when the listener processes the event.
Implementation public function get bytesLoaded():Number
public function set bytesLoaded(value:Number):void
bytesTotal | property |
bytesTotal:Number
[read-write]
Language version: | ActionScript 3.0 |
Runtime version: |
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.
Implementation public function get bytesTotal():Number
public function set bytesTotal(value:Number):void
ProgressEvent | () | constructor |
public function ProgressEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bytesLoaded:Number = 0, bytesTotal:Number = 0)
Language version: | ActionScript 3.0 |
Runtime version: |
Creates an Event object that contains information about progress events. Event objects are passed as parameters to event listeners.
Parameterstype:String — The type of the event. Possible values are:ProgressEvent.PROGRESS ,
ProgressEvent.SOCKET_DATA , ProgressEvent.STANDARD_ERROR_DATA , ProgressEvent.STANDARD_INPUT_PROGRESS , and ProgressEvent.STANDARD_OUTPUT_DATA .
|
|
bubbles:Boolean (default = false ) — Determines whether the Event object participates in the bubbling stage of the event flow.
|
|
cancelable:Boolean (default = false ) — Determines whether the Event object can be canceled.
|
|
bytesLoaded:Number (default = 0 ) — The number of items or bytes loaded at the time the listener processes the event.
|
|
bytesTotal:Number (default = 0 ) — The total number of items or bytes that will be loaded if the loading process succeeds.
|
clone | () | method |
public override function clone():Event
Language version: | ActionScript 3.0 |
Runtime version: |
Creates a copy of the ProgressEvent object and sets each property's value to match that of the original.
ReturnsEvent —
A new ProgressEvent object with property values that match those of the original.
|
toString | () | method |
public override function toString():String
Language version: | ActionScript 3.0 |
Runtime version: |
Returns a string that contains all the properties of the ProgressEvent object. The string is in the following format:
[ProgressEvent type=value bubbles=value cancelable=value bytesLoaded=value bytesTotal=value]
String —
A string that contains all the properties of the ProgressEvent object.
|
PROGRESS | constant |
public static const PROGRESS:String = "progress"
Language version: | ActionScript 3.0 |
Runtime version: |
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. |
See also
SOCKET_DATA | constant |
public static const SOCKET_DATA:String = "socketData"
Language version: | ActionScript 3.0 |
Runtime version: |
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. |
See also
STANDARD_ERROR_DATA | constant |
public static const STANDARD_ERROR_DATA:String = "standardErrorData"
Language version: | ActionScript 3.0 |
Runtime version: | AIR 2 |
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 error data buffered by the NativeProcessObject.error due to this event. |
bytesTotal | 0; this property is not used by standardErrorData event objects. |
target | The NativeProcess object reporting error data. |
See also
STANDARD_INPUT_PROGRESS | constant |
public static const STANDARD_INPUT_PROGRESS:String = "standardInputProgress"
Language version: | ActionScript 3.0 |
Runtime version: | AIR 2 |
Defines the value of the type
property of a standardInputProgress
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 error data buffered by the NativeProcessObject.error due to this event. |
bytesTotal | 0; this property is not used by standardInputProgress event objects. |
target | The NativeProcess object reporting error data. |
See also
STANDARD_OUTPUT_DATA | constant |
public static const STANDARD_OUTPUT_DATA:String = "standardOutputData"
Language version: | ActionScript 3.0 |
Runtime version: | AIR 2 |
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.output due to this event. |
bytesTotal | 0; this property is not used by standardOutputData event objects. |
target | The NativeProcess object reporting output data. |
See also
ProgressEventExample
class to illustrate how various
event listeners are used when a file is being downloaded. The example carries out the following tasks:
downloadURL
and fileName
are created, which indicate the location
and name of the download file.ProgressEventExample
constructor, a new FileReference object named file
is
created and then passed to the configureListeners()
method.downloadURL
and fileName
properties are then passed to file.download()
,
which prompts for the location to download the file.configureListeners()
method adds seven event listeners and their associated subscriber
methods:
cancel
/cancelHandler()
is dispatched if the file download is canceled.complete
/complereHandler()
is dispatched when the file download process is
finished.ioError
/ioErrorHandler()
is dispatched if the download file is unavailable or
inaccessible.open
/openHandler()
is dispatched when the download operation has started.progress
/progressHandler()
is dispatched when the download process begins and again
when it ends.securityError
/securityErrorHandler
is dispatched if the local playback
security setting does not match the type of data access for the download file (local versus network);
see the notes below.select
/selectHandler()
is dispatched when the download object is selected.Notes:
package { import flash.display.Sprite; import flash.events.*; import flash.net.FileReference; import flash.net.URLRequest; public class ProgressEventExample extends Sprite { private var downloadURL:String = "http://www.[yourDomain].com/SomeFile.pdf"; private var fileName:String = "SomeFile.pdf"; private var file:FileReference; public function ProgressEventExample() { var request:URLRequest = new URLRequest(downloadURL); file = new FileReference(); configureListeners(file); file.download(request, fileName); } private function configureListeners(dispatcher:IEventDispatcher):void { dispatcher.addEventListener(Event.CANCEL, cancelHandler); dispatcher.addEventListener(Event.COMPLETE, completeHandler); dispatcher.addEventListener(IOErrorEvent.IO_ERROR, ioErrorHandler); dispatcher.addEventListener(Event.OPEN, openHandler); dispatcher.addEventListener(ProgressEvent.PROGRESS, progressHandler); dispatcher.addEventListener(SecurityErrorEvent.SECURITY_ERROR, securityErrorHandler); dispatcher.addEventListener(Event.SELECT, selectHandler); } private function cancelHandler(event:Event):void { trace("cancelHandler: " + event); } private function completeHandler(event:Event):void { trace("completeHandler: " + event); } private function ioErrorHandler(event:IOErrorEvent):void { trace("ioErrorHandler: " + event); } private function openHandler(event:Event):void { trace("openHandler: " + event); } private function progressHandler(event:ProgressEvent):void { var file:FileReference = FileReference(event.target); trace("progressHandler: name=" + file.name + " bytesLoaded=" + event.bytesLoaded + " bytesTotal=" + event.bytesTotal); } private function securityErrorHandler(event:SecurityErrorEvent):void { trace("securityErrorHandler: " + event); } private function selectHandler(event:Event):void { var file:FileReference = FileReference(event.target); trace("selectHandler: name=" + file.name + " URL=" + downloadURL); } } }