AddAnnotations.java
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.pdfbox.examples.pdmodel;
import java.io.IOException;
import java.util.List;
import org.apache.pdfbox.cos.COSName;
import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.pdmodel.PDPage;
import org.apache.pdfbox.pdmodel.common.PDRectangle;
import org.apache.pdfbox.pdmodel.PDPageContentStream;
import org.apache.pdfbox.pdmodel.PDResources;
import org.apache.pdfbox.pdmodel.font.PDFont;
import org.apache.pdfbox.pdmodel.font.PDType0Font;
import org.apache.pdfbox.pdmodel.font.PDType1Font;
import org.apache.pdfbox.pdmodel.font.Standard14Fonts.FontName;
import org.apache.pdfbox.pdmodel.graphics.color.PDColor;
import org.apache.pdfbox.pdmodel.graphics.color.PDDeviceRGB;
import org.apache.pdfbox.pdmodel.interactive.action.PDActionGoTo;
import org.apache.pdfbox.pdmodel.interactive.action.PDActionURI;
import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation;
import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationCircle;
import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFreeText;
import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationHighlight;
import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine;
import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink;
import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPolygon;
import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquare;
import org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary;
import org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination;
import org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitWidthDestination;
import org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm;
import org.apache.pdfbox.pdmodel.interactive.form.PDVariableText;
/**
* Add annotations to pages of a PDF document.
*/
public final class AddAnnotations
{
static final float INCH = 72;
private AddAnnotations()
{
}
public static void main(String[] args) throws IOException
{
if (args.length != 1)
{
System.err.println("Usage: " + AddAnnotations.class.getName() + " <output-pdf>");
System.exit(1);
}
try (PDDocument document = new PDDocument())
{
PDPage page1 = new PDPage();
PDPage page2 = new PDPage();
PDPage page3 = new PDPage();
document.addPage(page1);
document.addPage(page2);
document.addPage(page3);
List<PDAnnotation> annotations = page1.getAnnotations();
// Some basic reusable objects/constants
// Annotations themselves can only be used once!
PDColor red = new PDColor(new float[] { 1, 0, 0 }, PDDeviceRGB.INSTANCE);
PDColor blue = new PDColor(new float[] { 0, 0, 1 }, PDDeviceRGB.INSTANCE);
PDColor green = new PDColor(new float[] { 0, 1, 0 }, PDDeviceRGB.INSTANCE);
PDColor black = new PDColor(new float[] { 0, 0, 0 }, PDDeviceRGB.INSTANCE);
PDBorderStyleDictionary borderThick = new PDBorderStyleDictionary();
borderThick.setWidth(INCH / 12); // 12th inch
PDBorderStyleDictionary borderThin = new PDBorderStyleDictionary();
borderThin.setWidth(INCH / 72); // 1 point
PDBorderStyleDictionary borderULine = new PDBorderStyleDictionary();
borderULine.setStyle(PDBorderStyleDictionary.STYLE_UNDERLINE);
borderULine.setWidth(INCH / 72); // 1 point
float pw = page1.getMediaBox().getUpperRightX();
float ph = page1.getMediaBox().getUpperRightY();
// First add some text, two lines we'll add some annotations to this later
PDFont font = new PDType1Font(FontName.HELVETICA_BOLD);
try (PDPageContentStream contents = new PDPageContentStream(document, page1))
{
contents.beginText();
contents.setFont(font, 18);
contents.newLineAtOffset(INCH, ph - INCH - 18);
contents.showText("PDFBox");
contents.newLineAtOffset(0, -(INCH / 2));
contents.showText("External URL");
contents.newLineAtOffset(0, -(INCH / 2));
contents.showText("Jump to page three");
contents.endText();
}
// Now add the markup annotation, a highlight to PDFBox text
PDAnnotationHighlight txtHighlight = new PDAnnotationHighlight();
txtHighlight.setColor(new PDColor(new float[] { 0, 1, 1 }, PDDeviceRGB.INSTANCE));
// remove line below if PDF/A-2b (and possibly other PDF-A flavours)
// also add txtMark.setPrinted(true)
txtHighlight.setConstantOpacity((float) 0.2);
// Set the rectangle containing the markup
float textWidth = font.getStringWidth("PDFBox") / 1000 * 18;
PDRectangle position = new PDRectangle();
position.setLowerLeftX(INCH);
position.setLowerLeftY(ph - INCH - 18);
position.setUpperRightX(INCH + textWidth);
position.setUpperRightY(ph - INCH);
txtHighlight.setRectangle(position);
// work out the points forming the four corners of the annotations
// set out in anti clockwise form (Completely wraps the text)
// OK, the below doesn't match that description.
// It's what acrobat 7 does and displays properly!
float[] quads = new float[8];
quads[0] = position.getLowerLeftX(); // x1
quads[1] = position.getUpperRightY()-2; // y1
quads[2] = position.getUpperRightX(); // x2
quads[3] = quads[1]; // y2
quads[4] = quads[0]; // x3
quads[5] = position.getLowerLeftY()-2; // y3
quads[6] = quads[2]; // x4
quads[7] = quads[5]; // y5
txtHighlight.setQuadPoints(quads);
txtHighlight.setContents("Highlighted since it's important");
annotations.add(txtHighlight);
// Now add the link annotation, so the click on "External URL" works
PDAnnotationLink txtLink = new PDAnnotationLink();
txtLink.setBorderStyle(borderULine);
// Set the rectangle containing the link
textWidth = font.getStringWidth("External URL") / 1000 * 18;
position = new PDRectangle();
position.setLowerLeftX(INCH);
position.setLowerLeftY(ph - 1.5f * INCH -20); // down a couple of points
position.setUpperRightX(INCH + textWidth);
position.setUpperRightY(ph - 1.5f * INCH);
txtLink.setRectangle(position);
// add an action
PDActionURI action = new PDActionURI();
action.setURI("http://pdfbox.apache.org");
txtLink.setAction(action);
annotations.add(txtLink);
// Now draw a few more annotations
PDAnnotationCircle aCircle = new PDAnnotationCircle();
aCircle.setContents("Circle Annotation");
aCircle.setInteriorColor(red); // Fill in circle in red
aCircle.setColor(blue); // The border itself will be blue
aCircle.setBorderStyle(borderThin);
// Place the annotation on the page, we'll make this 1" round
// 3" down, 1" in on the page
position = new PDRectangle();
position.setLowerLeftX(INCH);
position.setLowerLeftY(ph - 3 * INCH -INCH); // 1" height, 3" down
position.setUpperRightX(2 * INCH); // 1" in, 1" width
position.setUpperRightY(ph - 3*INCH); // 3" down
aCircle.setRectangle(position);
annotations.add(aCircle);
// Now a square annotation
PDAnnotationSquare aSquare = new PDAnnotationSquare();
aSquare.setContents("Square Annotation");
aSquare.setColor(red); // Outline in red, not setting a fill
aSquare.setBorderStyle(borderThick);
// Place the annotation on the page, we'll make this 1" (72 points) square
// 3.5" down, 1" in from the right on the page
position = new PDRectangle(); // Reuse the variable, but note it's a new object!
position.setLowerLeftX(pw - 2 * INCH); // 1" in from right, 1" wide
position.setLowerLeftY(ph - 3.5f * INCH - INCH); // 1" height, 3.5" down
position.setUpperRightX(pw - INCH); // 1" in from right
position.setUpperRightY(ph - 3.5f * INCH); // 3.5" down
aSquare.setRectangle(position);
annotations.add(aSquare);
// Now we want to draw a line between the two, one end with an open arrow
PDAnnotationLine aLine = new PDAnnotationLine();
aLine.setEndPointEndingStyle(PDAnnotationLine.LE_OPEN_ARROW);
aLine.setContents("Circle->Square");
aLine.setCaption(true); // Make the contents a caption on the line
// Set the rectangle containing the line
position = new PDRectangle(); // Reuse the variable, but note it's a new object!
position.setLowerLeftX(2 * INCH); // 1" in + width of circle
position.setLowerLeftY(ph - 3.5f * INCH - INCH); // 1" height, 3.5" down
position.setUpperRightX(pw - INCH - INCH); // 1" in from right, and width of square
position.setUpperRightY(ph - 3 * INCH); // 3" down (top of circle)
aLine.setRectangle(position);
// Now set the line position itself
float[] linepos = new float[4];
linepos[0] = 2 * INCH; // x1 = rhs of circle
linepos[1] = ph - 3.5f * INCH; // y1 halfway down circle
linepos[2] = pw - 2 * INCH; // x2 = lhs of square
linepos[3] = ph - 4 * INCH; // y2 halfway down square
aLine.setLine(linepos);
aLine.setBorderStyle(borderThick);
aLine.setColor(black);
annotations.add(aLine);
// Now add the link annotation, so the click on "Jump to page three" works
PDAnnotationLink pageLink = new PDAnnotationLink();
pageLink.setBorderStyle(borderULine);
// Set the rectangle containing the link
textWidth = font.getStringWidth("Jump to page three") / 1000 * 18;
position = new PDRectangle();
position.setLowerLeftX(INCH);
position.setLowerLeftY(ph - 2 * INCH - 20); // down a couple of points
position.setUpperRightX(INCH + textWidth);
position.setUpperRightY(ph - 2 * INCH);
pageLink.setRectangle(position);
// add the GoTo action
PDActionGoTo actionGoto = new PDActionGoTo();
// see javadoc for other types of PDPageDestination
PDPageDestination dest = new PDPageFitWidthDestination();
// do not use setPageNumber(), this is for external destinations only
dest.setPage(page3);
actionGoto.setDestination(dest);
pageLink.setAction(actionGoto);
annotations.add(pageLink);
PDAnnotationFreeText freeTextAnnotation = new PDAnnotationFreeText();
PDColor yellow = new PDColor(new float[] { 1, 1, 0 }, PDDeviceRGB.INSTANCE);
// this sets background only (contradicts PDF specification)
freeTextAnnotation.setColor(yellow);
position = new PDRectangle();
position.setLowerLeftX(1 * INCH);
position.setLowerLeftY(ph - 5f * INCH - 3 * INCH);
position.setUpperRightX(pw - INCH);
position.setUpperRightY(ph - 5f * INCH);
freeTextAnnotation.setRectangle(position);
freeTextAnnotation.setTitlePopup("Sophia Lorem");
freeTextAnnotation.setSubject("Lorem ipsum");
freeTextAnnotation.setContents("uppercase ��, lowercase ��\n"
+ "Lorem ipsum dolor sit amet, consetetur sadipscing elitr,"
+ " sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam "
+ "erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea "
+ "rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum "
+ "dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, "
+ "sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam "
+ "erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea "
+ "rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum "
+ "dolor sit amet.");
// Text and border in blue RGB color, "Liberation Sans" font, 20 point
freeTextAnnotation.setDefaultAppearance("0 0 1 rg /LibSans 20 Tf");
// Quadding does not have any effect?!
freeTextAnnotation.setQ(PDVariableText.QUADDING_RIGHT);
freeTextAnnotation.setIntent(PDAnnotationFreeText.IT_FREE_TEXT_CALLOUT);
freeTextAnnotation.setCallout(new float[]{0, ph - 9 * INCH, 3 * INCH, ph - 9 * INCH, 4 * INCH, ph - 8 * INCH});
freeTextAnnotation.setLineEndingStyle(PDAnnotationLine.LE_OPEN_ARROW);
annotations.add(freeTextAnnotation);
PDAnnotationPolygon polygon = new PDAnnotationPolygon();
position = new PDRectangle();
position.setLowerLeftX(pw - INCH);
position.setLowerLeftY(ph - INCH);
position.setUpperRightX(pw - 2 * INCH);
position.setUpperRightY(ph - 2 * INCH);
polygon.setRectangle(position);
polygon.setColor(blue);
polygon.setInteriorColor(green);
float[] vertices = { pw - INCH, ph - 2 * INCH,
pw - 1.5f * INCH, ph - INCH,
pw - 2 * INCH, ph - 2 * INCH };
polygon.setVertices(vertices);
polygon.setBorderStyle(borderThick);
polygon.setContents("Polygon annotation");
annotations.add(polygon);
// add the "Helv" font to the default resources
PDAcroForm acroForm = document.getDocumentCatalog().getAcroForm();
if (acroForm == null)
{
acroForm = new PDAcroForm(document);
document.getDocumentCatalog().setAcroForm(acroForm);
}
PDResources dr = acroForm.getDefaultResources();
if (dr == null)
{
dr = new PDResources();
acroForm.setDefaultResources(dr);
}
dr.put(COSName.HELV, new PDType1Font(FontName.HELVETICA));
// If you want to use a specific font, add it here but make sure it is not subset
// add the "Liberation Sans" font to the default resources so we can use greek
PDType0Font libSansFont = PDType0Font.load(document,
AddAnnotations.class.getResourceAsStream("/org/apache/pdfbox/resources/ttf/LiberationSans-Regular.ttf"),
false);
dr.put(COSName.getPDFName("LibSans"), libSansFont);
// Create the appearance streams.
// Adobe Reader will always display annotations without appearance streams nicely,
// but other applications may not.
// Pass the PDDocument so that the appearance handler can look into the default resources
// for non-standard fonts.
annotations.forEach(ann -> ann.constructAppearances(document));
showPageNo(document, page1, "Page 1");
showPageNo(document, page2, "Page 2");
showPageNo(document, page3, "Page 3");
// save the PDF
document.save(args[0]);
}
}
private static void showPageNo(PDDocument document, PDPage page, String pageText)
throws IOException
{
int fontSize = 10;
try (PDPageContentStream contents =
new PDPageContentStream(document, page, PDPageContentStream.AppendMode.PREPEND, true))
{
float pageWidth = page.getMediaBox().getWidth();
float pageHeight = page.getMediaBox().getHeight();
PDFont font = new PDType1Font(FontName.HELVETICA);
contents.setFont(font, fontSize);
float textWidth = font.getStringWidth(pageText) / 1000 * fontSize;
contents.beginText();
contents.newLineAtOffset(pageWidth / 2 - textWidth / 2, pageHeight - INCH / 2);
contents.showText(pageText);
contents.endText();
}
}
}