zkmax.wgt

Class Dropupload

java.lang.Object

zk.Object

zk.Widget

zul.Widget

zkmax.wgt.Dropupload

public class Dropupload
extends Widget

A widget can handle drag files into it, and upload files to server.

Default Widget.getZclass(): z-dropupload.

known support browser:

Chrome (v.19+)

Firefox (v.13+)

Safari (5.1+)

know unsupport browser:

IE9

Opera (11.x)

Since:

6.5.0

Field Summary

Fields inherited from class zk.Widget

$weave, auDelay, autag, bindLevel, className, desktop, effects_, firstChild, id, insertingBefore_, inServer, lastChild, nChildren, nextSibling, parent, previousSibling, uuid, widgetName

Fields inherited from class zk.Object

$class, $oid

Method Summary

Modifier and Type	Method and Description
String	getAnchorUuid() Return the anchor uuid of widget.
String	getContent() Return the content of widget, it's visible depends on detection setting.
String	getDetection() Return the setting of drag detection area.
int	getMaxFileCount() Get the maximum number of files user can upload at once, when number of upload files exceed the maxFileCount, nothing will be uploaded and onMaxFileCountExceed event will be triggered, developer can listen to onMaxFileCountExceed and get the number of upload files by calling event.getData().
int	getMaxsize() Get the max size setting of upload file, unit is "KB".
String	getSuppressedErrors() Return the suppressed errors setting.
String	getViewerClass() Retrun the custom upload viewer class name.
boolean	isNative() Deprecated. Since 8.6.2. Please use server-side API instead.
void	setAnchorUuid(String value) Set the anchor uuid of widget, the anchor allows the dropupload component to anchor to another component and overlay that component when the user drag & drops files to the browser.
void	setContent(String value) Set the content of widget.
void	setDetection(String value) Set drag detection area.
void	setMaxFileCount(int maxFileCount) Set the maximum number of files user can upload at once, when number of upload files exceed the maxFileCount, nothing will be uploaded and onMaxFileCountExceed event will be triggered, developer can listen to onMaxFileCountExceed and get the number of upload files by calling event.getData().
void	setMaxsize(int value) Set the max size of upload file, unit is "KB".
void	setNative() Deprecated. Since 8.6.2. Please use server-side API instead.
void	setSuppressedErrors(String suppressedErrors) Set the suppressed errors setting.
void	setViewerClass(String value) Set the custom upload viewer class name, if was not specified, will use ZK default upload viewer.

Methods inherited from class zul.Widget

afterKeyDown_, beforeCtrlKeys_, getContext, getCtrlKeys, getOpenTooltip, getPopup, getTooltip, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip

Methods inherited from class zk.Widget

$, $f, $f, $f, $init, $n, $n, $o, $s, $service, afterAnima_, afterParentChanged_, appendChild, appendChild, beforeParentChanged_, beforeSendAU_, bind_, bind, bindChildren_, bindDoubleTap_, bindMissingAncestors, bindSwipe_, bindTapHold_, canActivate, cleanDrag_, clear, clearCache, cloneDrag_, deferRedraw_, deferRedrawHTML_, detach, doBlur_, doClick_, doDoubleClick_, doFocus_, doKeyDown_, doKeyPress_, doKeyUp_, domAttrs_, domClass_, domListen_, doMouseDown_, doMouseMove_, doMouseOut_, doMouseOver_, doMouseUp_, domStyle_, domTextStyleAttr_, domTooltiptext_, domUnlisten_, doPaste_, doResizeScroll_, doRightClick_, doSelect_, doSwipe_, doTooltipOut_, doTooltipOver_, dropEffect_, extraBind_, fire, fireX, focus_, focus, forcerender, fromPageCoord, get, getAction, getCaveNode, getChildAt, getChildIndex, getClass, getCssflex, getDraggable, getDragMessage_, getDragNode, getDragOptions_, getDrop_, getDroppable, getElementsById, getElementsByName, getFirstNode_, getFloatZIndex_, getHeight, getHflex, getId, getLeft, getMold, getOldWidget_, getPage, getRenderdefer, getSclass, getScrollLeft, getScrollTop, getStyle, getTabindex, getTextNode, getTooltiptext, getTop, getTopWidget, getVflex, getWidth, getZclass, getZIndex, hide, ignoreDescendantFloatUp_, ignoreDrag_, initDrag_, insertBefore, insertChildHTML_, isAutoId, isBinding, isFloating_, isListen, isRealElement, isRealVisible, isRealVisible, isVisible, isVisible, isWatchable_, listen, listenOnFitSize_, mimicMouseDown_, newInstance, nextUuid, onAfterSize, onChildAdded_, onChildRemoved_, onChildRenderDefer_, onChildReplaced_, onChildVisible_, onDrop_, redraw, redrawHTML_, register, removeChild, removeChild, removeChildHTML_, removeHTML_, replaceCavedChildren_, replaceChildHTML_, replaceHTML, replaceWidget, rerender, rerender, rerenderLater_, rerenderNow_, scrollIntoView, sendAU_, set, set, setAction, setChildren, setCssflex, setDomVisible_, setDraggable, setDroppable, setFloating_, setFloatZIndex_, setHeight, setHflex, setId, setLeft, setListener, setListener, setListeners, setMold, setRenderdefer, setSclass, setScrollLeft, setScrollTop, setStyle, setTabindex, setTooltiptext, setTop, setTopmost, setVflex, setVisible, setWidth, setZclass, setZIndex, shallChildROD_, shallFireSizedLaterWhenAddChd_, shallIgnoreClick_, show, smartUpdate, unbind_, unbind, unbindChildren_, unbindDoubleTap_, unbindSwipe_, unbindTapHold_, uncloneDrag_, unlisten, unlistenOnFitSize_, updateDomClass_, updateDomStyle_, uuid, zsync

