akasha

Class ProgressEvent

java.lang.Object

akasha.Event

akasha.ProgressEvent

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="ProgressEvent")
public class ProgressEvent
extends Event

The ProgressEvent interface represents events measuring progress of an underlying process, like an HTTP request (for an XMLHttpRequest, or the loading of the underlying resource of an <img>, <audio>, <video>, <style> or <link>).

See Also:

ProgressEvent - MDN, ProgressEvent - XMLHttpRequest

Field Summary

Fields inherited from class akasha.Event

AT_TARGET, BUBBLING_PHASE, cancelBubble, CAPTURING_PHASE, NONE, returnValue

Constructor Summary

Constructors

Constructor and Description
ProgressEvent(java.lang.String type) The ProgressEvent() constructor returns a newly created ProgressEvent, representing the current completion of a long process.
ProgressEvent(java.lang.String type, ProgressEventInit eventInitDict) The ProgressEvent() constructor returns a newly created ProgressEvent, representing the current completion of a long process.

Method Summary

Modifier and Type	Method and Description
boolean	lengthComputable() The ProgressEvent.lengthComputable read-only property is a Boolean flag indicating if the resource concerned by the ProgressEvent has a length that can be calculated.
int	loaded() The ProgressEvent.loaded read-only property is an integer representing the amount of work already performed by the underlying process.
int	total() The ProgressEvent.total read-only property is an unsigned 64-bit integer value indicating the total size of the data being processed or transmitted.

Methods inherited from class akasha.Event

bubbles, cancelable, composed, composedPath, currentTarget, defaultPrevented, eventPhase, initEvent, initEvent, initEvent, isTrusted, preventDefault, srcElement, stopImmediatePropagation, stopPropagation, target, timeStamp, type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProgressEvent

public ProgressEvent(@Nonnull
                     java.lang.String type,
                     @Nonnull
                     ProgressEventInit eventInitDict)

The ProgressEvent() constructor returns a newly created ProgressEvent, representing the current completion of a long process.

See Also:

ProgressEvent.ProgressEvent - MDN, ProgressEvent() - XMLHttpRequest

ProgressEvent

public ProgressEvent(@Nonnull
                     java.lang.String type)

The ProgressEvent() constructor returns a newly created ProgressEvent, representing the current completion of a long process.

See Also:

ProgressEvent.ProgressEvent - MDN, ProgressEvent() - XMLHttpRequest

Method Detail

lengthComputable

@JsProperty(name="lengthComputable")
public boolean lengthComputable()

The ProgressEvent.lengthComputable read-only property is a Boolean flag indicating if the resource concerned by the ProgressEvent has a length that can be calculated. If not, the ProgressEvent.total property has no significant value.

See Also:

ProgressEvent.lengthComputable - MDN, ProgressEvent.lengthComputable - XMLHttpRequest

loaded

@JsProperty(name="loaded")
public int loaded()

The ProgressEvent.loaded read-only property is an integer representing the amount of work already performed by the underlying process. The ratio of work done can be calculated with the property and ProgressEvent.total. When downloading a resource using HTTP, this only represent the part of the content itself, not headers and other overhead.

See Also:

ProgressEvent.loaded - MDN, ProgressEvent.loaded - XMLHttpRequest

total

@JsProperty(name="total")
public int total()

The ProgressEvent.total read-only property is an unsigned 64-bit integer value indicating the total size of the data being processed or transmitted. In the case of an HTTP transmission, this is the size of the body of the message (the Content-Length), and does not include headers and other overhead.

See Also:

ProgressEvent.total - MDN, ProgressEvent.lengthComputable - XMLHttpRequest