org.krysalis.barcode4j.impl.AbstractBarcodeBean Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of barcode4j-fop-ext-complete Show documentation
Show all versions of barcode4j-fop-ext-complete Show documentation
Barcode4J is a flexible generator for barcodes written in Java inclusive
extensions to support Apache FOP 0.93 and later.
The newest version!
/*
* Copyright 2002-2007 Jeremias Maerki or contributors to Barcode4J, as applicable
*
* Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.krysalis.barcode4j.impl;
import org.krysalis.barcode4j.BarcodeDimension;
import org.krysalis.barcode4j.BarcodeGenerator;
import org.krysalis.barcode4j.HumanReadablePlacement;
import org.krysalis.barcode4j.output.CanvasProvider;
import org.krysalis.barcode4j.tools.UnitConv;
/**
* Base class for most barcode implementations.
*
* @version $Id: AbstractBarcodeBean.java,v 1.7 2008/05/13 13:00:45 jmaerki Exp $
*/
public abstract class AbstractBarcodeBean
implements BarcodeGenerator {
/** Net height of bars in mm */
protected double height = 15.0; //mm
/** Width of narrow module in mm */
protected double moduleWidth;
/** Position of human-readable text */
protected HumanReadablePlacement msgPos = HumanReadablePlacement.HRP_BOTTOM;
/** Font size in mm */
protected double fontSize = UnitConv.pt2mm(8); //8pt
/** Font name */
protected String fontName = "Helvetica"; //"OCR-B,Helvetica,Arial";
/** True if quiet zone should be rendered */
protected boolean doQuietZone = true;
/** Width of the quiet zone left and right of the barcode in mm */
protected double quietZone;
/** Height of the vertical quiet zone above and below the barcode in mm */
protected Double quietZoneVertical;
/** pattern to be applied over the human readable message */
protected String pattern;
/**
* returns the pattern to be applied over the human readable message
* @return String
*/
public String getPattern() {
return this.pattern;
}
/**
* Sets the pattern to be applied over the human readable message
* @param v String
*/
public void setPattern(String v) {
this.pattern = v;
}
/**
* Indicates whether the barcode height calculation should take a font descender
* into account. This is necessary for barcodes that support lower-case
* characters like Code128.
* @return true if the implementation has to take font descenders into account
*/
protected boolean hasFontDescender() {
return false;
}
/**
* Returns the height of the human-readable part.
* @return the height of the human-readable part (in mm)
*/
public double getHumanReadableHeight() {
if (getMsgPosition() != HumanReadablePlacement.HRP_NONE) {
double textHeight = this.fontSize;
if (hasFontDescender()) {
return 1.3 * textHeight;
//1.3 is the factor for the font descender
//(just an approximation due to the lack of a font engine)
} else {
return textHeight;
}
} else {
return 0.0;
}
}
/**
* Returns the height of the bars.
* @return the height of the bars (in mm)
*/
public double getBarHeight() {
return this.height;
}
/**
* Returns the full height of the barcode.
* @return the full height (in mm)
*/
public double getHeight() {
return getBarHeight() + getHumanReadableHeight();
}
/**
* Sets the height of the bars.
* @param height the height of the bars (in mm)
*/
public void setBarHeight(double height) {
this.height = height;
}
/**
* Sets the full height of the barcode.
* @param height the full height (in mm)
*/
public void setHeight(double height) {
this.height = height - getHumanReadableHeight();
}
/**
* Returns the width of the narrow module.
* @return the width of the narrow module (in mm)
*/
public double getModuleWidth() {
return this.moduleWidth;
}
/**
* Sets the width of the narrow module.
* @param width the width of the narrow module (in mm)
*/
public void setModuleWidth(double width) {
this.moduleWidth = width;
}
/**
* Returns the effective width of a bar with a given logical width.
* @param width the logical width (1=narrow, 2=wide)
* @return the effective width of a bar (in mm)
*/
public abstract double getBarWidth(int width);
/**
* Indicates whether a quiet zone is included.
* @return true if a quiet zone is included
*/
public boolean hasQuietZone() {
return this.doQuietZone;
}
/**
* Controls whether a quiet zone should be included or not.
* @param value true if a quiet zone should be included
*/
public void doQuietZone(boolean value) {
this.doQuietZone = value;
}
/** @return the width of the quiet zone (in mm) */
public double getQuietZone() {
return this.quietZone;
}
/**
* Returns the vertical quiet zone. If no vertical quiet zone is set explicitely, the value
* if {@link #getQuietZone()} is returned.
* @return the height of the vertical quiet zone (in mm)
*/
public double getVerticalQuietZone() {
if (this.quietZoneVertical != null) {
return this.quietZoneVertical.doubleValue();
} else {
return getQuietZone();
}
}
/**
* Sets the width of the quiet zone.
* @param width the width of the quiet zone (in mm)
*/
public void setQuietZone(double width) {
this.quietZone = width;
}
/**
* Sets the height of the vertical quiet zone. If this value is not explicitely set the
* vertical quiet zone has the same width as the horizontal quiet zone.
* @param height the height of the vertical quiet zone (in mm)
*/
public void setVerticalQuietZone(double height) {
this.quietZoneVertical = new Double(height);
}
/**
* Returns the placement of the human-readable part.
* @return the placement of the human-readable part
*/
public HumanReadablePlacement getMsgPosition() {
return this.msgPos;
}
/**
* Sets the placement of the human-readable part.
* @param placement the placement of the human-readable part
*/
public void setMsgPosition(HumanReadablePlacement placement) {
this.msgPos = placement;
}
/**
* Returns the font size of the human-readable part.
* @return the font size
*/
public double getFontSize() {
return this.fontSize;
}
/**
* Sets the font size of the human-readable part.
* @param size the font size
*/
public void setFontSize(double size) {
this.fontSize = size;
}
/**
* Returns the font name of the human-readable part.
* @return the font name
*/
public String getFontName() {
return this.fontName;
}
/**
* Sets the font name of the human-readable part.
* @param name the font name
*/
public void setFontName(String name) {
this.fontName = name;
}
/** {@inheritDoc} */
public abstract void generateBarcode(CanvasProvider canvas, String msg);
/** {@inheritDoc} */
public BarcodeDimension calcDimensions(String msg) {
throw new UnsupportedOperationException("NYI");
}
}