jfileupload.upload.client
Interface JSAPI

All Known Implementing Classes:

JSMApplet

public interface JSAPI

JavaScript API

Field Summary

static java.lang.String	APPLETINITIALIZED
static java.lang.String	CANCELTRANSFER
static java.lang.String	CHECKSUMCOMPLETED
static java.lang.String	CHECKSUMSTARTED
static java.lang.String	COMPRESSCANCELLED
static java.lang.String	COMPRESSCOMPLETED
static java.lang.String	COMPRESSFAILED
static java.lang.String	COMPRESSSTARTED
static java.lang.String	FILTERCOMPLETED
static java.lang.String	FILTERFAILED
static java.lang.String	FILTERSTARTED
static java.lang.String	FILTERSTARTING
static java.lang.String	GETEXTRAPARAMETER
static java.lang.String	GETREGULARPARAMETER
static java.lang.String	PUTEXTRAPARAMETER
static java.lang.String	PUTREGULARPARAMETER
static java.lang.String	READEXTRAPARAMETER
static java.lang.String	READREGULARPARAMETER
static java.lang.String	SETEXTRAPARAMETER
static java.lang.String	SETREGULARPARAMETER
static java.lang.String	SETTARGETCALLBACK
static java.lang.String	SPLITCOMPLETED
static java.lang.String	SPLITFAILED
static java.lang.String	SPLITSTARTED
static java.lang.String	SPLITTRIGERRED
static java.lang.String	TRANSFERCANCELLED
static java.lang.String	TRANSFERCOMPLETED
static java.lang.String	TRANSFERDATAREAD
static java.lang.String	TRANSFERDONE
static java.lang.String	TRANSFERFAILED
static java.lang.String	TRANSFERSTARTED
static java.lang.String	TRANSFERTRIGGERED

Method Summary

void	cancelTransfer() Cancel current transfer.
java.lang.String	getExtraParameter(java.lang.String name) Return extra parameter (valueX matching to paramX).
java.lang.String	getFilenames() Returns list of filenames to upload, uploaded or uploading.
java.lang.String	getRegularParameter(java.lang.String name) Return regular parameter.
java.lang.String	getState(java.lang.String filename) Return transfer status for a given filename.
void	JSAppletInitialized(java.lang.String signature) Callback when applet is loaded and initialized.
void	JSChecksumCompleted(java.lang.String checksum) Callback when checksum computation is completed.
void	JSChecksumStarted(java.lang.String type) Callback when checksum computation is starting.
void	JSCompressCancelled() Callback when compression is cancelled.
void	JSCompressCompleted(java.lang.String zipfilename, java.lang.String zipfilesize) Callback when compression completed.
void	JSCompressFailed(java.lang.String errormsg) Callback when compression failed.
void	JSCompressStarted(java.lang.String filename, java.lang.String filesize) Callback when compression starting.
void	JSDataRead(long bytes) Callback when data are read from file to transfer.
void	JSFilterCompleted(java.lang.String filteredfilename) Callback when filtering is completed
void	JSFilterFailed(java.lang.String errormsg) Callback when filtering failed.
void	JSFilterStarted(java.lang.String filename) Callback when filtering started.
void	JSFilterStarting(java.lang.String filename) Callback when filtering starting.
void	JSSplitCompleted(java.lang.String chunkid) Callback when a chunk is creation is completed.
void	JSSplitFailed(java.lang.String chunkid, java.lang.String errormsg) Callback when chunk creation failed.
void	JSSplitStarted(java.lang.String chunkid, java.lang.String chunksize) Callback when a chunk creation is started.
void	JSSplitTriggered(java.lang.String filename, java.lang.String size, java.lang.String chunksize, java.lang.String amount) Callback when chunking is initialized.
void	JSTransferCancelled() Callback when current transfer is cancelled.
void	JSTransferCompleted(java.lang.String filename) Callback when transfer is completed.
void	JSTransferDone(java.lang.String filelist) Callback when all files have been transfer.
void	JSTransferFailed(java.lang.String errormsg) Callback when current transfer failed.
void	JSTransferStarted(java.lang.String filename, java.lang.String filesize) Callback when transfer of file (or chunk) is starting.
void	JSTransferTriggered(java.lang.String filelist) Callback when transfer is initialized.
void	putExtraParameter(java.lang.String name, java.lang.String value) Same as setExtraParameter
void	putRegularParameter(java.lang.String name, java.lang.String value) Same as setRegularParameter
java.lang.String	readExtraParameter(java.lang.String name) Same as getExtraParameter
java.lang.String	readRegularParameter(java.lang.String name) Same as getRegularParameter
void	setExtraParameter(java.lang.String name, java.lang.String value) It only applies to paramX, valueX.
void	setRegularParameter(java.lang.String name, java.lang.String value) It only applies regular parameter.
void	setTargetCallback(java.lang.String name) Set target frame for JavaScript callback functions

