barcode4j 2.1.0

org.krysalis.barcode4j.impl.int2of5
Class Interleaved2Of5Bean

java.lang.Object
  extended by org.krysalis.barcode4j.impl.AbstractBarcodeBean
      extended by org.krysalis.barcode4j.impl.int2of5.Interleaved2Of5Bean
All Implemented Interfaces:
BarcodeGenerator
Direct Known Subclasses:
ITF14Bean

public class Interleaved2Of5Bean
extends AbstractBarcodeBean

This class is an implementation of the Interleaved 2 of 5 barcode.

Version:
$Id: Interleaved2Of5Bean.java,v 1.5 2008/05/13 13:00:46 jmaerki Exp $
Author:
Jeremias Maerki

Field Summary
protected static double DEFAULT_MODULE_WIDTH
          The default module width for Interleaved 2 of 5.
static double DEFAULT_WIDE_FACTOR
          The default wide factor for Interleaved 2 of 5.
 
Fields inherited from class org.krysalis.barcode4j.impl.AbstractBarcodeBean
doQuietZone, fontName, fontSize, height, moduleWidth, msgPos, pattern, quietZone, quietZoneVertical
 
Constructor Summary
Interleaved2Of5Bean()
          Create a new instance.
 
Method Summary
 BarcodeDimension calcDimensions(java.lang.String msg)
          Calculates the dimension of a barcode with the given message.
 void generateBarcode(CanvasProvider canvas, java.lang.String msg)
          Generates a barcode using the given Canvas to render the barcode to its output format.
 double getBarWidth(int width)
          Returns the effective width of a bar with a given logical width.
 ChecksumMode getChecksumMode()
          Returns the current checksum mode.
 double getWideFactor()
          Returns the factor by which wide bars are broader than narrow bars.
 boolean isDisplayChecksum()
          Indicates whether the checksum will be displayed as part of the human-readable message.
 void setChecksumMode(ChecksumMode mode)
          Sets the checksum mode
 void setDisplayChecksum(boolean value)
          Enables or disables the use of the checksum in the human-readable message.
 void setWideFactor(double value)
          Sets the factor by which wide bars are broader than narrow bars.
 
Methods inherited from class org.krysalis.barcode4j.impl.AbstractBarcodeBean
doQuietZone, getBarHeight, getFontName, getFontSize, getHeight, getHumanReadableHeight, getModuleWidth, getMsgPosition, getPattern, getQuietZone, getVerticalQuietZone, hasFontDescender, hasQuietZone, setBarHeight, setFontName, setFontSize, setHeight, setModuleWidth, setMsgPosition, setPattern, setQuietZone, setVerticalQuietZone
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_MODULE_WIDTH

protected static final double DEFAULT_MODULE_WIDTH
The default module width for Interleaved 2 of 5.

See Also:
Constant Field Values

DEFAULT_WIDE_FACTOR

public static final double DEFAULT_WIDE_FACTOR
The default wide factor for Interleaved 2 of 5.

See Also:
Constant Field Values
Constructor Detail

Interleaved2Of5Bean

public Interleaved2Of5Bean()
Create a new instance.

Method Detail

isDisplayChecksum

public boolean isDisplayChecksum()
Indicates whether the checksum will be displayed as part of the human-readable message.

Returns:
true if checksum will be included in the human-readable message

setDisplayChecksum

public void setDisplayChecksum(boolean value)
Enables or disables the use of the checksum in the human-readable message.

Parameters:
value - true to include the checksum in the human-readable message, false to ignore

generateBarcode

public void generateBarcode(CanvasProvider canvas,
                            java.lang.String msg)
Description copied from class: AbstractBarcodeBean
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
See Also:
BarcodeGenerator.generateBarcode(CanvasProvider, String)

calcDimensions

public BarcodeDimension calcDimensions(java.lang.String msg)
Description copied from class: AbstractBarcodeBean
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
See Also:
BarcodeGenerator.calcDimensions(String)

getBarWidth

public double getBarWidth(int width)
Description copied from class: AbstractBarcodeBean
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)
See Also:
AbstractBarcodeBean.getBarWidth(int)

setChecksumMode

public void setChecksumMode(ChecksumMode mode)
Sets the checksum mode

Parameters:
mode - the checksum mode

getChecksumMode

public ChecksumMode getChecksumMode()
Returns the current checksum mode.

Returns:
ChecksumMode the checksum mode

getWideFactor

public double getWideFactor()
Returns the factor by which wide bars are broader than narrow bars.

Returns:
the wide factor

setWideFactor

public void setWideFactor(double value)
Sets the factor by which wide bars are broader than narrow bars.

Parameters:
value - the wide factory (should be > 1.0)

barcode4j 2.1.0

Copyright © 2000-2010 Jeremias Maerki. All rights reserved.