Package com.itextpdf.barcodes

Class BarcodeMSI

java.lang.Object

com.itextpdf.barcodes.Barcode1D

com.itextpdf.barcodes.BarcodeMSI

       public class BarcodeMSI extends Barcode1D
      

Implements the MSI Barcode. The code may only contain numeric characters. The getChecksum method returns the mod 10 checksum digit which is the most widely used for MSI barcodes.

Field Summary

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	Description
BarcodeMSI(PdfDocument document)	Creates a new BarcodeMSI.
BarcodeMSI(PdfDocument document, PdfFont font)	Creates a new BarcodeMSI

Method Summary

Modifier and Type	Method	Description
Image	createAwtImage(Color foreground, Color background)	Creates a java.awt.Image.
Rectangle	getBarcodeSize()	Gets the maximum area that the barcode and the text, if any, will occupy.
static byte[]	getBarsMSI(String text)	Creates the bars.
static int	getChecksum(String text)	Calculates the mod 10 checksum digit using the Luhn algorithm.
Rectangle	placeBarcode(PdfCanvas canvas, Color barColor, Color textColor)	Places the barcode in a PdfCanvas.

Methods inherited from class com.itextpdf.barcodes.Barcode1D

createFormXObject, createFormXObject, fitWidth, 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

Constructor Details

BarcodeMSI

             public BarcodeMSI
             (PdfDocument document)
            

Creates a new BarcodeMSI. To generate the font the PdfDocument.getDefaultFont() will be implicitly called. If you want to use this barcode in PDF/A documents, please consider using BarcodeMSI(PdfDocument, PdfFont).

Parameters:

document - The document to which the barcode will be added

BarcodeMSI

             public BarcodeMSI
             (PdfDocument document, PdfFont font)
            

Creates a new BarcodeMSI

Parameters:

document - The document to which the barcode will be added

font - The font to use

Method Details

getBarcodeSize

             public Rectangle getBarcodeSize()
            

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.

placeBarcode

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

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)
            

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

background - the color of the background

Returns:

the image

getBarsMSI

             public static byte[] getBarsMSI
             (String text)
            

Creates the bars.

Parameters:

text - the text to create the bars.

Returns:

the bars

getChecksum

             public static int getChecksum
             (String text)
            

Calculates the mod 10 checksum digit using the Luhn algorithm.

Parameters:

text - the barcode data

Returns:

the checksum digit