| Package | flash.events |
| Class | public class OutputProgressEvent |
| Inheritance | OutputProgressEvent  Event Object |
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0 |
OutputProgressEvent.OUTPUT_PROGRESS
.
See also
| Property | Defined By | ||
|---|---|---|---|
 | bubbles : Boolean [read-only] Indicates whether an event is a bubbling event. | Event | |
 bytesPending : NumberThe number of bytes not yet written when the listener processes the event. | OutputProgressEvent | ||
| bytesTotal : Number The total number of bytes written so far, plus the number of pending bytes to be written. | OutputProgressEvent | ||
| 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 | ||
|---|---|---|---|
| OutputProgressEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bytesPending:Number = 0, bytesTotal:Number = 0) Creates an Event object that contains information about output progress events. | OutputProgressEvent | ||
Creates a copy of the OutputProgressEvent object and sets each property's value to match that of the original. | OutputProgressEvent | ||
| 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 a string that contains all the properties of the OutputProgressEvent object. | OutputProgressEvent | ||
| 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 | |
| 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 | |
| CLEAR : String = "clear" [static] The Event.CLEAR constant efines 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 | |
| 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 | |
| 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 | |
| OUTPUT_PROGRESS : String = "outputProgress" [static] Defines the value of the type property of an outputProgress event object. | OutputProgressEvent | ||
| PASTE : String = "paste" [static] The Event.PASTE constant defines the value of the type property of a paste event object. | Event | |
| 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 | |
| SOUND_COMPLETE : String = "soundComplete" [static] The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete 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 | |
| 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 | |
| bytesPending | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesbytesPending:Number [read-write] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0 |
The number of bytes not yet written when the listener processes the event.
public function get bytesPending():Number public function set bytesPending(value:Number):void| bytesTotal | property |
bytesTotal:Number [read-write] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0 |
The total number of bytes written so far, plus the number of pending bytes to be written.
public function get bytesTotal():Number public function set bytesTotal(value:Number):void| OutputProgressEvent | () | Constructor |
public function OutputProgressEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bytesPending:Number = 0, bytesTotal:Number = 0)| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0 |
Creates an Event object that contains information about output progress events. Event objects are passed as parameters to event listeners.
Parameterstype:String —
The type of the event. There is only one type of error event:
OutputProgressEvent.OUTPUT_PROGRESS
.
| |
bubbles:Boolean (default = false) | |
cancelable:Boolean (default = false) | |
bytesPending:Number (default = 0) | |
bytesTotal:Number (default = 0) |
| clone | () | method |
override public function clone():Event| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0 |
Creates a copy of the OutputProgressEvent object and sets each property's value to match that of the original.
ReturnsEvent — A new OutputProgressEvent object with property values that match those of the original. |
| toString | () | method |
override public function toString():String| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0 |
Returns a string that contains all the properties of the OutputProgressEvent object. The string is in the following format:
[OutputProgressEvent type=
value
bubbles=
value
cancelable=
value
eventPhase=
value
bytesPending=
value
bytesTotal=
value
]
String — A string that contains all the properties of the OutputProgressEvent object. |
| OUTPUT_PROGRESS | Constant |
public static const OUTPUT_PROGRESS:String = "outputProgress"| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0 |
Defines the value of the
type
property of an
outputProgress
event object.
This event has the following properties:
| Property | Value |
|---|---|
bubbles
|
false
|
bytesPending
| The number of bytes remaining to be written at the time the listener processes the event. |
bytesTotal
| The total number of bytes that ultimately will be written if the write 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 FileStream object reporting progress. |
See also