com.github.andrezimmermann.dropzone.client.event

Interface DropzoneEventHandler

All Known Implementing Classes:

DropzoneEventHandlerAdaptor

public interface DropzoneEventHandler

Maps the events handlers for the Dropzone, if needed, instance your own DropzoneEventHandler and implement the required method

Author:

Andre

Method Summary

Modifier and Type	Method and Description
void	onAddedFile(File file) When a file is added
void	onCancelled(File file) Called when a file upload gets canceled.
void	onComplete(File file) Called when the upload was either successful or erroneous.
void	onError(File file, String message, XHRObjet xhrObject) An error occured.
void	onMaxFilesExceeded(File file) Called for each file that has been rejected because the number of files exceeds the maxFiles limit.
void	onMaxFilesReached(File file) Called when the number of files accepted reached the maxFiles limit.
void	onProcessing(File file) When a file gets processed (since there is a queue not all files are processed immediately).
void	onRemovedfile(File file) Called whenever a file is removed from the list.
void	onSending(File file, FormData formData, XHRObjet xhrObject) Called just before each file is sent.
void	onSuccess(File file, String response) The file has been uploaded successfully.
void	onThumbnail(File file, String dataURI) When the thumbnail has been generated.
void	onUploadProgress(File file, int progressSent, int bytesSent) Gets called periodically whenever the file upload progress changes.

Method Detail

onAddedFile

void onAddedFile(File file)

When a file is added

Parameters:

file - that was added

onCancelled

void onCancelled(File file)

Called when a file upload gets canceled.

Parameters:

file - that was cancelled

onComplete

void onComplete(File file)

Called when the upload was either successful or erroneous.

Parameters:

file - that was completed, either was sucess or failiture

onError

void onError(File file,
             String message,
             XHRObjet xhrObject)

An error occured. Receives the errorMessage as second parameter and if the error was due to the XMLHttpRequest the xhr object as third.

Parameters:

file - instance

message - from the error

xhrObject - null if not present (ommited by javascript code)

onMaxFilesExceeded

void onMaxFilesExceeded(File file)

Called for each file that has been rejected because the number of files exceeds the maxFiles limit.

Parameters:

file - that was rejected because of the maxFile limit

onMaxFilesReached

void onMaxFilesReached(File file)

Called when the number of files accepted reached the maxFiles limit.

Parameters:

file - the last file that was accepted

onProcessing

void onProcessing(File file)

When a file gets processed (since there is a queue not all files are processed immediately). This event was called processingfile previously.

Parameters:

file -

onRemovedfile

void onRemovedfile(File file)

Called whenever a file is removed from the list. You can listen to this and delete the file from your server if you want to.

Parameters:

file -

onSending

void onSending(File file,
               FormData formData,
               XHRObjet xhrObject)

Called just before each file is sent. Gets the xhr object and the formData objects as second and third parameters, so you can modify them (for example to add a CSRF token) or add additional data.

Parameters:

file -

formData -

xhrObject -

onSuccess

void onSuccess(File file,
               String response)

The file has been uploaded successfully. Gets the server response as second argument. (This event was called finished previously)

Parameters:

file -

onThumbnail

void onThumbnail(File file,
                 String dataURI)

When the thumbnail has been generated. Receives the dataUrl as second parameter.

Parameters:

file -

dataURI -

onUploadProgress

void onUploadProgress(File file,
                      int progressSent,
                      int bytesSent)

Gets called periodically whenever the file upload progress changes. Gets the progress parameter as second parameter which is a percentage (0-100) and the bytesSent parameter as third which is the number of the bytes that have been sent to the server. When an upload finishes dropzone ensures that uploadprogress will be called with a percentage of 100 at least once. Warning: This function can potentially be called with the same progress multiple times.

Parameters:

file -

progressSent - percentage (0-100)

bytesSent -