Package | flash.events |
Class | public class ProgressEvent |
Inheritance | ProgressEvent ![]() ![]() |
Language Version: | ActionScript 3.0 |
Runtime Versions: | 1.0, 9 |
ProgressEvent.PROGRESS
and
ProgressEvent.SOCKET_DATA
.
See also
Property | Defined By | ||
---|---|---|---|
![]() | bubbles : Boolean [read-only] Indicates whether an event is a bubbling event. | Event | |
bytesLoaded : uint The number of items or bytes loaded when the listener processes the event. | ProgressEvent | ||
bytesTotal : uint The total number of items or bytes that will be loaded if the loading process succeeds. | ProgressEvent | ||
![]() | cancelable : Boolean [read-only] 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 [read-only] The object that is actively processing the Event object with an event listener. | Event | |
![]() | eventPhase : uint [read-only] 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 [read-only] The event target. | Event | |
![]() | type : String [read-only] The type of event. | Event |
Method | Defined By | ||
---|---|---|---|
ProgressEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bytesLoaded:uint = 0, bytesTotal:uint = 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 your custom Event class. | Event | |
![]() | Indicates whether an object has a specified property defined. | Object | |
![]() | Checks whether preventDefault() 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 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] Defines the value of the type property of an activate event object. | Event | |
![]() | ADDED : String = "added" [static] Defines the value of the type property of an added event object. | Event | |
![]() | ADDED_TO_STAGE : String = "addedToStage" [static] Defines the value of the type property of an addedToStage event object. | Event | |
![]() | CANCEL : String = "cancel" [static] Defines the value of the type property of a cancel event object. | Event | |
![]() | CHANGE : String = "change" [static] Defines the value of the type property of a change event object. | Event | |
![]() | CLEAR : String = "clear" [static] Defines the value of the type property of a clear event object. | Event | |
![]() | CLOSE : String = "close" [static] Defines the value of the type property of a close event object. | Event | |
![]() | COMPLETE : String = "complete" [static] Defines the value of the type property of a complete event object. | Event | |
![]() | CONNECT : String = "connect" [static] Defines the value of the type property of a connect 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] Defines the value of the type property of a deactivate event object. | Event | |
![]() | ENTER_FRAME : String = "enterFrame" [static] Defines the value of the type property of an enterFrame event object. | Event | |
![]() | EXIT_FRAME : String = "exitFrame" [static] Defines the value of the type property of an exitFrame event object. | Event | |
![]() | FRAME_CONSTRUCTED : String = "frameConstructed" [static] Defines the value of the type property of an frameConstructed event object. | Event | |
![]() | FULLSCREEN : String = "fullScreen" [static] The Event.FULLSCREEN constant defines the value of the type property of a fullScreen event object. | Event | |
![]() | ID3 : String = "id3" [static] Defines the value of the type property of an id3 event object. | Event | |
![]() | INIT : String = "init" [static] Defines the value of the type property of an init event object. | Event | |
![]() | MOUSE_LEAVE : String = "mouseLeave" [static] Defines the value of the type property of a mouseLeave event object. | Event | |
![]() | OPEN : String = "open" [static] Defines the value of the type property of an open event object. | Event | |
![]() | PASTE : String = "paste" [static] Defines the value of the type property of a paste event object. | Event | |
PROGRESS : String = "progress" [static] Defines the value of the type property of a progress event object. | ProgressEvent | ||
![]() | REMOVED : String = "removed" [static] Defines the value of the type property of a removed event object. | Event | |
![]() | REMOVED_FROM_STAGE : String = "removedFromStage" [static] Defines the value of the type property of a removedFromStage event object. | Event | |
![]() | RENDER : String = "render" [static] Defines the value of the type property of a render event object. | Event | |
![]() | RESIZE : String = "resize" [static] Defines the value of the type property of a resize event object. | Event | |
![]() | SCROLL : String = "scroll" [static] Defines the value of the type property of a scroll event object. | Event | |
![]() | SELECT : String = "select" [static] Defines the value of the type property of a select event object. | Event | |
![]() | SELECT_ALL : String = "selectAll" [static] 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] Defines the value of the type property of a soundComplete event object. | Event | |
![]() | TAB_CHILDREN_CHANGE : String = "tabChildrenChange" [static] Defines the value of the type property of a tabChildrenChange event object. | Event | |
![]() | TAB_ENABLED_CHANGE : String = "tabEnabledChange" [static] Defines the value of the type property of a tabEnabledChange event object. | Event | |
![]() | TAB_INDEX_CHANGE : String = "tabIndexChange" [static] Defines the value of the type property of a tabIndexChange event object. | Event | |
![]() | UNLOAD : String = "unload" [static] Defines the value of the type property of an unload event object. | Event |
bytesLoaded | property |
bytesLoaded:uint
[read-write] Language Version: | ActionScript 3.0 |
Runtime Versions: | 1.0, 9 |
The number of items or bytes loaded when the listener processes the event.
public function get bytesLoaded():uint
public function set bytesLoaded(value:uint):void
bytesTotal | property |
bytesTotal:uint
[read-write] Language Version: | ActionScript 3.0 |
Runtime Versions: | 1.0, 9 |
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.
public function get bytesTotal():uint
public function set bytesTotal(value:uint):void
ProgressEvent | () | Constructor |
public function ProgressEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bytesLoaded:uint = 0, bytesTotal:uint = 0)
Language Version: | ActionScript 3.0 |
Runtime Versions: | 1.0, 9 |
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
and
ProgressEvent.SOCKET_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:uint (default = 0 ) — The number of items or bytes loaded at the time the listener processes the event. | |
bytesTotal:uint (default = 0 ) — The total number of items or bytes that will be loaded if the loading process succeeds. |
clone | () | method |
override public function clone():Event
Language Version: | ActionScript 3.0 |
Runtime Versions: | 1.0, 9 |
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 |
override public function toString():String
Language Version: | ActionScript 3.0 |
Runtime Versions: | 1.0, 9 |
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 Versions: | 1.0, 9 |
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 network object reporting progress. |
See also
SOCKET_DATA | Constant |
public static const SOCKET_DATA:String = "socketData"
Language Version: | ActionScript 3.0 |
Runtime Versions: | 1.0, 9 |
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 object reporting progress. |
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:
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); } } }