Field Detail

APPLETINITIALIZED

static final java.lang.String APPLETINITIALIZED

See Also:

Constant Field Values

TRANSFERTRIGGERED

static final java.lang.String TRANSFERTRIGGERED

See Also:

Constant Field Values

TRANSFERSTARTED

static final java.lang.String TRANSFERSTARTED

See Also:

Constant Field Values

TRANSFERDATAREAD

static final java.lang.String TRANSFERDATAREAD

See Also:

Constant Field Values

TRANSFERCOMPLETED

static final java.lang.String TRANSFERCOMPLETED

See Also:

Constant Field Values

TRANSFERFAILED

static final java.lang.String TRANSFERFAILED

See Also:

Constant Field Values

TRANSFERCANCELLED

static final java.lang.String TRANSFERCANCELLED

See Also:

Constant Field Values

TRANSFERDONE

static final java.lang.String TRANSFERDONE

See Also:

Constant Field Values

COMPRESSSTARTED

static final java.lang.String COMPRESSSTARTED

See Also:

Constant Field Values

COMPRESSCOMPLETED

static final java.lang.String COMPRESSCOMPLETED

See Also:

Constant Field Values

COMPRESSCANCELLED

static final java.lang.String COMPRESSCANCELLED

See Also:

Constant Field Values

COMPRESSFAILED

static final java.lang.String COMPRESSFAILED

See Also:

Constant Field Values

SPLITTRIGERRED

static final java.lang.String SPLITTRIGERRED

See Also:

Constant Field Values

SPLITSTARTED

static final java.lang.String SPLITSTARTED

See Also:

Constant Field Values

SPLITCOMPLETED

static final java.lang.String SPLITCOMPLETED

See Also:

Constant Field Values

SPLITFAILED

static final java.lang.String SPLITFAILED

See Also:

Constant Field Values

FILTERSTARTING

static final java.lang.String FILTERSTARTING

See Also:

Constant Field Values

FILTERSTARTED

static final java.lang.String FILTERSTARTED

See Also:

Constant Field Values

FILTERCOMPLETED

static final java.lang.String FILTERCOMPLETED

See Also:

Constant Field Values

FILTERFAILED

static final java.lang.String FILTERFAILED

See Also:

Constant Field Values

CHECKSUMSTARTED

static final java.lang.String CHECKSUMSTARTED

See Also:

Constant Field Values

CHECKSUMCOMPLETED

static final java.lang.String CHECKSUMCOMPLETED

See Also:

Constant Field Values

GETEXTRAPARAMETER

static final java.lang.String GETEXTRAPARAMETER

See Also:

Constant Field Values

SETEXTRAPARAMETER

static final java.lang.String SETEXTRAPARAMETER

See Also:

Constant Field Values

GETREGULARPARAMETER

static final java.lang.String GETREGULARPARAMETER

See Also:

Constant Field Values

SETREGULARPARAMETER

static final java.lang.String SETREGULARPARAMETER

See Also:

Constant Field Values

SETTARGETCALLBACK

static final java.lang.String SETTARGETCALLBACK

See Also:

Constant Field Values

CANCELTRANSFER

static final java.lang.String CANCELTRANSFER

See Also:

Constant Field Values

READEXTRAPARAMETER

static final java.lang.String READEXTRAPARAMETER

See Also:

Constant Field Values

PUTEXTRAPARAMETER

static final java.lang.String PUTEXTRAPARAMETER

See Also:

Constant Field Values

READREGULARPARAMETER

static final java.lang.String READREGULARPARAMETER

See Also:

Constant Field Values

PUTREGULARPARAMETER

static final java.lang.String PUTREGULARPARAMETER

See Also:

Constant Field Values

Method Detail

setExtraParameter

void setExtraParameter(java.lang.String name,
                       java.lang.String value)

It only applies to paramX, valueX. "jsfullfilename" parameter is reserved. It could be called from JavaScript.

Parameters:

name - extra parameter name

value - extra parameter value

putExtraParameter

void putExtraParameter(java.lang.String name,
                       java.lang.String value)

Same as setExtraParameter

Parameters:

name -

value -

getExtraParameter

java.lang.String getExtraParameter(java.lang.String name)

Return extra parameter (valueX matching to paramX).

Parameters:

name -

Returns:

readExtraParameter

java.lang.String readExtraParameter(java.lang.String name)

Same as getExtraParameter

Parameters:

name -

Returns:

setRegularParameter

void setRegularParameter(java.lang.String name,
                         java.lang.String value)

