com.github.andrezimmermann.dropzone.client

Class DropzoneEventHandlerAdaptor

java.lang.Object

com.github.andrezimmermann.dropzone.client.DropzoneEventHandlerAdaptor

All Implemented Interfaces:

DropzoneEventHandler

public class DropzoneEventHandlerAdaptor
extends Object
implements DropzoneEventHandler

Empty implementation for the events dispatched by the Dropzone

Author:

andrezimmermann

Constructor Summary

Constructors

Constructor and Description
DropzoneEventHandlerAdaptor()

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DropzoneEventHandlerAdaptor

public DropzoneEventHandlerAdaptor()

Method Detail

onAddedFile

public void onAddedFile(File file)

Description copied from interface: DropzoneEventHandler

When a file is added

Specified by:

onAddedFile in interface DropzoneEventHandler

Parameters:

file - that was added

onCancelled

public void onCancelled(File file)

Description copied from interface: DropzoneEventHandler

Called when a file upload gets canceled.

Specified by:

onCancelled in interface DropzoneEventHandler

Parameters:

file - that was cancelled

onComplete

public void onComplete(File file)

Description copied from interface: DropzoneEventHandler

Called when the upload was either successful or erroneous.

Specified by:

onComplete in interface DropzoneEventHandler

Parameters:

file - that was completed, either was sucess or failiture

onError

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

Description copied from interface: DropzoneEventHandler

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

Specified by:

onError in interface DropzoneEventHandler

Parameters:

file - instance

message - from the error

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

onMaxFilesExceeded

public void onMaxFilesExceeded(File file)

Description copied from interface: DropzoneEventHandler

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

Specified by:

onMaxFilesExceeded in interface DropzoneEventHandler

Parameters:

file - that was rejected because of the maxFile limit

onMaxFilesReached

public void onMaxFilesReached(File file)

Description copied from interface: DropzoneEventHandler

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

Specified by:

onMaxFilesReached in interface DropzoneEventHandler

Parameters:

file - the last file that was accepted

onProcessing

public void onProcessing(File file)

Description copied from interface: DropzoneEventHandler

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

Specified by:

onProcessing in interface DropzoneEventHandler

onRemovedfile

public void onRemovedfile(File file)

Description copied from interface: DropzoneEventHandler

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.

Specified by:

onRemovedfile in interface DropzoneEventHandler

onSending

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

Description copied from interface: DropzoneEventHandler

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.

Specified by:

onSending in interface DropzoneEventHandler

onSuccess

public void onSuccess(File file,
                      String response)

Description copied from interface: DropzoneEventHandler

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

Specified by:

onSuccess in interface DropzoneEventHandler

onThumbnail

public void onThumbnail(File file,
                        String dataURI)

Description copied from interface: DropzoneEventHandler

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

Specified by:

onThumbnail in interface DropzoneEventHandler

onUploadProgress

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

Description copied from interface: DropzoneEventHandler

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.

Specified by:

onUploadProgress in interface DropzoneEventHandler

progressSent - percentage (0-100)