qnx.events.WebDownloadProgressEvent

WebDownloadProgressEvent

Properties | Methods | Constants


Packageqnx.events
Classpublic class WebDownloadProgressEvent
InheritanceWebDownloadProgressEvent Inheritance flash.events.Event

A QNXStageWebView object dispatches a WebDownloadProgressEvent object when the download progress of a file has changed.

There is only one type of WebDownloadProgressEvent:

  • WebDownloadProgressEvent.DOWNLOAD_PROGRESS: dispatched when download progress has changed. Cannot be cancelled.


Class information:
PlayBook Tablet OS Version:   1.0.6

See also

QNXStageWebView



Public Properties

 PropertyDefined By
  downloadedBytes : uint
The number of bytes that have been downloaded.
WebDownloadProgressEvent
  downloadId : uint
The identifier of the download.
WebDownloadProgressEvent
  totalBytes : uint
The total number of bytes to be downloaded.
WebDownloadProgressEvent

Public Methods

 MethodDefined By
  
WebDownloadProgressEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, downloadId:uint = 0, downloadedBytes:uint = 0, totalBytes:uint = 0)
Creates a WebDownloadProgressEvent object.
WebDownloadProgressEvent
  
clone():Event
[override] Duplicates an instance of an Event subclass.
WebDownloadProgressEvent
  
toString():String
[override] Returns a string that contains all the properties of the WebDownloadProgressEvent object.
WebDownloadProgressEvent

Public Constants

 ConstantDefined By
  DOWNLOAD_PROGRESS : String = downloadProgress
[static] Signals that the download has started.
WebDownloadProgressEvent

Property Detail

downloadedBytes


downloadedBytes:uint

The number of bytes that have been downloaded.


Implementation

public function get downloadedBytes():uint
public function set downloadedBytes(value:uint):void

downloadId


downloadId:uint

The identifier of the download. Used to refer to this download in future events and in API calls.


Implementation

public function get downloadId():uint
public function set downloadId(value:uint):void

totalBytes


totalBytes:uint

The total number of bytes to be downloaded.


Implementation

public function get totalBytes():uint
public function set totalBytes(value:uint):void

Constructor Detail

WebDownloadProgressEvent()


public function WebDownloadProgressEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, downloadId:uint = 0, downloadedBytes:uint = 0, totalBytes:uint = 0)

Creates a WebDownloadProgressEvent object.

Parameters

type:String
bubbles:Boolean (default = false)
cancelable:Boolean (default = false)
downloadId:uint (default = 0)
downloadedBytes:uint (default = 0)
totalBytes:uint (default = 0)

Method Detail

clone()


override public function clone():Event

Duplicates an instance of an Event subclass.

Returns a new Event object that is a copy of the original instance of the Event object. You do not normally call clone(); the EventDispatcher class calls it automatically when you redispatch an event—that is, when you call dispatchEvent(event) from a handler that is handling event.

The new Event object includes all the properties of the original.

When creating your own custom Event class, you must override the inherited Event.clone() method in order for it to duplicate the properties of your custom class. If you do not set all the properties that you add in your event subclass, those properties will not have the correct values when listeners handle the redispatched event.

Returns

Event

toString()


override public function toString():String

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

[WebDownloadProgressEvent type=value bubbles=value cancelable=value eventPhase=value downloadId=value downloadedBytes=value totalBytes=value

Returns

String

Constant Detail

DOWNLOAD_PROGRESS


public static const DOWNLOAD_PROGRESS:String = downloadProgress

Signals that the download has started.