elemental.events

Interface ProgressEvent

All Superinterfaces:

Event

All Known Subinterfaces:

XMLHttpRequestProgressEvent

All Known Implementing Classes:

JsProgressEvent, JsXMLHttpRequestProgressEvent

public interface ProgressEvent
extends Event

dom/interfaces/events/nsIDOMProgressEvent.idlScriptable

This interface represents the events sent with progress information while uploading data using the XMLHttpRequest object.

1.0

11.0

Introduced

Gecko 1.9.1

Inherits from: nsIDOMEvent Last changed in Gecko 1.9.1 (Firefox 3.5 / Thunderbird 3.0 / SeaMonkey 2.0)

The nsIDOMProgressEvent is used in the media elements (<video> and <audio> ) to inform interested code of the progress of the media download. This implementation is a placeholder until the specification is complete, and is compatible with the WebKit ProgressEvent.

Field Summary

Fields inherited from interface elemental.events.Event

AT_TARGET, BEFORECOPY, BEFORECUT, BEFOREPASTE, BLUR, BUBBLING_PHASE, CAPTURING_PHASE, CHANGE, CLICK, CONTEXTMENU, COPY, CUT, DBLCLICK, DRAG, DRAGEND, DRAGENTER, DRAGLEAVE, DRAGOVER, DRAGSTART, DROP, ERROR, FOCUS, FOCUSIN, FOCUSOUT, INPUT, INVALID, KEYDOWN, KEYPRESS, KEYUP, MOUSEDOWN, MOUSEMOVE, MOUSEOUT, MOUSEOVER, MOUSEUP, MOUSEWHEEL, NONE, PASTE, RESIZE, SCROLL, SELECTSTART, SUBMIT, TOUCHCANCEL, TOUCHEND, TOUCHMOVE, TOUCHSTART, WEBKITANIMATIONEND, WEBKITANIMATIONITERATION, WEBKITANIMATIONSTART, WEBKITTRANSITIONEND

Method Summary

Modifier and Type	Method and Description
double	getLoaded() The number of bytes transferred since the beginning of the operation.
double	getTotal() The total number of bytes of content that will be transferred during the operation.
boolean	isLengthComputable() Specifies whether or not the total size of the transfer is known.

Methods inherited from interface elemental.events.Event

getClipboardData, getCurrentTarget, getEventPhase, getSrcElement, getTarget, getTimeStamp, getType, initEvent, isBubbles, isCancelable, isCancelBubble, isDefaultPrevented, isReturnValue, preventDefault, setCancelBubble, setReturnValue, stopImmediatePropagation, stopPropagation

Method Detail

isLengthComputable

boolean isLengthComputable()

Specifies whether or not the total size of the transfer is known. Read only.

getLoaded

double getLoaded()

The number of bytes transferred since the beginning of the operation. This doesn't include headers and other overhead, but only the content itself. Read only.

getTotal

double getTotal()

The total number of bytes of content that will be transferred during the operation. If the total size is unknown, this value is zero. Read only.