zkmax.wgt

Class Signature

java.lang.Object

zk.Object

zk.Widget

zul.Widget

zkmax.wgt.Signature

public class Signature
extends Widget

A signature pad for user to sign a signature on it with save, undo, clear method.

Since:

8.6.0

Author:

klyve, charles

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
void	clear() Clear the signature.
void	drawBackground() Draws the background color and image of signature.
String	getBackgroundColor() Returns the background color of the signature pad.
String	getBackgroundImage() Returns the background image URI of signature pad.
String	getClearLabel() Returns the label on clear button.
String	getPenColor() Returns the pen color of the signature pad.
int	getPenSize() Returns the pen size of the signature pad.
String	getSaveLabel() Returns the label on save button.
String	getSaveType() Returns the MIME type for saving signature image.
String	getUndoLabel() Returns the label on undo button.
boolean	isBackgroundIncluded() Returns whether the background color and image are included while saved.
boolean	isToolbarVisible() Returns the visibility of the toolbar for signature pad.
void	save() Save the Signature.
void	setBackgroundColor(String backgroundColor) Sets the background color for the signature pad.
void	setBackgroundImage(String backgroundImage) Sets the background image for the signature pad.
void	setBackgroundIncluded(boolean whether) Sets whether the background color and image are included while saved.
void	setClearLabel(String clearLabel) Sets the label on clear button.
void	setPenColor(String penColor) Sets the pen color of the signature pad.
void	setPenSize(int penSize) Sets the pen size of the signature pad.
void	setSaveLabel(String saveLabel) Sets the label on save button.
void	setSaveType(String saveType) Sets the MIME type for saving signature image.
void	setToolbarVisible(boolean toolbarVisible) Sets the visibility of the toolbar for signature pad.
void	setUndoLabel(String undoLabel) Sets the label on undo button.
void	undo() Undo the signature.

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_, 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

setPenColor

public void setPenColor(String penColor)

Sets the pen color of the signature pad.

Parameters:

penColor - the pen color for signature pad.

getPenColor

public String getPenColor()

Returns the pen color of the signature pad.

Default: black.

Returns:

String the pen color of the signature pad.

setPenSize

public void setPenSize(int penSize)

Sets the pen size of the signature pad.

Parameters:

penSize - the pen size for signature pad.

getPenSize

public int getPenSize()

Returns the pen size of the signature pad.

Default: 1.

Returns:

int the pen size of the signature pad.

setBackgroundColor

public void setBackgroundColor(String backgroundColor)

Sets the background color for the signature pad.

Parameters:

backgroundColor - the background color for signature pad.

getBackgroundColor

public String getBackgroundColor()

Returns the background color of the signature pad.

Default: white.

Returns:

String the background color of the signature pad.

setBackgroundImage

public void setBackgroundImage(String backgroundImage)

Sets the background image for the signature pad.

Parameters:

backgroundImage - the background image URI of signature pad.

Since:

9.6.0

getBackgroundImage

public String getBackgroundImage()

Returns the background image URI of signature pad.

Default: null.

Returns:

String the background image URI of signature pad.

Since:

9.6.0

setBackgroundIncluded

public void setBackgroundIncluded(boolean whether)

Sets whether the background color and image are included while saved.

Parameters:

whether - the background color and image are included while saved.

Since:

9.6.0

isBackgroundIncluded

public boolean isBackgroundIncluded()

Returns whether the background color and image are included while saved.

Default: true.

Returns:

boolean whether the background color and image are included while saved.

Since:

9.6.0

setToolbarVisible

public void setToolbarVisible(boolean toolbarVisible)

Sets the visibility of the toolbar for signature pad.

Parameters:

toolbarVisible - the visibility of the toolbar.

isToolbarVisible

public boolean isToolbarVisible()

Returns the visibility of the toolbar for signature pad.

Default: true.

Returns:

boolean the visibility of the toolbar.

setSaveType

public void setSaveType(String saveType)

Sets the MIME type for saving signature image. The supported type is MIME type, e.g., image/png, image/jpeg. If the requested type is invalid or unspecified, it will use image/png.

Parameters:

saveType - type for saving signature image.

getSaveType

public String getSaveType()

Returns the MIME type for saving signature image. The supported type is MIME type, e.g., image/png, image/jpeg. If the requested type is invalid or unspecified, it will use image/png. Default: image/png.

Returns:

String type for saving signature image.

setUndoLabel

public void setUndoLabel(String undoLabel)

Sets the label on undo button.

Parameters:

undoLabel - the label on undo button.

getUndoLabel

public String getUndoLabel()

Returns the label on undo button. Default: null.

Returns:

String the label on undo button.

setSaveLabel

public void setSaveLabel(String saveLabel)

Sets the label on save button.

Parameters:

saveLabel - the label on undo button.

getSaveLabel

public String getSaveLabel()

Returns the label on save button. Default: null.

Returns:

String the label on save button.

setClearLabel

public void setClearLabel(String clearLabel)

Sets the label on clear button.

Parameters:

clearLabel - the label on clear button.

getClearLabel

public String getClearLabel()

Returns the label on clear button. Default: null.

Returns:

String the label on clear button.

undo

public void undo()

Undo the signature.

clear

public void clear()

Clear the signature.

Overrides:

clear in class Widget

drawBackground

public void drawBackground()

Draws the background color and image of signature.

Since:

9.6.0

save

public void save()

Save the Signature. It will upload a file and fire an onSave event to server, upload file type is according to this.getSaveType().