Editable Forms with JasperReports & PDFBox

<dependencies>
  <dependency>
    <groupId>net.sf.jasperreports</groupId>
    <artifactId>jasperreports</artifactId>
    <version>7.0.8</version>
  </dependency>
  <dependency>
    <groupId>net.sf.jasperreports</groupId>
    <artifactId>jasperreports-pdf</artifactId>
    <version>7.0.8</version>
  </dependency>
  <dependency>
    <groupId>net.sf.jasperreports</groupId>
    <artifactId>jasperreports-jdt</artifactId>
    <version>7.0.8</version>
  </dependency>
  <dependency>
    <groupId>org.apache.pdfbox</groupId>
    <artifactId>pdfbox</artifactId>
    <version>3.0.8</version>
  </dependency>
</dependencies>

package bookshelf;

import java.io.IOException;
import java.nio.file.Path;

import org.apache.pdfbox.Loader;
import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm;
import org.apache.pdfbox.pdmodel.interactive.form.PDField;
import org.apache.pdfbox.pdmodel.interactive.form.PDNonTerminalField;
import org.apache.pdfbox.pdmodel.interactive.form.PDTerminalField;

/** Prints every field of a PDF form: the fully qualified name, the class, the value and the widget count. */
public final class FormInspector {

    private FormInspector() {
    }

    public static void print(Path pdf) throws IOException {
        try (PDDocument document = Loader.loadPDF(pdf.toFile())) {
            PDAcroForm form = document.getDocumentCatalog().getAcroForm();
            if (form == null) {
                System.out.println("no AcroForm");
                return;
            }
            System.out.println("NeedAppearances=" + form.getNeedAppearances()
                    + " XFA=" + form.hasXFA());
            for (PDField field : form.getFieldTree()) {
                if (field instanceof PDNonTerminalField) {
                    System.out.println("  group   " + field.getFullyQualifiedName());
                } else {
                    PDTerminalField terminal = (PDTerminalField) field;
                    System.out.printf("  %-8s %-22s value=%-14s widgets=%d%n",
                            field.getFieldType(), field.getFullyQualifiedName(),
                            field.getValueAsString(), terminal.getWidgets().size());
                }
            }
        }
    }

    public static void main(String[] args) throws IOException {
        print(Path.of(args[0]));
    }
}

NeedAppearances=false XFA=false
  Tx       customerId             value=BK-000123      widgets=1
  Tx       fullName               value=               widgets=1
  Tx       billingAddress         value=               widgets=1
  Ch       country                value=[Spain]        widgets=1
  Ch       interests              value=[Fiction]      widgets=1
  Btn      newsletter             value=checked        widgets=1
  Btn      plan                   value=FIELD_<uuid>   widgets=2

package bookshelf;

import java.io.IOException;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.List;

import org.apache.pdfbox.Loader;
import org.apache.pdfbox.cos.COSName;
import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget;
import org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm;
import org.apache.pdfbox.pdmodel.interactive.form.PDCheckBox;
import org.apache.pdfbox.pdmodel.interactive.form.PDComboBox;
import org.apache.pdfbox.pdmodel.interactive.form.PDField;
import org.apache.pdfbox.pdmodel.interactive.form.PDListBox;
import org.apache.pdfbox.pdmodel.interactive.form.PDRadioButton;
import org.apache.pdfbox.pdmodel.interactive.form.PDTextField;

/** Fills the form exported by JasperReports and writes a filled copy and a flattened copy. */
public final class FillAndFlatten {

    private FillAndFlatten() {
    }

    public static void fill(Path source, Path filled) throws IOException {
        try (PDDocument document = Loader.loadPDF(source.toFile())) {
            PDAcroForm form = document.getDocumentCatalog().getAcroForm();

            ((PDTextField) form.getField("fullName")).setValue("Ada Example");
            ((PDTextField) form.getField("billingAddress")).setValue("1 Fictitious Street\nSampletown");
            ((PDComboBox) form.getField("country")).setValue("Portugal");
            // The list that JasperReports writes is single-select: a second value is rejected.
            ((PDListBox) form.getField("interests")).setValue("Science");

            PDCheckBox newsletter = (PDCheckBox) form.getField("newsletter");
            newsletter.unCheck();

            // JasperReports names each radio option after its element (FIELD_ and a UUID that changes on every
            // export), so read the "on" state of the second widget instead of hard-coding a value.
            PDRadioButton plan = (PDRadioButton) form.getField("plan");
            plan.setValue(onState(plan.getWidgets().get(1)));

            document.save(filled.toFile());
        }
    }

