Packageflash.events
Classpublic class OutputProgressEvent
InheritanceOutputProgressEvent Inheritance Event Inheritance Object

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.

See also

flash.filesystem.FileStream

Public Properties
 PropertyDefined by
 Inheritedbubbles : Boolean
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
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
The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : uint
The current phase in the event flow.
Event
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 Inheritedtarget : Object
The event target.
Event
 Inheritedtype : String
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
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 your custom Event class.
Event
 Inherited
isDefaultPrevented():Boolean
Checks whether preventDefault() has been called on the event.
Event
 Inherited
preventDefault():void
Cancels an event's default behavior if that behavior can be canceled.
Event
 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
  
toString():String
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
 InheritedACTIVATE : String = "activate"
[static] Defines the value of the type property of an activate event object.
Event
 InheritedADDED : String = "added"
[static] Defines the value of the type property of an added event object.
Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] Defines the value of the type property of an addedToStage event object.
Event
 InheritedCANCEL : String = "cancel"
[static] Defines the value of the type property of a cancel event object.
Event
 InheritedCHANGE : String = "change"
[static] Defines the value of the type property of a change event object.
Event
 InheritedCLOSE : String = "close"
[static] Defines the value of the type property of a close event object.
Event
 InheritedCLOSING : String = "closing"
[static] Defines the value of the type property of a closing event object.
Event
 InheritedCOMPLETE : String = "complete"
[static] Defines the value of the type property of a complete event object.
Event
 InheritedCONNECT : String = "connect"
[static] Defines the value of the type property of a connect event object.
Event
 InheritedDEACTIVATE : String = "deactivate"
[static] Defines the value of the type property of a deactivate event object.
Event
 InheritedDOM_INITIALIZE : String = "domInitialize"
[static] Defines the value of the type property of a domInitialize event object.
Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] Defines the value of the type property of an enterFrame event object.
Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] Defines the value of the type property of a fullScreen event object.
Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] Defines the value of the type property of an htmlBoundsChange event object.
Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] Defines the value of the type property of an htmlRender event object.
Event
 InheritedID3 : String = "id3"
[static] Defines the value of the type property of an id3 event object.
Event
 InheritedINIT : String = "init"
[static] Defines the value of the type property of an init event object.
Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] Defines the value of the type property of a locationChange event object.
Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] Defines the value of the type property of a mouseLeave event object.
Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] Defines the value of the type property of a networkChange event object.
Event
 InheritedOPEN : String = "open"
[static] 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
 InheritedREMOVED : String = "removed"
[static] Defines the value of the type property of a removed event object.
Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] Defines the value of the type property of a removedFromStage event object.
Event
 InheritedRENDER : String = "render"
[static] Defines the value of the type property of a render event object.
Event
 InheritedRESIZE : String = "resize"
[static] Defines the value of the type property of a resize event object.
Event
 InheritedSCROLL : String = "scroll"
[static] Defines the value of the type property of a scroll event object.
Event
 InheritedSELECT : String = "select"
[static] Defines the value of the type property of a select event object.
Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] Defines the value of the type property of a soundComplete event object.
Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] Defines the value of the type property of a tabChildrenChange event object.
Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] Defines the value of the type property of a tabEnabledChange event object.
Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] Defines the value of the type property of a tabIndexChange event object.
Event
 InheritedUNLOAD : String = "unload"
[static] Defines the value of the type property of an unload event object.
Event
Property detail
bytesPendingproperty
bytesPending:Number  [read-write]

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
bytesTotalproperty 
bytesTotal:Number  [read-write]

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)

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
public override function clone():Event

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 
public override function toString():String

Returns a string that contains all the properties of the OutputProgressEvent object. The string is in the following format:

[ProgressEvent 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_PROGRESSconstant
public static const OUTPUT_PROGRESS:String = "outputProgress"

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.

See also

flash.display.LoaderInfo.progress
flash.media.Sound.progress
flash.net.FileReference.progress
flash.net.URLLoader.progress
flash.net.URLStream.progress



© 2004-2006 Adobe Systems Incorporated. All rights reserved.
Fri Mar 16 2007, 3:19 PM GMT-07:00

 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/apollo/1.0/aslr/flash/events/OutputProgressEvent.html