Class Code39Bean
java.lang.Object
org.krysalis.barcode4j.impl.AbstractBarcodeBean
org.krysalis.barcode4j.impl.code39.Code39Bean
- All Implemented Interfaces:
BarcodeGenerator
This class is an implementation of the Code39 barcode.
- Version:
- $Id: Code39Bean.java,v 1.9 2009-02-20 09:33:43 jmaerki Exp $
- Author:
- Jeremias Maerki
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final doubleThe default module width for Code 39.protected static final doubleThe default wide factor for Code 39Fields inherited from class org.krysalis.barcode4j.impl.AbstractBarcodeBean
doQuietZone, fontName, fontSize, height, moduleWidth, msgPos, pattern, quietZone, quietZoneVertical -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncalcDimensions(String msg) Calculates the dimension of a barcode with the given message.voidgenerateBarcode(CanvasProvider canvas, String msg) Generates a barcode using the given Canvas to render the barcode to its output format.doublegetBarWidth(int width) Returns the effective width of a bar with a given logical width.Returns the current checksum mode.doubleReturns the width between encoded characters.doubleReturns the factor by which wide bars are broader than narrow bars.booleanIndicates whether the checksum will be displayed as part of the human-readable message.booleanIndicates whether the start and stop character will be displayed as part of the human-readable message.booleanIndicates whether the extended character set is enabled.voidsetChecksumMode(ChecksumMode mode) Sets the checksum modevoidsetDisplayChecksum(boolean value) Enables or disables the use of the checksum in the human-readable message.voidsetDisplayStartStop(boolean value) Enables or disables the use of the start and stop characters in the human-readable message.voidsetExtendedCharSetEnabled(boolean value) Enables or disables the extended character set.voidsetIntercharGapWidth(double width) Sets the width between encoded characters.voidsetWideFactor(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
-
Field Details
-
DEFAULT_MODULE_WIDTH
protected static final double DEFAULT_MODULE_WIDTHThe default module width for Code 39.- See Also:
-
DEFAULT_WIDE_FACTOR
protected static final double DEFAULT_WIDE_FACTORThe default wide factor for Code 39- See Also:
-
-
Constructor Details
-
Code39Bean
public Code39Bean()Create a new instance.
-
-
Method Details
-
getChecksumMode
Returns the current checksum mode.- Returns:
- ChecksumMode the checksum mode
-
setChecksumMode
Sets the checksum mode- Parameters:
mode- the checksum mode
-
getIntercharGapWidth
public double getIntercharGapWidth()Returns the width between encoded characters.- Returns:
- the interchar gap width
-
setIntercharGapWidth
public void setIntercharGapWidth(double width) Sets the width between encoded characters.- Parameters:
width- the interchar gap width
-
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)
-
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
-
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
-
isExtendedCharSetEnabled
public boolean isExtendedCharSetEnabled()Indicates whether the extended character set is enabled.- Returns:
- true if the extended character set is enabled
-
setExtendedCharSetEnabled
public void setExtendedCharSetEnabled(boolean value) Enables or disables the extended character set. The extended character set enables the whole ASCII 7-bit character set for Code39.- Parameters:
value- true to enable the extended character set
-
getBarWidth
public double getBarWidth(int width) Returns the effective width of a bar with a given logical width.- Specified by:
getBarWidthin classAbstractBarcodeBean- Parameters:
width- the logical width (1=narrow, 2=wide)- Returns:
- the effective width of a bar (in mm)
-
generateBarcode
Generates a barcode using the given Canvas to render the barcode to its output format.- Specified by:
generateBarcodein interfaceBarcodeGenerator- Specified by:
generateBarcodein classAbstractBarcodeBean- Parameters:
canvas- CanvasProvider that the barcode is to be rendered on.msg- message to encode
-
calcDimensions
Calculates the dimension of a barcode with the given message. The dimensions are dependant on the configuration of the barcode generator.- Specified by:
calcDimensionsin interfaceBarcodeGenerator- Overrides:
calcDimensionsin classAbstractBarcodeBean- Parameters:
msg- message to use for calculation.- Returns:
- BarcodeDimension a BarcodeDimension object containing the barcode's dimensions
-