    private static String onState(PDAnnotationWidget widget) {
        return widget.getAppearance().getNormalAppearance().getSubDictionary().keySet().stream()
                .map(COSName::getName)
                .filter(name -> !"Off".equals(name))
                .findFirst()
                .orElseThrow();
    }

    public static void flatten(Path filled, Path flat) throws IOException {
        try (PDDocument document = Loader.loadPDF(filled.toFile())) {
            PDAcroForm form = document.getDocumentCatalog().getAcroForm();
            // Flatten every field of the tree (the same as flatten()), refreshing each appearance first.
            List<PDField> toFlatten = new ArrayList<>();
            form.getFieldTree().forEach(toFlatten::add);
            form.flatten(toFlatten, true);
            document.save(flat.toFile());
        }
    }

    public static void main(String[] args) throws IOException {
        fill(Path.of(args[0]), Path.of(args[1]));
        flatten(Path.of(args[1]), Path.of(args[2]));
    }
}

package bookshelf;

import java.io.IOException;
import java.nio.file.Path;

import org.apache.pdfbox.Loader;
import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.pdmodel.PDPage;
import org.apache.pdfbox.pdmodel.common.PDRectangle;
import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget;
import org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm;
import org.apache.pdfbox.pdmodel.interactive.form.PDSignatureField;

/** Adds the one thing the JasperReports exporter cannot produce: an empty signature field. */
public final class AddSignatureField {

    private AddSignatureField() {
    }

    public static void add(Path source, Path target) throws IOException {
        try (PDDocument document = Loader.loadPDF(source.toFile())) {
            PDAcroForm form = document.getDocumentCatalog().getAcroForm();
            PDPage page = document.getPage(0);

            PDSignatureField signature = new PDSignatureField(form);
            signature.setPartialName("customerSignature");
            PDAnnotationWidget widget = signature.getWidgets().get(0);
            widget.setRectangle(new PDRectangle(150, 250, 200, 60));
            widget.setPage(page);
            widget.setPrinted(true);
            page.getAnnotations().add(widget);
            form.getFields().add(signature);

            // SignaturesExist (1) | AppendOnly (2): later signatures must be incremental updates.
            form.setSignaturesExist(true);
            form.setAppendOnly(true);
            document.save(target.toFile());
        }
    }

    public static void main(String[] args) throws IOException {
        add(Path.of(args[0]), Path.of(args[1]));
    }
}

package bookshelf;

import java.io.IOException;
import java.nio.file.Path;
import java.util.List;

import org.apache.pdfbox.cos.COSDictionary;
import org.apache.pdfbox.cos.COSName;
import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.pdmodel.PDPage;
import org.apache.pdfbox.pdmodel.PDPageContentStream;
import org.apache.pdfbox.pdmodel.PDResources;
import org.apache.pdfbox.pdmodel.common.PDRectangle;
import org.apache.pdfbox.pdmodel.font.PDType1Font;
import org.apache.pdfbox.pdmodel.font.Standard14Fonts;
import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget;
import org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary;
import org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceEntry;
import org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceStream;
import org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm;
import org.apache.pdfbox.pdmodel.interactive.form.PDCheckBox;
import org.apache.pdfbox.pdmodel.interactive.form.PDRadioButton;
import org.apache.pdfbox.pdmodel.interactive.form.PDTextField;

/** Builds a two-page form from nothing: text field, check box, radio group and a field with two widgets. */
public final class CreateForm {

    private CreateForm() {
    }

