Package com.itextpdf.barcodes
Class BarcodeEAN
java.lang.Object
com.itextpdf.barcodes.Barcode1D
com.itextpdf.barcodes.BarcodeEAN
The implementation of the barcode EAN.
The International Article Number (also known as European Article Number or EAN) is a standard describing a barcode symbology and numbering system used in global trade to identify a specific retail product type, in a specific packaging configuration, from a specific manufacturer
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final byte[][]
The basic bar widths.static final int
A type of barcodestatic final int
A type of barcodeprivate static final int
Marker for even parity.private static final int[]
The bar positions that are guard bars.private static final int[]
The bar positions that are guard bars.private static final int[]
The bar positions that are guard bars.private static final int[]
The bar positions that are guard bars.private static final int[]
The bar positions that are guard bars.private static final int
Marker for odd parity.private static final byte[][]
Sequence of parities to be used with EAN13.private static final byte[][]
Sequence of parities to be used with supplemental 2.private static final byte[][]
Sequence of parities to be used with supplemental 2.private static final byte[][]
Sequence of parities to be used with UPCE.static final int
A type of barcodestatic final int
A type of barcodeprivate static final float[]
The x coordinates to place the text.private static final float[]
The x coordinates to place the text.private static final int
The total number of bars for EAN13.private static final int
The total number of bars for EAN8.private static final int
The total number of bars for supplemental 2.private static final int
The total number of bars for supplemental 5.private static final int
The total number of bars for UPCE.static final int
A type of barcodestatic final int
A type of barcodeFields 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
ConstructorsConstructorDescriptionBarcodeEAN
(PdfDocument document) Creates new BarcodeEAN.BarcodeEAN
(PdfDocument document, PdfFont font) Creates new BarcodeEAN -
Method Summary
Modifier and TypeMethodDescriptionstatic int
calculateEANParity
(String code) Calculates the EAN parity character.static String
convertUPCAtoUPCE
(String text) Converts an UPCA code into an UPCE code.createAwtImage
(Color foreground, Color background) Creates ajava.awt.Image
.Gets the maximum area that the barcode and the text, if any, will occupy.static byte[]
getBarsEAN13
(String _code) Creates the bars for the barcode EAN13 and UPCA.static byte[]
getBarsEAN8
(String _code) Creates the bars for the barcode EAN8.static byte[]
getBarsSupplemental2
(String _code) Creates the bars for the barcode supplemental 2.static byte[]
getBarsSupplemental5
(String _code) Creates the bars for the barcode supplemental 5.static byte[]
getBarsUPCE
(String _code) Creates the bars for the barcode UPCE.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
-
EAN13
public static final int EAN13A type of barcode- See Also:
-
EAN8
public static final int EAN8A type of barcode- See Also:
-
UPCA
public static final int UPCAA type of barcode- See Also:
-
UPCE
public static final int UPCEA type of barcode- See Also:
-
SUPP2
public static final int SUPP2A type of barcode- See Also:
-
SUPP5
public static final int SUPP5A type of barcode- See Also:
-
GUARD_EMPTY
private static final int[] GUARD_EMPTYThe bar positions that are guard bars. -
GUARD_UPCA
private static final int[] GUARD_UPCAThe bar positions that are guard bars. -
GUARD_EAN13
private static final int[] GUARD_EAN13The bar positions that are guard bars. -
GUARD_EAN8
private static final int[] GUARD_EAN8The bar positions that are guard bars. -
GUARD_UPCE
private static final int[] GUARD_UPCEThe bar positions that are guard bars. -
TEXTPOS_EAN13
private static final float[] TEXTPOS_EAN13The x coordinates to place the text. -
TEXTPOS_EAN8
private static final float[] TEXTPOS_EAN8The x coordinates to place the text. -
BARS
private static final byte[][] BARSThe basic bar widths. -
TOTALBARS_EAN13
private static final int TOTALBARS_EAN13The total number of bars for EAN13.- See Also:
-
TOTALBARS_EAN8
private static final int TOTALBARS_EAN8The total number of bars for EAN8.- See Also:
-
TOTALBARS_UPCE
private static final int TOTALBARS_UPCEThe total number of bars for UPCE.- See Also:
-
TOTALBARS_SUPP2
private static final int TOTALBARS_SUPP2The total number of bars for supplemental 2.- See Also:
-
TOTALBARS_SUPP5
private static final int TOTALBARS_SUPP5The total number of bars for supplemental 5.- See Also:
-
ODD
private static final int ODDMarker for odd parity.- See Also:
-
EVEN
private static final int EVENMarker for even parity.- See Also:
-
PARITY13
private static final byte[][] PARITY13Sequence of parities to be used with EAN13. -
PARITY2
private static final byte[][] PARITY2Sequence of parities to be used with supplemental 2. -
PARITY5
private static final byte[][] PARITY5Sequence of parities to be used with supplemental 2. -
PARITYE
private static final byte[][] PARITYESequence of parities to be used with UPCE.
-
-
Constructor Details
-
BarcodeEAN
Creates new BarcodeEAN. To generate the font thePdfDocument.getDefaultFont()
will be implicitly called. If you want to use this barcode in PDF/A documents, please consider usingBarcodeEAN(PdfDocument, PdfFont)
.- Parameters:
document
- The document to which the barcode will be added
-
BarcodeEAN
Creates new BarcodeEAN- Parameters:
document
- The document to which the barcode will be addedfont
- The font to use
-
-
Method Details
-
calculateEANParity
Calculates the EAN parity character.- Parameters:
code
- the code- Returns:
- the parity character
-
convertUPCAtoUPCE
Converts an UPCA code into an UPCE code. If the code can not be converted anull
is returned.- Parameters:
text
- the code to convert. It must have 12 numeric characters- Returns:
- the 8 converted digits or
null
if the code could not be converted
-
getBarsEAN13
Creates the bars for the barcode EAN13 and UPCA.- Parameters:
_code
- the text with 13 digits- Returns:
- the barcode
-
getBarsEAN8
Creates the bars for the barcode EAN8.- Parameters:
_code
- the text with 8 digits- Returns:
- the barcode
-
getBarsUPCE
Creates the bars for the barcode UPCE.- Parameters:
_code
- the text with 8 digits- Returns:
- the barcode
-
getBarsSupplemental2
Creates the bars for the barcode supplemental 2.- Parameters:
_code
- the text with 2 digits- Returns:
- the barcode
-
getBarsSupplemental5
Creates the bars for the barcode supplemental 5.- Parameters:
_code
- the text with 5 digits- Returns:
- the barcode
-
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
-