(Beta)
| Package | flash.events |
| Class | public class OutputProgressEvent |
| Inheritance | OutputProgressEvent  Event Object |
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0 |
OutputProgressEvent.OUTPUT_PROGRESS.
Related API Elements
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | bubbles : Boolean [read-only]
Indicates whether an event is a bubbling event. | Event | |
| bytesPending : Number
The 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 | |
| target : Object [read-only]
The event target. | Event | |
| type : String [read-only]
The type of event. | Event | |
Public Methods
| 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 | ||
[override]
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 the string representation of this object, formatted according to locale-specific conventions. | Object | |
[override]
Returns a string that contains all the properties of the OutputProgressEvent object. | OutputProgressEvent | ||
|
Returns the primitive value of the specified object. | Object | |
Public Constants
| Constant | Defined By | ||
|---|---|---|---|
| OUTPUT_PROGRESS : String = "outputProgress" [static]
Defines the value of the type property of an outputProgress event object. | OutputProgressEvent | ||
Property Detail
bytesPending | property |
bytesTotal | property |
Constructor Detail
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) |
Method Detail
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.
|
Constant Detail
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. |
Related API Elements
Wed Nov 21 2018, 06:34 AM -08:00