    public static void create(Path target) throws IOException {
        try (PDDocument document = new PDDocument()) {
            PDPage page1 = new PDPage(PDRectangle.A4);
            PDPage page2 = new PDPage(PDRectangle.A4);
            document.addPage(page1);
            document.addPage(page2);

            PDAcroForm form = new PDAcroForm(document);
            document.getDocumentCatalog().setAcroForm(form);

            // The default resources name the font that the default appearance string refers to.
            PDType1Font helvetica = new PDType1Font(Standard14Fonts.FontName.HELVETICA);
            PDResources resources = new PDResources();
            resources.put(COSName.getPDFName("Helv"), helvetica);
            form.setDefaultResources(resources);
            form.setDefaultAppearance("/Helv 0 Tf 0 g");

            // 1. A text field with a single widget.
            PDTextField name = new PDTextField(form);
            name.setPartialName("fullName");
            form.getFields().add(name);
            addWidget(name.getWidgets().get(0), page1, new PDRectangle(150, 700, 250, 22));
            name.setValue("Ada Example");

            // 2. A check box: the two appearance states are drawn by hand.
            PDCheckBox newsletter = new PDCheckBox(form);
            newsletter.setPartialName("newsletter");
            form.getFields().add(newsletter);
            PDAnnotationWidget box = newsletter.getWidgets().get(0);
            addWidget(box, page1, new PDRectangle(150, 660, 18, 18));
            box.setAppearance(appearance(document, 18, "Yes", true));
            newsletter.check();

            // 3. A radio group: one field, two widgets, one export value per widget.
            PDRadioButton plan = new PDRadioButton(form);
            plan.setPartialName("plan");
            plan.setRadiosInUnison(true);
            form.getFields().add(plan);
            plan.setExportValues(List.of("basic", "premium"));
            PDAnnotationWidget basic = new PDAnnotationWidget();
            PDAnnotationWidget premium = new PDAnnotationWidget();
            addWidget(basic, page1, new PDRectangle(150, 620, 18, 18));
            addWidget(premium, page1, new PDRectangle(250, 620, 18, 18));
            basic.setAppearance(appearance(document, 18, "basic", false));
            premium.setAppearance(appearance(document, 18, "premium", false));
            plan.setWidgets(List.of(basic, premium));
            plan.setValue("premium");
            // A radio widget is invisible until its /AS names a state: set the unselected one explicitly.
            basic.getCOSObject().setName(COSName.AS, "Off");

            // 4. One field, two widgets on two pages: both always show the same value.
            PDTextField phone = new PDTextField(form);
            phone.setPartialName("contactPhone");
            form.getFields().add(phone);
            // Two fresh widgets, both pointing at the field through /Parent (do not reuse the merged one).
            PDAnnotationWidget first = new PDAnnotationWidget();
            PDAnnotationWidget second = new PDAnnotationWidget();
            first.setParent(phone);
            second.setParent(phone);
            addWidget(first, page1, new PDRectangle(150, 580, 150, 22));
            addWidget(second, page2, new PDRectangle(150, 780, 150, 22));
            phone.setWidgets(List.of(first, second));
            phone.setValue("+34 600 000 000");

            try (PDPageContentStream cs = new PDPageContentStream(document, page1)) {
                cs.beginText();
                cs.setFont(helvetica, 12);
                cs.newLineAtOffset(40, 706);
                cs.showText("Full name");
                cs.newLineAtOffset(0, -40);
                cs.showText("Newsletter");
                cs.newLineAtOffset(0, -40);
                cs.showText("Plan (basic, premium)");
                cs.newLineAtOffset(0, -40);
                cs.showText("Contact phone");
                cs.endText();
            }
            document.save(target.toFile());
        }
    }

    private static void addWidget(PDAnnotationWidget widget, PDPage page, PDRectangle rectangle)
            throws IOException {
        widget.setRectangle(rectangle);
        widget.setPage(page);
        widget.setPrinted(true);
        page.getAnnotations().add(widget);
    }

    /** Normal appearance with an "on" state named onName and an empty Off state. */
    private static PDAppearanceDictionary appearance(PDDocument document, float size, String onName,
                                                     boolean cross) throws IOException {
        COSDictionary states = new COSDictionary();
        states.setItem(COSName.getPDFName(onName), state(document, size, true, cross));
        states.setItem(COSName.OFF, state(document, size, false, cross));
        PDAppearanceDictionary dictionary = new PDAppearanceDictionary();
        dictionary.setNormalAppearance(new PDAppearanceEntry(states));
        return dictionary;
    }

    private static PDAppearanceStream state(PDDocument document, float size, boolean on, boolean cross)
            throws IOException {
        PDAppearanceStream stream = new PDAppearanceStream(document);
        stream.setBBox(new PDRectangle(size, size));
        stream.setResources(new PDResources());
        try (PDPageContentStream cs = new PDPageContentStream(document, stream)) {
            cs.setLineWidth(1);
            cs.addRect(0.5f, 0.5f, size - 1, size - 1);
            cs.stroke();
            if (on && cross) {
                cs.moveTo(3, 3);
                cs.lineTo(size - 3, size - 3);
                cs.moveTo(3, size - 3);
                cs.lineTo(size - 3, 3);
                cs.stroke();
            } else if (on) {
                cs.addRect(4, 4, size - 8, size - 8);
                cs.fill();
            }
        }
        return stream;
    }

    public static void main(String[] args) throws IOException {
        create(Path.of(args[0]));
    }
}

  Tx       fullName               value=Ada Example    widgets=1
  Btn      newsletter             value=Yes            widgets=1
  Btn      plan                   value=premium        widgets=2
  Tx       contactPhone           value=+34 600 000 000 widgets=2