Package org.krysalis.barcode4j.impl.datamatrix

Class DataMatrixBean

java.lang.Object
org.krysalis.barcode4j.impl.AbstractBarcodeBean
org.krysalis.barcode4j.impl.datamatrix.DataMatrixBean
All Implemented Interfaces:
BarcodeGenerator
public class DataMatrixBean extends AbstractBarcodeBean
This class is an implementation of DataMatrix (ISO 16022:2000(E)).
Version:
$Id: DataMatrixBean.java,v 1.8 2011-05-04 08:29:03 jmaerki Exp $

  • Field Details

    • DEFAULT_MODULE_WIDTH

      protected static final double DEFAULT_MODULE_WIDTH
      The default module width (dot size) for DataMatrix.

  • Constructor Details

    • DataMatrixBean

      public DataMatrixBean()
      Create a new instance.

  • Method Details

    • getShape

      public SymbolShapeHint getShape()
      Gets the requested shape for the generated barcodes.
      Returns:
      the requested shape (one of SymbolShapeHint.*).

    • setShape

      public void setShape(SymbolShapeHint shape)
      Sets the requested shape for the generated barcodes.
      Parameters:
      shape - requested shape. May be SymbolShapeHint.FORCE_NONE, SymbolShapeHint.FORCE_SQUARE or SymbolShapeHint.FORCE_RECTANGLE.

    • getMinSize

      public Dimension getMinSize()
      Returns the minimum symbol size that is to be produced. If the method returns null, there's no constraint on the symbol size.
      Returns:
      the minimum symbol size (in pixels), or null if there's no size constraint

    • setMinSize

      public void setMinSize(Dimension minSize)
      Sets the minimum symbol size that is to be produced.
      Parameters:
      minSize - the minimum size (in pixels), or null for no constraint

    • getMaxSize

      public Dimension getMaxSize()
      Returns the maximum symbol size that is to be produced. If the method returns null, there's no constraint on the symbol size.
      Returns:
      the maximum symbol size (in pixels), or null if there's no size constraint

    • setMaxSize

      public void setMaxSize(Dimension maxSize)
      Sets the maximum symbol size that is to be produced.
      Parameters:
      maxSize - the maximum size (in pixels), or null for no constraint

    • getBarHeight

      public double getBarHeight()
      Returns the height of the bars.
      Overrides:
      getBarHeight in class AbstractBarcodeBean
      Returns:
      the height of the bars (in mm)

    • getBarWidth

      public double getBarWidth(int width)
      Returns the effective width of a bar with a given logical width.
      Specified by:
      getBarWidth in class AbstractBarcodeBean
      Parameters:
      width - the logical width (1=narrow, 2=wide)
      Returns:
      the effective width of a bar (in mm)

    • getVerticalQuietZone

      public double getVerticalQuietZone()
      Returns the vertical quiet zone. If no vertical quiet zone is set explicitely, the value if AbstractBarcodeBean.getQuietZone() is returned.
      Overrides:
      getVerticalQuietZone in class AbstractBarcodeBean
      Returns:
      the height of the vertical quiet zone (in mm)

    • generateBarcode

      public void generateBarcode(CanvasProvider canvas, String msg)
      Generates a barcode using the given Canvas to render the barcode to its output format.
      Specified by:
      generateBarcode in interface BarcodeGenerator
      Specified by:
      generateBarcode in class AbstractBarcodeBean
      Parameters:
      canvas - CanvasProvider that the barcode is to be rendered on.
      msg - message to encode

    • calcDimensions

      public BarcodeDimension calcDimensions(String msg)
      Calculates the dimension of a barcode with the given message. The dimensions are dependant on the configuration of the barcode generator.
      Specified by:
      calcDimensions in interface BarcodeGenerator
      Overrides:
      calcDimensions in class AbstractBarcodeBean
      Parameters:
      msg - message to use for calculation.
      Returns:
      BarcodeDimension a BarcodeDimension object containing the barcode's dimensions