org.krysalis.barcode4j.impl.codabar

Class CodabarBean

java.lang.Object

org.krysalis.barcode4j.impl.AbstractBarcodeBean

org.krysalis.barcode4j.impl.codabar.CodabarBean

All Implemented Interfaces:

BarcodeGenerator

public class CodabarBean
extends AbstractBarcodeBean

This class is an implementation of the Codabar barcode.

Version:

$Id: CodabarBean.java,v 1.7 2008-11-22 09:57:10 jmaerki Exp $

Author:

Jeremias Maerki

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	DEFAULT_DISPLAY_START_STOP The default display start/stop value for Codabar.
protected static double	DEFAULT_MODULE_WIDTH The default module width for Codabar.
protected static double	DEFAULT_WIDE_FACTOR The default wide factor for Codabar.

Fields inherited from class org.krysalis.barcode4j.impl.AbstractBarcodeBean

doQuietZone, fontName, fontSize, height, moduleWidth, msgPos, pattern, quietZone, quietZoneVertical

Constructor Summary

Constructors

Constructor and Description
CodabarBean() Create a new instance.

Method Summary

Modifier and Type	Method and Description
BarcodeDimension	calcDimensions(String msg) Calculates the dimension of a barcode with the given message.
void	generateBarcode(CanvasProvider canvas, 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	isDisplayStartStop() Indicates whether the start and stop character will be displayed as part of the human-readable message.
void	setChecksumMode(ChecksumMode mode) Sets the checksum mode
void	setDisplayStartStop(boolean value) Enables or disables the use of the start and stop characters 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 Codabar.

See Also:

Constant Field Values

DEFAULT_WIDE_FACTOR

protected static final double DEFAULT_WIDE_FACTOR

The default wide factor for Codabar.

See Also:

Constant Field Values

DEFAULT_DISPLAY_START_STOP

protected static final boolean DEFAULT_DISPLAY_START_STOP

The default display start/stop value for Codabar.

See Also:

Constant Field Values

Constructor Detail

CodabarBean

public CodabarBean()

Create a new instance.

Method Detail

getChecksumMode

public ChecksumMode getChecksumMode()

Returns the current checksum mode.

Returns:

ChecksumMode the checksum mode

setChecksumMode

public void setChecksumMode(ChecksumMode mode)

Sets the checksum mode

Parameters:

mode - 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)

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)

isDisplayStartStop

public boolean isDisplayStartStop()

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

Returns:

true if leading and trailing "*" will be displayed

setDisplayStartStop

public void setDisplayStartStop(boolean value)

Enables or disables the use of the start and stop characters in the human-readable message.

Parameters:

value - true to enable the start/stop character, false to disable

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