Examples with PDAnnotationLink org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink used on opensource projects

Example 1 with PDAnnotationLink

use of org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink in project pdfbox by apache.

the class TestPDPageAnnotationsFiltering method initMock.

@Before
public void initMock() {
    COSDictionary mockedPageWithAnnotations = new COSDictionary();
    COSArray annotsDictionnary = new COSArray();
    annotsDictionnary.add(new PDAnnotationRubberStamp().getCOSObject());
    annotsDictionnary.add(new PDAnnotationSquare().getCOSObject());
    annotsDictionnary.add(new PDAnnotationLink().getCOSObject());
    mockedPageWithAnnotations.setItem(COSName.ANNOTS, annotsDictionnary);
    page = new PDPage(mockedPageWithAnnotations);
}

Example 2 with PDAnnotationLink

use of org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink in project pdfbox by apache.

the class AddAnnotations method main.

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 black = new PDColor(new float[] { 0, 0, 0 }, PDDeviceRGB.INSTANCE);
        PDBorderStyleDictionary borderThick = new PDBorderStyleDictionary();
        // 12th inch
        borderThick.setWidth(INCH / 12);
        PDBorderStyleDictionary borderThin = new PDBorderStyleDictionary();
        // 1 point
        borderThin.setWidth(INCH / 72);
        PDBorderStyleDictionary borderULine = new PDBorderStyleDictionary();
        borderULine.setStyle(PDBorderStyleDictionary.STYLE_UNDERLINE);
        // 1 point
        borderULine.setWidth(INCH / 72);
        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 = PDType1Font.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));
        // 20% transparent
        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];
        // x1
        quads[0] = position.getLowerLeftX();
        // y1
        quads[1] = position.getUpperRightY() - 2;
        // x2
        quads[2] = position.getUpperRightX();
        // y2
        quads[3] = quads[1];
        // x3
        quads[4] = quads[0];
        // y3
        quads[5] = position.getLowerLeftY() - 2;
        // x4
        quads[6] = quads[2];
        // y5
        quads[7] = quads[5];
        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);
        // down a couple of points
        position.setLowerLeftY(ph - 1.5f * INCH - 20);
        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");
        // Fill in circle in red
        aCircle.setInteriorColor(red);
        // The border itself will be blue
        aCircle.setColor(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);
        // 1" height, 3" down
        position.setLowerLeftY(ph - 3 * INCH - INCH);
        // 1" in, 1" width
        position.setUpperRightX(2 * INCH);
        // 3" down
        position.setUpperRightY(ph - 3 * INCH);
        aCircle.setRectangle(position);
        annotations.add(aCircle);
        // Now a square annotation
        PDAnnotationSquare aSquare = new PDAnnotationSquare();
        aSquare.setContents("Square Annotation");
        // Outline in red, not setting a fill
        aSquare.setColor(red);
        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
        // Reuse the variable, but note it's a new object!
        position = new PDRectangle();
        // 1" in from right, 1" wide
        position.setLowerLeftX(pw - 2 * INCH);
        // 1" height, 3.5" down
        position.setLowerLeftY(ph - 3.5f * INCH - INCH);
        // 1" in from right
        position.setUpperRightX(pw - INCH);
        // 3.5" down
        position.setUpperRightY(ph - 3.5f * INCH);
        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");
        // Make the contents a caption on the line
        aLine.setCaption(true);
        // Set the rectangle containing the line
        // Reuse the variable, but note it's a new object!
        position = new PDRectangle();
        // 1" in + width of circle
        position.setLowerLeftX(2 * INCH);
        // 1" height, 3.5" down
        position.setLowerLeftY(ph - 3.5f * INCH - INCH);
        // 1" in from right, and width of square
        position.setUpperRightX(pw - INCH - INCH);
        // 3" down (top of circle)
        position.setUpperRightY(ph - 3 * INCH);
        aLine.setRectangle(position);
        // Now set the line position itself
        float[] linepos = new float[4];
        // x1 = rhs of circle
        linepos[0] = 2 * INCH;
        // y1 halfway down circle
        linepos[1] = ph - 3.5f * INCH;
        // x2 = lhs of square
        linepos[2] = pw - 2 * INCH;
        // y2 halfway down square
        linepos[3] = ph - 4 * INCH;
        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);
        // down a couple of points
        position.setLowerLeftY(ph - 2 * INCH - 20);
        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("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, "Helv" font, 20 point
        freeTextAnnotation.setDefaultAppearance("0 0 1 rg /Helv 20 Tf");
        // Quadding does not have any effect?!
        freeTextAnnotation.setQ(PDVariableText.QUADDING_RIGHT);
        annotations.add(freeTextAnnotation);
        // 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.getPDFName("Helv"), PDType1Font.HELVETICA);
        // but other applications may not.
        for (PDAnnotation ann : annotations) {
            ann.constructAppearances();
        }
        showPageNo(document, page1, "Page 1");
        showPageNo(document, page2, "Page 2");
        showPageNo(document, page3, "Page 3");
        // save the PDF
        document.save(args[0]);
    }
}