Methods inherited from class zk.Object

$init, $instanceof, $super, $super, $supers, $supers, afterInit, isAssignableFrom, isInstance, proxy

Methods inherited from class java.lang.Object

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

Method Detail

setMaxsize

public void setMaxsize(int value)

Set the max size of upload file, unit is "KB". Notice: All the files in one drag-and-drop action must smaller than max size, or nothing will upload.

Parameters:

value -

getMaxsize

public int getMaxsize()

Get the max size setting of upload file, unit is "KB".

Returns:

int

setViewerClass

public void setViewerClass(String value)

Set the custom upload viewer class name, if was not specified, will use ZK default upload viewer.

Parameters:

value -

getViewerClass

public String getViewerClass()

Retrun the custom upload viewer class name.

Returns:

String

setDetection

public void setDetection(String value)

Set drag detection area. There are four accept value:

1. browser: whole browser, default value.
2. none: disable detection.
3. self: the Dropupload itself.
4. $id: the id value of specified widget. If specified widget is not exist, will use default setting.

Parameters:

value -

getDetection

public String getDetection()

Return the setting of drag detection area.

Returns:

String

setContent

public void setContent(String value)

Set the content of widget.

Parameters:

value -

getContent

public String getContent()

Return the content of widget, it's visible depends on detection setting.

Returns:

String

setAnchorUuid

public void setAnchorUuid(String value)

Set the anchor uuid of widget, the anchor allows the dropupload component to anchor to another component and overlay that component when the user drag & drops files to the browser.

Parameters:

value -

getAnchorUuid

public String getAnchorUuid()

Return the anchor uuid of widget.

Returns:

String

setMaxFileCount

public void setMaxFileCount(int maxFileCount)

Set the maximum number of files user can upload at once, when number of upload files exceed the maxFileCount, nothing will be uploaded and onMaxFileCountExceed event will be triggered, developer can listen to onMaxFileCountExceed and get the number of upload files by calling event.getData().

Parameters:

maxFileCount -

Since:

8.5.2

getMaxFileCount

public int getMaxFileCount()

Get the maximum number of files user can upload at once, when number of upload files exceed the maxFileCount, nothing will be uploaded and onMaxFileCountExceed event will be triggered, developer can listen to onMaxFileCountExceed and get the number of upload files by calling event.getData(). Default: -1

Returns:

int

Since:

8.5.2

setSuppressedErrors

public void setSuppressedErrors(String suppressedErrors)

Set the suppressed errors setting.

Parameters:

suppressedErrors -

Since:

9.5.1

getSuppressedErrors

public String getSuppressedErrors()

Return the suppressed errors setting.

Default: null

Returns:

String

Since:

9.5.1

setNative

public void setNative()

Deprecated. Since 8.6.2. Please use server-side API instead.

Set the setting that treat the upload file as binary or not.

isNative

public boolean isNative()

Deprecated. Since 8.6.2. Please use server-side API instead.

Return the setting that treat the upload file as binary or not.

Returns:

boolean