org.wisepersist.gwt.uploader.client

Class File

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

org.wisepersist.gwt.uploader.client.File

public final class File
extends com.google.gwt.core.client.JavaScriptObject

A logical bean that provides access to the details of a file being uploaded. An instance of this object is available on all uploader related event handlers, such as the UploadProgressHandler.

Note that, by default, the SWFUpload "Speed" plugin is enabled, providing access to additional metrics on this object such as getAverageSpeed(), getPercentUploaded(), etc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	File.Status An enumeration of reported file status types, which can be determined during any of the uploader events, such as UploadEvent.getFile().

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	File() Instances of the File object can not be created directly, but should instead be obtained via an event handler.

Method Summary

Modifier and Type	Method and Description
double	getAverageSpeed() Return a floating point number indicating the overall average uploader speed, bytes per second, in bits per second.
protected java.util.Date	getCreationDate() Returns the date the file was created, as reported by the client machine.
double	getCurrentSpeed() Return a floating point number indicating the current uploader speed of the file, in bits per second.
java.lang.String	getId() Return the unique id of the file instance as it is being maintained within the Uploader component file queue.
int	getIndex() Return the index of the file within the queue of files being uploaded by the Uploader component.
java.util.Date	getModificationDate() Return the date the file was last modified, as reported by the client machine, or null if the browser or OS did not make the file's modification date available.
double	getMovingAverageSpeed() Return a floating point number indicating the uploader speed averaged over the last several measurements, in bits per second.
java.lang.String	getName() Return the original name of the file being uploaded.
double	getPercentUploaded() Return a floating point number indicating the percentage of the file uploaded (0 to 100).
long	getSize() Return the original size of the file being uploaded (in bytes).
double	getSizeUploaded() Return a floating point number indicating the size uploaded so far, in bytes.
File.Status	getStatus() Get the file's current status (see File.Status enumeration for possible values).
double	getTimeElapsed() Return a floating point number indicating the number of seconds passed so far for this uploader.
double	getTimeRemaining() Return a floating point number indicating the estimated remaining uploader time, in seconds.
java.lang.String	getType() Return the mime type of the file being uploaded.

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

File

protected File()

Instances of the File object can not be created directly, but should instead be obtained via an event handler. E.g. UploadEvent.getFile().

Method Detail

getId

public java.lang.String getId()

Return the unique id of the file instance as it is being maintained within the Uploader component file queue.

Returns:

String

getIndex

public int getIndex()

Return the index of the file within the queue of files being uploaded by the Uploader component.

Returns:

int

getName

public java.lang.String getName()

Return the original name of the file being uploaded.

Returns:

String

getSize

public long getSize()

Return the original size of the file being uploaded (in bytes).

Returns:

long

getType

public java.lang.String getType()

Return the mime type of the file being uploaded.

Returns:

String

getCreationDate

protected java.util.Date getCreationDate()

Returns the date the file was created, as reported by the client machine. This method is purposefully hidden as it is available when the SWFUpload/Flash component is used, but is not available when the XMLHttpRequest Level 2 approach is used (which is the default). Please use the getModificationDate() method instead (which is available in both cases). Reference: http://www.w3.org/TR/file-uploader/#dfn-file

Returns:

Date

getModificationDate

public java.util.Date getModificationDate()

Return the date the file was last modified, as reported by the client machine, or null if the browser or OS did not make the file's modification date available.

Returns:

Date

getStatus

public File.Status getStatus()

Get the file's current status (see File.Status enumeration for possible values).

Returns:

Status

getCurrentSpeed

public double getCurrentSpeed()

Return a floating point number indicating the current uploader speed of the file, in bits per second.

Returns:

double

getAverageSpeed

public double getAverageSpeed()

Return a floating point number indicating the overall average uploader speed, bytes per second, in bits per second.

Returns:

double

getMovingAverageSpeed

public double getMovingAverageSpeed()

Return a floating point number indicating the uploader speed averaged over the last several measurements, in bits per second.

Returns:

double

getTimeRemaining

public double getTimeRemaining()

Return a floating point number indicating the estimated remaining uploader time, in seconds.

Returns:

double

getTimeElapsed

public double getTimeElapsed()

Return a floating point number indicating the number of seconds passed so far for this uploader.

Returns:

double

getPercentUploaded

public double getPercentUploaded()

Return a floating point number indicating the percentage of the file uploaded (0 to 100).

Returns:

double

getSizeUploaded

public double getSizeUploaded()

Return a floating point number indicating the size uploaded so far, in bytes.

Returns:

double