It only applies regular parameter. It could be called from JavaScript.

Parameters:

name - property name

value - property value

putRegularParameter

void putRegularParameter(java.lang.String name,
                         java.lang.String value)

Same as setRegularParameter

Parameters:

name -

value -

getRegularParameter

java.lang.String getRegularParameter(java.lang.String name)

Return regular parameter.

Parameters:

name -

Returns:

readRegularParameter

java.lang.String readRegularParameter(java.lang.String name)

Same as getRegularParameter

Parameters:

name -

Returns:

setTargetCallback

void setTargetCallback(java.lang.String name)

Set target frame for JavaScript callback functions

Parameters:

name -

getState

java.lang.String getState(java.lang.String filename)

Return transfer status for a given filename. It could be called from JavaScript.

Parameters:

filename -

Returns:

status (WAITING, INPROGRESS, COMPLETED, FAILED, CANCELLED)

getFilenames

java.lang.String getFilenames()

Returns list of filenames to upload, uploaded or uploading. It could be called from from JavaScript.

Returns:

filenames separated by | char.

cancelTransfer

void cancelTransfer()

Cancel current transfer.

JSAppletInitialized

void JSAppletInitialized(java.lang.String signature)

Callback when applet is loaded and initialized.

Parameters:

signature - applet version

JSTransferTriggered

void JSTransferTriggered(java.lang.String filelist)

Callback when transfer is initialized.

Parameters:

filelist - list of filenames to transfer separated by | char

JSTransferStarted

void JSTransferStarted(java.lang.String filename,
                       java.lang.String filesize)

Callback when transfer of file (or chunk) is starting.

Parameters:

filename - filename to be transfered

filesize - size in bytes

JSDataRead

void JSDataRead(long bytes)

Callback when data are read from file to transfer. It is disabled by default. To enable it set "jsdatareadcallbackenabled" regular parameter to true.

Parameters:

bytes -

JSTransferCompleted

void JSTransferCompleted(java.lang.String filename)

Callback when transfer is completed.

Parameters:

filename - filename transfered.

JSTransferCancelled

void JSTransferCancelled()

Callback when current transfer is cancelled.

JSTransferFailed

void JSTransferFailed(java.lang.String errormsg)

Callback when current transfer failed.

Parameters:

errormsg -

JSTransferDone

void JSTransferDone(java.lang.String filelist)

Callback when all files have been transfer.

Parameters:

filelist - list of filename transfered separated by | char

JSCompressStarted

void JSCompressStarted(java.lang.String filename,
                       java.lang.String filesize)

Callback when compression starting.

Parameters:

filename -

filesize -

JSCompressCompleted

void JSCompressCompleted(java.lang.String zipfilename,
                         java.lang.String zipfilesize)

Callback when compression completed.

Parameters:

zipfilename -

zipfilesize -

JSCompressCancelled

void JSCompressCancelled()

Callback when compression is cancelled.

JSCompressFailed

void JSCompressFailed(java.lang.String errormsg)

Callback when compression failed.

Parameters:

errormsg -

JSSplitTriggered

void JSSplitTriggered(java.lang.String filename,
                      java.lang.String size,
                      java.lang.String chunksize,
                      java.lang.String amount)

Callback when chunking is initialized.

Parameters:

filename -

size -

chunksize -

amount -

JSSplitStarted

void JSSplitStarted(java.lang.String chunkid,
                    java.lang.String chunksize)

Callback when a chunk creation is started.

Parameters:

chunkid -

chunksize -

JSSplitCompleted

void JSSplitCompleted(java.lang.String chunkid)

Callback when a chunk is creation is completed.

Parameters:

chunkid -

JSSplitFailed

void JSSplitFailed(java.lang.String chunkid,
                   java.lang.String errormsg)

Callback when chunk creation failed.

Parameters:

chunkid -

errormsg -

JSFilterStarting

void JSFilterStarting(java.lang.String filename)

Callback when filtering starting.

Parameters:

filename -

JSFilterStarted

void JSFilterStarted(java.lang.String filename)

Callback when filtering started.

Parameters:

filename -

JSFilterCompleted

void JSFilterCompleted(java.lang.String filteredfilename)

Callback when filtering is completed

Parameters:

filteredfilename -

JSFilterFailed

void JSFilterFailed(java.lang.String errormsg)

Callback when filtering failed.

Parameters:

errormsg -

JSChecksumStarted

void JSChecksumStarted(java.lang.String type)

Callback when checksum computation is starting.

Parameters:

type - checksumtype

JSChecksumCompleted

void JSChecksumCompleted(java.lang.String checksum)

Callback when checksum computation is completed.

Parameters:

checksum - value