barcode4j 2.1.0

org.krysalis.barcode4j.impl.code128
Class Code128Bean

java.lang.Object
  extended by org.krysalis.barcode4j.impl.AbstractBarcodeBean
      extended by org.krysalis.barcode4j.impl.code128.Code128Bean
All Implemented Interfaces:
BarcodeGenerator
Direct Known Subclasses:
EAN128Bean

public class Code128Bean
extends AbstractBarcodeBean

This class is an implementation of the Code 128 barcode.

Version:
$Id: Code128Bean.java,v 1.9 2009/02/18 16:09:04 jmaerki Exp $

Field Summary
protected static int DEFAULT_CODESET
          Default codeset.
protected static double DEFAULT_MODULE_WIDTH
          The default module width for Code 128.
 
Fields inherited from class org.krysalis.barcode4j.impl.AbstractBarcodeBean
doQuietZone, fontName, fontSize, height, moduleWidth, msgPos, pattern, quietZone, quietZoneVertical
 
Constructor Summary
Code128Bean()
          Create a new instance.
 
Method Summary
 BarcodeDimension calcDimensions(java.lang.String msg)
          Calculates the dimension of a barcode with the given message. The dimensions are dependant on the configuration of the barcode generator.
 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.
 int getCodeset()
          Returns the codeset to be used.
protected  boolean hasFontDescender()
          Indicates whether the barcode height calculation should take a font descender into account.
 void setCodeset(int codeset)
          Sets the codesets to use.
 
Methods inherited from class org.krysalis.barcode4j.impl.AbstractBarcodeBean
doQuietZone, getBarHeight, getFontName, getFontSize, getHeight, getHumanReadableHeight, getModuleWidth, getMsgPosition, getPattern, getQuietZone, getVerticalQuietZone, 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 Code 128.

See Also:
Constant Field Values

DEFAULT_CODESET

protected static final int DEFAULT_CODESET
Default codeset.

See Also:
Constant Field Values
Constructor Detail

Code128Bean

public Code128Bean()
Create a new instance.

Method Detail

setCodeset

public void setCodeset(int codeset)
Sets the codesets to use. This can be used to restrict the Code 128 codesets if an application requires that.

Parameters:
codeset - the codesets to use (see Code128Constants.CODESET_*)

getCodeset

public int getCodeset()
Returns the codeset to be used.

Returns:
the codeset (see Code128Constants.CODESET_*)

hasFontDescender

protected boolean hasFontDescender()
Indicates whether the barcode height calculation should take a font descender into account. This is necessary for barcodes that support lower-case characters like Code128.

Overrides:
hasFontDescender in class AbstractBarcodeBean
Returns:
true if the implementation has to take font descenders into account

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)

calcDimensions

public BarcodeDimension calcDimensions(java.lang.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

generateBarcode

public void generateBarcode(CanvasProvider canvas,
                            java.lang.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

barcode4j 2.1.0

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