com.itextpdf.text.pdf.BarcodeEAN Maven / Gradle / Ivy
/*
*
* This file is part of the iText (R) project.
* Copyright (c) 1998-2016 iText Group NV
* Authors: Bruno Lowagie, Paulo Soares, et al.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License version 3
* as published by the Free Software Foundation with the addition of the
* following permission added to Section 15 as permitted in Section 7(a):
* FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
* ITEXT GROUP. ITEXT GROUP DISCLAIMS THE WARRANTY OF NON INFRINGEMENT
* OF THIRD PARTY RIGHTS
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU Affero General Public License for more details.
* You should have received a copy of the GNU Affero General Public License
* along with this program; if not, see http://www.gnu.org/licenses or write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA, 02110-1301 USA, or download the license from the following URL:
* http://itextpdf.com/terms-of-use/
*
* The interactive user interfaces in modified source and object code versions
* of this program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU Affero General Public License.
*
* In accordance with Section 7(b) of the GNU Affero General Public License,
* a covered work must retain the producer line in every PDF that is created
* or manipulated using iText.
*
* You can be released from the requirements of the license by purchasing
* a commercial license. Buying such a license is mandatory as soon as you
* develop commercial activities involving the iText software without
* disclosing the source code of your own applications.
* These activities include: offering paid services to customers as an ASP,
* serving PDFs on the fly in a web application, shipping iText with a closed
* source product.
*
* For more information, please contact iText Software Corp. at this
* address: [email protected]
*/
package com.itextpdf.text.pdf;
import java.util.Arrays;
import com.itextpdf.text.error_messages.MessageLocalization;
import com.itextpdf.text.ExceptionConverter;
import com.itextpdf.text.Rectangle;
import com.itextpdf.text.BaseColor;
/** Generates barcodes in several formats: EAN13, EAN8, UPCA, UPCE,
* supplemental 2 and 5. The default parameters are:
*
*x = 0.8f;
*font = BaseFont.createFont("Helvetica", "winansi", false);
*size = 8;
*baseline = size;
*barHeight = size * 3;
*guardBars = true;
*codeType = EAN13;
*code = "";
*
*
* @author Paulo Soares
*/
public class BarcodeEAN extends Barcode{
/** The bar positions that are guard bars.*/
private static final int GUARD_EMPTY[] = {};
/** The bar positions that are guard bars.*/
private static final int GUARD_UPCA[] = {0, 2, 4, 6, 28, 30, 52, 54, 56, 58};
/** The bar positions that are guard bars.*/
private static final int GUARD_EAN13[] = {0, 2, 28, 30, 56, 58};
/** The bar positions that are guard bars.*/
private static final int GUARD_EAN8[] = {0, 2, 20, 22, 40, 42};
/** The bar positions that are guard bars.*/
private static final int GUARD_UPCE[] = {0, 2, 28, 30, 32};
/** The x coordinates to place the text.*/
private static final float TEXTPOS_EAN13[] = {6.5f, 13.5f, 20.5f, 27.5f, 34.5f, 41.5f, 53.5f, 60.5f, 67.5f, 74.5f, 81.5f, 88.5f};
/** The x coordinates to place the text.*/
private static final float TEXTPOS_EAN8[] = {6.5f, 13.5f, 20.5f, 27.5f, 39.5f, 46.5f, 53.5f, 60.5f};
/** The basic bar widths.*/
private static final byte BARS[][] =
{
{3, 2, 1, 1}, // 0
{2, 2, 2, 1}, // 1
{2, 1, 2, 2}, // 2
{1, 4, 1, 1}, // 3
{1, 1, 3, 2}, // 4
{1, 2, 3, 1}, // 5
{1, 1, 1, 4}, // 6
{1, 3, 1, 2}, // 7
{1, 2, 1, 3}, // 8
{3, 1, 1, 2} // 9
};
/** The total number of bars for EAN13.*/
private static final int TOTALBARS_EAN13 = 11 + 12 * 4;
/** The total number of bars for EAN8.*/
private static final int TOTALBARS_EAN8 = 11 + 8 * 4;
/** The total number of bars for UPCE.*/
private static final int TOTALBARS_UPCE = 9 + 6 * 4;
/** The total number of bars for supplemental 2.*/
private static final int TOTALBARS_SUPP2 = 13;
/** The total number of bars for supplemental 5.*/
private static final int TOTALBARS_SUPP5 = 31;
/** Marker for odd parity.*/
private static final int ODD = 0;
/** Marker for even parity.*/
private static final int EVEN = 1;
/** Sequence of parities to be used with EAN13.*/
private static final byte PARITY13[][] =
{
{ODD, ODD, ODD, ODD, ODD, ODD}, // 0
{ODD, ODD, EVEN, ODD, EVEN, EVEN}, // 1
{ODD, ODD, EVEN, EVEN, ODD, EVEN}, // 2
{ODD, ODD, EVEN, EVEN, EVEN, ODD}, // 3
{ODD, EVEN, ODD, ODD, EVEN, EVEN}, // 4
{ODD, EVEN, EVEN, ODD, ODD, EVEN}, // 5
{ODD, EVEN, EVEN, EVEN, ODD, ODD}, // 6
{ODD, EVEN, ODD, EVEN, ODD, EVEN}, // 7
{ODD, EVEN, ODD, EVEN, EVEN, ODD}, // 8
{ODD, EVEN, EVEN, ODD, EVEN, ODD} // 9
};
/** Sequence of parities to be used with supplemental 2.*/
private static final byte PARITY2[][] =
{
{ODD, ODD}, // 0
{ODD, EVEN}, // 1
{EVEN, ODD}, // 2
{EVEN, EVEN} // 3
};
/** Sequence of parities to be used with supplemental 2.*/
private static final byte PARITY5[][] =
{
{EVEN, EVEN, ODD, ODD, ODD}, // 0
{EVEN, ODD, EVEN, ODD, ODD}, // 1
{EVEN, ODD, ODD, EVEN, ODD}, // 2
{EVEN, ODD, ODD, ODD, EVEN}, // 3
{ODD, EVEN, EVEN, ODD, ODD}, // 4
{ODD, ODD, EVEN, EVEN, ODD}, // 5
{ODD, ODD, ODD, EVEN, EVEN}, // 6
{ODD, EVEN, ODD, EVEN, ODD}, // 7
{ODD, EVEN, ODD, ODD, EVEN}, // 8
{ODD, ODD, EVEN, ODD, EVEN} // 9
};
/** Sequence of parities to be used with UPCE.*/
private static final byte PARITYE[][] =
{
{EVEN, EVEN, EVEN, ODD, ODD, ODD}, // 0
{EVEN, EVEN, ODD, EVEN, ODD, ODD}, // 1
{EVEN, EVEN, ODD, ODD, EVEN, ODD}, // 2
{EVEN, EVEN, ODD, ODD, ODD, EVEN}, // 3
{EVEN, ODD, EVEN, EVEN, ODD, ODD}, // 4
{EVEN, ODD, ODD, EVEN, EVEN, ODD}, // 5
{EVEN, ODD, ODD, ODD, EVEN, EVEN}, // 6
{EVEN, ODD, EVEN, ODD, EVEN, ODD}, // 7
{EVEN, ODD, EVEN, ODD, ODD, EVEN}, // 8
{EVEN, ODD, ODD, EVEN, ODD, EVEN} // 9
};
/** Creates new BarcodeEAN */
public BarcodeEAN() {
try {
x = 0.8f;
font = BaseFont.createFont("Helvetica", "winansi", false);
size = 8;
baseline = size;
barHeight = size * 3;
guardBars = true;
codeType = EAN13;
code = "";
}
catch (Exception e) {
throw new ExceptionConverter(e);
}
}
/** Calculates the EAN parity character.
* @param code the code
* @return the parity character
*/
public static int calculateEANParity(String code) {
int mul = 3;
int total = 0;
for (int k = code.length() - 1; k >= 0; --k) {
int n = code.charAt(k) - '0';
total += mul * n;
mul ^= 2;
}
return (10 - (total % 10)) % 10;
}
/** Converts an UPCA code into an UPCE code. If the code can not
* be converted a null is returned.
* @param text the code to convert. It must have 12 numeric characters
* @return the 8 converted digits or null if the
* code could not be converted
*/
static public String convertUPCAtoUPCE(String text) {
if (text.length() != 12 || !(text.startsWith("0") || text.startsWith("1")))
return null;
if (text.substring(3, 6).equals("000") || text.substring(3, 6).equals("100")
|| text.substring(3, 6).equals("200")) {
if (text.substring(6, 8).equals("00"))
return text.substring(0, 1) + text.substring(1, 3) + text.substring(8, 11) + text.substring(3, 4) + text.substring(11);
}
else if (text.substring(4, 6).equals("00")) {
if (text.substring(6, 9).equals("000"))
return text.substring(0, 1) + text.substring(1, 4) + text.substring(9, 11) + "3" + text.substring(11);
}
else if (text.substring(5, 6).equals("0")) {
if (text.substring(6, 10).equals("0000"))
return text.substring(0, 1) + text.substring(1, 5) + text.substring(10, 11) + "4" + text.substring(11);
}
else if (text.charAt(10) >= '5') {
if (text.substring(6, 10).equals("0000"))
return text.substring(0, 1) + text.substring(1, 6) + text.substring(10, 11) + text.substring(11);
}
return null;
}
/** Creates the bars for the barcode EAN13 and UPCA.
* @param _code the text with 13 digits
* @return the barcode
*/
public static byte[] getBarsEAN13(String _code) {
int code[] = new int[_code.length()];
for (int k = 0; k < code.length; ++k)
code[k] = _code.charAt(k) - '0';
byte bars[] = new byte[TOTALBARS_EAN13];
int pb = 0;
bars[pb++] = 1;
bars[pb++] = 1;
bars[pb++] = 1;
byte sequence[] = PARITY13[code[0]];
for (int k = 0; k < sequence.length; ++k) {
int c = code[k + 1];
byte stripes[] = BARS[c];
if (sequence[k] == ODD) {
bars[pb++] = stripes[0];
bars[pb++] = stripes[1];
bars[pb++] = stripes[2];
bars[pb++] = stripes[3];
}
else {
bars[pb++] = stripes[3];
bars[pb++] = stripes[2];
bars[pb++] = stripes[1];
bars[pb++] = stripes[0];
}
}
bars[pb++] = 1;
bars[pb++] = 1;
bars[pb++] = 1;
bars[pb++] = 1;
bars[pb++] = 1;
for (int k = 7; k < 13; ++k) {
int c = code[k];
byte stripes[] = BARS[c];
bars[pb++] = stripes[0];
bars[pb++] = stripes[1];
bars[pb++] = stripes[2];
bars[pb++] = stripes[3];
}
bars[pb++] = 1;
bars[pb++] = 1;
bars[pb++] = 1;
return bars;
}
/** Creates the bars for the barcode EAN8.
* @param _code the text with 8 digits
* @return the barcode
*/
public static byte[] getBarsEAN8(String _code) {
int code[] = new int[_code.length()];
for (int k = 0; k < code.length; ++k)
code[k] = _code.charAt(k) - '0';
byte bars[] = new byte[TOTALBARS_EAN8];
int pb = 0;
bars[pb++] = 1;
bars[pb++] = 1;
bars[pb++] = 1;
for (int k = 0; k < 4; ++k) {
int c = code[k];
byte stripes[] = BARS[c];
bars[pb++] = stripes[0];
bars[pb++] = stripes[1];
bars[pb++] = stripes[2];
bars[pb++] = stripes[3];
}
bars[pb++] = 1;
bars[pb++] = 1;
bars[pb++] = 1;
bars[pb++] = 1;
bars[pb++] = 1;
for (int k = 4; k < 8; ++k) {
int c = code[k];
byte stripes[] = BARS[c];
bars[pb++] = stripes[0];
bars[pb++] = stripes[1];
bars[pb++] = stripes[2];
bars[pb++] = stripes[3];
}
bars[pb++] = 1;
bars[pb++] = 1;
bars[pb++] = 1;
return bars;
}
/** Creates the bars for the barcode UPCE.
* @param _code the text with 8 digits
* @return the barcode
*/
public static byte[] getBarsUPCE(String _code) {
int code[] = new int[_code.length()];
for (int k = 0; k < code.length; ++k)
code[k] = _code.charAt(k) - '0';
byte bars[] = new byte[TOTALBARS_UPCE];
boolean flip = (code[0] != 0);
int pb = 0;
bars[pb++] = 1;
bars[pb++] = 1;
bars[pb++] = 1;
byte sequence[] = PARITYE[code[code.length - 1]];
for (int k = 1; k < code.length - 1; ++k) {
int c = code[k];
byte stripes[] = BARS[c];
if (sequence[k - 1] == (flip ? EVEN : ODD)) {
bars[pb++] = stripes[0];
bars[pb++] = stripes[1];
bars[pb++] = stripes[2];
bars[pb++] = stripes[3];
}
else {
bars[pb++] = stripes[3];
bars[pb++] = stripes[2];
bars[pb++] = stripes[1];
bars[pb++] = stripes[0];
}
}
bars[pb++] = 1;
bars[pb++] = 1;
bars[pb++] = 1;
bars[pb++] = 1;
bars[pb++] = 1;
bars[pb++] = 1;
return bars;
}
/** Creates the bars for the barcode supplemental 2.
* @param _code the text with 2 digits
* @return the barcode
*/
public static byte[] getBarsSupplemental2(String _code) {
int code[] = new int[2];
for (int k = 0; k < code.length; ++k)
code[k] = _code.charAt(k) - '0';
byte bars[] = new byte[TOTALBARS_SUPP2];
int pb = 0;
int parity = (code[0] * 10 + code[1]) % 4;
bars[pb++] = 1;
bars[pb++] = 1;
bars[pb++] = 2;
byte sequence[] = PARITY2[parity];
for (int k = 0; k < sequence.length; ++k) {
if (k == 1) {
bars[pb++] = 1;
bars[pb++] = 1;
}
int c = code[k];
byte stripes[] = BARS[c];
if (sequence[k] == ODD) {
bars[pb++] = stripes[0];
bars[pb++] = stripes[1];
bars[pb++] = stripes[2];
bars[pb++] = stripes[3];
}
else {
bars[pb++] = stripes[3];
bars[pb++] = stripes[2];
bars[pb++] = stripes[1];
bars[pb++] = stripes[0];
}
}
return bars;
}
/** Creates the bars for the barcode supplemental 5.
* @param _code the text with 5 digits
* @return the barcode
*/
public static byte[] getBarsSupplemental5(String _code) {
int code[] = new int[5];
for (int k = 0; k < code.length; ++k)
code[k] = _code.charAt(k) - '0';
byte bars[] = new byte[TOTALBARS_SUPP5];
int pb = 0;
int parity = (((code[0] + code[2] + code[4]) * 3) + ((code[1] + code[3]) * 9)) % 10;
bars[pb++] = 1;
bars[pb++] = 1;
bars[pb++] = 2;
byte sequence[] = PARITY5[parity];
for (int k = 0; k < sequence.length; ++k) {
if (k != 0) {
bars[pb++] = 1;
bars[pb++] = 1;
}
int c = code[k];
byte stripes[] = BARS[c];
if (sequence[k] == ODD) {
bars[pb++] = stripes[0];
bars[pb++] = stripes[1];
bars[pb++] = stripes[2];
bars[pb++] = stripes[3];
}
else {
bars[pb++] = stripes[3];
bars[pb++] = stripes[2];
bars[pb++] = stripes[1];
bars[pb++] = stripes[0];
}
}
return bars;
}
/** Gets the maximum area that the barcode and the text, if
* any, will occupy. The lower left corner is always (0, 0).
* @return the size the barcode occupies.
*/
public Rectangle getBarcodeSize() {
float width = 0;
float height = barHeight;
if (font != null) {
if (baseline <= 0)
height += -baseline + size;
else
height += baseline - font.getFontDescriptor(BaseFont.DESCENT, size);
}
switch (codeType) {
case EAN13:
width = x * (11 + 12 * 7);
if (font != null) {
width += font.getWidthPoint(code.charAt(0), size);
}
break;
case EAN8:
width = x * (11 + 8 * 7);
break;
case UPCA:
width = x * (11 + 12 * 7);
if (font != null) {
width += font.getWidthPoint(code.charAt(0), size) + font.getWidthPoint(code.charAt(11), size);
}
break;
case UPCE:
width = x * (9 + 6 * 7);
if (font != null) {
width += font.getWidthPoint(code.charAt(0), size) + font.getWidthPoint(code.charAt(7), size);
}
break;
case SUPP2:
width = x * (6 + 2 * 7);
break;
case SUPP5:
width = x * (4 + 5 * 7 + 4 * 2);
break;
default:
throw new RuntimeException(MessageLocalization.getComposedMessage("invalid.code.type"));
}
return new Rectangle(width, height);
}
/** Places the barcode in a PdfContentByte. 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
*
* @param cb the PdfContentByte where the barcode will be placed
* @param barColor the color of the bars. It can be null
* @param textColor the color of the text. It can be null
* @return the dimensions the barcode occupies
*/
public Rectangle placeBarcode(PdfContentByte cb, BaseColor barColor, BaseColor textColor) {
Rectangle rect = getBarcodeSize();
float barStartX = 0;
float barStartY = 0;
float textStartY = 0;
if (font != null) {
if (baseline <= 0)
textStartY = barHeight - baseline;
else {
textStartY = -font.getFontDescriptor(BaseFont.DESCENT, size);
barStartY = textStartY + baseline;
}
}
switch (codeType) {
case EAN13:
case UPCA:
case UPCE:
if (font != null)
barStartX += font.getWidthPoint(code.charAt(0), size);
break;
}
byte bars[] = null;
int guard[] = GUARD_EMPTY;
switch (codeType) {
case EAN13:
bars = getBarsEAN13(code);
guard = GUARD_EAN13;
break;
case EAN8:
bars = getBarsEAN8(code);
guard = GUARD_EAN8;
break;
case UPCA:
bars = getBarsEAN13("0" + code);
guard = GUARD_UPCA;
break;
case UPCE:
bars = getBarsUPCE(code);
guard = GUARD_UPCE;
break;
case SUPP2:
bars = getBarsSupplemental2(code);
break;
case SUPP5:
bars = getBarsSupplemental5(code);
break;
}
float keepBarX = barStartX;
boolean print = true;
float gd = 0;
if (font != null && baseline > 0 && guardBars) {
gd = baseline / 2;
}
if (barColor != null)
cb.setColorFill(barColor);
for (int k = 0; k < bars.length; ++k) {
float w = bars[k] * x;
if (print) {
if (Arrays.binarySearch(guard, k) >= 0)
cb.rectangle(barStartX, barStartY - gd, w - inkSpreading, barHeight + gd);
else
cb.rectangle(barStartX, barStartY, w - inkSpreading, barHeight);
}
print = !print;
barStartX += w;
}
cb.fill();
if (font != null) {
if (textColor != null)
cb.setColorFill(textColor);
cb.beginText();
cb.setFontAndSize(font, size);
switch (codeType) {
case EAN13:
cb.setTextMatrix(0, textStartY);
cb.showText(code.substring(0, 1));
for (int k = 1; k < 13; ++k) {
String c = code.substring(k, k + 1);
float len = font.getWidthPoint(c, size);
float pX = keepBarX + TEXTPOS_EAN13[k - 1] * x - len / 2;
cb.setTextMatrix(pX, textStartY);
cb.showText(c);
}
break;
case EAN8:
for (int k = 0; k < 8; ++k) {
String c = code.substring(k, k + 1);
float len = font.getWidthPoint(c, size);
float pX = TEXTPOS_EAN8[k] * x - len / 2;
cb.setTextMatrix(pX, textStartY);
cb.showText(c);
}
break;
case UPCA:
cb.setTextMatrix(0, textStartY);
cb.showText(code.substring(0, 1));
for (int k = 1; k < 11; ++k) {
String c = code.substring(k, k + 1);
float len = font.getWidthPoint(c, size);
float pX = keepBarX + TEXTPOS_EAN13[k] * x - len / 2;
cb.setTextMatrix(pX, textStartY);
cb.showText(c);
}
cb.setTextMatrix(keepBarX + x * (11 + 12 * 7), textStartY);
cb.showText(code.substring(11, 12));
break;
case UPCE:
cb.setTextMatrix(0, textStartY);
cb.showText(code.substring(0, 1));
for (int k = 1; k < 7; ++k) {
String c = code.substring(k, k + 1);
float len = font.getWidthPoint(c, size);
float pX = keepBarX + TEXTPOS_EAN13[k - 1] * x - len / 2;
cb.setTextMatrix(pX, textStartY);
cb.showText(c);
}
cb.setTextMatrix(keepBarX + x * (9 + 6 * 7), textStartY);
cb.showText(code.substring(7, 8));
break;
case SUPP2:
case SUPP5:
for (int k = 0; k < code.length(); ++k) {
String c = code.substring(k, k + 1);
float len = font.getWidthPoint(c, size);
float pX = (7.5f + (9 * k)) * x - len / 2;
cb.setTextMatrix(pX, textStartY);
cb.showText(c);
}
break;
}
cb.endText();
}
return rect;
}
}