com.itextpdf.barcodes.Barcode39 Maven / Gradle / Ivy
/*
This file is part of the iText (R) project.
Copyright (c) 1998-2023 Apryse Group NV
Authors: Apryse Software.
This program is offered under a commercial and under the AGPL license.
For commercial licensing, contact us at https://itextpdf.com/sales. For AGPL licensing, see below.
AGPL licensing:
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
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 .
*/
package com.itextpdf.barcodes;
import com.itextpdf.kernel.font.PdfFont;
import com.itextpdf.kernel.geom.Rectangle;
import com.itextpdf.kernel.pdf.canvas.PdfCanvas;
import com.itextpdf.kernel.colors.Color;
import com.itextpdf.kernel.pdf.PdfDocument;
public class Barcode39 extends Barcode1D {
/**
* The bars to generate the code.
*/
private static final byte[][] BARS =
{
{0, 0, 0, 1, 1, 0, 1, 0, 0},
{1, 0, 0, 1, 0, 0, 0, 0, 1},
{0, 0, 1, 1, 0, 0, 0, 0, 1},
{1, 0, 1, 1, 0, 0, 0, 0, 0},
{0, 0, 0, 1, 1, 0, 0, 0, 1},
{1, 0, 0, 1, 1, 0, 0, 0, 0},
{0, 0, 1, 1, 1, 0, 0, 0, 0},
{0, 0, 0, 1, 0, 0, 1, 0, 1},
{1, 0, 0, 1, 0, 0, 1, 0, 0},
{0, 0, 1, 1, 0, 0, 1, 0, 0},
{1, 0, 0, 0, 0, 1, 0, 0, 1},
{0, 0, 1, 0, 0, 1, 0, 0, 1},
{1, 0, 1, 0, 0, 1, 0, 0, 0},
{0, 0, 0, 0, 1, 1, 0, 0, 1},
{1, 0, 0, 0, 1, 1, 0, 0, 0},
{0, 0, 1, 0, 1, 1, 0, 0, 0},
{0, 0, 0, 0, 0, 1, 1, 0, 1},
{1, 0, 0, 0, 0, 1, 1, 0, 0},
{0, 0, 1, 0, 0, 1, 1, 0, 0},
{0, 0, 0, 0, 1, 1, 1, 0, 0},
{1, 0, 0, 0, 0, 0, 0, 1, 1},
{0, 0, 1, 0, 0, 0, 0, 1, 1},
{1, 0, 1, 0, 0, 0, 0, 1, 0},
{0, 0, 0, 0, 1, 0, 0, 1, 1},
{1, 0, 0, 0, 1, 0, 0, 1, 0},
{0, 0, 1, 0, 1, 0, 0, 1, 0},
{0, 0, 0, 0, 0, 0, 1, 1, 1},
{1, 0, 0, 0, 0, 0, 1, 1, 0},
{0, 0, 1, 0, 0, 0, 1, 1, 0},
{0, 0, 0, 0, 1, 0, 1, 1, 0},
{1, 1, 0, 0, 0, 0, 0, 0, 1},
{0, 1, 1, 0, 0, 0, 0, 0, 1},
{1, 1, 1, 0, 0, 0, 0, 0, 0},
{0, 1, 0, 0, 1, 0, 0, 0, 1},
{1, 1, 0, 0, 1, 0, 0, 0, 0},
{0, 1, 1, 0, 1, 0, 0, 0, 0},
{0, 1, 0, 0, 0, 0, 1, 0, 1},
{1, 1, 0, 0, 0, 0, 1, 0, 0},
{0, 1, 1, 0, 0, 0, 1, 0, 0},
{0, 1, 0, 1, 0, 1, 0, 0, 0},
{0, 1, 0, 1, 0, 0, 0, 1, 0},
{0, 1, 0, 0, 0, 1, 0, 1, 0},
{0, 0, 0, 1, 0, 1, 0, 1, 0},
{0, 1, 0, 0, 1, 0, 1, 0, 0}
};
/**
* The index chars to BARS
, symbol * use only start and stop characters,
* the * character will not appear in the input data.
*/
private static final String CHARS = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ-. $/+%*";
/**
* The character combinations to make the code 39 extended.
*/
private static final String EXTENDED = "%U" +
"$A$B$C$D$E$F$G$H$I$J$K$L$M$N$O$P$Q$R$S$T$U$V$W$X$Y$Z" +
"%A%B%C%D%E /A/B/C/D/E/F/G/H/I/J/K/L - ./O" +
" 0 1 2 3 4 5 6 7 8 9/Z%F%G%H%I%J%V" +
" A B C D E F G H I J K L M N O P Q R S T U V W X Y Z" +
"%K%L%M%N%O%W" +
"+A+B+C+D+E+F+G+H+I+J+K+L+M+N+O+P+Q+R+S+T+U+V+W+X+Y+Z" +
"%P%Q%R%S%T";
/**
* Creates a new Barcode39.
* To generate the font the {@link PdfDocument#getDefaultFont()} will be implicitly called.
* If you want to use this barcode in PDF/A documents, please consider using {@link #Barcode39(PdfDocument, PdfFont)}.
*
* @param document The document to which the barcode will be added
*/
public Barcode39(PdfDocument document) {
this(document, document.getDefaultFont());
}
/**
* Creates a new Barcode39.
*
* @param document The document to which the barcode will be added
* @param font The font to use
*/
public Barcode39(PdfDocument document, PdfFont font) {
super(document);
this.x = 0.8f;
this.n = 2;
this.font = font;
this.size = 8;
this.baseline = size;
this.barHeight = size * 3;
this.generateChecksum = false;
this.checksumText = false;
this.startStopText = true;
this.extended = false;
}
/**
* Creates the bars.
*
* @param text the text to create the bars. This text does not include the start and
* stop characters
* @return the bars
*/
public static byte[] getBarsCode39(String text) {
text = "*" + text + "*";
byte[] bars = new byte[text.length() * 10 - 1];
for (int k = 0; k < text.length(); ++k) {
char ch = text.charAt(k);
int idx = CHARS.indexOf(ch);
if(ch == '*' && k != 0 && k != (text.length() - 1)){
throw new IllegalArgumentException("The character " + ch + " is illegal in code 39");
}
if (idx < 0 ) {
throw new IllegalArgumentException("The character " + text.charAt(k) + " is illegal in code 39");
}
System.arraycopy(BARS[idx], 0, bars, k * 10, 9);
}
return bars;
}
/**
* Converts the extended text into a normal, escaped text,
* ready to generate bars.
*
* @param text the extended text
* @return the escaped text
*/
public static String getCode39Ex(String text) {
StringBuilder out = new StringBuilder("");
for (int k = 0; k < text.length(); ++k) {
char c = text.charAt(k);
if (c > 127) {
throw new IllegalArgumentException("The character " + c + " is illegal in code 39");
}
char c1 = EXTENDED.charAt(c * 2);
char c2 = EXTENDED.charAt(c * 2 + 1);
if (c1 != ' ') {
out.append(c1);
}
out.append(c2);
}
return out.toString();
}
/**
* Calculates the checksum.
*
* @param text the text
* @return the checksum
*/
static char getChecksum(String text) {
int chk = 0;
for (int k = 0; k < text.length(); ++k) {
int idx = CHARS.indexOf(text.charAt(k));
char ch = text.charAt(k);
if(ch == '*' && k != 0 && k != (text.length() - 1)){
throw new IllegalArgumentException("The character " + ch + " is illegal in code 39");
}
if (idx < 0) {
throw new IllegalArgumentException("The character " + text.charAt(k) + " is illegal in code 39");
}
chk += idx;
}
return CHARS.charAt(chk % 43);
}
/**
* 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.
*/
@Override
public Rectangle getBarcodeSize() {
float fontX = 0;
float fontY = 0;
String fCode = code;
if (extended) {
fCode = getCode39Ex(code);
}
if (font != null) {
if (baseline > 0) {
fontY = baseline - getDescender();
} else {
fontY = -baseline + size;
}
String fullCode = code;
if (generateChecksum && checksumText) {
fullCode += getChecksum(fCode);
}
if (startStopText) {
fullCode = "*" + fullCode + "*";
}
fontX = font.getWidth(altText != null ? altText : fullCode, size);
}
int len = fCode.length() + 2;
if (generateChecksum) {
++len;
}
float fullWidth = len * (6 * x + 3 * x * n) + (len - 1) * x;
fullWidth = Math.max(fullWidth, fontX);
float fullHeight = barHeight + fontY;
return new Rectangle(fullWidth, fullHeight);
}
/**
* 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
*
*
*
* @param canvas the PdfCanvas
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
*/
@Override
public Rectangle placeBarcode(PdfCanvas canvas, Color barColor, Color textColor) {
String fullCode = code;
float fontX = 0;
String bCode = code;
if (extended) {
bCode = getCode39Ex(code);
}
if (font != null) {
if (generateChecksum && checksumText) {
fullCode += getChecksum(bCode);
}
if (startStopText) {
fullCode = "*" + fullCode + "*";
}
fontX = font.getWidth(fullCode = altText != null ? altText : fullCode, size);
}
if (generateChecksum) {
bCode += getChecksum(bCode);
}
int len = bCode.length() + 2;
float fullWidth = len * (6 * x + 3 * x * n) + (len - 1) * x;
float barStartX = 0;
float textStartX = 0;
switch (textAlignment) {
case ALIGN_LEFT:
break;
case ALIGN_RIGHT:
if (fontX > fullWidth) {
barStartX = fontX - fullWidth;
} else {
textStartX = fullWidth - fontX;
}
break;
default:
if (fontX > fullWidth) {
barStartX = (fontX - fullWidth) / 2;
} else {
textStartX = (fullWidth - fontX) / 2;
}
break;
}
float barStartY = 0;
float textStartY = 0;
if (font != null) {
if (baseline <= 0) {
textStartY = barHeight - baseline;
} else {
textStartY = -getDescender();
barStartY = textStartY + baseline;
}
}
byte[] bars = getBarsCode39(bCode);
boolean print = true;
if (barColor != null) {
canvas.setFillColor(barColor);
}
for (int k = 0; k < bars.length; ++k) {
float w = (bars[k] == 0 ? x : x * n);
if (print) {
canvas.rectangle(barStartX, barStartY, w - inkSpreading, barHeight);
}
print = !print;
barStartX += w;
}
canvas.fill();
if (font != null) {
if (textColor != null) {
canvas.setFillColor(textColor);
}
canvas.
beginText().
setFontAndSize(font, size).
setTextMatrix(textStartX, textStartY).
showText(fullCode).
endText();
}
return getBarcodeSize();
}
}