com.github.andrezimmermann.dropzone.client

Class Dropzone

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.Composite

com.github.andrezimmermann.dropzone.client.Dropzone

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsRenderable, com.google.gwt.user.client.ui.IsWidget

public class Dropzone
extends com.google.gwt.user.client.ui.Composite

Main class, that is used to interact

Author:

andrezimmermann

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
Dropzone(DropzoneOptions options)
Dropzone(DropzoneOptions options, DropzoneDictonary dictionary)
Dropzone(DropzoneOptions options, DropzoneEventHandler handler)
Dropzone(DropzoneOptions options, DropzoneEventHandler handler, DropzoneDictonary dictionary)
Dropzone(DropzoneOptions options, DropzoneEventHandler handler, DropzoneDictonary dictionary, Resources resources)

Method Summary

Modifier and Type	Method and Description
void	addFile(String fileName, Integer fileSize, String thumbnailUrl) Add file information manually to Dropzone.
static DropzoneDictonary	dictionary() Create the object that contains the Dictionary used by Dropzone
File	getFile(int index) Return information about particular file added to dropzone.
ArrayList<File>	getFiles() Return array if all files added to dropzone.
int	getFilesCount() Return number of added files.
static DropzoneOptions	options() Create the object that contains the Options used by Dropzone
void	processQueue() Checks how many files are currently uploading, and if it’s less than options.parallelUploads, .processFile(file) is called.
void	removeAllFiles() Removes all files from dropzone.
void	removeFile(File file) Removes file at index i.
void	removeFile(int i) Removes file at index i.

Methods inherited from class com.google.gwt.user.client.ui.Composite

claimElement, getWidget, initializeClaimedElement, initWidget, isAttached, onAttach, onBrowserEvent, onDetach, render, render, resolvePotentialElement, setWidget

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Dropzone

public Dropzone(DropzoneOptions options)

Dropzone

public Dropzone(DropzoneOptions options,
                DropzoneDictonary dictionary)

Dropzone

public Dropzone(DropzoneOptions options,
                DropzoneEventHandler handler)

Dropzone

public Dropzone(DropzoneOptions options,
                DropzoneEventHandler handler,
                DropzoneDictonary dictionary)

Dropzone

public Dropzone(DropzoneOptions options,
                DropzoneEventHandler handler,
                DropzoneDictonary dictionary,
                Resources resources)

Method Detail

dictionary

public static DropzoneDictonary dictionary()

Create the object that contains the Dictionary used by Dropzone

Returns:

a default (en-us) DropzoneDictonary instance

options

public static DropzoneOptions options()

Create the object that contains the Options used by Dropzone

Returns:

a default DropzoneOptions instance

addFile

public void addFile(String fileName,
                    Integer fileSize,
                    String thumbnailUrl)

Add file information manually to Dropzone. Added file is not uploaded, it is just shown in the dropzone. This feature is useful for displaying e.g. files that already exists on the server.

Parameters:

fileName - name of file to add

fileSize - size of file to add

thumbnailUrl - thumbnail image for file

getFile

public File getFile(int index)

Return information about particular file added to dropzone.

Parameters:

index - of the file

Returns:

file information

getFiles

public ArrayList<File> getFiles()

Return array if all files added to dropzone.

Returns:

all files added to dropzone.

getFilesCount

public int getFilesCount()

Return number of added files.

Returns:

number of files

processQueue

public void processQueue()

Checks how many files are currently uploading, and if it’s less than options.parallelUploads, .processFile(file) is called.

If you set autoProcessQueue to false, then .processQueue() is never called implicitly. This means that you have to call it yourself when you want to upload all files currently queued.

removeAllFiles

public void removeAllFiles()

Removes all files from dropzone.

removeFile

public void removeFile(int i)

Removes file at index i.

Parameters:

i - index of the file to remove.

removeFile

public void removeFile(File file)

Removes file at index i.

Parameters:

i - index of the file to remove.