Package com.itextpdf.barcodes
Class BarcodeMSI
java.lang.Object
com.itextpdf.barcodes.Barcode1D
com.itextpdf.barcodes.BarcodeMSI
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
FieldsModifier and TypeFieldDescriptionprivate static final byte[][]
The bars to generate the code.private static final byte[]
The sequence appended to the end of all MSI Barcodes.private static final int
The number of individual bars either drawn or not drawn for the start character in the BarcodeMSI.private static final int
The number of individual bars either drawn or not drawn for the stop character in the BarcodeMSI.private static final int
The number of individual bars either drawn or not drawn per character of thecode
private static final byte[]
The sequence prepended to the start of all MSI Barcodes.private static final String
The index chars toBARS
representing valid characters in thecode
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
ConstructorsConstructorDescriptionBarcodeMSI
(PdfDocument document) Creates a new BarcodeMSI.BarcodeMSI
(PdfDocument document, PdfFont font) Creates a new BarcodeMSI -
Method Summary
Modifier and TypeMethodDescriptioncreateAwtImage
(Color foreground, Color background) Creates ajava.awt.Image
.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.placeBarcode
(PdfCanvas canvas, Color barColor, Color textColor) Places the barcode in aPdfCanvas
.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
-
Field Details
-
CHARS
The index chars toBARS
representing valid characters in thecode
- See Also:
-
BARS_START
private static final byte[] BARS_STARTThe sequence prepended to the start of all MSI Barcodes. -
BARS_END
private static final byte[] BARS_ENDThe sequence appended to the end of all MSI Barcodes. -
BARS
private static final byte[][] BARSThe bars to generate the code. -
BARS_PER_CHARACTER
private static final int BARS_PER_CHARACTERThe number of individual bars either drawn or not drawn per character of thecode
- See Also:
-
BARS_FOR_START
private static final int BARS_FOR_STARTThe number of individual bars either drawn or not drawn for the start character in the BarcodeMSI.- See Also:
-
BARS_FOR_STOP
private static final int BARS_FOR_STOPThe number of individual bars either drawn or not drawn for the stop character in the BarcodeMSI.- See Also:
-
-
Constructor Details
-
BarcodeMSI
Creates a new BarcodeMSI. To generate the font thePdfDocument.getDefaultFont()
will be implicitly called. If you want to use this barcode in PDF/A documents, please consider usingBarcodeMSI(PdfDocument, PdfFont)
.- Parameters:
document
- The document to which the barcode will be added
-
BarcodeMSI
Creates a new BarcodeMSI- Parameters:
document
- The document to which the barcode will be addedfont
- The font to use
-
-
Method Details
-
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 classBarcode1D
- Returns:
- the size the barcode occupies.
-
placeBarcode
Places the barcode in aPdfCanvas
. 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 withtextColor
barColor
textColor
bars painted with barColor
text painted withtextColor
- Specified by:
placeBarcode
in classBarcode1D
- Parameters:
canvas
- thePdfCanvas
where the barcode will be placedbarColor
- the color of the bars. It can benull
textColor
- the color of the text. It can benull
- Returns:
- the dimensions the barcode occupies
-
createAwtImage
Creates ajava.awt.Image
. This image only contains the bars without any text.- Specified by:
createAwtImage
in classBarcode1D
- Parameters:
foreground
- the color of the barsbackground
- the color of the background- Returns:
- the image
-
getBarsMSI
Creates the bars.- Parameters:
text
- the text to create the bars.- Returns:
- the bars
-
getChecksum
Calculates the mod 10 checksum digit using the Luhn algorithm.- Parameters:
text
- the barcode data- Returns:
- the checksum digit
-