com.itextpdf.barcodes

Class BarcodePostnet

java.lang.Object

com.itextpdf.barcodes.Barcode1D

com.itextpdf.barcodes.BarcodePostnet

public class BarcodePostnet
extends Barcode1D

POSTNET (Postal Numeric Encoding Technique) is a barcode symbology used by the United States Postal Service to assist in directing mail. The ZIP Code or ZIP+4 code is encoded in half- and full-height bars.[1] Most often, the delivery point is added, usually being the last two digits of the address or PO box number.

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPE_PLANET
static int	TYPE_POSTNET

Fields inherited from class com.itextpdf.barcodes.Barcode1D

ALIGN_CENTER, ALIGN_LEFT, ALIGN_RIGHT, altText, barHeight, baseline, checksumText, code, codeType, DEFAULT_BAR_BACKGROUND_COLOR, DEFAULT_BAR_FOREGROUND_COLOR, document, extended, font, generateChecksum, guardBars, inkSpreading, n, size, startStopText, textAlignment, x

Constructor Summary

Constructors

Constructor and Description
BarcodePostnet(PdfDocument document) Creates new BarcodePostnet instance.

Method Summary

Modifier and Type	Method and Description
Image	createAwtImage(Color foreground, Color background) Creates a java.awt.Image.
void	fitWidth(float width) Make the barcode occupy the specified width.
Rectangle	getBarcodeSize() Gets the maximum area that the barcode and the text, if any, will occupy.
static byte[]	getBarsPostnet(String text) Creates the bars for Postnet.
Rectangle	placeBarcode(PdfCanvas canvas, Color barColor, Color textColor) Places the barcode in a PdfCanvas.

Methods inherited from class com.itextpdf.barcodes.Barcode1D

createFormXObject, createFormXObject, getAltText, getBarHeight, getBaseline, getCode, getCodeType, getDescender, getFont, getInkSpreading, getN, getSize, getTextAlignment, getX, isChecksumText, isExtended, isGenerateChecksum, isGuardBars, isStartStopText, setAltText, setBarHeight, setBaseline, setChecksumText, setCode, setCodeType, setExtended, setFont, setGenerateChecksum, setGuardBars, setInkSpreading, setN, setSize, setStartStopText, setTextAlignment, setX

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE_POSTNET

public static final int TYPE_POSTNET

See Also:

Constant Field Values

TYPE_PLANET

public static final int TYPE_PLANET

See Also:

Constant Field Values

Constructor Detail

BarcodePostnet

public BarcodePostnet(PdfDocument document)

Creates new BarcodePostnet instance.

Parameters:

document - The document

Method Detail

getBarsPostnet

public static byte[] getBarsPostnet(String text)

Creates the bars for Postnet.

Parameters:

text - the code to be created without checksum

Returns:

the bars

getBarcodeSize

public Rectangle getBarcodeSize()

Description copied from class: Barcode1D

Gets the maximum area that the barcode and the text, if any, will occupy. The lower left corner is always (0, 0).

Specified by:

getBarcodeSize in class Barcode1D

Returns:

the size the barcode occupies.

fitWidth

public void fitWidth(float width)

Description copied from class: Barcode1D

Make the barcode occupy the specified width. Usually this is achieved by adjusting bar widths.

Overrides:

fitWidth in class Barcode1D

Parameters:

width - The width

placeBarcode

public Rectangle placeBarcode(PdfCanvas canvas,
                              Color barColor,
                              Color textColor)

Description copied from class: Barcode1D

Places the barcode in a PdfCanvas. The barcode is always placed at coordinates (0, 0). Use the translation matrix to move it elsewhere.

The bars and text are written in the following colors:

barColor	textColor	Result
null	null	bars and text painted with current fill color
barColor	null	bars and text painted with barColor
null	textColor	bars painted with current color text painted with textColor
barColor	textColor	bars painted with barColor text painted with textColor

Specified by:

placeBarcode in class Barcode1D

Parameters:

canvas - the PdfCanvas where the barcode will be placed

barColor - the color of the bars. It can be null

textColor - the color of the text. It can be null

Returns:

the dimensions the barcode occupies

createAwtImage

public Image createAwtImage(Color foreground,
                            Color background)

Description copied from class: Barcode1D

Creates a java.awt.Image. This image only contains the bars without any text.

Specified by:

createAwtImage in class Barcode1D

Parameters:

foreground - the color of the bars. If null defaults to Barcode1D.DEFAULT_BAR_FOREGROUND_COLOR

background - the color of the background. If null defaults to Barcode1D.DEFAULT_BAR_BACKGROUND_COLOR

Returns:

the image