com.github.andrezimmermann.dropzone.client.interfaces

Interface DropzoneOptions

public interface DropzoneOptions

Method Summary

Modifier and Type	Method and Description
void	setAcceptedFiles(String acceptedFiles) The default implementation of accept checks the file's mime type or extension against this list.
void	setAddRemoveLinks(boolean addRemoveLinks) This will add a link to every file preview to remove or cancel (if already uploading) the file.
void	setAutoProcessQueue(boolean autoProcessQueue) When set to false you have to call myDropzone.processQueue() yourself in order to upload the dropped files.
void	setClickable(boolean clickable) If true, the dropzone element itself will be clickable, if false nothing will be clickable.
void	setClickable(Collection<com.google.gwt.dom.client.Element> arrayOfClickableElements) If true, the dropzone element itself will be clickable, if false nothing will be clickable.
void	setClickable(String cssSelectorOfClickableElements) If true, the dropzone element itself will be clickable, if false nothing will be clickable.
void	setFallback(DropzoneFallbackEvent fallbackHandler) is a function that gets called when the browser is not supported.
void	setForceFallback(boolean forceFallback) If true the fallback will be forced.
void	setHeaders(Map<String,String> headers)
void	setMaxFiles(int maxFiles) if not null defines how many files this Dropzone handles.
void	setMaxFilesize(int fileSize) in MB
void	setMethod(Method method) Defaults to "post" and can be changed to "put" if necessary.
void	setParallelUploads(int amount) How many file uploads to process in parallel (See the Enqueuing file uploads section for more info)
void	setParamName(String paramName) The name of the file param that gets transferred.
void	setPreviewsContainer(String previewsContainer) Defines where to display the file previews – if null the Dropzone element is used.
void	setPreviewTemplate(String previewTemplate) String that contains the template used for each dropped image.
void	setThumbnailHeight(int height) The same as setThumbnailWidth.
void	setThumbnailWidth(int width) If null, the ratio of the image will be used to calculate it.
void	setUploadMultiple(boolean multipleUploads) Whether Dropzone should send multiple files in one request.
void	setUrl(String url) Has to be specified on elements other than form (or when the form doesn't have an action attribute)

Method Detail

setAcceptedFiles

void setAcceptedFiles(String acceptedFiles)

The default implementation of accept checks the file's mime type or extension against this list. This is a comma separated list of mime types or file extensions. Eg.: image/*,application/pdf,.psd. If the Dropzone is clickable this option will be used as accept parameter on the hidden file input as well.

Parameters:

acceptedFiles - This is a comma separated list of mime types or file extensions. Eg.: image/*,application/pdf,.psd.

setAddRemoveLinks

void setAddRemoveLinks(boolean addRemoveLinks)

This will add a link to every file preview to remove or cancel (if already uploading) the file. The dictCancelUpload, dictCancelUploadConfirmation and dictRemoveFile options are used for the wording.

Parameters:

addRemoveLinks -

setAutoProcessQueue

void setAutoProcessQueue(boolean autoProcessQueue)

When set to false you have to call myDropzone.processQueue() yourself in order to upload the dropped files. See below for more information on handling queues.

Parameters:

autoProcessQueue -

setClickable

void setClickable(boolean clickable)

If true, the dropzone element itself will be clickable, if false nothing will be clickable. Otherwise you can pass an HTML element, a CSS selector (for multiple elements) or an array of those.

Parameters:

clickable -

setClickable

void setClickable(Collection<com.google.gwt.dom.client.Element> arrayOfClickableElements)

If true, the dropzone element itself will be clickable, if false nothing will be clickable. Otherwise you can pass an HTML element, a CSS selector (for multiple elements) or an array of those.

Parameters:

arrayOfClickableElements -

setClickable

void setClickable(String cssSelectorOfClickableElements)

If true, the dropzone element itself will be clickable, if false nothing will be clickable. Otherwise you can pass an HTML element, a CSS selector (for multiple elements) or an array of those.

Parameters:

cssSelectorOfClickableElements -

setFallback

void setFallback(DropzoneFallbackEvent fallbackHandler)

is a function that gets called when the browser is not supported. The default implementation shows the fallback input field and adds a text.

Parameters:

fallbackHandler - (GWT Callback)

setForceFallback

void setForceFallback(boolean forceFallback)

If true the fallback will be forced. This is very useful to test your server implementations first and make sure that everything works as expected without dropzone if you experience problems, and to test how your fallbacks will look. Defaults to false.

Parameters:

forceFallback -

setHeaders

void setHeaders(Map<String,String> headers)

setMaxFiles

void setMaxFiles(int maxFiles)

if not null defines how many files this Dropzone handles. If it exceeds, the event maxfilesexceeded will be called. The dropzone element gets the class dz-max-files-reached accordingly so you can provided visual feedback.

Parameters:

maxFiles -

setMaxFilesize

void setMaxFilesize(int fileSize)

in MB

setMethod

void setMethod(Method method)

Defaults to "post" and can be changed to "put" if necessary.

Parameters:

method -

setParallelUploads

void setParallelUploads(int amount)

How many file uploads to process in parallel (See the Enqueuing file uploads section for more info)

Parameters:

amount -

setParamName

void setParamName(String paramName)

The name of the file param that gets transferred. Defaults to file. NOTE: If you have the option uploadMultiple set to true, then Dropzone will append [] to the name.

Parameters:

paramName -

setPreviewsContainer

void setPreviewsContainer(String previewsContainer)

Defines where to display the file previews – if null the Dropzone element is used. Can be a plain HTMLElement or a CSS selector. The element should have the dropzone-previews class so the previews are displayed properly.

Parameters:

previewsContainer -

setPreviewTemplate

void setPreviewTemplate(String previewTemplate)

String that contains the template used for each dropped image. Change it to fulfill your needs but make sure to properly provide all elements.

Parameters:

previewTemplate -

setUploadMultiple

void setUploadMultiple(boolean multipleUploads)

Whether Dropzone should send multiple files in one request. If this it set to true, then the fallback file input element will have the multiple attribute as well. This option will also trigger additional events (like processingmultiple). See the events section for more information.

Parameters:

multipleUploads -

setUrl

void setUrl(String url)

Has to be specified on elements other than form (or when the form doesn't have an action attribute)

Parameters:

url -

setThumbnailWidth

void setThumbnailWidth(int width)

If null, the ratio of the image will be used to calculate it.

Parameters:

width -

setThumbnailHeight

void setThumbnailHeight(int height)

The same as setThumbnailWidth. If both are null, images will not be resized.

Parameters:

height -