Package org.zkoss.stateless.sul

Interface IBarcode

All Superinterfaces:
IAnyGroup<IBarcode>, IComponent<IBarcode>, IHtmlBasedComponent<IBarcode>, IXulElement<IBarcode>
public interface IBarcode extends IXulElement<IBarcode>, IAnyGroup<IBarcode>
Immutable Barcode component

A barcode is a component to handle 1D and 2D barcode image.

Author:
katherine
See Also:
  • Barcode

  • Field Details

    • DEFAULT

      static final IBarcode DEFAULT
      Constant for default attributes of this immutable component.

  • Method Details

    • getWidgetClass

      default String getWidgetClass()
      Returns the client widget class.

      Default: "zkmax.barcode.Barcode"

      Specified by:
      getWidgetClass in interface IComponent<IBarcode>

    • getType

      default String getType()
      Returns the encoded and decoded type of this component. The built-in types are
      • CODE family: CODE39, CODE128, CODE128A, CODE128B, CODE128C
      • EAN family: EAN13, EAN8, EAN5, EAN2
      • ITF family: ITF14, ITF
      • MSI family: MSI, MSI10, MSI11, MSI1010, MSI1110
      • others: UPC, PHARMACODE , CODABAR, QR
      Some types have character and length limit. You can check it at https://en.wikipedia.org/wiki/Barcode

      Default: "CODE128".

      Returns:
      A value of the barcode current type.

    • withType

      IBarcode withType(String type)
      Returns a copy of this immutable component with the specified type.

      Sets the encoded and decoded type of this component. The built-in types are

      • CODE family: CODE39, CODE128, CODE128A, CODE128B, CODE128C
      • EAN family: EAN13, EAN8, EAN5, EAN2
      • ITF family: ITF14, ITF
      • MSI family: MSI, MSI10, MSI11, MSI1010, MSI1110
      • others: UPC, PHARMACODE , CODABAR, QR
      Some types have character and length limit. You can check it at https://en.wikipedia.org/wiki/Barcode
      Parameters:
      type - The encoded and decoded type of this component.

      Default: "CODE128".

      Returns:
      A modified copy of the this object

    • getDisplayValue

      default boolean getDisplayValue()
      Returns the visibility of the value of barcode component (only for 1D barcode).

      Default: false.

    • withDisplayValue

      IBarcode withDisplayValue(boolean displayValue)
      Returns a copy of this immutable component with the specified displayValue.

      Sets the visibility of the value of barcode component (only for 1D barcode).

      Parameters:
      displayValue - The visibility of the value of barcode component

      Default: false.

      Returns:
      A modified copy of the this object

    • getValue

      default String getValue()
      Returns the value of the barcode image.

      Default: "".

    • withValue

      IBarcode withValue(String value)
      Returns a copy of this immutable component with the specified value.

      Sets the value of the barcode image.

      Parameters:
      value - The value of the barcode image.

      Default: "".

      Returns:
      A modified copy of the this object

    • getFontSize

      default int getFontSize()
      Returns the fontSize of barcode (only for 1D barcode).

      Default: 10.

    • withFontSize

      IBarcode withFontSize(int fontSize)
      Returns a copy of this immutable component with the specified fontSize.

      Sets the fontSize of barcode (only for 1D barcode).

      Parameters:
      fontSize - The fontSize of barcode (only for 1D barcode).

      Default: 10.

      Returns:
      A modified copy of the this object

    • getBarWidth

      default int getBarWidth()
      Returns the width of single bar (only for 1D barcode).

      Default: 2.

    • withBarWidth

      IBarcode withBarWidth(int barWidth)
      Returns a copy of this immutable component with the specified barWidth.

      Sets the width of single bar (only for 1D barcode).

      Parameters:
      barWidth - The width of single bar (only for 1D barcode).

      Default: 2.

      Returns:
      A modified copy of the this object

    • of

      static IBarcode of(String value)
      Returns the instance with the given value
      Parameters:
      value - The value of the component

    • ofType

      static IBarcode ofType(String type, String value)
      Returns the instance with the given type and value
      Parameters:
      type - The encoded or decoded type of the component.
      value - The value of the component

    • ofId

      static IBarcode ofId(String id)
      Returns the instance with the given id.
      Parameters:
      id - The id to identify this component