PdfContentByte.java
| Index Score | ||
|---|---|---|
 |
 |
com.lowagie.text.pdf |
 |
 |
iText |
View: Reasons, Metrics, Source Code
These are the metrics that contribute to the Enerjy Score for this file, ranked by impact. So the metrics listed at the top influence the score to a greater extent that the metrics listed at the bottom.
| Metric | Description | |
|---|---|---|
| DECL_COMMENTS | Comments in declarations |  |
| PARAMS | Number of formal parameter declarations | |
| DOC_COMMENT | Number of javadoc comment lines | |
| SIZE | Size of the file in bytes | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| COMMENTS | Comment lines | |
| OPERANDS | Number of operands | |
| PROGRAM_LENGTH | Halstead program length | |
| OPERATORS | Number of operators | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| LINES | Number of lines in the source file | |
| CYCLOMATIC | Cyclomatic complexity | |
| LOGICAL_LINES | Number of statements | |
| FUNCTIONS | Number of function declarations | |
| UNIQUE_OPERANDS | Number of unique operands | |
| ELOC | Effective lines of code | |
| EXITS | Procedure exits | |
| RETURNS | Number of return points from functions | |
| LOC | Lines of code | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| BLOCKS | Number of blocks | |
| COMPARISONS | Number of comparison operators | |
| JAVA0076 | JAVA0076 Use of magic number | |
| EXEC_COMMENTS | Comments in executable code | |
| WHITESPACE | Number of whitespace lines | |
| LINE_COMMENT | Number of line comments | |
| JAVA0138 | JAVA0138 N parameters defined for method (maximum: M) | |
| LOOPS | Number of loops | |
| JAVA0144 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0078 | JAVA0078 Floating point values compared with == | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| JAVA0031 | JAVA0031 Case statement not properly closed | |
| JAVA0067 | JAVA0067 Array descriptor on identifier name | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0032 | JAVA0032 Switch statement missing default | |
| JAVA0049 | JAVA0049 Nested block at depth N (maximum: M) | |
| NEST_DEPTH | Maximum nesting depth | |
| JAVA0036 | JAVA0036 Missing braces in while statement | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0166 | JAVA0166 Generic exception caught | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0173 | JAVA0173 Unused method parameter | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0075 | JAVA0075 Method parameter hides field | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/*
* $Id: PdfContentByte.java 3427 2008-05-24 18:32:31Z xlv $
*
* Copyright 1999, 2000, 2001, 2002 Bruno Lowagie
*
* 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:
* http://www.lowagie.com/iText/
*/
package com.lowagie.text.pdf;
import java.awt.Color;
import java.awt.geom.AffineTransform;
import java.awt.print.PrinterJob;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import com.lowagie.text.Annotation;
import com.lowagie.text.DocumentException;
import com.lowagie.text.Element;
import com.lowagie.text.ExceptionConverter;
import com.lowagie.text.Image;
import com.lowagie.text.Rectangle;
import com.lowagie.text.pdf.internal.PdfAnnotationsImp;
import com.lowagie.text.pdf.internal.PdfXConformanceImp;
/**
* <CODE>PdfContentByte</CODE> is an object containing the user positioned
* text and graphic contents of a page. It knows how to apply the proper
* font encoding.
*/
public class PdfContentByte {
/**
* This class keeps the graphic state of the current page
*/
static class GraphicState {
/** This is the font in use */
FontDetails fontDetails;
/** This is the color in use */
ColorDetails colorDetails;
/** This is the font size in use */
float size;
/** The x position of the text line matrix. */
protected float xTLM = 0;
/** The y position of the text line matrix. */
protected float yTLM = 0;
/** The current text leading. */
protected float leading = 0;
/** The current horizontal scaling */
protected float scale = 100;
/** The current character spacing */
protected float charSpace = 0;
/** The current word spacing */
protected float wordSpace = 0;
GraphicState() {
}
GraphicState(GraphicState cp) {
fontDetails = cp.fontDetails;
colorDetails = cp.colorDetails;
size = cp.size;
xTLM = cp.xTLM;
yTLM = cp.yTLM;
leading = cp.leading;
scale = cp.scale;
charSpace = cp.charSpace;
wordSpace = cp.wordSpace;
}
}
/** The alignment is center */
public static final int ALIGN_CENTER = Element.ALIGN_CENTER;
/** The alignment is left */
public static final int ALIGN_LEFT = Element.ALIGN_LEFT;
/** The alignment is right */
public static final int ALIGN_RIGHT = Element.ALIGN_RIGHT;
/** A possible line cap value */
public static final int LINE_CAP_BUTT = 0;
/** A possible line cap value */
public static final int LINE_CAP_ROUND = 1;
/** A possible line cap value */
public static final int LINE_CAP_PROJECTING_SQUARE = 2;
/** A possible line join value */
public static final int LINE_JOIN_MITER = 0;
/** A possible line join value */
public static final int LINE_JOIN_ROUND = 1;
/** A possible line join value */
public static final int LINE_JOIN_BEVEL = 2;
/** A possible text rendering value */
public static final int TEXT_RENDER_MODE_FILL = 0;
/** A possible text rendering value */
public static final int TEXT_RENDER_MODE_STROKE = 1;
/** A possible text rendering value */
public static final int TEXT_RENDER_MODE_FILL_STROKE = 2;
/** A possible text rendering value */
public static final int TEXT_RENDER_MODE_INVISIBLE = 3;
/** A possible text rendering value */
public static final int TEXT_RENDER_MODE_FILL_CLIP = 4;
/** A possible text rendering value */
public static final int TEXT_RENDER_MODE_STROKE_CLIP = 5;
/** A possible text rendering value */
public static final int TEXT_RENDER_MODE_FILL_STROKE_CLIP = 6;
/** A possible text rendering value */
public static final int TEXT_RENDER_MODE_CLIP = 7;
private static final float[] unitRect = {0, 0, 0, 1, 1, 0, 1, 1};
// membervariables
/** This is the actual content */
protected ByteBuffer content = new ByteBuffer();
/** This is the writer */
protected PdfWriter writer;
/** This is the PdfDocument */
protected PdfDocument pdf;
/** This is the GraphicState in use */
protected GraphicState state = new GraphicState();
/** The list were we save/restore the state */
protected ArrayList stateList = new ArrayList();
/** The list were we save/restore the layer depth */
protected ArrayList layerDepth;
/** The separator between commands.
*/
protected int separator = '\n';
private static HashMap abrev = new HashMap();
static {
abrev.put(PdfName.BITSPERCOMPONENT, "/BPC ");
abrev.put(PdfName.COLORSPACE, "/CS ");
abrev.put(PdfName.DECODE, "/D ");
abrev.put(PdfName.DECODEPARMS, "/DP ");
abrev.put(PdfName.FILTER, "/F ");
abrev.put(PdfName.HEIGHT, "/H ");
abrev.put(PdfName.IMAGEMASK, "/IM ");
abrev.put(PdfName.INTENT, "/Intent ");
abrev.put(PdfName.INTERPOLATE, "/I ");
abrev.put(PdfName.WIDTH, "/W ");
}
// constructors
/**
* Constructs a new <CODE>PdfContentByte</CODE>-object.
*
* @param wr the writer associated to this content
*/
public PdfContentByte(PdfWriter wr) {
if (wr != null) {
writer = wr;
pdf = writer.getPdfDocument();
}
}
// methods to get the content of this object
/**
* Returns the <CODE>String</CODE> representation of this <CODE>PdfContentByte</CODE>-object.
*
* @return a <CODE>String</CODE>
*/
public String toString() {
return content.toString();
}
/**
* Gets the internal buffer.
* @return the internal buffer
*/
public ByteBuffer getInternalBuffer() {
return content;
}
/** Returns the PDF representation of this <CODE>PdfContentByte</CODE>-object.
*
* @param writer the <CODE>PdfWriter</CODE>
* @return a <CODE>byte</CODE> array with the representation
*/
public byte[] toPdf(PdfWriter writer) {
return content.toByteArray();
}
// methods to add graphical content
/**
* Adds the content of another <CODE>PdfContent</CODE>-object to this object.
*
* @param other another <CODE>PdfByteContent</CODE>-object
*/
public void add(PdfContentByte other) {
if (other.writer != null && writer != other.writer)
throw new RuntimeException("Inconsistent writers. Are you mixing two documents?");
content.append(other.content);
}
/**
* Gets the x position of the text line matrix.
*
* @return the x position of the text line matrix
*/
public float getXTLM() {
return state.xTLM;
}
/**
* Gets the y position of the text line matrix.
*
* @return the y position of the text line matrix
*/
public float getYTLM() {
return state.yTLM;
}
/**
* Gets the current text leading.
*
* @return the current text leading
*/
public float getLeading() {
return state.leading;
}
/**
* Gets the current character spacing.
*
* @return the current character spacing
*/
public float getCharacterSpacing() {
return state.charSpace;
}
/**
* Gets the current word spacing.
*
* @return the current word spacing
*/
public float getWordSpacing() {
return state.wordSpace;
}
/**
* Gets the current character spacing.
*
* @return the current character spacing
*/
public float getHorizontalScaling() {
return state.scale;
}
/**
* Changes the <VAR>Flatness</VAR>.
* <P>
* <VAR>Flatness</VAR> sets the maximum permitted distance in device pixels between the
* mathematically correct path and an approximation constructed from straight line segments.<BR>
*
* @param flatness a value
*/
public void setFlatness(float flatness) {
if (flatness >= 0 && flatness <= 100) {
content.append(flatness).append(" i").append_i(separator);
}
}
/**
* Changes the <VAR>Line cap style</VAR>.
* <P>
* The <VAR>line cap style</VAR> specifies the shape to be used at the end of open subpaths
* when they are stroked.<BR>
* Allowed values are LINE_CAP_BUTT, LINE_CAP_ROUND and LINE_CAP_PROJECTING_SQUARE.<BR>
*
* @param style a value
*/
public void setLineCap(int style) {
if (style >= 0 && style <= 2) {
content.append(style).append(" J").append_i(separator);
}
}
/**
* Changes the value of the <VAR>line dash pattern</VAR>.
* <P>
* The line dash pattern controls the pattern of dashes and gaps used to stroke paths.
* It is specified by an <I>array</I> and a <I>phase</I>. The array specifies the length
* of the alternating dashes and gaps. The phase specifies the distance into the dash
* pattern to start the dash.<BR>
*
* @param phase the value of the phase
*/
public void setLineDash(float phase) {
content.append("[] ").append(phase).append(" d").append_i(separator);
}
/**
* Changes the value of the <VAR>line dash pattern</VAR>.
* <P>
* The line dash pattern controls the pattern of dashes and gaps used to stroke paths.
* It is specified by an <I>array</I> and a <I>phase</I>. The array specifies the length
* of the alternating dashes and gaps. The phase specifies the distance into the dash
* pattern to start the dash.<BR>
*
* @param phase the value of the phase
* @param unitsOn the number of units that must be 'on' (equals the number of units that must be 'off').
*/
public void setLineDash(float unitsOn, float phase) {
content.append("[").append(unitsOn).append("] ").append(phase).append(" d").append_i(separator);
}
/**
* Changes the value of the <VAR>line dash pattern</VAR>.
* <P>
* The line dash pattern controls the pattern of dashes and gaps used to stroke paths.
* It is specified by an <I>array</I> and a <I>phase</I>. The array specifies the length
* of the alternating dashes and gaps. The phase specifies the distance into the dash
* pattern to start the dash.<BR>
*
* @param phase the value of the phase
* @param unitsOn the number of units that must be 'on'
* @param unitsOff the number of units that must be 'off'
*/
public void setLineDash(float unitsOn, float unitsOff, float phase) {
content.append("[").append(unitsOn).append(' ').append(unitsOff).append("] ").append(phase).append(" d").append_i(separator);
}
/**
* Changes the value of the <VAR>line dash pattern</VAR>.
* <P>
* The line dash pattern controls the pattern of dashes and gaps used to stroke paths.
* It is specified by an <I>array</I> and a <I>phase</I>. The array specifies the length
* of the alternating dashes and gaps. The phase specifies the distance into the dash
* pattern to start the dash.<BR>
*
* @param array length of the alternating dashes and gaps
* @param phase the value of the phase
*/
public final void setLineDash(float[] array, float phase) {
content.append("[");
for (int i = 0; i < array.length; i++) {
content.append(array[i]);
if (i < array.length - 1) content.append(' ');
}
content.append("] ").append(phase).append(" d").append_i(separator);
}
/**
* Changes the <VAR>Line join style</VAR>.
* <P>
* The <VAR>line join style</VAR> specifies the shape to be used at the corners of paths
* that are stroked.<BR>
* Allowed values are LINE_JOIN_MITER (Miter joins), LINE_JOIN_ROUND (Round joins) and LINE_JOIN_BEVEL (Bevel joins).<BR>
*
* @param style a value
*/
public void setLineJoin(int style) {
if (style >= 0 && style <= 2) {
content.append(style).append(" j").append_i(separator);
}
}
/**
* Changes the <VAR>line width</VAR>.
* <P>
* The line width specifies the thickness of the line used to stroke a path and is measured
* in user space units.<BR>
*
* @param w a width
*/
public void setLineWidth(float w) {
content.append(w).append(" w").append_i(separator);
}
/**
* Changes the <VAR>Miter limit</VAR>.
* <P>
* When two line segments meet at a sharp angle and mitered joins have been specified as the
* line join style, it is possible for the miter to extend far beyond the thickness of the line
* stroking path. The miter limit imposes a maximum on the ratio of the miter length to the line
* witdh. When the limit is exceeded, the join is converted from a miter to a bevel.<BR>
*
* @param miterLimit a miter limit
*/
public void setMiterLimit(float miterLimit) {
if (miterLimit > 1) {
content.append(miterLimit).append(" M").append_i(separator);
}
}
/**
* Modify the current clipping path by intersecting it with the current path, using the
* nonzero winding number rule to determine which regions lie inside the clipping
* path.
*/
public void clip() {
content.append("W").append_i(separator);
}
/**
* Modify the current clipping path by intersecting it with the current path, using the
* even-odd rule to determine which regions lie inside the clipping path.
*/
public void eoClip() {
content.append("W*").append_i(separator);
}
/**
* Changes the currentgray tint for filling paths (device dependent colors!).
* <P>
* Sets the color space to <B>DeviceGray</B> (or the <B>DefaultGray</B> color space),
* and sets the gray tint to use for filling paths.</P>
*
* @param gray a value between 0 (black) and 1 (white)
*/
public void setGrayFill(float gray) {
content.append(gray).append(" g").append_i(separator);
}
/**
* Changes the current gray tint for filling paths to black.
*/
public void resetGrayFill() {
content.append("0 g").append_i(separator);
}
/**
* Changes the currentgray tint for stroking paths (device dependent colors!).
* <P>
* Sets the color space to <B>DeviceGray</B> (or the <B>DefaultGray</B> color space),
* and sets the gray tint to use for stroking paths.</P>
*
* @param gray a value between 0 (black) and 1 (white)
*/
public void setGrayStroke(float gray) {
content.append(gray).append(" G").append_i(separator);
}
/**
* Changes the current gray tint for stroking paths to black.
*/
public void resetGrayStroke() {
content.append("0 G").append_i(separator);
}
/**
* Helper to validate and write the RGB color components
* @param red the intensity of red. A value between 0 and 1
* @param green the intensity of green. A value between 0 and 1
* @param blue the intensity of blue. A value between 0 and 1
*/
private void HelperRGB(float red, float green, float blue) {
PdfXConformanceImp.checkPDFXConformance(writer, PdfXConformanceImp.PDFXKEY_RGB, null);
if (red < 0)
red = 0.0f;
else if (red > 1.0f)
red = 1.0f;
if (green < 0)
green = 0.0f;
else if (green > 1.0f)
green = 1.0f;
if (blue < 0)
blue = 0.0f;
else if (blue > 1.0f)
blue = 1.0f;
content.append(red).append(' ').append(green).append(' ').append(blue);
}
/**
* Changes the current color for filling paths (device dependent colors!).
* <P>
* Sets the color space to <B>DeviceRGB</B> (or the <B>DefaultRGB</B> color space),
* and sets the color to use for filling paths.</P>
* <P>
* Following the PDF manual, each operand must be a number between 0 (minimum intensity) and
* 1 (maximum intensity).</P>
*
* @param red the intensity of red. A value between 0 and 1
* @param green the intensity of green. A value between 0 and 1
* @param blue the intensity of blue. A value between 0 and 1
*/
public void setRGBColorFillF(float red, float green, float blue) {
HelperRGB(red, green, blue);
content.append(" rg").append_i(separator);
}
/**
* Changes the current color for filling paths to black.
*/
public void resetRGBColorFill() {
content.append("0 g").append_i(separator);
}
/**
* Changes the current color for stroking paths (device dependent colors!).
* <P>
* Sets the color space to <B>DeviceRGB</B> (or the <B>DefaultRGB</B> color space),
* and sets the color to use for stroking paths.</P>
* <P>
* Following the PDF manual, each operand must be a number between 0 (miniumum intensity) and
* 1 (maximum intensity).
*
* @param red the intensity of red. A value between 0 and 1
* @param green the intensity of green. A value between 0 and 1
* @param blue the intensity of blue. A value between 0 and 1
*/
public void setRGBColorStrokeF(float red, float green, float blue) {
HelperRGB(red, green, blue);
content.append(" RG").append_i(separator);
}
/**
* Changes the current color for stroking paths to black.
*
*/
public void resetRGBColorStroke() {
content.append("0 G").append_i(separator);
}
/**
* Helper to validate and write the CMYK color components.
*
* @param cyan the intensity of cyan. A value between 0 and 1
* @param magenta the intensity of magenta. A value between 0 and 1
* @param yellow the intensity of yellow. A value between 0 and 1
* @param black the intensity of black. A value between 0 and 1
*/
private void HelperCMYK(float cyan, float magenta, float yellow, float black) {
if (cyan < 0)
cyan = 0.0f;
else if (cyan > 1.0f)
cyan = 1.0f;
if (magenta < 0)
magenta = 0.0f;
else if (magenta > 1.0f)
magenta = 1.0f;
if (yellow < 0)
yellow = 0.0f;
else if (yellow > 1.0f)
yellow = 1.0f;
if (black < 0)
black = 0.0f;
else if (black > 1.0f)
black = 1.0f;
content.append(cyan).append(' ').append(magenta).append(' ').append(yellow).append(' ').append(black);
}
/**
* Changes the current color for filling paths (device dependent colors!).
* <P>
* Sets the color space to <B>DeviceCMYK</B> (or the <B>DefaultCMYK</B> color space),
* and sets the color to use for filling paths.</P>
* <P>
* Following the PDF manual, each operand must be a number between 0 (no ink) and
* 1 (maximum ink).</P>
*
* @param cyan the intensity of cyan. A value between 0 and 1
* @param magenta the intensity of magenta. A value between 0 and 1
* @param yellow the intensity of yellow. A value between 0 and 1
* @param black the intensity of black. A value between 0 and 1
*/
public void setCMYKColorFillF(float cyan, float magenta, float yellow, float black) {
HelperCMYK(cyan, magenta, yellow, black);
content.append(" k").append_i(separator);
}
/**
* Changes the current color for filling paths to black.
*
*/
public void resetCMYKColorFill() {
content.append("0 0 0 1 k").append_i(separator);
}
/**
* Changes the current color for stroking paths (device dependent colors!).
* <P>
* Sets the color space to <B>DeviceCMYK</B> (or the <B>DefaultCMYK</B> color space),
* and sets the color to use for stroking paths.</P>
* <P>
* Following the PDF manual, each operand must be a number between 0 (miniumum intensity) and
* 1 (maximum intensity).
*
* @param cyan the intensity of cyan. A value between 0 and 1
* @param magenta the intensity of magenta. A value between 0 and 1
* @param yellow the intensity of yellow. A value between 0 and 1
* @param black the intensity of black. A value between 0 and 1
*/
public void setCMYKColorStrokeF(float cyan, float magenta, float yellow, float black) {
HelperCMYK(cyan, magenta, yellow, black);
content.append(" K").append_i(separator);
}
/**
* Changes the current color for stroking paths to black.
*
*/
public void resetCMYKColorStroke() {
content.append("0 0 0 1 K").append_i(separator);
}
/**
* Move the current point <I>(x, y)</I>, omitting any connecting line segment.
*
* @param x new x-coordinate
* @param y new y-coordinate
*/
public void moveTo(float x, float y) {
content.append(x).append(' ').append(y).append(" m").append_i(separator);
}
/**
* Appends a straight line segment from the current point <I>(x, y)</I>. The new current
* point is <I>(x, y)</I>.
*
* @param x new x-coordinate
* @param y new y-coordinate
*/
public void lineTo(float x, float y) {
content.append(x).append(' ').append(y).append(" l").append_i(separator);
}
/**
* Appends a Bêzier curve to the path, starting from the current point.
*
* @param x1 x-coordinate of the first control point
* @param y1 y-coordinate of the first control point
* @param x2 x-coordinate of the second control point
* @param y2 y-coordinate of the second control point
* @param x3 x-coordinate of the ending point (= new current point)
* @param y3 y-coordinate of the ending point (= new current point)
*/
public void curveTo(float x1, float y1, float x2, float y2, float x3, float y3) {
content.append(x1).append(' ').append(y1).append(' ').append(x2).append(' ').append(y2).append(' ').append(x3).append(' ').append(y3).append(" c").append_i(separator);
}
/**
* Appends a Bêzier curve to the path, starting from the current point.
*
* @param x2 x-coordinate of the second control point
* @param y2 y-coordinate of the second control point
* @param x3 x-coordinate of the ending point (= new current point)
* @param y3 y-coordinate of the ending point (= new current point)
*/
public void curveTo(float x2, float y2, float x3, float y3) {
content.append(x2).append(' ').append(y2).append(' ').append(x3).append(' ').append(y3).append(" v").append_i(separator);
}
/**
* Appends a Bêzier curve to the path, starting from the current point.
*
* @param x1 x-coordinate of the first control point
* @param y1 y-coordinate of the first control point
* @param x3 x-coordinate of the ending point (= new current point)
* @param y3 y-coordinate of the ending point (= new current point)
*/
public void curveFromTo(float x1, float y1, float x3, float y3) {
content.append(x1).append(' ').append(y1).append(' ').append(x3).append(' ').append(y3).append(" y").append_i(separator);
}
/** Draws a circle. The endpoint will (x+r, y).
*
* @param x x center of circle
* @param y y center of circle
* @param r radius of circle
*/
public void circle(float x, float y, float r) {
float b = 0.5523f;
moveTo(x + r, y);
curveTo(x + r, y + r * b, x + r * b, y + r, x, y + r);
curveTo(x - r * b, y + r, x - r, y + r * b, x - r, y);
curveTo(x - r, y - r * b, x - r * b, y - r, x, y - r);
curveTo(x + r * b, y - r, x + r, y - r * b, x + r, y);
}
/**
* Adds a rectangle to the current path.
*
* @param x x-coordinate of the starting point
* @param y y-coordinate of the starting point
* @param w width
* @param h height
*/
public void rectangle(float x, float y, float w, float h) {
content.append(x).append(' ').append(y).append(' ').append(w).append(' ').append(h).append(" re").append_i(separator);
}
private boolean compareColors(Color c1, Color c2) {
if (c1 == null && c2 == null)
return true;
if (c1 == null || c2 == null)
return false;
if (c1 instanceof ExtendedColor)
return c1.equals(c2);
return c2.equals(c1);
}
/**
* Adds a variable width border to the current path.
* Only use if {@link com.lowagie.text.Rectangle#isUseVariableBorders() Rectangle.isUseVariableBorders}
* = true.
* @param rect a <CODE>Rectangle</CODE>
*/
public void variableRectangle(Rectangle rect) {
float t = rect.getTop();
float b = rect.getBottom();
float r = rect.getRight();
float l = rect.getLeft();
float wt = rect.getBorderWidthTop();
float wb = rect.getBorderWidthBottom();
float wr = rect.getBorderWidthRight();
float wl = rect.getBorderWidthLeft();
Color ct = rect.getBorderColorTop();
Color cb = rect.getBorderColorBottom();
Color cr = rect.getBorderColorRight();
Color cl = rect.getBorderColorLeft();
saveState();
setLineCap(PdfContentByte.LINE_CAP_BUTT);
setLineJoin(PdfContentByte.LINE_JOIN_MITER);
float clw = 0;
boolean cdef = false;
Color ccol = null;
boolean cdefi = false;
Color cfil = null;
// draw top
if (wt > 0) {
setLineWidth(clw = wt);
cdef = true;
if (ct == null)
resetRGBColorStroke();
else
setColorStroke(ct);
ccol = ct;
moveTo(l, t - wt / 2f);
lineTo(r, t - wt / 2f);
stroke();
}
// Draw bottom
if (wb > 0) {
if (wb != clw)
setLineWidth(clw = wb);
if (!cdef || !compareColors(ccol, cb)) {
cdef = true;
if (cb == null)
resetRGBColorStroke();
else
setColorStroke(cb);
ccol = cb;
}
moveTo(r, b + wb / 2f);
lineTo(l, b + wb / 2f);
stroke();
}
// Draw right
if (wr > 0) {
if (wr != clw)
setLineWidth(clw = wr);
if (!cdef || !compareColors(ccol, cr)) {
cdef = true;
if (cr == null)
resetRGBColorStroke();
else
setColorStroke(cr);
ccol = cr;
}
boolean bt = compareColors(ct, cr);
boolean bb = compareColors(cb, cr);
moveTo(r - wr / 2f, bt ? t : t - wt);
lineTo(r - wr / 2f, bb ? b : b + wb);
stroke();
if (!bt || !bb) {
cdefi = true;
if (cr == null)
resetRGBColorFill();
else
setColorFill(cr);
cfil = cr;
if (!bt) {
moveTo(r, t);
lineTo(r, t - wt);
lineTo(r - wr, t - wt);
fill();
}
if (!bb) {
moveTo(r, b);
lineTo(r, b + wb);
lineTo(r - wr, b + wb);
fill();
}
}
}
// Draw Left
if (wl > 0) {
if (wl != clw)
setLineWidth(wl);
if (!cdef || !compareColors(ccol, cl)) {
if (cl == null)
resetRGBColorStroke();
else
setColorStroke(cl);
}
boolean bt = compareColors(ct, cl);
boolean bb = compareColors(cb, cl);
moveTo(l + wl / 2f, bt ? t : t - wt);
lineTo(l + wl / 2f, bb ? b : b + wb);
stroke();
if (!bt || !bb) {
if (!cdefi || !compareColors(cfil, cl)) {
if (cl == null)
resetRGBColorFill();
else
setColorFill(cl);
}
if (!bt) {
moveTo(l, t);
lineTo(l, t - wt);
lineTo(l + wl, t - wt);
fill();
}
if (!bb) {
moveTo(l, b);
lineTo(l, b + wb);
lineTo(l + wl, b + wb);
fill();
}
}
}
restoreState();
}
/**
* Adds a border (complete or partially) to the current path..
*
* @param rectangle a <CODE>Rectangle</CODE>
*/
public void rectangle(Rectangle rectangle) {
// the coordinates of the border are retrieved
float x1 = rectangle.getLeft();
float y1 = rectangle.getBottom();
float x2 = rectangle.getRight();
float y2 = rectangle.getTop();
// the backgroundcolor is set
Color background = rectangle.getBackgroundColor();
if (background != null) {
setColorFill(background);
rectangle(x1, y1, x2 - x1, y2 - y1);
fill();
resetRGBColorFill();
}
// if the element hasn't got any borders, nothing is added
if (! rectangle.hasBorders()) {
return;
}
// if any of the individual border colors are set
// we draw the borders all around using the
// different colors
if (rectangle.isUseVariableBorders()) {
variableRectangle(rectangle);
}
else {
// the width is set to the width of the element
if (rectangle.getBorderWidth() != Rectangle.UNDEFINED) {
setLineWidth(rectangle.getBorderWidth());
}
// the color is set to the color of the element
Color color = rectangle.getBorderColor();
if (color != null) {
setColorStroke(color);
}
// if the box is a rectangle, it is added as a rectangle
if (rectangle.hasBorder(Rectangle.BOX)) {
rectangle(x1, y1, x2 - x1, y2 - y1);
}
// if the border isn't a rectangle, the different sides are added apart
else {
if (rectangle.hasBorder(Rectangle.RIGHT)) {
moveTo(x2, y1);
lineTo(x2, y2);
}
if (rectangle.hasBorder(Rectangle.LEFT)) {
moveTo(x1, y1);
lineTo(x1, y2);
}
if (rectangle.hasBorder(Rectangle.BOTTOM)) {
moveTo(x1, y1);
lineTo(x2, y1);
}
if (rectangle.hasBorder(Rectangle.TOP)) {
moveTo(x1, y2);
lineTo(x2, y2);
}
}
stroke();
if (color != null) {
resetRGBColorStroke();
}
}
}
/**
* Closes the current subpath by appending a straight line segment from the current point
* to the starting point of the subpath.
*/
public void closePath() {
content.append("h").append_i(separator);
}
/**
* Ends the path without filling or stroking it.
*/
public void newPath() {
content.append("n").append_i(separator);
}
/**
* Strokes the path.
*/
public void stroke() {
content.append("S").append_i(separator);
}
/**
* Closes the path and strokes it.
*/
public void closePathStroke() {
content.append("s").append_i(separator);
}
/**
* Fills the path, using the non-zero winding number rule to determine the region to fill.
*/
public void fill() {
content.append("f").append_i(separator);
}
/**
* Fills the path, using the even-odd rule to determine the region to fill.
*/
public void eoFill() {
content.append("f*").append_i(separator);
}
/**
* Fills the path using the non-zero winding number rule to determine the region to fill and strokes it.
*/
public void fillStroke() {
content.append("B").append_i(separator);
}
/**
* Closes the path, fills it using the non-zero winding number rule to determine the region to fill and strokes it.
*/
public void closePathFillStroke() {
content.append("b").append_i(separator);
}
/**
* Fills the path, using the even-odd rule to determine the region to fill and strokes it.
*/
public void eoFillStroke() {
content.append("B*").append_i(separator);
}
/**
* Closes the path, fills it using the even-odd rule to determine the region to fill and strokes it.
*/
public void closePathEoFillStroke() {
content.append("b*").append_i(separator);
}
/**
* Adds an <CODE>Image</CODE> to the page. The <CODE>Image</CODE> must have
* absolute positioning.
* @param image the <CODE>Image</CODE> object
* @throws DocumentException if the <CODE>Image</CODE> does not have absolute positioning
*/
public void addImage(Image image) throws DocumentException {
addImage(image, false);
}
/**
* Adds an <CODE>Image</CODE> to the page. The <CODE>Image</CODE> must have
* absolute positioning. The image can be placed inline.
* @param image the <CODE>Image</CODE> object
* @param inlineImage <CODE>true</CODE> to place this image inline, <CODE>false</CODE> otherwise
* @throws DocumentException if the <CODE>Image</CODE> does not have absolute positioning
*/
public void addImage(Image image, boolean inlineImage) throws DocumentException {
if (!image.hasAbsoluteY())
throw new DocumentException("The image must have absolute positioning.");
float matrix[] = image.matrix();
matrix[Image.CX] = image.getAbsoluteX() - matrix[Image.CX];
matrix[Image.CY] = image.getAbsoluteY() - matrix[Image.CY];
addImage(image, matrix[0], matrix[1], matrix[2], matrix[3], matrix[4], matrix[5], inlineImage);
}
/**
* Adds an <CODE>Image</CODE> to the page. The positioning of the <CODE>Image</CODE>
* is done with the transformation matrix. To position an <CODE>image</CODE> at (x,y)
* use addImage(image, image_width, 0, 0, image_height, x, y).
* @param image the <CODE>Image</CODE> object
* @param a an element of the transformation matrix
* @param b an element of the transformation matrix
* @param c an element of the transformation matrix
* @param d an element of the transformation matrix
* @param e an element of the transformation matrix
* @param f an element of the transformation matrix
* @throws DocumentException on error
*/
public void addImage(Image image, float a, float b, float c, float d, float e, float f) throws DocumentException {
addImage(image, a, b, c, d, e, f, false);
}
/**
* Adds an <CODE>Image</CODE> to the page. The positioning of the <CODE>Image</CODE>
* is done with the transformation matrix. To position an <CODE>image</CODE> at (x,y)
* use addImage(image, image_width, 0, 0, image_height, x, y). The image can be placed inline.
* @param image the <CODE>Image</CODE> object
* @param a an element of the transformation matrix
* @param b an element of the transformation matrix
* @param c an element of the transformation matrix
* @param d an element of the transformation matrix
* @param e an element of the transformation matrix
* @param f an element of the transformation matrix
* @param inlineImage <CODE>true</CODE> to place this image inline, <CODE>false</CODE> otherwise
* @throws DocumentException on error
*/
public void addImage(Image image, float a, float b, float c, float d, float e, float f, boolean inlineImage) throws DocumentException {
try {
if (image.getLayer() != null)
beginLayer(image.getLayer());
if (image.isImgTemplate()) {
writer.addDirectImageSimple(image);
PdfTemplate template = image.getTemplateData();
float w = template.getWidth();
float h = template.getHeight();
addTemplate(template, a / w, b / w, c / h, d / h, e, f);
}
else {
content.append("q ");
content.append(a).append(' ');
content.append(b).append(' ');
content.append(c).append(' ');
content.append(d).append(' ');
content.append(e).append(' ');
content.append(f).append(" cm");
if (inlineImage) {
content.append("\nBI\n");
PdfImage pimage = new PdfImage(image, "", null);
for (Iterator it = pimage.getKeys().iterator(); it.hasNext();) {
PdfName key = (PdfName)it.next();
PdfObject value = pimage.get(key);
String s = (String)abrev.get(key);
if (s == null)
continue;
content.append(s);
boolean check = true;
if (key.equals(PdfName.COLORSPACE) && value.isArray()) {
ArrayList ar = ((PdfArray)value).getArrayList();
if (ar.size() == 4
&& PdfName.INDEXED.equals(ar.get(0))
&& ((PdfObject)ar.get(1)).isName()
&& ((PdfObject)ar.get(2)).isNumber()
&& ((PdfObject)ar.get(3)).isString()
) {
check = false;
}
}
if (check && key.equals(PdfName.COLORSPACE) && !value.isName()) {
PdfName cs = writer.getColorspaceName();
PageResources prs = getPageResources();
prs.addColor(cs, writer.addToBody(value).getIndirectReference());
value = cs;
}
value.toPdf(null, content);
content.append('\n');
}
content.append("ID\n");
pimage.writeContent(content);
content.append("\nEI\nQ").append_i(separator);
}
else {
PdfName name;
PageResources prs = getPageResources();
Image maskImage = image.getImageMask();
if (maskImage != null) {
name = writer.addDirectImageSimple(maskImage);
prs.addXObject(name, writer.getImageReference(name));
}
name = writer.addDirectImageSimple(image);
name = prs.addXObject(name, writer.getImageReference(name));
content.append(' ').append(name.getBytes()).append(" Do Q").append_i(separator);
}
}
if (image.hasBorders()) {
saveState();
float w = image.getWidth();
float h = image.getHeight();
concatCTM(a / w, b / w, c / h, d / h, e, f);
rectangle(image);
restoreState();
}
if (image.getLayer() != null)
endLayer();
Annotation annot = image.getAnnotation();
if (annot == null)
return;
float[] r = new float[unitRect.length];
for (int k = 0; k < unitRect.length; k += 2) {
r[k] = a * unitRect[k] + c * unitRect[k + 1] + e;
r[k + 1] = b * unitRect[k] + d * unitRect[k + 1] + f;
}
float llx = r[0];
float lly = r[1];
float urx = llx;
float ury = lly;
for (int k = 2; k < r.length; k += 2) {
llx = Math.min(llx, r[k]);
lly = Math.min(lly, r[k + 1]);
urx = Math.max(urx, r[k]);
ury = Math.max(ury, r[k + 1]);
}
annot = new Annotation(annot);
annot.setDimensions(llx, lly, urx, ury);
PdfAnnotation an = PdfAnnotationsImp.convertAnnotation(writer, annot, new Rectangle(llx, lly, urx, ury));
if (an == null)
return;
addAnnotation(an);
}
catch (Exception ee) {
throw new DocumentException(ee);
}
}
/**
* Makes this <CODE>PdfContentByte</CODE> empty.
*/
public void reset() {
content.reset();
stateList.clear();
state = new GraphicState();
}
/**
* Starts the writing of text.
*/
public void beginText() {
state.xTLM = 0;
state.yTLM = 0;
content.append("BT").append_i(separator);
}
/**
* Ends the writing of text and makes the current font invalid.
*/
public void endText() {
content.append("ET").append_i(separator);
}
/**
* Saves the graphic state. <CODE>saveState</CODE> and
* <CODE>restoreState</CODE> must be balanced.
*/
public void saveState() {
content.append("q").append_i(separator);
stateList.add(new GraphicState(state));
}
/**
* Restores the graphic state. <CODE>saveState</CODE> and
* <CODE>restoreState</CODE> must be balanced.
*/
public void restoreState() {
content.append("Q").append_i(separator);
int idx = stateList.size() - 1;
if (idx < 0)
throw new RuntimeException("Unbalanced save/restore state operators.");
state = (GraphicState)stateList.get(idx);
stateList.remove(idx);
}
/**
* Sets the character spacing parameter.
*
* @param charSpace a parameter
*/
public void setCharacterSpacing(float charSpace) {
state.charSpace = charSpace;
content.append(charSpace).append(" Tc").append_i(separator);
}
/**
* Sets the word spacing parameter.
*
* @param wordSpace a parameter
*/
public void setWordSpacing(float wordSpace) {
state.wordSpace = wordSpace;
content.append(wordSpace).append(" Tw").append_i(separator);
}
/**
* Sets the horizontal scaling parameter.
*
* @param scale a parameter
*/
public void setHorizontalScaling(float scale) {
state.scale = scale;
content.append(scale).append(" Tz").append_i(separator);
}
/**
* Sets the text leading parameter.
* <P>
* The leading parameter is measured in text space units. It specifies the vertical distance
* between the baselines of adjacent lines of text.</P>
*
* @param leading the new leading
*/
public void setLeading(float leading) {
state.leading = leading;
content.append(leading).append(" TL").append_i(separator);
}
/**
* Set the font and the size for the subsequent text writing.
*
* @param bf the font
* @param size the font size in points
*/
public void setFontAndSize(BaseFont bf, float size) {
checkWriter();
if (size < 0.0001f && size > -0.0001f)
throw new IllegalArgumentException("Font size too small: " + size);
state.size = size;
state.fontDetails = writer.addSimple(bf);
PageResources prs = getPageResources();
PdfName name = state.fontDetails.getFontName();
name = prs.addFont(name, state.fontDetails.getIndirectReference());
content.append(name.getBytes()).append(' ').append(size).append(" Tf").append_i(separator);
}
/**
* Sets the text rendering parameter.
*
* @param rendering a parameter
*/
public void setTextRenderingMode(int rendering) {
content.append(rendering).append(" Tr").append_i(separator);
}
/**
* Sets the text rise parameter.
* <P>
* This allows to write text in subscript or superscript mode.</P>
*
* @param rise a parameter
*/
public void setTextRise(float rise) {
content.append(rise).append(" Ts").append_i(separator);
}
/**
* A helper to insert into the content stream the <CODE>text</CODE>
* converted to bytes according to the font's encoding.
*
* @param text the text to write
*/
private void showText2(String text) {
if (state.fontDetails == null)
throw new NullPointerException("Font and size must be set before writing any text");
byte b[] = state.fontDetails.convertToBytes(text);
escapeString(b, content);
}
/**
* Shows the <CODE>text</CODE>.
*
* @param text the text to write
*/
public void showText(String text) {
showText2(text);
content.append("Tj").append_i(separator);
}
/**
* Constructs a kern array for a text in a certain font
* @param text the text
* @param font the font
* @return a PdfTextArray
*/
public static PdfTextArray getKernArray(String text, BaseFont font) {
PdfTextArray pa = new PdfTextArray();
StringBuffer acc = new StringBuffer();
int len = text.length() - 1;
char c[] = text.toCharArray();
if (len >= 0)
acc.append(c, 0, 1);
for (int k = 0; k < len; ++k) {
char c2 = c[k + 1];
int kern = font.getKerning(c[k], c2);
if (kern == 0) {
acc.append(c2);
}
else {
pa.add(acc.toString());
acc.setLength(0);
acc.append(c, k + 1, 1);
pa.add(-kern);
}
}
pa.add(acc.toString());
return pa;
}
/**
* Shows the <CODE>text</CODE> kerned.
*
* @param text the text to write
*/
public void showTextKerned(String text) {
if (state.fontDetails == null)
throw new NullPointerException("Font and size must be set before writing any text");
BaseFont bf = state.fontDetails.getBaseFont();
if (bf.hasKernPairs())
showText(getKernArray(text, bf));
else
showText(text);
}
/**
* Moves to the next line and shows <CODE>text</CODE>.
*
* @param text the text to write
*/
public void newlineShowText(String text) {
state.yTLM -= state.leading;
showText2(text);
content.append("'").append_i(separator);
}
/**
* Moves to the next line and shows text string, using the given values of the character and word spacing parameters.
*
* @param wordSpacing a parameter
* @param charSpacing a parameter
* @param text the text to write
*/
public void newlineShowText(float wordSpacing, float charSpacing, String text) {
state.yTLM -= state.leading;
content.append(wordSpacing).append(' ').append(charSpacing);
showText2(text);
content.append("\"").append_i(separator);
// The " operator sets charSpace and wordSpace into graphics state
// (cfr PDF reference v1.6, table 5.6)
state.charSpace = charSpacing;
state.wordSpace = wordSpacing;
}
/**
* Changes the text matrix.
* <P>
* Remark: this operation also initializes the current point position.</P>
*
* @param a operand 1,1 in the matrix
* @param b operand 1,2 in the matrix
* @param c operand 2,1 in the matrix
* @param d operand 2,2 in the matrix
* @param x operand 3,1 in the matrix
* @param y operand 3,2 in the matrix
*/
public void setTextMatrix(float a, float b, float c, float d, float x, float y) {
state.xTLM = x;
state.yTLM = y;
content.append(a).append(' ').append(b).append_i(' ')
.append(c).append_i(' ').append(d).append_i(' ')
.append(x).append_i(' ').append(y).append(" Tm").append_i(separator);
}
/**
* Changes the text matrix. The first four parameters are {1,0,0,1}.
* <P>
* Remark: this operation also initializes the current point position.</P>
*
* @param x operand 3,1 in the matrix
* @param y operand 3,2 in the matrix
*/
public void setTextMatrix(float x, float y) {
setTextMatrix(1, 0, 0, 1, x, y);
}
/**
* Moves to the start of the next line, offset from the start of the current line.
*
* @param x x-coordinate of the new current point
* @param y y-coordinate of the new current point
*/
public void moveText(float x, float y) {
state.xTLM += x;
state.yTLM += y;
content.append(x).append(' ').append(y).append(" Td").append_i(separator);
}
/**
* Moves to the start of the next line, offset from the start of the current line.
* <P>
* As a side effect, this sets the leading parameter in the text state.</P>
*
* @param x offset of the new current point
* @param y y-coordinate of the new current point
*/
public void moveTextWithLeading(float x, float y) {
state.xTLM += x;
state.yTLM += y;
state.leading = -y;
content.append(x).append(' ').append(y).append(" TD").append_i(separator);
}
/**
* Moves to the start of the next line.
*/
public void newlineText() {
state.yTLM -= state.leading;
content.append("T*").append_i(separator);
}
/**
* Gets the size of this content.
*
* @return the size of the content
*/
int size() {
return content.size();
}
/**
* Escapes a <CODE>byte</CODE> array according to the PDF conventions.
*
* @param b the <CODE>byte</CODE> array to escape
* @return an escaped <CODE>byte</CODE> array
*/
static byte[] escapeString(byte b[]) {
ByteBuffer content = new ByteBuffer();
escapeString(b, content);
return content.toByteArray();
}
/**
* Escapes a <CODE>byte</CODE> array according to the PDF conventions.
*
* @param b the <CODE>byte</CODE> array to escape
* @param content the content
*/
static void escapeString(byte b[], ByteBuffer content) {
content.append_i('(');
for (int k = 0; k < b.length; ++k) {
byte c = b[k];
switch (c) {
case '\r':
content.append("\\r");
break;
case '\n':
content.append("\\n");
break;
case '\t':
content.append("\\t");
break;
case '\b':
content.append("\\b");
break;
case '\f':
content.append("\\f");
break;
case '(':
case ')':
case '\\':
content.append_i('\\').append_i(c);
break;
default:
content.append_i(c);
}
}
content.append(")");
}
/**
* Adds a named outline to the document.
*
* @param outline the outline
* @param name the name for the local destination
*/
public void addOutline(PdfOutline outline, String name) {
checkWriter();
pdf.addOutline(outline, name);
}
/**
* Gets the root outline.
*
* @return the root outline
*/
public PdfOutline getRootOutline() {
checkWriter();
return pdf.getRootOutline();
}
/**
* Computes the width of the given string taking in account
* the current values of "Character spacing", "Word Spacing"
* and "Horizontal Scaling".
* The additional spacing is not computed for the last character
* of the string.
* @param text the string to get width of
* @param kerned the kerning option
* @return the width
*/
public float getEffectiveStringWidth(String text, boolean kerned) {
BaseFont bf = state.fontDetails.getBaseFont();
float w;
if (kerned)
w = bf.getWidthPointKerned(text, state.size);
else
w = bf.getWidthPoint(text, state.size);
if (state.charSpace != 0.0f && text.length() > 1) {
w += state.charSpace * (text.length() -1);
}
int ft = bf.getFontType();
if (state.wordSpace != 0.0f && (ft == BaseFont.FONT_TYPE_T1 || ft == BaseFont.FONT_TYPE_TT || ft == BaseFont.FONT_TYPE_T3)) {
for (int i = 0; i < (text.length() -1); i++) {
if (text.charAt(i) == ' ')
w += state.wordSpace;
}
}
if (state.scale != 100.0)
w = (w * state.scale) / 100.0f;
//System.out.println("String width = " + Float.toString(w));
return w;
}
/**
* Shows text right, left or center aligned with rotation.
* @param alignment the alignment can be ALIGN_CENTER, ALIGN_RIGHT or ALIGN_LEFT
* @param text the text to show
* @param x the x pivot position
* @param y the y pivot position
* @param rotation the rotation to be applied in degrees counterclockwise
*/
public void showTextAligned(int alignment, String text, float x, float y, float rotation) {
showTextAligned(alignment, text, x, y, rotation, false);
}
private void showTextAligned(int alignment, String text, float x, float y, float rotation, boolean kerned) {
if (state.fontDetails == null)
throw new NullPointerException("Font and size must be set before writing any text");
if (rotation == 0) {
switch (alignment) {
case ALIGN_CENTER:
x -= getEffectiveStringWidth(text, kerned) / 2;
break;
case ALIGN_RIGHT:
x -= getEffectiveStringWidth(text, kerned);
break;
}
setTextMatrix(x, y);
if (kerned)
showTextKerned(text);
else
showText(text);
}
else {
double alpha = rotation * Math.PI / 180.0;
float cos = (float)Math.cos(alpha);
float sin = (float)Math.sin(alpha);
float len;
switch (alignment) {
case ALIGN_CENTER:
len = getEffectiveStringWidth(text, kerned) / 2;
x -= len * cos;
y -= len * sin;
break;
case ALIGN_RIGHT:
len = getEffectiveStringWidth(text, kerned);
x -= len * cos;
y -= len * sin;
break;
}
setTextMatrix(cos, sin, -sin, cos, x, y);
if (kerned)
showTextKerned(text);
else
showText(text);
setTextMatrix(0f, 0f);
}
}
/**
* Shows text kerned right, left or center aligned with rotation.
* @param alignment the alignment can be ALIGN_CENTER, ALIGN_RIGHT or ALIGN_LEFT
* @param text the text to show
* @param x the x pivot position
* @param y the y pivot position
* @param rotation the rotation to be applied in degrees counterclockwise
*/
public void showTextAlignedKerned(int alignment, String text, float x, float y, float rotation) {
showTextAligned(alignment, text, x, y, rotation, true);
}
/**
* Concatenate a matrix to the current transformation matrix.
* @param a an element of the transformation matrix
* @param b an element of the transformation matrix
* @param c an element of the transformation matrix
* @param d an element of the transformation matrix
* @param e an element of the transformation matrix
* @param f an element of the transformation matrix
**/
public void concatCTM(float a, float b, float c, float d, float e, float f) {
content.append(a).append(' ').append(b).append(' ').append(c).append(' ');
content.append(d).append(' ').append(e).append(' ').append(f).append(" cm").append_i(separator);
}
/**
* Generates an array of bezier curves to draw an arc.
* <P>
* (x1, y1) and (x2, y2) are the corners of the enclosing rectangle.
* Angles, measured in degrees, start with 0 to the right (the positive X
* axis) and increase counter-clockwise. The arc extends from startAng
* to startAng+extent. I.e. startAng=0 and extent=180 yields an openside-down
* semi-circle.
* <P>
* The resulting coordinates are of the form float[]{x1,y1,x2,y2,x3,y3, x4,y4}
* such that the curve goes from (x1, y1) to (x4, y4) with (x2, y2) and
* (x3, y3) as their respective Bezier control points.
* <P>
* Note: this code was taken from ReportLab (www.reportlab.org), an excellent
* PDF generator for Python (BSD license: http://www.reportlab.org/devfaq.html#1.3 ).
*
* @param x1 a corner of the enclosing rectangle
* @param y1 a corner of the enclosing rectangle
* @param x2 a corner of the enclosing rectangle
* @param y2 a corner of the enclosing rectangle
* @param startAng starting angle in degrees
* @param extent angle extent in degrees
* @return a list of float[] with the bezier curves
*/
public static ArrayList bezierArc(float x1, float y1, float x2, float y2, float startAng, float extent) {
float tmp;
if (x1 > x2) {
tmp = x1;
x1 = x2;
x2 = tmp;
}
if (y2 > y1) {
tmp = y1;
y1 = y2;
y2 = tmp;
}
float fragAngle;
int Nfrag;
if (Math.abs(extent) <= 90f) {
fragAngle = extent;
Nfrag = 1;
}
else {
Nfrag = (int)(Math.ceil(Math.abs(extent)/90f));
fragAngle = extent / Nfrag;
}
float x_cen = (x1+x2)/2f;
float y_cen = (y1+y2)/2f;
float rx = (x2-x1)/2f;
float ry = (y2-y1)/2f;
float halfAng = (float)(fragAngle * Math.PI / 360.);
float kappa = (float)(Math.abs(4. / 3. * (1. - Math.cos(halfAng)) / Math.sin(halfAng)));
ArrayList pointList = new ArrayList();
for (int i = 0; i < Nfrag; ++i) {
float theta0 = (float)((startAng + i*fragAngle) * Math.PI / 180.);
float theta1 = (float)((startAng + (i+1)*fragAngle) * Math.PI / 180.);
float cos0 = (float)Math.cos(theta0);
float cos1 = (float)Math.cos(theta1);
float sin0 = (float)Math.sin(theta0);
float sin1 = (float)Math.sin(theta1);
if (fragAngle > 0f) {
pointList.add(new float[]{x_cen + rx * cos0,
y_cen - ry * sin0,
x_cen + rx * (cos0 - kappa * sin0),
y_cen - ry * (sin0 + kappa * cos0),
x_cen + rx * (cos1 + kappa * sin1),
y_cen - ry * (sin1 - kappa * cos1),
x_cen + rx * cos1,
y_cen - ry * sin1});
}
else {
pointList.add(new float[]{x_cen + rx * cos0,
y_cen - ry * sin0,
x_cen + rx * (cos0 + kappa * sin0),
y_cen - ry * (sin0 - kappa * cos0),
x_cen + rx * (cos1 - kappa * sin1),
y_cen - ry * (sin1 + kappa * cos1),
x_cen + rx * cos1,
y_cen - ry * sin1});
}
}
return pointList;
}
/**
* Draws a partial ellipse inscribed within the rectangle x1,y1,x2,y2,
* starting at startAng degrees and covering extent degrees. Angles
* start with 0 to the right (+x) and increase counter-clockwise.
*
* @param x1 a corner of the enclosing rectangle
* @param y1 a corner of the enclosing rectangle
* @param x2 a corner of the enclosing rectangle
* @param y2 a corner of the enclosing rectangle
* @param startAng starting angle in degrees
* @param extent angle extent in degrees
*/
public void arc(float x1, float y1, float x2, float y2, float startAng, float extent) {
ArrayList ar = bezierArc(x1, y1, x2, y2, startAng, extent);
if (ar.isEmpty())
return;
float pt[] = (float [])ar.get(0);
moveTo(pt[0], pt[1]);
for (int k = 0; k < ar.size(); ++k) {
pt = (float [])ar.get(k);
curveTo(pt[2], pt[3], pt[4], pt[5], pt[6], pt[7]);
}
}
/**
* Draws an ellipse inscribed within the rectangle x1,y1,x2,y2.
*
* @param x1 a corner of the enclosing rectangle
* @param y1 a corner of the enclosing rectangle
* @param x2 a corner of the enclosing rectangle
* @param y2 a corner of the enclosing rectangle
*/
public void ellipse(float x1, float y1, float x2, float y2) {
arc(x1, y1, x2, y2, 0f, 360f);
}
/**
* Create a new colored tiling pattern.
*
* @param width the width of the pattern
* @param height the height of the pattern
* @param xstep the desired horizontal spacing between pattern cells.
* May be either positive or negative, but not zero.
* @param ystep the desired vertical spacing between pattern cells.
* May be either positive or negative, but not zero.
* @return the <CODE>PdfPatternPainter</CODE> where the pattern will be created
*/
public PdfPatternPainter createPattern(float width, float height, float xstep, float ystep) {
checkWriter();
if ( xstep == 0.0f || ystep == 0.0f )
throw new RuntimeException("XStep or YStep can not be ZERO.");
PdfPatternPainter painter = new PdfPatternPainter(writer);
painter.setWidth(width);
painter.setHeight(height);
painter.setXStep(xstep);
painter.setYStep(ystep);
writer.addSimplePattern(painter);
return painter;
}
/**
* Create a new colored tiling pattern. Variables xstep and ystep are set to the same values
* of width and height.
* @param width the width of the pattern
* @param height the height of the pattern
* @return the <CODE>PdfPatternPainter</CODE> where the pattern will be created
*/
public PdfPatternPainter createPattern(float width, float height) {
return createPattern(width, height, width, height);
}
/**
* Create a new uncolored tiling pattern.
*
* @param width the width of the pattern
* @param height the height of the pattern
* @param xstep the desired horizontal spacing between pattern cells.
* May be either positive or negative, but not zero.
* @param ystep the desired vertical spacing between pattern cells.
* May be either positive or negative, but not zero.
* @param color the default color. Can be <CODE>null</CODE>
* @return the <CODE>PdfPatternPainter</CODE> where the pattern will be created
*/
public PdfPatternPainter createPattern(float width, float height, float xstep, float ystep, Color color) {
checkWriter();
if ( xstep == 0.0f || ystep == 0.0f )
throw new RuntimeException("XStep or YStep can not be ZERO.");
PdfPatternPainter painter = new PdfPatternPainter(writer, color);
painter.setWidth(width);
painter.setHeight(height);
painter.setXStep(xstep);
painter.setYStep(ystep);
writer.addSimplePattern(painter);
return painter;
}
/**
* Create a new uncolored tiling pattern.
* Variables xstep and ystep are set to the same values
* of width and height.
* @param width the width of the pattern
* @param height the height of the pattern
* @param color the default color. Can be <CODE>null</CODE>
* @return the <CODE>PdfPatternPainter</CODE> where the pattern will be created
*/
public PdfPatternPainter createPattern(float width, float height, Color color) {
return createPattern(width, height, width, height, color);
}
/**
* Creates a new template.
* <P>
* Creates a new template that is nothing more than a form XObject. This template can be included
* in this <CODE>PdfContentByte</CODE> or in another template. Templates are only written
* to the output when the document is closed permitting things like showing text in the first page
* that is only defined in the last page.
*
* @param width the bounding box width
* @param height the bounding box height
* @return the created template
*/
public PdfTemplate createTemplate(float width, float height) {
return createTemplate(width, height, null);
}
PdfTemplate createTemplate(float width, float height, PdfName forcedName) {
checkWriter();
PdfTemplate template = new PdfTemplate(writer);
template.setWidth(width);
template.setHeight(height);
writer.addDirectTemplateSimple(template, forcedName);
return template;
}
/**
* Creates a new appearance to be used with form fields.
*
* @param width the bounding box width
* @param height the bounding box height
* @return the appearance created
*/
public PdfAppearance createAppearance(float width, float height) {
return createAppearance(width, height, null);
}
PdfAppearance createAppearance(float width, float height, PdfName forcedName) {
checkWriter();
PdfAppearance template = new PdfAppearance(writer);
template.setWidth(width);
template.setHeight(height);
writer.addDirectTemplateSimple(template, forcedName);
return template;
}
/**
* Adds a PostScript XObject to this content.
*
* @param psobject the object
*/
public void addPSXObject(PdfPSXObject psobject) {
checkWriter();
PdfName name = writer.addDirectTemplateSimple(psobject, null);
PageResources prs = getPageResources();
name = prs.addXObject(name, psobject.getIndirectReference());
content.append(name.getBytes()).append(" Do").append_i(separator);
}
/**
* Adds a template to this content.
*
* @param template the template
* @param a an element of the transformation matrix
* @param b an element of the transformation matrix
* @param c an element of the transformation matrix
* @param d an element of the transformation matrix
* @param e an element of the transformation matrix
* @param f an element of the transformation matrix
*/
public void addTemplate(PdfTemplate template, float a, float b, float c, float d, float e, float f) {
checkWriter();
checkNoPattern(template);
PdfName name = writer.addDirectTemplateSimple(template, null);
PageResources prs = getPageResources();
name = prs.addXObject(name, template.getIndirectReference());
content.append("q ");
content.append(a).append(' ');
content.append(b).append(' ');
content.append(c).append(' ');
content.append(d).append(' ');
content.append(e).append(' ');
content.append(f).append(" cm ");
content.append(name.getBytes()).append(" Do Q").append_i(separator);
}
void addTemplateReference(PdfIndirectReference template, PdfName name, float a, float b, float c, float d, float e, float f) {
checkWriter();
PageResources prs = getPageResources();
name = prs.addXObject(name, template);
content.append("q ");
content.append(a).append(' ');
content.append(b).append(' ');
content.append(c).append(' ');
content.append(d).append(' ');
content.append(e).append(' ');
content.append(f).append(" cm ");
content.append(name.getBytes()).append(" Do Q").append_i(separator);
}
/**
* Adds a template to this content.
*
* @param template the template
* @param x the x location of this template
* @param y the y location of this template
*/
public void addTemplate(PdfTemplate template, float x, float y) {
addTemplate(template, 1, 0, 0, 1, x, y);
}
/**
* Changes the current color for filling paths (device dependent colors!).
* <P>
* Sets the color space to <B>DeviceCMYK</B> (or the <B>DefaultCMYK</B> color space),
* and sets the color to use for filling paths.</P>
* <P>
* This method is described in the 'Portable Document Format Reference Manual version 1.3'
* section 8.5.2.1 (page 331).</P>
* <P>
* Following the PDF manual, each operand must be a number between 0 (no ink) and
* 1 (maximum ink). This method however accepts only integers between 0x00 and 0xFF.</P>
*
* @param cyan the intensity of cyan
* @param magenta the intensity of magenta
* @param yellow the intensity of yellow
* @param black the intensity of black
*/
public void setCMYKColorFill(int cyan, int magenta, int yellow, int black) {
content.append((float)(cyan & 0xFF) / 0xFF);
content.append(' ');
content.append((float)(magenta & 0xFF) / 0xFF);
content.append(' ');
content.append((float)(yellow & 0xFF) / 0xFF);
content.append(' ');
content.append((float)(black & 0xFF) / 0xFF);
content.append(" k").append_i(separator);
}
/**
* Changes the current color for stroking paths (device dependent colors!).
* <P>
* Sets the color space to <B>DeviceCMYK</B> (or the <B>DefaultCMYK</B> color space),
* and sets the color to use for stroking paths.</P>
* <P>
* This method is described in the 'Portable Document Format Reference Manual version 1.3'
* section 8.5.2.1 (page 331).</P>
* Following the PDF manual, each operand must be a number between 0 (minimum intensity) and
* 1 (maximum intensity). This method however accepts only integers between 0x00 and 0xFF.
*
* @param cyan the intensity of red
* @param magenta the intensity of green
* @param yellow the intensity of blue
* @param black the intensity of black
*/
public void setCMYKColorStroke(int cyan, int magenta, int yellow, int black) {
content.append((float)(cyan & 0xFF) / 0xFF);
content.append(' ');
content.append((float)(magenta & 0xFF) / 0xFF);
content.append(' ');
content.append((float)(yellow & 0xFF) / 0xFF);
content.append(' ');
content.append((float)(black & 0xFF) / 0xFF);
content.append(" K").append_i(separator);
}
/**
* Changes the current color for filling paths (device dependent colors!).
* <P>
* Sets the color space to <B>DeviceRGB</B> (or the <B>DefaultRGB</B> color space),
* and sets the color to use for filling paths.</P>
* <P>
* This method is described in the 'Portable Document Format Reference Manual version 1.3'
* section 8.5.2.1 (page 331).</P>
* <P>
* Following the PDF manual, each operand must be a number between 0 (minimum intensity) and
* 1 (maximum intensity). This method however accepts only integers between 0x00 and 0xFF.</P>
*
* @param red the intensity of red
* @param green the intensity of green
* @param blue the intensity of blue
*/
public void setRGBColorFill(int red, int green, int blue) {
HelperRGB((float)(red & 0xFF) / 0xFF, (float)(green & 0xFF) / 0xFF, (float)(blue & 0xFF) / 0xFF);
content.append(" rg").append_i(separator);
}
/**
* Changes the current color for stroking paths (device dependent colors!).
* <P>
* Sets the color space to <B>DeviceRGB</B> (or the <B>DefaultRGB</B> color space),
* and sets the color to use for stroking paths.</P>
* <P>
* This method is described in the 'Portable Document Format Reference Manual version 1.3'
* section 8.5.2.1 (page 331).</P>
* Following the PDF manual, each operand must be a number between 0 (minimum intensity) and
* 1 (maximum intensity). This method however accepts only integers between 0x00 and 0xFF.
*
* @param red the intensity of red
* @param green the intensity of green
* @param blue the intensity of blue
*/
public void setRGBColorStroke(int red, int green, int blue) {
HelperRGB((float)(red & 0xFF) / 0xFF, (float)(green & 0xFF) / 0xFF, (float)(blue & 0xFF) / 0xFF);
content.append(" RG").append_i(separator);
}
/** Sets the stroke color. <CODE>color</CODE> can be an
* <CODE>ExtendedColor</CODE>.
* @param color the color
*/
public void setColorStroke(Color color) {
PdfXConformanceImp.checkPDFXConformance(writer, PdfXConformanceImp.PDFXKEY_COLOR, color);
int type = ExtendedColor.getType(color);
switch (type) {
case ExtendedColor.TYPE_GRAY: {
setGrayStroke(((GrayColor)color).getGray());
break;
}
case ExtendedColor.TYPE_CMYK: {
CMYKColor cmyk = (CMYKColor)color;
setCMYKColorStrokeF(cmyk.getCyan(), cmyk.getMagenta(), cmyk.getYellow(), cmyk.getBlack());
break;
}
case ExtendedColor.TYPE_SEPARATION: {
SpotColor spot = (SpotColor)color;
setColorStroke(spot.getPdfSpotColor(), spot.getTint());
break;
}
case ExtendedColor.TYPE_PATTERN: {
PatternColor pat = (PatternColor) color;
setPatternStroke(pat.getPainter());
break;
}
case ExtendedColor.TYPE_SHADING: {
ShadingColor shading = (ShadingColor) color;
setShadingStroke(shading.getPdfShadingPattern());
break;
}
default:
setRGBColorStroke(color.getRed(), color.getGreen(), color.getBlue());
}
}
/** Sets the fill color. <CODE>color</CODE> can be an
* <CODE>ExtendedColor</CODE>.
* @param color the color
*/
public void setColorFill(Color color) {
PdfXConformanceImp.checkPDFXConformance(writer, PdfXConformanceImp.PDFXKEY_COLOR, color);
int type = ExtendedColor.getType(color);
switch (type) {
case ExtendedColor.TYPE_GRAY: {
setGrayFill(((GrayColor)color).getGray());
break;
}
case ExtendedColor.TYPE_CMYK: {
CMYKColor cmyk = (CMYKColor)color;
setCMYKColorFillF(cmyk.getCyan(), cmyk.getMagenta(), cmyk.getYellow(), cmyk.getBlack());
break;
}
case ExtendedColor.TYPE_SEPARATION: {
SpotColor spot = (SpotColor)color;
setColorFill(spot.getPdfSpotColor(), spot.getTint());
break;
}
case ExtendedColor.TYPE_PATTERN: {
PatternColor pat = (PatternColor) color;
setPatternFill(pat.getPainter());
break;
}
case ExtendedColor.TYPE_SHADING: {
ShadingColor shading = (ShadingColor) color;
setShadingFill(shading.getPdfShadingPattern());
break;
}
default:
setRGBColorFill(color.getRed(), color.getGreen(), color.getBlue());
}
}
/** Sets the fill color to a spot color.
* @param sp the spot color
* @param tint the tint for the spot color. 0 is no color and 1
* is 100% color
*/
public void setColorFill(PdfSpotColor sp, float tint) {
checkWriter();
state.colorDetails = writer.addSimple(sp);
PageResources prs = getPageResources();
PdfName name = state.colorDetails.getColorName();
name = prs.addColor(name, state.colorDetails.getIndirectReference());
content.append(name.getBytes()).append(" cs ").append(tint).append(" scn").append_i(separator);
}
/** Sets the stroke color to a spot color.
* @param sp the spot color
* @param tint the tint for the spot color. 0 is no color and 1
* is 100% color
*/
public void setColorStroke(PdfSpotColor sp, float tint) {
checkWriter();
state.colorDetails = writer.addSimple(sp);
PageResources prs = getPageResources();
PdfName name = state.colorDetails.getColorName();
name = prs.addColor(name, state.colorDetails.getIndirectReference());
content.append(name.getBytes()).append(" CS ").append(tint).append(" SCN").append_i(separator);
}
/** Sets the fill color to a pattern. The pattern can be
* colored or uncolored.
* @param p the pattern
*/
public void setPatternFill(PdfPatternPainter p) {
if (p.isStencil()) {
setPatternFill(p, p.getDefaultColor());
return;
}
checkWriter();
PageResources prs = getPageResources();
PdfName name = writer.addSimplePattern(p);
name = prs.addPattern(name, p.getIndirectReference());
content.append(PdfName.PATTERN.getBytes()).append(" cs ").append(name.getBytes()).append(" scn").append_i(separator);
}
/** Outputs the color values to the content.
* @param color The color
* @param tint the tint if it is a spot color, ignored otherwise
*/
void outputColorNumbers(Color color, float tint) {
PdfXConformanceImp.checkPDFXConformance(writer, PdfXConformanceImp.PDFXKEY_COLOR, color);
int type = ExtendedColor.getType(color);
switch (type) {
case ExtendedColor.TYPE_RGB:
content.append((float)(color.getRed()) / 0xFF);
content.append(' ');
content.append((float)(color.getGreen()) / 0xFF);
content.append(' ');
content.append((float)(color.getBlue()) / 0xFF);
break;
case ExtendedColor.TYPE_GRAY:
content.append(((GrayColor)color).getGray());
break;
case ExtendedColor.TYPE_CMYK: {
CMYKColor cmyk = (CMYKColor)color;
content.append(cmyk.getCyan()).append(' ').append(cmyk.getMagenta());
content.append(' ').append(cmyk.getYellow()).append(' ').append(cmyk.getBlack());
break;
}
case ExtendedColor.TYPE_SEPARATION:
content.append(tint);
break;
default:
throw new RuntimeException("Invalid color type.");
}
}
/** Sets the fill color to an uncolored pattern.
* @param p the pattern
* @param color the color of the pattern
*/
public void setPatternFill(PdfPatternPainter p, Color color) {
if (ExtendedColor.getType(color) == ExtendedColor.TYPE_SEPARATION)
setPatternFill(p, color, ((SpotColor)color).getTint());
else
setPatternFill(p, color, 0);
}
/** Sets the fill color to an uncolored pattern.
* @param p the pattern
* @param color the color of the pattern
* @param tint the tint if the color is a spot color, ignored otherwise
*/
public void setPatternFill(PdfPatternPainter p, Color color, float tint) {
checkWriter();
if (!p.isStencil())
throw new RuntimeException("An uncolored pattern was expected.");
PageResources prs = getPageResources();
PdfName name = writer.addSimplePattern(p);
name = prs.addPattern(name, p.getIndirectReference());
ColorDetails csDetail = writer.addSimplePatternColorspace(color);
PdfName cName = prs.addColor(csDetail.getColorName(), csDetail.getIndirectReference());
content.append(cName.getBytes()).append(" cs").append_i(separator);
outputColorNumbers(color, tint);
content.append(' ').append(name.getBytes()).append(" scn").append_i(separator);
}
/** Sets the stroke color to an uncolored pattern.
* @param p the pattern
* @param color the color of the pattern
*/
public void setPatternStroke(PdfPatternPainter p, Color color) {
if (ExtendedColor.getType(color) == ExtendedColor.TYPE_SEPARATION)
setPatternStroke(p, color, ((SpotColor)color).getTint());
else
setPatternStroke(p, color, 0);
}
/** Sets the stroke color to an uncolored pattern.
* @param p the pattern
* @param color the color of the pattern
* @param tint the tint if the color is a spot color, ignored otherwise
*/
public void setPatternStroke(PdfPatternPainter p, Color color, float tint) {
checkWriter();
if (!p.isStencil())
throw new RuntimeException("An uncolored pattern was expected.");
PageResources prs = getPageResources();
PdfName name = writer.addSimplePattern(p);
name = prs.addPattern(name, p.getIndirectReference());
ColorDetails csDetail = writer.addSimplePatternColorspace(color);
PdfName cName = prs.addColor(csDetail.getColorName(), csDetail.getIndirectReference());
content.append(cName.getBytes()).append(" CS").append_i(separator);
outputColorNumbers(color, tint);
content.append(' ').append(name.getBytes()).append(" SCN").append_i(separator);
}
/** Sets the stroke color to a pattern. The pattern can be
* colored or uncolored.
* @param p the pattern
*/
public void setPatternStroke(PdfPatternPainter p) {
if (p.isStencil()) {
setPatternStroke(p, p.getDefaultColor());
return;
}
checkWriter();
PageResources prs = getPageResources();
PdfName name = writer.addSimplePattern(p);
name = prs.addPattern(name, p.getIndirectReference());
content.append(PdfName.PATTERN.getBytes()).append(" CS ").append(name.getBytes()).append(" SCN").append_i(separator);
}
/**
* Paints using a shading object.
* @param shading the shading object
*/
public void paintShading(PdfShading shading) {
writer.addSimpleShading(shading);
PageResources prs = getPageResources();
PdfName name = prs.addShading(shading.getShadingName(), shading.getShadingReference());
content.append(name.getBytes()).append(" sh").append_i(separator);
ColorDetails details = shading.getColorDetails();
if (details != null)
prs.addColor(details.getColorName(), details.getIndirectReference());
}
/**
* Paints using a shading pattern.
* @param shading the shading pattern
*/
public void paintShading(PdfShadingPattern shading) {
paintShading(shading.getShading());
}
/**
* Sets the shading fill pattern.
* @param shading the shading pattern
*/
public void setShadingFill(PdfShadingPattern shading) {
writer.addSimpleShadingPattern(shading);
PageResources prs = getPageResources();
PdfName name = prs.addPattern(shading.getPatternName(), shading.getPatternReference());
content.append(PdfName.PATTERN.getBytes()).append(" cs ").append(name.getBytes()).append(" scn").append_i(separator);
ColorDetails details = shading.getColorDetails();
if (details != null)
prs.addColor(details.getColorName(), details.getIndirectReference());
}
/**
* Sets the shading stroke pattern
* @param shading the shading pattern
*/
public void setShadingStroke(PdfShadingPattern shading) {
writer.addSimpleShadingPattern(shading);
PageResources prs = getPageResources();
PdfName name = prs.addPattern(shading.getPatternName(), shading.getPatternReference());
content.append(PdfName.PATTERN.getBytes()).append(" CS ").append(name.getBytes()).append(" SCN").append_i(separator);
ColorDetails details = shading.getColorDetails();
if (details != null)
prs.addColor(details.getColorName(), details.getIndirectReference());
}
/** Check if we have a valid PdfWriter.
*
*/
protected void checkWriter() {
if (writer == null)
throw new NullPointerException("The writer in PdfContentByte is null.");
}
/**
* Show an array of text.
* @param text array of text
*/
public void showText(PdfTextArray text) {
if (state.fontDetails == null)
throw new NullPointerException("Font and size must be set before writing any text");
content.append("[");
ArrayList arrayList = text.getArrayList();
boolean lastWasNumber = false;
for (int k = 0; k < arrayList.size(); ++k) {
Object obj = arrayList.get(k);
if (obj instanceof String) {
showText2((String)obj);
lastWasNumber = false;
}
else {
if (lastWasNumber)
content.append(' ');
else
lastWasNumber = true;
content.append(((Float)obj).floatValue());
}
}
content.append("]TJ").append_i(separator);
}
/**
* Gets the <CODE>PdfWriter</CODE> in use by this object.
* @return the <CODE>PdfWriter</CODE> in use by this object
*/
public PdfWriter getPdfWriter() {
return writer;
}
/**
* Gets the <CODE>PdfDocument</CODE> in use by this object.
* @return the <CODE>PdfDocument</CODE> in use by this object
*/
public PdfDocument getPdfDocument() {
return pdf;
}
/**
* Implements a link to other part of the document. The jump will
* be made to a local destination with the same name, that must exist.
* @param name the name for this link
* @param llx the lower left x corner of the activation area
* @param lly the lower left y corner of the activation area
* @param urx the upper right x corner of the activation area
* @param ury the upper right y corner of the activation area
*/
public void localGoto(String name, float llx, float lly, float urx, float ury) {
pdf.localGoto(name, llx, lly, urx, ury);
}
/**
* The local destination to where a local goto with the same
* name will jump.
* @param name the name of this local destination
* @param destination the <CODE>PdfDestination</CODE> with the jump coordinates
* @return <CODE>true</CODE> if the local destination was added,
* <CODE>false</CODE> if a local destination with the same name
* already exists
*/
public boolean localDestination(String name, PdfDestination destination) {
return pdf.localDestination(name, destination);
}
/**
* Gets a duplicate of this <CODE>PdfContentByte</CODE>. All
* the members are copied by reference but the buffer stays different.
*
* @return a copy of this <CODE>PdfContentByte</CODE>
*/
public PdfContentByte getDuplicate() {
return new PdfContentByte(writer);
}
/**
* Implements a link to another document.
* @param filename the filename for the remote document
* @param name the name to jump to
* @param llx the lower left x corner of the activation area
* @param lly the lower left y corner of the activation area
* @param urx the upper right x corner of the activation area
* @param ury the upper right y corner of the activation area
*/
public void remoteGoto(String filename, String name, float llx, float lly, float urx, float ury) {
pdf.remoteGoto(filename, name, llx, lly, urx, ury);
}
/**
* Implements a link to another document.
* @param filename the filename for the remote document
* @param page the page to jump to
* @param llx the lower left x corner of the activation area
* @param lly the lower left y corner of the activation area
* @param urx the upper right x corner of the activation area
* @param ury the upper right y corner of the activation area
*/
public void remoteGoto(String filename, int page, float llx, float lly, float urx, float ury) {
pdf.remoteGoto(filename, page, llx, lly, urx, ury);
}
/**
* Adds a round rectangle to the current path.
*
* @param x x-coordinate of the starting point
* @param y y-coordinate of the starting point
* @param w width
* @param h height
* @param r radius of the arc corner
*/
public void roundRectangle(float x, float y, float w, float h, float r) {
if (w < 0) {
x += w;
w = -w;
}
if (h < 0) {
y += h;
h = -h;
}
if (r < 0)
r = -r;
float b = 0.4477f;
moveTo(x + r, y);
lineTo(x + w - r, y);
curveTo(x + w - r * b, y, x + w, y + r * b, x + w, y + r);
lineTo(x + w, y + h - r);
curveTo(x + w, y + h - r * b, x + w - r * b, y + h, x + w - r, y + h);
lineTo(x + r, y + h);
curveTo(x + r * b, y + h, x, y + h - r * b, x, y + h - r);
lineTo(x, y + r);
curveTo(x, y + r * b, x + r * b, y, x + r, y);
}
/** Implements an action in an area.
* @param action the <CODE>PdfAction</CODE>
* @param llx the lower left x corner of the activation area
* @param lly the lower left y corner of the activation area
* @param urx the upper right x corner of the activation area
* @param ury the upper right y corner of the activation area
*/
public void setAction(PdfAction action, float llx, float lly, float urx, float ury) {
pdf.setAction(action, llx, lly, urx, ury);
}
/** Outputs a <CODE>String</CODE> directly to the content.
* @param s the <CODE>String</CODE>
*/
public void setLiteral(String s) {
content.append(s);
}
/** Outputs a <CODE>char</CODE> directly to the content.
* @param c the <CODE>char</CODE>
*/
public void setLiteral(char c) {
content.append(c);
}
/** Outputs a <CODE>float</CODE> directly to the content.
* @param n the <CODE>float</CODE>
*/
public void setLiteral(float n) {
content.append(n);
}
/** Throws an error if it is a pattern.
* @param t the object to check
*/
void checkNoPattern(PdfTemplate t) {
if (t.getType() == PdfTemplate.TYPE_PATTERN)
throw new RuntimeException("Invalid use of a pattern. A template was expected.");
}
/**
* Draws a TextField.
* @param llx
* @param lly
* @param urx
* @param ury
* @param on
*/
public void drawRadioField(float llx, float lly, float urx, float ury, boolean on) {
if (llx > urx) { float x = llx; llx = urx; urx = x; }
if (lly > ury) { float y = lly; lly = ury; ury = y; }
// silver circle
setLineWidth(1);
setLineCap(1);
setColorStroke(new Color(0xC0, 0xC0, 0xC0));
arc(llx + 1f, lly + 1f, urx - 1f, ury - 1f, 0f, 360f);
stroke();
// gray circle-segment
setLineWidth(1);
setLineCap(1);
setColorStroke(new Color(0xA0, 0xA0, 0xA0));
arc(llx + 0.5f, lly + 0.5f, urx - 0.5f, ury - 0.5f, 45, 180);
stroke();
// black circle-segment
setLineWidth(1);
setLineCap(1);
setColorStroke(new Color(0x00, 0x00, 0x00));
arc(llx + 1.5f, lly + 1.5f, urx - 1.5f, ury - 1.5f, 45, 180);
stroke();
if (on) {
// gray circle
setLineWidth(1);
setLineCap(1);
setColorFill(new Color(0x00, 0x00, 0x00));
arc(llx + 4f, lly + 4f, urx - 4f, ury - 4f, 0, 360);
fill();
}
}
/**
* Draws a TextField.
* @param llx
* @param lly
* @param urx
* @param ury
*/
public void drawTextField(float llx, float lly, float urx, float ury) {
if (llx > urx) { float x = llx; llx = urx; urx = x; }
if (lly > ury) { float y = lly; lly = ury; ury = y; }
// silver rectangle not filled
setColorStroke(new Color(0xC0, 0xC0, 0xC0));
setLineWidth(1);
setLineCap(0);
rectangle(llx, lly, urx - llx, ury - lly);
stroke();
// white rectangle filled
setLineWidth(1);
setLineCap(0);
setColorFill(new Color(0xFF, 0xFF, 0xFF));
rectangle(llx + 0.5f, lly + 0.5f, urx - llx - 1f, ury -lly - 1f);
fill();
// silver lines
setColorStroke(new Color(0xC0, 0xC0, 0xC0));
setLineWidth(1);
setLineCap(0);
moveTo(llx + 1f, lly + 1.5f);
lineTo(urx - 1.5f, lly + 1.5f);
lineTo(urx - 1.5f, ury - 1f);
stroke();
// gray lines
setColorStroke(new Color(0xA0, 0xA0, 0xA0));
setLineWidth(1);
setLineCap(0);
moveTo(llx + 1f, lly + 1);
lineTo(llx + 1f, ury - 1f);
lineTo(urx - 1f, ury - 1f);
stroke();
// black lines
setColorStroke(new Color(0x00, 0x00, 0x00));
setLineWidth(1);
setLineCap(0);
moveTo(llx + 2f, lly + 2f);
lineTo(llx + 2f, ury - 2f);
lineTo(urx - 2f, ury - 2f);
stroke();
}
/**
* Draws a button.
* @param llx
* @param lly
* @param urx
* @param ury
* @param text
* @param bf
* @param size
*/
public void drawButton(float llx, float lly, float urx, float ury, String text, BaseFont bf, float size) {
if (llx > urx) { float x = llx; llx = urx; urx = x; }
if (lly > ury) { float y = lly; lly = ury; ury = y; }
// black rectangle not filled
setColorStroke(new Color(0x00, 0x00, 0x00));
setLineWidth(1);
setLineCap(0);
rectangle(llx, lly, urx - llx, ury - lly);
stroke();
// silver rectangle filled
setLineWidth(1);
setLineCap(0);
setColorFill(new Color(0xC0, 0xC0, 0xC0));
rectangle(llx + 0.5f, lly + 0.5f, urx - llx - 1f, ury -lly - 1f);
fill();
// white lines
setColorStroke(new Color(0xFF, 0xFF, 0xFF));
setLineWidth(1);
setLineCap(0);
moveTo(llx + 1f, lly + 1f);
lineTo(llx + 1f, ury - 1f);
lineTo(urx - 1f, ury - 1f);
stroke();
// dark grey lines
setColorStroke(new Color(0xA0, 0xA0, 0xA0));
setLineWidth(1);
setLineCap(0);
moveTo(llx + 1f, lly + 1f);
lineTo(urx - 1f, lly + 1f);
lineTo(urx - 1f, ury - 1f);
stroke();
// text
resetRGBColorFill();
beginText();
setFontAndSize(bf, size);
showTextAligned(PdfContentByte.ALIGN_CENTER, text, llx + (urx - llx) / 2, lly + (ury - lly - size) / 2, 0);
endText();
}
/** Gets a <CODE>Graphics2D</CODE> to write on. The graphics
* are translated to PDF commands as shapes. No PDF fonts will appear.
* @param width the width of the panel
* @param height the height of the panel
* @return a <CODE>Graphics2D</CODE>
*/
public java.awt.Graphics2D createGraphicsShapes(float width, float height) {
return new PdfGraphics2D(this, width, height, null, true, false, 0);
}
/** Gets a <CODE>Graphics2D</CODE> to print on. The graphics
* are translated to PDF commands as shapes. No PDF fonts will appear.
* @param width the width of the panel
* @param height the height of the panel
* @param printerJob a printer job
* @return a <CODE>Graphics2D</CODE>
*/
public java.awt.Graphics2D createPrinterGraphicsShapes(float width, float height, PrinterJob printerJob) {
return new PdfPrinterGraphics2D(this, width, height, null, true, false, 0, printerJob);
}
/** Gets a <CODE>Graphics2D</CODE> to write on. The graphics
* are translated to PDF commands.
* @param width the width of the panel
* @param height the height of the panel
* @return a <CODE>Graphics2D</CODE>
*/
public java.awt.Graphics2D createGraphics(float width, float height) {
return new PdfGraphics2D(this, width, height, null, false, false, 0);
}
/** Gets a <CODE>Graphics2D</CODE> to print on. The graphics
* are translated to PDF commands.
* @param width the width of the panel
* @param height the height of the panel
* @param printerJob
* @return a <CODE>Graphics2D</CODE>
*/
public java.awt.Graphics2D createPrinterGraphics(float width, float height, PrinterJob printerJob) {
return new PdfPrinterGraphics2D(this, width, height, null, false, false, 0, printerJob);
}
/** Gets a <CODE>Graphics2D</CODE> to write on. The graphics
* are translated to PDF commands.
* @param width the width of the panel
* @param height the height of the panel
* @param convertImagesToJPEG
* @param quality
* @return a <CODE>Graphics2D</CODE>
*/
public java.awt.Graphics2D createGraphics(float width, float height, boolean convertImagesToJPEG, float quality) {
return new PdfGraphics2D(this, width, height, null, false, convertImagesToJPEG, quality);
}
/** Gets a <CODE>Graphics2D</CODE> to print on. The graphics
* are translated to PDF commands.
* @param width the width of the panel
* @param height the height of the panel
* @param convertImagesToJPEG
* @param quality
* @param printerJob
* @return a <CODE>Graphics2D</CODE>
*/
public java.awt.Graphics2D createPrinterGraphics(float width, float height, boolean convertImagesToJPEG, float quality, PrinterJob printerJob) {
return new PdfPrinterGraphics2D(this, width, height, null, false, convertImagesToJPEG, quality, printerJob);
}
/** Gets a <CODE>Graphics2D</CODE> to print on. The graphics
* are translated to PDF commands.
* @param width
* @param height
* @param convertImagesToJPEG
* @param quality
* @return A Graphics2D object
*/
public java.awt.Graphics2D createGraphicsShapes(float width, float height, boolean convertImagesToJPEG, float quality) {
return new PdfGraphics2D(this, width, height, null, true, convertImagesToJPEG, quality);
}
/** Gets a <CODE>Graphics2D</CODE> to print on. The graphics
* are translated to PDF commands.
* @param width
* @param height
* @param convertImagesToJPEG
* @param quality
* @param printerJob
* @return a Graphics2D object
*/
public java.awt.Graphics2D createPrinterGraphicsShapes(float width, float height, boolean convertImagesToJPEG, float quality, PrinterJob printerJob) {
return new PdfPrinterGraphics2D(this, width, height, null, true, convertImagesToJPEG, quality, printerJob);
}
/** Gets a <CODE>Graphics2D</CODE> to write on. The graphics
* are translated to PDF commands.
* @param width the width of the panel
* @param height the height of the panel
* @param fontMapper the mapping from awt fonts to <CODE>BaseFont</CODE>
* @return a <CODE>Graphics2D</CODE>
*/
public java.awt.Graphics2D createGraphics(float width, float height, FontMapper fontMapper) {
return new PdfGraphics2D(this, width, height, fontMapper, false, false, 0);
}
/** Gets a <CODE>Graphics2D</CODE> to print on. The graphics
* are translated to PDF commands.
* @param width the width of the panel
* @param height the height of the panel
* @param fontMapper the mapping from awt fonts to <CODE>BaseFont</CODE>
* @param printerJob a printer job
* @return a <CODE>Graphics2D</CODE>
*/
public java.awt.Graphics2D createPrinterGraphics(float width, float height, FontMapper fontMapper, PrinterJob printerJob) {
return new PdfPrinterGraphics2D(this, width, height, fontMapper, false, false, 0, printerJob);
}
/** Gets a <CODE>Graphics2D</CODE> to write on. The graphics
* are translated to PDF commands.
* @param width the width of the panel
* @param height the height of the panel
* @param fontMapper the mapping from awt fonts to <CODE>BaseFont</CODE>
* @param convertImagesToJPEG converts awt images to jpeg before inserting in pdf
* @param quality the quality of the jpeg
* @return a <CODE>Graphics2D</CODE>
*/
public java.awt.Graphics2D createGraphics(float width, float height, FontMapper fontMapper, boolean convertImagesToJPEG, float quality) {
return new PdfGraphics2D(this, width, height, fontMapper, false, convertImagesToJPEG, quality);
}
/** Gets a <CODE>Graphics2D</CODE> to print on. The graphics
* are translated to PDF commands.
* @param width the width of the panel
* @param height the height of the panel
* @param fontMapper the mapping from awt fonts to <CODE>BaseFont</CODE>
* @param convertImagesToJPEG converts awt images to jpeg before inserting in pdf
* @param quality the quality of the jpeg
* @param printerJob a printer job
* @return a <CODE>Graphics2D</CODE>
*/
public java.awt.Graphics2D createPrinterGraphics(float width, float height, FontMapper fontMapper, boolean convertImagesToJPEG, float quality, PrinterJob printerJob) {
return new PdfPrinterGraphics2D(this, width, height, fontMapper, false, convertImagesToJPEG, quality, printerJob);
}
PageResources getPageResources() {
return pdf.getPageResources();
}
/** Sets the graphic state
* @param gstate the graphic state
*/
public void setGState(PdfGState gstate) {
PdfObject obj[] = writer.addSimpleExtGState(gstate);
PageResources prs = getPageResources();
PdfName name = prs.addExtGState((PdfName)obj[0], (PdfIndirectReference)obj[1]);
content.append(name.getBytes()).append(" gs").append_i(separator);
}
/**
* Begins a graphic block whose visibility is controlled by the <CODE>layer</CODE>.
* Blocks can be nested. Each block must be terminated by an {@link #endLayer()}.<p>
* Note that nested layers with {@link PdfLayer#addChild(PdfLayer)} only require a single
* call to this method and a single call to {@link #endLayer()}; all the nesting control
* is built in.
* @param layer the layer
*/
public void beginLayer(PdfOCG layer) {
if ((layer instanceof PdfLayer) && ((PdfLayer)layer).getTitle() != null)
throw new IllegalArgumentException("A title is not a layer");
if (layerDepth == null)
layerDepth = new ArrayList();
if (layer instanceof PdfLayerMembership) {
layerDepth.add(new Integer(1));
beginLayer2(layer);
return;
}
int n = 0;
PdfLayer la = (PdfLayer)layer;
while (la != null) {
if (la.getTitle() == null) {
beginLayer2(la);
++n;
}
la = la.getParent();
}
layerDepth.add(new Integer(n));
}
private void beginLayer2(PdfOCG layer) {
PdfName name = (PdfName)writer.addSimpleProperty(layer, layer.getRef())[0];
PageResources prs = getPageResources();
name = prs.addProperty(name, layer.getRef());
content.append("/OC ").append(name.getBytes()).append(" BDC").append_i(separator);
}
/**
* Ends a layer controlled graphic block. It will end the most recent open block.
*/
public void endLayer() {
int n = 1;
if (layerDepth != null && !layerDepth.isEmpty()) {
n = ((Integer)layerDepth.get(layerDepth.size() - 1)).intValue();
layerDepth.remove(layerDepth.size() - 1);
}
while (n-- > 0)
content.append("EMC").append_i(separator);
}
/** Concatenates a transformation to the current transformation
* matrix.
* @param af the transformation
*/
public void transform(AffineTransform af) {
double arr[] = new double[6];
af.getMatrix(arr);
content.append(arr[0]).append(' ').append(arr[1]).append(' ').append(arr[2]).append(' ');
content.append(arr[3]).append(' ').append(arr[4]).append(' ').append(arr[5]).append(" cm").append_i(separator);
}
void addAnnotation(PdfAnnotation annot) {
writer.addAnnotation(annot);
}
/**
* Sets the default colorspace.
* @param name the name of the colorspace. It can be <CODE>PdfName.DEFAULTGRAY</CODE>, <CODE>PdfName.DEFAULTRGB</CODE>
* or <CODE>PdfName.DEFAULTCMYK</CODE>
* @param obj the colorspace. A <CODE>null</CODE> or <CODE>PdfNull</CODE> removes any colorspace with the same name
*/
public void setDefaultColorspace(PdfName name, PdfObject obj) {
PageResources prs = getPageResources();
prs.addDefaultColor(name, obj);
}
/**
* Begins a marked content sequence. This sequence will be tagged with the structure <CODE>struc</CODE>.
* The same structure can be used several times to connect text that belongs to the same logical segment
* but is in a different location, like the same paragraph crossing to another page, for example.
* @param struc the tagging structure
*/
public void beginMarkedContentSequence(PdfStructureElement struc) {
PdfObject obj = struc.get(PdfName.K);
int mark = pdf.getMarkPoint();
if (obj != null) {
PdfArray ar = null;
if (obj.isNumber()) {
ar = new PdfArray();
ar.add(obj);
struc.put(PdfName.K, ar);
}
else if (obj.isArray()) {
ar = (PdfArray)obj;
if (!((PdfObject)ar.getArrayList().get(0)).isNumber())
throw new IllegalArgumentException("The structure has kids.");
}
else
throw new IllegalArgumentException("Unknown object at /K " + obj.getClass().toString());
PdfDictionary dic = new PdfDictionary(PdfName.MCR);
dic.put(PdfName.PG, writer.getCurrentPage());
dic.put(PdfName.MCID, new PdfNumber(mark));
ar.add(dic);
struc.setPageMark(writer.getPageNumber() - 1, -1);
}
else {
struc.setPageMark(writer.getPageNumber() - 1, mark);
struc.put(PdfName.PG, writer.getCurrentPage());
}
pdf.incMarkPoint();
content.append(struc.get(PdfName.S).getBytes()).append(" <</MCID ").append(mark).append(">> BDC").append_i(separator);
}
/**
* Ends a marked content sequence
*/
public void endMarkedContentSequence() {
content.append("EMC").append_i(separator);
}
/**
* Begins a marked content sequence. If property is <CODE>null</CODE> the mark will be of the type
* <CODE>BMC</CODE> otherwise it will be <CODE>BDC</CODE>.
* @param tag the tag
* @param property the property
* @param inline <CODE>true</CODE> to include the property in the content or <CODE>false</CODE>
* to include the property in the resource dictionary with the possibility of reusing
*/
public void beginMarkedContentSequence(PdfName tag, PdfDictionary property, boolean inline) {
if (property == null) {
content.append(tag.getBytes()).append(" BMC").append_i(separator);
return;
}
content.append(tag.getBytes()).append(' ');
if (inline)
try {
property.toPdf(writer, content);
}
catch (Exception e) {
throw new ExceptionConverter(e);
}
else {
PdfObject[] objs;
if (writer.propertyExists(property))
objs = writer.addSimpleProperty(property, null);
else
objs = writer.addSimpleProperty(property, writer.getPdfIndirectReference());
PdfName name = (PdfName)objs[0];
PageResources prs = getPageResources();
name = prs.addProperty(name, (PdfIndirectReference)objs[1]);
content.append(name.getBytes());
}
content.append(" BDC").append_i(separator);
}
/**
* This is just a shorthand to <CODE>beginMarkedContentSequence(tag, null, false)</CODE>.
* @param tag the tag
*/
public void beginMarkedContentSequence(PdfName tag) {
beginMarkedContentSequence(tag, null, false);
}
}
The table below shows all metrics for PdfContentByte.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 273.00 | Number of blocks | |
| BLOCK_COMMENT | 48.00 | Number of block comment lines | |
| COMMENTS | 1210.00 | Comment lines | |
| COMMENT_DENSITY | 0.93 | Comment density | |
| COMPARISONS | 162.00 | Number of comparison operators | |
| CYCLOMATIC | 376.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 201.00 | Comments in declarations | |
| DOC_COMMENT | 1127.00 | Number of javadoc comment lines | |
| ELOC | 1305.00 | Effective lines of code | |
| EXEC_COMMENTS | 28.00 | Comments in executable code | |
| EXITS | 245.00 | Procedure exits | |
| FUNCTIONS | 171.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 137.29 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 553.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 0.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 0.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 0.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains public constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 0.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 0.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 0.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 3.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 2.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 81.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 1.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 2.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 0.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 6.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 1.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 103.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 12.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 0.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 1.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 0.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 0.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 0.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 1.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 1.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 0.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 0.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 0.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 0.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 0.00 | JAVA0123 Use all three components of for loop | |
| JAVA0125 | 0.00 | JAVA0125 Continue statement with label | |
| JAVA0126 | 0.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 0.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 2.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 1.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 14.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 8.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 4.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 0.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 2.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 1.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 7.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 0.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 0.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 0.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 0.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 1.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 0.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 0.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 0.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 0.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 2.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 1.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 0.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 0.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 0.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 3059.00 | Number of lines in the source file | |
| LINE_COMMENT | 35.00 | Number of line comments | |
| LOC | 1580.00 | Lines of code | |
| LOGICAL_LINES | 941.00 | Number of statements | |
| LOOPS | 12.00 | Number of loops | |
| NEST_DEPTH | 7.00 | Maximum nesting depth | |
| OPERANDS | 4955.00 | Number of operands | |
| OPERATORS | 8679.00 | Number of operators | |
| PARAMS | 350.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 13634.00 | Halstead program length | |
| PROGRAM_VOCAB | 1238.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 203.00 | Number of return points from functions | |
| SIZE | 113724.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 1173.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 65.00 | Number of unique operators | |
| WHITESPACE | 269.00 | Number of whitespace lines | |