ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
flash.events 

OutputProgressEvent  - AS3

Packageflash.events
Classpublic class OutputProgressEvent
InheritanceOutputProgressEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

A FileStream object dispatches OutputProgressEvent objects as pending asynchronous file write operations are performed. There is one type of output progress event: OutputProgressEvent.OUTPUT_PROGRESS.

Related API Elements

flash.filesystem.FileStream

Public Properties
 PropertyDefined By
 Inheritedbubbles : 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
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined 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
  
    clone():Event
[override] Creates a copy of the OutputProgressEvent object and sets each property's value to match that of the original.
OutputProgressEvent
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isDefaultPrevented():Boolean
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
preventDefault():void
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
stopImmediatePropagation():void
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
stopPropagation():void
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
  
    toString():String
[override] Returns a string that contains all the properties of the OutputProgressEvent object.
OutputProgressEvent
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
      OUTPUT_PROGRESS : String = "outputProgress"
[static] Defines the value of the type property of an outputProgress event object.
OutputProgressEvent
Property Detail
    

bytesPending

property
bytesPending:Number

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

The number of bytes not yet written when the listener processes the event.



Implementation
    public function get bytesPending():Number
    public function set bytesPending(value:Number):void
    

bytesTotal

property 
bytesTotal:Number

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.



Implementation
    public function get bytesTotal():Number
    public function set bytesTotal(value:Number):void
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.

Parameters
type:String — The type of the event. There is only one type of error event: OutputProgressEvent.OUTPUT_PROGRESS.
 
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.
 
bytesPending:Number (default = 0) — The number of bytes not yet written.
 
bytesTotal:Number (default = 0) — The total number of bytes written or with pending writes.
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.

Returns
Event — 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]

Returns
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:

PropertyValue
bubblesfalse
bytesPendingThe number of bytes remaining to be written at the time the listener processes the event.
bytesTotalThe total number of bytes that ultimately will be written if the write process succeeds.
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe FileStream object reporting progress.

Related API Elements

flash.filesystem.FileStream



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy