Package com.ebasetech.xi.api.controls

Interface BarcodeControl

All Superinterfaces:
Control, Element, EventOwner, MessageContainer, java.io.Serializable, WebFormEventOwner
public interface BarcodeControl
extends Control
Barcode Control

Further documentation

Since:
V4.4

  • Field Details

    • CODABAR

      static final int CODABAR
      A constant to represent a Codabar barcode for use with setType() method.
      See Also:
      Constant Field Values

    • CODE128

      static final int CODE128
      A constant to represent a Code 128 barcode for use with setType() method.
      See Also:
      Constant Field Values

    • CODE39

      static final int CODE39
      A constant to represent a Code 39 barcode for use with setType() method.
      See Also:
      Constant Field Values

    • DATAMATRIX

      static final int DATAMATRIX
      A constant to represent a Datamatrix barcode for use with setType() method.
      See Also:
      Constant Field Values

    • POSTNET

      static final int POSTNET
      A constant to represent a Postnet barcode for use with setType() method.
      See Also:
      Constant Field Values

    • INTERLEAVED

      static final int INTERLEAVED
      A constant to represent an Interleaved 2 of 5 barcode for use with setType() method.
      See Also:
      Constant Field Values

    • PDF417

      static final int PDF417
      A constant to represent a PDF417 barcode for use with setType() method.
      See Also:
      Constant Field Values

    • EAN13

      static final int EAN13
      A constant to represent a EAN 13 barcode for use with setType() method.
      See Also:
      Constant Field Values

    • EAN8

      static final int EAN8
      A constant to represent a EAN 8 barcode for use with setType() method.
      See Also:
      Constant Field Values

    • UPCA

      static final int UPCA
      A constant to represent a UPC-A barcode for use with setType() method.
      See Also:
      Constant Field Values

    • UPCE

      static final int UPCE
      A constant to represent a UPC-E barcode for use with setType() method.
      See Also:
      Constant Field Values

    • ROYALMAIL

      static final int ROYALMAIL
      A constant to represent a Royal Mail barcode for use with setType() method.
      See Also:
      Constant Field Values

    • USPS

      static final int USPS
      A constant to represent a Intelligent Mail barcode for use with setType() method.
      See Also:
      Constant Field Values

    • EAN128

      static final int EAN128
      A constant to represent a EAN 128 barcode for use with setType() method.
      See Also:
      Constant Field Values

    • QRCODE

      static final int QRCODE
      A constant to represent a QR Code barcode for use with setType() method.
      See Also:
      Constant Field Values

  • Method Details

    • getType

      int getType()
      Returns the barcode type for the generated barcode.

      Further documentation

      Since:
      V4.4
      See Also:
      setType(int)

    • setType

      void setType​(int type)
      Sets the barcode type for this barcode.

      Further documentation

      Since:
      V4.4
      See Also:
      getType()

    • getBarcodeHeight

      java.lang.String getBarcodeHeight()
      Returns the barcode height for the generated barcode.

      Further documentation

      Since:
      V4.4
      See Also:
      setBarcodeHeight(String)

    • setBarcodeHeight

      void setBarcodeHeight​(java.lang.String barcodeHeight)
      Sets the barcode height for the generated barcode. This is usually configured with a double number.

      Further documentation

      Since:
      V4.4
      See Also:
      getBarcodeHeight()

    • getModuleWidth

      java.lang.String getModuleWidth()
      Returns the width for the generated barcode.

      Further documentation

      Since:
      V4.4
      See Also:
      setModuleWidth(String)

    • setModuleWidth

      void setModuleWidth​(java.lang.String moduleWidth)
      Sets the width for the generated barcode.

      Further documentation

      Since:
      V4.4
      See Also:
      getModuleWidth()

    • isQuietZoneEnabled

      boolean isQuietZoneEnabled()
      Returns whether the quiet zone should be rendered

      Further documentation

      Returns:
      true if quiet zone is enabled.
      Since:
      V4.4
      See Also:
      setQuietZoneEnabled(boolean)

    • setQuietZoneEnabled

      void setQuietZoneEnabled​(boolean quietZoneEnabled)
      Set whether the quiet zone should be rendered.

      Further documentation

      Since:
      V4.4
      See Also:
      isQuietZoneEnabled()

    • getQuietZone

      java.lang.String getQuietZone()
      Returns the width of the quiet zone left and right of the barcode in mm (gap either side of the barcode)

      Further documentation

      Since:
      V4.4
      See Also:
      setQuietZone(String)

    • setQuietZone

      void setQuietZone​(java.lang.String quietZone)
      Set the width of the quiet zone left and right of the barcode in mm (gap either side of the barcode)

      Further documentation

      Since:
      V4.4
      See Also:
      getQuietZone()

    • getMessagePosition

      java.lang.String getMessagePosition()
      Returns the position of the message text of the barcode.

      Further documentation

      Since:
      V4.4
      See Also:
      setMessagePosition(String)

    • setMessagePosition

      void setMessagePosition​(java.lang.String messagePosition)
      Sets the position of the message text of the barcode. This can be either above the barcode, below the barcode or do not display the message text.
      Value Description
      top The human readable part is displayed at the top of the barcode
      bottom The human readable part is displayed at the bottom of the barcode
      none No text is shown

      Further documentation

      Since:
      V4.4
      See Also:
      getMessagePosition()

    • getImageResolution

      int getImageResolution()
      Returns the image resolution (dots per inch)

      Further documentation

      Since:
      V4.4
      See Also:
      setImageResolution(int)

    • setImageResolution

      void setImageResolution​(int imageResolution)
      Sets the image resolution (dots per inch)

      Further documentation

      Since:
      V4.4
      See Also:
      setImageResolution(int)

    • isImageGrayscale

      boolean isImageGrayscale()
      Returns whether the image should be rendered gray scaled and anti aliased

      Further documentation

      Since:
      V4.4
      See Also:
      setImageGrayscale(boolean)

    • setImageGrayscale

      void setImageGrayscale​(boolean imageGrayscale)
      Sets the image gray scale. If set to true then the image is gray scaled with anti-aliasing

      Further documentation

      Since:
      V4.4
      See Also:
      isImageGrayscale()

    • getOrientation

      int getOrientation()
      Returns image orientation on the page.

      Further documentation

      Since:
      V4.4
      See Also:
      setOrientation(int)

    • setOrientation

      void setOrientation​(int orientation)
      Sets the image orientation on the page. This is an integer value and represents degrees in a circle.
      The value should be be between 0 and 359

      Further documentation

      Since:
      V4.4
      See Also:
      setOrientation(int)

    • getMessage

      Text getMessage()
      Returns the text for the barcode.

      Further documentation

      Since:
      V4.4

    • getBarcodeWideFactor

      java.lang.String getBarcodeWideFactor()
      Returns the factor by which wide bars are broader than narrow bars.

      Further documentation

      Since:
      V4.4
      See Also:
      setBarcodeWideFactor(String)

    • setBarcodeWideFactor

      void setBarcodeWideFactor​(java.lang.String barcodeWideFactor)
      Sets the factor by which wide bars are broader than narrow bars. This value is supported by the Codabar and Interleaved barcodes

      Further documentation

      Since:
      V4.4
      See Also:
      getBarcodeWideFactor(), CODABAR, INTERLEAVED

    • getFontSize

      int getFontSize()
      Returns the font size of the human readable part

      Further documentation

      Since:
      V4.4
      See Also:
      setFontSize(int)

    • setFontSize

      void setFontSize​(int fontSize)
      Sets the font size of the human readable part

      Further documentation

      Since:
      V4.4
      See Also:
      getFontSize()

    • getFontName

      java.lang.String getFontName()
      Returns the font name of the human readable part

      Further documentation

      Since:
      V4.4
      See Also:
      setFontName(String)

    • setFontName

      void setFontName​(java.lang.String fontName)
      Sets the font name of the human readable part

      Further documentation

      Since:
      V4.4
      See Also:
      getFontSize()

    • getPattern

      java.lang.String getPattern()
      Returns the pattern to be applied over the human readable message

      Further documentation

      Since:
      V4.4
      See Also:
      setPattern(String)

    • setPattern

      void setPattern​(java.lang.String pattern)
      Sets the pattern to be applied over the human readable message

      Further documentation

      Since:
      V4.4
      See Also:
      getPattern()

    • getChecksum

      java.lang.String getChecksum()
      Returns the checksum mode

      This value is supported by the Code 39, EAN 128, Post Net, Royal Mail and Intelligent Mail barcodes

      Further documentation

      Since:
      V4.4
      See Also:
      setChecksum(String), isDisplayChecksum(), CODE39, EAN128, POSTNET, ROYALMAIL, USPS

    • setChecksum

      void setChecksum​(java.lang.String checksum)
      Sets the checksum mode. This can be set to one of:
      Checksum Mode Value Description
      add Adds the necessary checksum to the message to be encoded
      auto Chooses the barcode's default checksum behaviour
      ignore Doesn't check nor add a checksum
      check Requires the check character to be present in the message. This is a digitally generated digit appended to the end of the barcode to ensure the barcode is composed correctly

      This value is supported by the Code 39, EAN 128, Post Net, Royal Mail and Intelligent Mail barcodes

      Further documentation

      Since:
      V4.4
      See Also:
      getChecksum(), isDisplayChecksum(), CODE39, EAN128, POSTNET, ROYALMAIL, USPS

    • isDisplayChecksum

      boolean isDisplayChecksum()
      Returns whether to display the checksum digit at the end of the barcode

      This value is supported by the Code 39, EAN 128, Post Net, Royal Mail and Intelligent Mail barcodes

      Further documentation

      Since:
      V4.4
      See Also:
      setChecksum(String), setDisplayChecksum(boolean), CODE39, EAN128, POSTNET, ROYALMAIL, USPS

    • setDisplayChecksum

      void setDisplayChecksum​(boolean displayChecksum)
      Sets whether to display the checksum digit at the end of the barcode

      This value is supported by the Code 39, EAN 128, Post Net, Royal Mail and Intelligent Mail barcodes

      Further documentation

      Since:
      V4.4
      See Also:
      setChecksum(String), isDisplayChecksum(), CODE39, EAN128, POSTNET, ROYALMAIL, USPS

    • getInterCharGap

      java.lang.String getInterCharGap()
      Returns the width between encoded characters. This should be a double value

      This value is supported by the Code 39, Post Net, Royal Mail and Intelligent Mail barcodes

      Further documentation

      Since:
      V4.4
      See Also:
      setInterCharGap(String), CODE39, POSTNET, ROYALMAIL, USPS

    • setInterCharGap

      void setInterCharGap​(java.lang.String interCharGap)
      Sets the width between encoded characters. This should be a double value

      This value is supported by the Code 39, Post Net, Royal Mail and Intelligent Mail barcodes

      Further documentation

      Since:
      V4.4
      See Also:
      getInterCharGap(), CODE39, POSTNET, ROYALMAIL, USPS

    • isDisplayStartStop

      boolean isDisplayStartStop()
      Indicates whether the start and stop character will be displayed as part of the human-readable message.

      This value is supported by the Code 39 barcode

      Further documentation

      Returns:
      true if leading and trailing "*" will be displayed
      Since:
      V4.4
      See Also:
      setDisplayStartStop(boolean), CODE39

    • setDisplayStartStop

      void setDisplayStartStop​(boolean displayStartStop)
      Sets whether the start and stop character will be displayed as part of the human-readable message.
      Set to true - "*" will be displayed either wide of the barcode

      This value is supported by the Code 39 barcode

      Further documentation

      Since:
      V4.4
      See Also:
      isDisplayStartStop(), CODE39

    • getDataMatrixShape

      java.lang.String getDataMatrixShape()
      Returns the data matrix shape.

      This value is supported by the Datamatrix barcode

      Further documentation

      Returns:
      one of "force-none", "force-square" or "force-rectangle"
      Since:
      V4.4
      See Also:
      setDataMatrixShape(String), DATAMATRIX

    • setDataMatrixShape

      void setDataMatrixShape​(java.lang.String dataMatrixShape)
      Returns the data matrix shape.

      This value is supported by the Datamatrix barcode

      Further documentation

      Value Description
      force-none The human-readable part is suppressed.
      force-square The barcode is displayed as a square.
      force-rectangle The barcode is displayed as a rectangle
      Since:
      V4.4
      See Also:
      getDataMatrixShape(), DATAMATRIX

    • getBaselinePosition

      java.lang.String getBaselinePosition()
      Returns the position of the baseline on the barcode.

      This value is supported by the Postnet barcode

      Further documentation

      Returns:
      one of "top" or "bottom"
      Since:
      V4.4
      See Also:
      setBaselinePosition(String), POSTNET

    • setBaselinePosition

      void setBaselinePosition​(java.lang.String baselinePosition)
      Sets the position of the baseline on the barcode.

      This value is supported by the Postnet barcode

      Further documentation

      Value Description
      top The bar is displayed at the top of the barcode
      bottom The bar is displayed at the bottom of the barcode
      Since:
      V4.4
      See Also:
      setBaselinePosition(String), POSTNET

    • getShortBarHeight

      java.lang.String getShortBarHeight()
      Returns the height of a short bar.

      This value is supported by the Postnet barcode

      Further documentation

      Returns:
      the height of the short bar
      Since:
      V4.4
      See Also:
      setShortBarHeight(String), POSTNET

    • setShortBarHeight

      void setShortBarHeight​(java.lang.String shortBarHeight)
      Sets the height of a short bar.

      This value is supported by the Postnet barcode

      Further documentation

      Since:
      V4.4
      See Also:
      getShortBarHeight(), POSTNET

    • getQuietZoneVertical

      java.lang.String getQuietZoneVertical()
      Returns the vertical quiet zone (gap above and below the barcode)

      This value is supported by the Postnet barcode

      Further documentation

      Since:
      V4.4
      See Also:
      setQuietZoneVertical(String), POSTNET

    • setQuietZoneVertical

      void setQuietZoneVertical​(java.lang.String quietZoneVertical)
      Sets the vertical quiet zone (gap above and below the barcode)

      This value is supported by the Postnet barcode

      Further documentation

      Since:
      V4.4
      See Also:
      getQuietZoneVertical()

    • getMaxRows

      int getMaxRows()
      Returns the maximum number of rows of the barcode

      This value is supported by the PDF417 barcode

      Further documentation

      Since:
      V4.4
      See Also:
      setMaxRows(int), PDF417

    • setMaxRows

      void setMaxRows​(int maxRows)
      Sets the maximum number of rows of the barcode

      This value is supported by the PDF417 barcode

      Further documentation

      Since:
      V4.4
      See Also:
      getMaxRows(), PDF417

    • getMinRows

      int getMinRows()
      Returns the minimum number of rows of the barcode

      This value is supported by the PDF417 barcode

      Further documentation

      Since:
      V4.4
      See Also:
      setMinRows(int), PDF417

    • setMinRows

      void setMinRows​(int minRows)
      Sets the minimum number of rows of the barcode

      This value is supported by the PDF417 barcode

      Further documentation

      Since:
      V4.4
      See Also:
      getMaxRows(), PDF417

    • getMaxCols

      int getMaxCols()
      Returns the maximum number of columns of the barcode

      This value is supported by the PDF417 barcode

      Further documentation

      Since:
      V4.4
      See Also:
      setMaxCols(int), PDF417

    • setMaxCols

      void setMaxCols​(int maxCols)
      Sets the maximum number of columns of the barcode

      This value is supported by the PDF417 barcode

      Further documentation

      Since:
      V4.4
      See Also:
      getMaxCols(), PDF417

    • getMinCols

      int getMinCols()
      Returns the minimum number of columns of the barcode

      This value is supported by the PDF417 barcode

      Further documentation

      Since:
      V4.4
      See Also:
      setMinCols(int), PDF417

    • setMinCols

      void setMinCols​(int minCols)
      Sets the minimum number of columns of the barcode

      This value is supported by the PDF417 barcode

      Further documentation

      Since:
      V4.4
      See Also:
      getMinCols(), PDF417

    • getWidthToHeightRatio

      java.lang.String getWidthToHeightRatio()
      Returns the ratio of the barcode width to the height.

      This value is supported by the PDF417 barcode

      Further documentation

      Since:
      V4.4
      See Also:
      setWidthToHeightRatio(String), PDF417

    • setWidthToHeightRatio

      void setWidthToHeightRatio​(java.lang.String widthToHeightRatio)
      Sets the ratio of the barcode width to the height.

      This value is supported by the PDF417 barcode

      Further documentation

      Since:
      V4.4
      See Also:
      getWidthToHeightRatio(), PDF417

    • getErrorCorrectionLevel

      int getErrorCorrectionLevel()
      Returns the error correction of the barcode

      This value is supported by the PDF417 barcode

      Further documentation

      Since:
      V4.4
      See Also:
      setErrorCorrectionLevel(int), PDF417

    • setErrorCorrectionLevel

      void setErrorCorrectionLevel​(int errorCorrectionLevel)
      Sets the error correction of the barcode

      This value is supported by the PDF417 barcode

      Further documentation

      Since:
      V4.4
      See Also:
      getErrorCorrectionLevel(), PDF417

    • getTemplate

      java.lang.String getTemplate()
      Returns the message template with the fields for the EAN message

      This value is supported by the EAN 128 barcode

      Further documentation

      Since:
      V4.4
      See Also:
      setTemplate(String), EAN128

    • setTemplate

      void setTemplate​(java.lang.String template)
      Sets the message template with the fields for the EAN message

      This value is supported by the EAN 128 barcode

      Further documentation

      Since:
      V4.4
      See Also:
      getTemplate(), EAN128

    • isOmitBrackets

      boolean isOmitBrackets()
      Returns whether to include the brackets in the human readable part of the message

      This value is supported by the EAN 128 barcode

      Further documentation

      Since:
      V4.4
      See Also:
      setOmitBrackets(boolean), EAN128

    • setOmitBrackets

      void setOmitBrackets​(boolean omitBrackets)
      Sets whether to include the brackets in the human readable part of the message

      This value is supported by the EAN 128 barcode

      Further documentation

      Since:
      V4.4
      See Also:
      isOmitBrackets(), EAN128

    • getTrackheight

      java.lang.String getTrackheight()
      Returns the height of the track

      This value is supported by the Royal Mail and Intelligent mail barcode

      Further documentation

      Since:
      V4.4
      See Also:
      setTrackheight(String), ROYALMAIL, USPS

    • setTrackheight

      void setTrackheight​(java.lang.String trackheight)
      Sets the height of the track

      This value is supported by the Royal Mail and Intelligent mail barcode

      Further documentation

      Since:
      V4.4
      See Also:
      getTrackheight(), ROYALMAIL, USPS

    • getAscenderHeight

      java.lang.String getAscenderHeight()
      Returns the height of the ascender/descender.

      This value is supported by the Royal Mail and Intelligent mail barcode

      Further documentation

      Since:
      V4.4
      See Also:
      setTrackheight(String), ROYALMAIL, USPS

    • setAscenderHeight

      void setAscenderHeight​(java.lang.String ascenderHeight)
      Sets the height of the ascender/descender.

      This value is supported by the Royal Mail and Intelligent mail barcode

      Further documentation

      Since:
      V4.4
      See Also:
      setTrackheight(String), ROYALMAIL, USPS

    • getAlternativeText

      Text getAlternativeText()
      Returns the Text object for the barcode alternate text; <barcode-name> barcode is returned if a value is not entered. e.g Codabar barcode

      Accessibility Note: an alternate text is required for all images.

      Further documentation

      Since:
      V5.10

    • getMouseOverText

      Text getMouseOverText()
      Returns the Text object for the mouse over text.

      Further documentation

      Since:
      V5.10