Example 3 with PDAnnotationLink

use of org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink in project pdfbox by apache.

the class ReplaceURLs method main.

/**
 * This will read in a document and replace all of the urls with
 * http://pdfbox.apache.org.
 * <br>
 * see usage() for commandline
 *
 * @param args Command line arguments.
 *
 * @throws IOException If there is an error during the process.
 */
public static void main(String[] args) throws IOException {
    PDDocument doc = null;
    try {
        if (args.length != 2) {
            usage();
        } else {
            doc = PDDocument.load(new File(args[0]));
            int pageNum = 0;
            for (PDPage page : doc.getPages()) {
                pageNum++;
                List<PDAnnotation> annotations = page.getAnnotations();
                for (PDAnnotation annotation : annotations) {
                    PDAnnotation annot = annotation;
                    if (annot instanceof PDAnnotationLink) {
                        PDAnnotationLink link = (PDAnnotationLink) annot;
                        PDAction action = link.getAction();
                        if (action instanceof PDActionURI) {
                            PDActionURI uri = (PDActionURI) action;
                            String oldURI = uri.getURI();
                            String newURI = "http://pdfbox.apache.org";
                            System.out.println("Page " + pageNum + ": Replacing " + oldURI + " with " + newURI);
                            uri.setURI(newURI);
                        }
                    }
                }
            }
            doc.save(args[1]);
        }
    } finally {
        if (doc != null) {
            doc.close();
        }
    }
}

Example 4 with PDAnnotationLink

use of org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink in project xwiki-platform by xwiki.

the class PDFTest method extractLinks.

/**
 * Code adapted from http://www.docjar.com/html/api/org/apache/pdfbox/examples/pdmodel/PrintURLs.java.html
 */
private Map<String, PDAction> extractLinks(PDPage page) throws Exception {
    Map<String, PDAction> links = new HashMap<String, PDAction>();
    PDFTextStripperByArea stripper = new PDFTextStripperByArea();
    List<PDAnnotation> annotations = page.getAnnotations();
    // First setup the text extraction regions.
    for (int j = 0; j < annotations.size(); j++) {
        PDAnnotation annotation = annotations.get(j);
        if (annotation instanceof PDAnnotationLink) {
            PDAnnotationLink link = (PDAnnotationLink) annotation;
            PDRectangle rect = link.getRectangle();
            // Need to reposition link rectangle to match text space.
            float x = rect.getLowerLeftX();
            float y = rect.getUpperRightY();
            float width = rect.getWidth();
            float height = rect.getHeight();
            int rotation = page.getRotation();
            if (rotation == 0) {
                PDRectangle pageSize = page.getMediaBox();
                y = pageSize.getHeight() - y;
            } else if (rotation == 90) {
            // Do nothing.
            }
            Rectangle2D.Float awtRect = new Rectangle2D.Float(x, y, width, height);
            stripper.addRegion(String.valueOf(j), awtRect);
        }
    }
    stripper.extractRegions(page);
    for (int j = 0; j < annotations.size(); j++) {
        PDAnnotation annotation = annotations.get(j);
        if (annotation instanceof PDAnnotationLink) {
            PDAnnotationLink link = (PDAnnotationLink) annotation;
            String label = stripper.getTextForRegion(String.valueOf(j)).trim();
            links.put(label, link.getAction());
        }
    }
    return links;
}

Example 5 with PDAnnotationLink

use of org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink in project estatio by estatio.

the class PdfManipulator method addHyperlink.

private void addHyperlink(final float x, final float y, final String hyperlink, final PDPage pdPage) throws IOException {
    PDAnnotationLink txtLink = new PDAnnotationLink();
    PDRectangle position = new PDRectangle();
    PDBorderStyleDictionary underline = new PDBorderStyleDictionary();
    underline.setStyle(PDBorderStyleDictionary.STYLE_UNDERLINE);
    txtLink.setBorderStyle(underline);
    position.setLowerLeftX(x);
    position.setLowerLeftY(y);
    position.setUpperRightX(X_MARGIN_LEFT + BOX_WIDTH);
    position.setUpperRightY(y + TEXT_LINE_HEIGHT);
    txtLink.setRectangle(position);
    PDActionURI action = new PDActionURI();
    action.setURI(hyperlink);
    txtLink.setAction(action);
    pdPage.getAnnotations().add(txtLink);
}