org.wisepersist.gwt.uploader.client.events

Class UploadProgressEvent

java.lang.Object

org.wisepersist.gwt.uploader.client.events.UploadEvent

org.wisepersist.gwt.uploader.client.events.UploadProgressEvent

public class UploadProgressEvent
extends UploadEvent

Provides access to the raw information provided by Uploader when an 'uploader progress' event occurs. This class should not be instantiated directly, but instead you should create a UploadProgressHandler and register it via the .Uploader#setUploadProgressHandler(UploadProgressHandler) method in order to access progress events.

Note that the 'uploadProgress' event is fired periodically by the Flash Control. This event is useful for providing UI updates on the page.

Note: The Linux Flash Player fires a single uploadProgress event after the entire file has been uploaded. This is a bug in the Linux Flash Player that we cannot work around.

Constructor Summary

Constructors

Constructor and Description
UploadProgressEvent(File file, long bytesComplete, long bytesTotal) This constructor is intended for internal use only.

Method Summary

Modifier and Type	Method and Description
long	getBytesComplete() Return the bytes transferred since the uploader process began.
long	getBytesTotal() Return the total size of the file being uploaded.

Methods inherited from class org.wisepersist.gwt.uploader.client.events.UploadEvent

getFile

Methods inherited from class java.lang.Object

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

Constructor Detail

UploadProgressEvent

public UploadProgressEvent(File file,
                           long bytesComplete,
                           long bytesTotal)

This constructor is intended for internal use only. You should not create progress events directly, but instead should register a UploadProgressHandler.

Parameters:

file - The native javascript object containing the details of the file being uploaded.

bytesComplete - Bytes transferred since the uploader process began.

bytesTotal - Total size of the file being uploaded.

Method Detail

getBytesComplete

public long getBytesComplete()

Return the bytes transferred since the uploader process began.

Returns:

double

getBytesTotal

public long getBytesTotal()

Return the total size of the file being uploaded.

Returns:

long