Package org.zkoss.zkmax.zul

Class Barcodescanner

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, Component, Scope, ComponentCtrl
    public class Barcodescanner
extends XulElement
    A Barcode scanner Only works for Chrome, Firefox and Edge. iOS Safari is supported since 11. (iOS WebView browsers like Chrome are not supported yet)
    Since:
    8.6.0
    Author:
    klyvechen
    See Also:
    Serialized Form

    • Constructor Detail

      • Barcodescanner

        public Barcodescanner()

    • Method Detail

      • getType

        public java.lang.String getType()
        Returns the types which the barcode scanner is dealing with.

        Default: "CODE128".

        Returns:
        String.

      • setType

        public void setType​(java.lang.String type)
        A string which is a combination of types, separated by comma, the widget can detect all the defined types at a same time. The more specific the types is, the more efficient the widget is. Example: "code128,EAN,qr"
        Parameters:
        type - .

      • getContinuous

        public boolean getContinuous()
        Deprecated.
        As release of ZK 10.0, please use isContinuous()
        Returns the continuous scan status of the barcode scanner.

        Default: false.

        Returns:
        boolean

      • isContinuous

        public boolean isContinuous()
        Returns the continue scan status of the barcode scanner.

        Default: false.

        Returns:
        boolean

      • setContinuous

        public void setContinuous​(boolean continuous)
        Set the continuous scan function of barcode scanner, true is enable continue scan function, false is disable the function
        Parameters:
        continuous -

      • getEnable

        public boolean getEnable()
        Deprecated.
        As of release 10.0.0, replaced with isEnable()
        Returns the enable status of the barcode scanner.

        Default: "true".

        Returns:
        boolean

      • isEnable

        public boolean isEnable()
        Returns the enabled status of the barcode scanner.

        Default: true.

      • setEnable

        public void setEnable​(boolean enable)
        Set the enabled status of barcode scanner, true is enable the scanner function, false is disable the scanner function.
        Parameters:
        enable -

      • getInterval

        public double getInterval()
        Returns the scan interval of the barcode scanner.

        Default: 1000. Unit: millisecond.

        Returns:
        double

      • setInterval

        public void setInterval​(int interval)
        Set the scan interval of barcode scanner, it works only when the continuous is true. Unit: millisecond.
        Parameters:
        interval -

      • getConstraints

        public java.util.Map getConstraints()
        Returns the constraints. About allowed constraints setting, see https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamConstraints Default: null.
        Returns:
        the constraints

      • setConstraints

        public void setConstraints​(java.util.Map constraints)
        Sets the constraints, if not specify constraints, it will use {video: {facingMode: 'environment'}}. About allowed constraints setting, see https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamConstraints
        Parameters:
        constraints - the constraints

      • getConstraintsString

        public java.lang.String getConstraintsString()
        Returns the constraints in JSON String format. About allowed constraints setting, see https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamConstraints

        Default: null.

        Returns:
        the constraints in JSON String format

      • setConstraintsString

        public void setConstraintsString​(java.lang.String constraints)
        Sets the constraints in JSON String format, if not specify constraints, it will use {video: {facingMode: 'environment'}}. About allowed constraints setting, see https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamConstraints
        Parameters:
        constraints - the constraints in JSON String format

      • getConsistencyBufferSize

        public int getConsistencyBufferSize()
        Returns the consistency buffer size (used in 1D barcode).

        Default: 5.

        Returns:
        buffer size

      • setConsistencyBufferSize

        public void setConsistencyBufferSize​(int bufferSize)
        Sets the consistency buffer size (used in 1D barcode).
        Parameters:
        bufferSize - buffer size. Must be > 0 and >= threshold.

      • getConsistencyThreshold

        public int getConsistencyThreshold()
        Returns the consistency threshold (used in 1D barcode). In other way, the result is required to be scanned at least N times out of consistency buffer size.

        Default: 3.

        Returns:
        threshold

      • setConsistencyThreshold

        public void setConsistencyThreshold​(int threshold)
        Sets the consistency threshold (used in 1D barcode). In other way, the result is required to be scanned at least N times out of consistency buffer size.
        Parameters:
        threshold - threshold. Must be > 0 and <= buffer size.

      • getErrorAcceptance

        public double getErrorAcceptance()
        Returns the error acceptance (used in 1D barcode).

        Default: 0.1 (means 10%)

        Returns:
        acceptance
        Since:
        8.6.1

      • setErrorAcceptance

        public void setErrorAcceptance​(double acceptance)
        Sets the error acceptance (used in 1D barcode). 0 means no error allowed, 1 (100%) means no check.
        Parameters:
        acceptance - Error acceptance. Must be >= 0 and <= 1.
        Since:
        8.6.1