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

Example 1 with PDAnnotationLine

use of org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine 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 2 with PDAnnotationLine

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

the class PDLineAppearanceHandler method generateNormalAppearance.

@Override
public void generateNormalAppearance() {
    PDAnnotationLine annotation = (PDAnnotationLine) getAnnotation();
    PDRectangle rect = annotation.getRectangle();
    float[] pathsArray = annotation.getLine();
    if (pathsArray == null) {
        return;
    }
    AnnotationBorder ab = AnnotationBorder.getAnnotationBorder(annotation, annotation.getBorderStyle());
    PDColor color = annotation.getColor();
    if (color == null || color.getComponents().length == 0) {
        return;
    }
    float ll = annotation.getLeaderLineLength();
    float lle = annotation.getLeaderLineExtensionLength();
    float llo = annotation.getLeaderLineOffsetLength();
    // Adjust rectangle even if not empty, see PLPDF.com-MarkupAnnotations.pdf
    float minX = Float.MAX_VALUE;
    float minY = Float.MAX_VALUE;
    float maxX = Float.MIN_VALUE;
    float maxY = Float.MIN_VALUE;
    for (int i = 0; i < pathsArray.length / 2; ++i) {
        float x = pathsArray[i * 2];
        float y = pathsArray[i * 2 + 1];
        minX = Math.min(minX, x);
        minY = Math.min(minY, y);
        maxX = Math.max(maxX, x);
        maxY = Math.max(maxY, y);
    }
    // Leader lines
    if (ll < 0) {
        // /LLO and /LLE go in the same direction as /LL
        llo = -llo;
        lle = -lle;
    }
    // add/substract with, font height, and arrows
    // arrow length is 9 * width at about 30° => 10 * width seems to be enough
    // but need to consider /LL, /LLE and /LLO too
    // TODO find better way to calculate padding
    rect.setLowerLeftX(Math.min(minX - Math.max(ab.width * 10, Math.abs(llo + ll + lle)), rect.getLowerLeftX()));
    rect.setLowerLeftY(Math.min(minY - Math.max(ab.width * 10, Math.abs(llo + ll + lle)), rect.getLowerLeftY()));
    rect.setUpperRightX(Math.max(maxX + Math.max(ab.width * 10, Math.abs(llo + ll + lle)), rect.getUpperRightX()));
    rect.setUpperRightY(Math.max(maxY + Math.max(ab.width * 10, Math.abs(llo + ll + lle)), rect.getUpperRightY()));
    annotation.setRectangle(rect);
    try {
        try (PDAppearanceContentStream cs = getNormalAppearanceAsContentStream()) {
            handleOpacity(annotation.getConstantOpacity());
            // Tested with Adobe Reader:
            // text is written first (TODO)
            // width 0 is used by Adobe as such (but results in a visible line in rendering)
            // empty color array results in an invisible line ("n" operator) but the rest is visible
            // empty content is like no caption
            boolean hasStroke = cs.setStrokingColorOnDemand(color);
            if (ab.dashArray != null) {
                cs.setLineDashPattern(ab.dashArray, 0);
            }
            cs.setLineWidth(ab.width);
            float x1 = pathsArray[0];
            float y1 = pathsArray[1];
            float x2 = pathsArray[2];
            float y2 = pathsArray[3];
            // if there are leader lines, then the /L coordinates represent
            // the endpoints of the leader lines rather than the endpoints of the line itself.
            // so for us, llo + ll is the vertical offset for the line.
            float y = llo + ll;
            String contents = annotation.getContents();
            if (contents == null) {
                contents = "";
            }
            double angle = Math.atan2(y2 - y1, x2 - x1);
            cs.transform(Matrix.getRotateInstance(angle, x1, y1));
            float lineLength = (float) Math.sqrt(((x2 - x1) * (x2 - x1)) + ((y2 - y1) * (y2 - y1)));
            if (annotation.hasCaption() && !contents.isEmpty()) {
                PDType1Font font = PDType1Font.HELVETICA;
                // TODO: support newlines!!!!!
                // see https://www.pdfill.com/example/pdf_commenting_new.pdf
                float contentLength = 0;
                try {
                    contentLength = font.getStringWidth(annotation.getContents()) / 1000 * FONT_SIZE;
                // TODO How to decide the size of the font?
                // 9 seems to be standard, but if the text doesn't fit, a scaling is done
                // see AnnotationSample.Standard.pdf, diagonal line
                } catch (IllegalArgumentException ex) {
                    // Adobe Reader displays placeholders instead
                    LOG.error("line text '" + annotation.getContents() + "' can't be shown", ex);
                }
                float xOffset = (lineLength - contentLength) / 2;
                float yOffset;
                // Leader lines
                cs.moveTo(0, llo);
                cs.lineTo(0, llo + ll + lle);
                cs.moveTo(lineLength, llo);
                cs.lineTo(lineLength, llo + ll + lle);
                String captionPositioning = annotation.getCaptionPositioning();
                // that's the easiest way to calculate the positions for the line before and after inline caption
                if (SHORT_STYLES.contains(annotation.getStartPointEndingStyle())) {
                    cs.moveTo(ab.width, y);
                } else {
                    cs.moveTo(0, y);
                }
                if ("Top".equals(captionPositioning)) {
                    // this arbitrary number is from Adobe
                    yOffset = 1.908f;
                } else {
                    // Inline
                    // this arbitrary number is from Adobe
                    yOffset = -2.6f;
                    cs.lineTo(xOffset - ab.width, y);
                    cs.moveTo(lineLength - xOffset + ab.width, y);
                }
                if (SHORT_STYLES.contains(annotation.getEndPointEndingStyle())) {
                    cs.lineTo(lineLength - ab.width, y);
                } else {
                    cs.lineTo(lineLength, y);
                }
                cs.drawShape(ab.width, hasStroke, false);
                // /CO entry (caption offset)
                float captionHorizontalOffset = annotation.getCaptionHorizontalOffset();
                float captionVerticalOffset = annotation.getCaptionVerticalOffset();
                // check contentLength so we don't show if there was trouble before
                if (contentLength > 0) {
                    prepareResources();
                    cs.beginText();
                    cs.setFont(font, FONT_SIZE);
                    cs.newLineAtOffset(xOffset + captionHorizontalOffset, y + yOffset + captionVerticalOffset);
                    cs.showText(annotation.getContents());
                    cs.endText();
                }
                if (Float.compare(captionVerticalOffset, 0) != 0) {
                    // Adobe paints vertical bar to the caption
                    cs.moveTo(0 + lineLength / 2, y);
                    cs.lineTo(0 + lineLength / 2, y + captionVerticalOffset);
                    cs.drawShape(ab.width, hasStroke, false);
                }
            } else {
                if (SHORT_STYLES.contains(annotation.getStartPointEndingStyle())) {
                    cs.moveTo(ab.width, y);
                } else {
                    cs.moveTo(0, y);
                }
                if (SHORT_STYLES.contains(annotation.getEndPointEndingStyle())) {
                    cs.lineTo(lineLength - ab.width, y);
                } else {
                    cs.lineTo(lineLength, y);
                }
                cs.drawShape(ab.width, hasStroke, false);
            }
            // do this here and not before showing the text, or the text would appear in the
            // interior color
            boolean hasBackground = cs.setNonStrokingColorOnDemand(annotation.getInteriorColor());
            switch(annotation.getStartPointEndingStyle()) {
                case PDAnnotationLine.LE_OPEN_ARROW:
                case PDAnnotationLine.LE_CLOSED_ARROW:
                    drawArrow(cs, ab.width, y, ab.width * 9);
                    if (PDAnnotationLine.LE_CLOSED_ARROW.equals(annotation.getStartPointEndingStyle())) {
                        cs.closePath();
                    }
                    break;
                case PDAnnotationLine.LE_BUTT:
                    cs.moveTo(0, y - ab.width * 3);
                    cs.lineTo(0, y + ab.width * 3);
                    break;
                case PDAnnotationLine.LE_DIAMOND:
                    drawDiamond(cs, 0, y, ab.width * 3);
                    break;
                case PDAnnotationLine.LE_SQUARE:
                    cs.addRect(0 - ab.width * 3, y - ab.width * 3, ab.width * 6, ab.width * 6);
                    break;
                case PDAnnotationLine.LE_CIRCLE:
                    addCircle(cs, 0, y, ab.width * 3);
                    break;
                case PDAnnotationLine.LE_R_OPEN_ARROW:
                case PDAnnotationLine.LE_R_CLOSED_ARROW:
                    drawArrow(cs, -ab.width, y, -ab.width * 9);
                    if (PDAnnotationLine.LE_R_CLOSED_ARROW.equals(annotation.getStartPointEndingStyle())) {
                        cs.closePath();
                    }
                    break;
                case PDAnnotationLine.LE_SLASH:
                    // the line is 18 x linewidth at an angle of 60°
                    cs.moveTo((float) (Math.cos(Math.toRadians(60)) * ab.width * 9), y + (float) (Math.sin(Math.toRadians(60)) * ab.width * 9));
                    cs.lineTo((float) (Math.cos(Math.toRadians(240)) * ab.width * 9), y + (float) (Math.sin(Math.toRadians(240)) * ab.width * 9));
                    break;
                default:
                    break;
            }
            if (INTERIOR_COLOR_STYLES.contains(annotation.getStartPointEndingStyle())) {
                cs.drawShape(ab.width, hasStroke, hasBackground);
            } else if (!PDAnnotationLine.LE_NONE.equals(annotation.getStartPointEndingStyle())) {
                // need to do this separately, because sometimes /IC is set anyway
                cs.drawShape(ab.width, hasStroke, false);
            }
            switch(annotation.getEndPointEndingStyle()) {
                case PDAnnotationLine.LE_OPEN_ARROW:
                case PDAnnotationLine.LE_CLOSED_ARROW:
                    drawArrow(cs, lineLength - ab.width, y, -ab.width * 9);
                    if (PDAnnotationLine.LE_CLOSED_ARROW.equals(annotation.getEndPointEndingStyle())) {
                        cs.closePath();
                    }
                    break;
                case PDAnnotationLine.LE_BUTT:
                    cs.moveTo(lineLength, y - ab.width * 3);
                    cs.lineTo(lineLength, y + ab.width * 3);
                    break;
                case PDAnnotationLine.LE_DIAMOND:
                    drawDiamond(cs, lineLength, y, ab.width * 3);
                    break;
                case PDAnnotationLine.LE_SQUARE:
                    cs.addRect(lineLength - ab.width * 3, y - ab.width * 3, ab.width * 6, ab.width * 6);
                    break;
                case PDAnnotationLine.LE_CIRCLE:
                    addCircle(cs, lineLength, y, ab.width * 3);
                    break;
                case PDAnnotationLine.LE_R_OPEN_ARROW:
                case PDAnnotationLine.LE_R_CLOSED_ARROW:
                    drawArrow(cs, lineLength + ab.width, y, ab.width * 9);
                    if (PDAnnotationLine.LE_R_CLOSED_ARROW.equals(annotation.getEndPointEndingStyle())) {
                        cs.closePath();
                    }
                    break;
                case PDAnnotationLine.LE_SLASH:
                    // the line is 18 x linewidth at an angle of 60°
                    cs.moveTo(lineLength + (float) (Math.cos(Math.toRadians(60)) * ab.width * 9), y + (float) (Math.sin(Math.toRadians(60)) * ab.width * 9));
                    cs.lineTo(lineLength + (float) (Math.cos(Math.toRadians(240)) * ab.width * 9), y + (float) (Math.sin(Math.toRadians(240)) * ab.width * 9));
                    break;
                default:
                    break;
            }
            if (INTERIOR_COLOR_STYLES.contains(annotation.getEndPointEndingStyle())) {
                cs.drawShape(ab.width, hasStroke, hasBackground);
            } else if (!PDAnnotationLine.LE_NONE.equals(annotation.getEndPointEndingStyle())) {
                // need to do this separately, because sometimes /IC is set anyway
                cs.drawShape(ab.width, hasStroke, false);
            }
        }
    } catch (IOException ex) {
        LOG.error(ex);
    }
}