Package org.zkoss.zkmax.zul

Class Signature

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, Component, Scope, ComponentCtrl
    public class Signature
extends XulElement
    A signature pad for user to sign a signature on it with save, undo, clear method.
    Since:
    8.6.0
    Author:
    klyve, charles
    See Also:
    Serialized Form

    • Constructor Detail

      • Signature

        public Signature()

    • Method Detail

      • isChildable

        protected boolean isChildable()
        Description copied from class: AbstractComponent
        Returns whether this component can have a child.

        Default: return true (means it can have children).

        Overrides:
        isChildable in class AbstractComponent

      • getPenSize

        public int getPenSize()
        Returns the pen size of the signature pad.

        Default: 1.

        Returns:
        pen size 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.

      • getPenColor

        public java.lang.String getPenColor()
        Returns the pen color of the signature pad.

        Default: black.

        Returns:
        pen color of the signature pad.

      • setPenColor

        public void setPenColor​(java.lang.String penColor)
        Sets the pen color of the signature pad.
        Parameters:
        penColor - the pen color for signature pad.

      • getBackgroundColor

        public java.lang.String getBackgroundColor()
        Returns the background color of the signature pad.

        Default: white.

        Returns:
        the background color of the signature pad.

      • setBackgroundColor

        public void setBackgroundColor​(java.lang.String backgroundColor)
        Sets the background color for the signature pad.
        Parameters:
        backgroundColor - the background color for signature pad.

      • getBackgroundImage

        public java.lang.String getBackgroundImage()
        Returns the background image URI of signature pad.

        Default: null.

        Returns:
        the background image URI of signature pad.
        Since:
        9.6.0

      • setBackgroundImage

        public void setBackgroundImage​(java.lang.String backgroundImage)
        Sets the background image URI for the signature pad. Notice that the background image will cover the background color.
        Parameters:
        backgroundImage - the background image URI of signature pad.
        Since:
        9.6.0

      • isBackgroundIncluded

        public boolean isBackgroundIncluded()
        Returns whether the background color and image are included while saved.

        Default: true.

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

      • setBackgroundIncluded

        public void setBackgroundIncluded​(boolean backgroundIncluded)
        Sets whether the background color and image are included while saved.
        Parameters:
        backgroundIncluded - whether the background color and image are included while saved.
        Since:
        9.6.0

      • isToolbarVisible

        public boolean isToolbarVisible()
        Returns the visibility of the toolbar for signature pad.

        Default: true.

        Returns:
        the visibility of the toolbar.

      • setToolbarVisible

        public void setToolbarVisible​(boolean toolbarVisible)
        Sets the visibility of the toolbar for signature pad.
        Parameters:
        toolbarVisible - the visibility of the toolbar.

      • getSaveType

        public java.lang.String getSaveType()
        Returns the 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:
        type for saving signature image.

      • setSaveType

        public void setSaveType​(java.lang.String saveType)
        Sets the 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.

      • getUndoLabel

        public java.lang.String getUndoLabel()
        Returns the label on undo button. Default: null.
        Returns:
        the label on undo button.

      • setUndoLabel

        public void setUndoLabel​(java.lang.String undoLabel)
        Sets the label on undo button.
        Parameters:
        undoLabel - the label on undo button.

      • getSaveLabel

        public java.lang.String getSaveLabel()
        Returns the label on save button. Default: null.
        Returns:
        the label on save button.

      • setSaveLabel

        public void setSaveLabel​(java.lang.String saveLabel)
        Sets the label on save button.
        Parameters:
        saveLabel - the label on undo button.

      • getClearLabel

        public java.lang.String getClearLabel()
        Returns the label on clear button. Default: null.
        Returns:
        the label on clear button.

      • setClearLabel

        public void setClearLabel​(java.lang.String clearLabel)
        Sets the label on clear button.
        Parameters:
        clearLabel - the label on clear button.

      • undo

        public void undo()
        Undo the signature.

      • clear

        public void clear()
        Clear the signature.

      • 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 getSaveType().