com.lowagie.text.pdf.Barcode39 Maven / Gradle / Ivy
/*
* $Id: Barcode39.java 4065 2009-09-16 23:09:11Z psoares33 $
*
* Copyright 2002-2006 by Paulo Soares.
*
* The contents of this file are subject to the Mozilla Public License Version 1.1
* (the "License"); you may not use this file except in compliance with the License.
* You may obtain a copy of the License at http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the License.
*
* The Original Code is 'iText, a free JAVA-PDF library'.
*
* The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
* the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
* All Rights Reserved.
* Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
* are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
*
* Contributor(s): all the names of the contributors are added in the source code
* where applicable.
*
* Alternatively, the contents of this file may be used under the terms of the
* LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
* provisions of LGPL are applicable instead of those above. If you wish to
* allow use of your version of this file only under the terms of the LGPL
* License and not to allow others to use your version of this file under
* the MPL, indicate your decision by deleting the provisions above and
* replace them with the notice and other provisions required by the LGPL.
* If you do not delete the provisions above, a recipient may use your version
* of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the MPL as stated above or under the terms of the GNU
* Library General Public License as published by the Free Software Foundation;
* either version 2 of the License, or any later version.
*
* This library 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 Library general Public License for more
* details.
*
* If you didn't download this code from the following link, you should check if
* you aren't using an obsolete version:
* https://github.com/LibrePDF/OpenPDF
*/
package com.lowagie.text.pdf;
import java.awt.Canvas;
import java.awt.Color;
import java.awt.Image;
import java.awt.image.MemoryImageSource;
import com.lowagie.text.error_messages.MessageLocalization;
import com.lowagie.text.Element;
import com.lowagie.text.Rectangle;
import com.lowagie.text.ExceptionConverter;
/** Implements the code 39 and code 39 extended. The default parameters are:
*
*x = 0.8f;
*n = 2;
*font = BaseFont.createFont("Helvetica", "winansi", false);
*size = 8;
*baseline = size;
*barHeight = size * 3;
*textAlignment = Element.ALIGN_CENTER;
*generateChecksum = false;
*checksumText = false;
*startStopText = true;
*extended = false;
*
*
* @author Paulo Soares ([email protected])
*/
public class Barcode39 extends Barcode{
/**
* 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.
*/
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.
*/
public Barcode39() {
try {
x = 0.8f;
n = 2;
font = BaseFont.createFont("Helvetica", "winansi", false);
size = 8;
baseline = size;
barHeight = size * 3;
textAlignment = Element.ALIGN_CENTER;
generateChecksum = false;
checksumText = false;
startStopText = true;
extended = false;
}
catch (Exception e) {
throw new ExceptionConverter(e);
}
}
/** 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) {
int idx = CHARS.indexOf(text.charAt(k));
if (idx < 0)
throw new IllegalArgumentException(MessageLocalization.getComposedMessage("the.character.1.is.illegal.in.code.39", text.charAt(k)));
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) {
String out = "";
for (int k = 0; k < text.length(); ++k) {
char c = text.charAt(k);
if (c > 127)
throw new IllegalArgumentException(MessageLocalization.getComposedMessage("the.character.1.is.illegal.in.code.39.extended", c));
char c1 = EXTENDED.charAt(c * 2);
char c2 = EXTENDED.charAt(c * 2 + 1);
if (c1 != ' ')
out += c1;
out += c2;
}
return out;
}
/** 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));
if (idx < 0)
throw new IllegalArgumentException(MessageLocalization.getComposedMessage("the.character.1.is.illegal.in.code.39", text.charAt(k)));
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.
*/
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 - font.getFontDescriptor(BaseFont.DESCENT, size);
else
fontY = -baseline + size;
String fullCode = code;
if (generateChecksum && checksumText)
fullCode += getChecksum(fCode);
if (startStopText)
fullCode = "*" + fullCode + "*";
fontX = font.getWidthPoint(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 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:
*
* table of the colors of the bars and text
*
* 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, 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.getWidthPoint(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 Element.ALIGN_LEFT:
break;
case Element.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 = -font.getFontDescriptor(BaseFont.DESCENT, size);
barStartY = textStartY + baseline;
}
}
byte[] bars = getBarsCode39(bCode);
boolean print = true;
if (barColor != null)
cb.setColorFill(barColor);
for (byte bar : bars) {
float w = (bar == 0 ? x : x * n);
if (print)
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);
cb.setTextMatrix(textStartX, textStartY);
cb.showText(fullCode);
cb.endText();
}
return getBarcodeSize();
}
/** Creates a java.awt.Image. This image only
* contains the bars without any text.
* @param foreground the color of the bars
* @param background the color of the background
* @return the image
*/
public java.awt.Image createAwtImage(Color foreground, Color background) {
int f = foreground.getRGB();
int g = background.getRGB();
Canvas canvas = new Canvas();
String bCode = code;
if (extended)
bCode = getCode39Ex(code);
if (generateChecksum)
bCode += getChecksum(bCode);
int len = bCode.length() + 2;
int nn = (int)n;
int fullWidth = len * (6 + 3 * nn) + (len - 1);
byte[] bars = getBarsCode39(bCode);
boolean print = true;
int ptr = 0;
int height = (int)barHeight;
int[] pix = new int[fullWidth * height];
for (byte bar : bars) {
int w = (bar == 0 ? 1 : nn);
int c = g;
if (print)
c = f;
print = !print;
for (int j = 0; j < w; ++j)
pix[ptr++] = c;
}
for (int k = fullWidth; k < pix.length; k += fullWidth) {
System.arraycopy(pix, 0, pix, k, fullWidth);
}
Image img = canvas.createImage(new MemoryImageSource(fullWidth, height, pix, 0, fullWidth));
return img;
}
}