PDFBox

Question

我正在使用 PDFBox 生成 PDF，我需要在其中添加一个复选框，需要将其预设为选中和只读。但有些方法不起作用。

请找到下面的代码，它在 PDF 上添加了复选框：

import java.io.File;
import java.io.IOException;
import org.apache.pdfbox.cos.COSArray;
import org.apache.pdfbox.cos.COSDictionary;
import org.apache.pdfbox.cos.COSFloat;
import org.apache.pdfbox.cos.COSName;
import org.apache.pdfbox.cos.COSString;
import org.apache.pdfbox.exceptions.COSVisitorException;
import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.pdmodel.PDPage;
import org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm;
import org.apache.pdfbox.pdmodel.interactive.form.PDCheckbox;
import org.apache.pdfbox.pdmodel.interactive.form.PDField;

public class MyTest {
    public static void main(String arg[])  throws IOException, COSVisitorException
    {
        PDDocument document = new PDDocument();
        PDPage page = new PDPage(PDPage.PAGE_SIZE_LETTER);
        document.addPage(page);

        COSDictionary acroFormDict = new COSDictionary();
        acroFormDict.setItem(COSName.getPDFName("Fields"), new COSArray()); // Added this line for Tilman's comment
        PDAcroForm acroForm = new PDAcroForm(document, acroFormDict);
        document.getDocumentCatalog().setAcroForm(acroForm);


        float x = 10f;
        float y = page.getMediaBox().getHeight();  
        float yOffset = 15f;
        float yCurrent = y - yOffset;  

        COSDictionary cosDict = new COSDictionary();
        COSArray rect = new COSArray();
        rect.add(new COSFloat(x));
        rect.add(new COSFloat(yCurrent));
        rect.add(new COSFloat(x+20));
        rect.add(new COSFloat(yCurrent-20));

        cosDict.setItem(COSName.RECT, rect);
        cosDict.setItem(COSName.FT, COSName.getPDFName("Btn")); // Field Type
        cosDict.setItem(COSName.TYPE, COSName.ANNOT);
        cosDict.setItem(COSName.SUBTYPE, COSName.getPDFName("Widget"));
        cosDict.setItem(COSName.T, new COSString("testChk"));
        cosDict.setItem(COSName.DA, new COSString("/Helv 7 Tf 0 g"));

        PDCheckbox checkbox = new PDCheckbox(acroForm, cosDict);
//      checkbox.setReadonly(true);
//      checkbox.setFieldFlags(PDField.FLAG_READ_ONLY);
        checkbox.setValue("Yes");
//      checkbox.check();
        page.getAnnotations().add(checkbox.getWidget());                          
        acroForm.getFields().add(checkbox); // Added this line for Tilman's comment

        yCurrent = yCurrent - 20 - yOffset;

        File file = new File("C:\pdf\CheckBox\CheckBoxSample1.pdf");
        System.out.println("Sample file saved at : " + file.getAbsolutePath());
        document.save(file);
        document.close();
    }

}

现在，如果您取消注释该行：

checkbox.setReadonly(true);

或者

checkbox.setFieldFlags(PDField.FLAG_READ_ONLY);

复选框将不再显示（或者可能存在但值未选中）。我正在使用 PDFBox 1.8.10

Adobe Reader 11 和 Foxit 中的行为相似。

此外，如果我在未将框设置为只读的情况下生成 PDF，在 Adobe 中，我会看到显示了设置了值的复选框，但是当我使用选项卡将焦点放在它上面时，它会消失。再次聚焦（我点击复选框以外的其他地方），它再次出现。

我好像漏掉了一个很小的东西，但是没找到。有什么帮助吗？提前致谢。

Answer 1

您需要使用 PDAppearanceCharacteristicsDictionary class 赋予字段外观。这将解决上述问题。

请检查下面的示例代码：

import java.io.File;
import java.io.IOException;

import org.apache.pdfbox.cos.COSArray;
import org.apache.pdfbox.cos.COSDictionary;
import org.apache.pdfbox.cos.COSFloat;
import org.apache.pdfbox.cos.COSName;
import org.apache.pdfbox.cos.COSString;
import org.apache.pdfbox.exceptions.COSVisitorException;
import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.pdmodel.PDPage;
import org.apache.pdfbox.pdmodel.PDResources;
import org.apache.pdfbox.pdmodel.font.PDFont;
import org.apache.pdfbox.pdmodel.font.PDType1Font;
import org.apache.pdfbox.pdmodel.graphics.color.PDGamma;
import org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary;
import org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm;
import org.apache.pdfbox.pdmodel.interactive.form.PDCheckbox;

public class MyCheckBox {
    public static void main(String arg[])  throws IOException, COSVisitorException
    {
        PDDocument document = new PDDocument();
        PDPage page = new PDPage(PDPage.PAGE_SIZE_LETTER);
        document.addPage(page);

        PDFont font = PDType1Font.HELVETICA;
        PDResources res = new PDResources();
        String fontName = res.addFont(font);
        String da = "/" + fontName + " 10 Tf 0 0.4 0 rg";


        COSDictionary acroFormDict = new COSDictionary(); 
        acroFormDict.setBoolean(COSName.getPDFName("NeedAppearances"), true);
        acroFormDict.setItem(COSName.FIELDS, new COSArray());
        acroFormDict.setItem(COSName.DA, new COSString(da));

        PDAcroForm acroForm =  new PDAcroForm(document, acroFormDict);
        acroForm.setDefaultResources(res);
        document.getDocumentCatalog().setAcroForm(acroForm);


        float x = 10f;
        float y = page.getMediaBox().getHeight();  
        float yOffset = 15f;
        float yCurrent = y - yOffset;  

        PDGamma colourBlack = new PDGamma();
        PDAppearanceCharacteristicsDictionary fieldAppearance = 
                new PDAppearanceCharacteristicsDictionary(new COSDictionary());
        fieldAppearance.setBorderColour(colourBlack);
        COSArray arr = new COSArray();
        arr.add(new COSFloat(227/255f));
        arr.add(new COSFloat(239/255f));
        arr.add(new COSFloat(1f));
        fieldAppearance.setBackground(new PDGamma(arr));

        COSDictionary cosDict = new COSDictionary();
        COSArray rect = new COSArray();
        rect.add(new COSFloat(x));
        rect.add(new COSFloat(yCurrent));
        rect.add(new COSFloat(x+20));
        rect.add(new COSFloat(yCurrent-20));

        cosDict.setItem(COSName.RECT, rect);
        cosDict.setItem(COSName.FT, COSName.getPDFName("Btn")); // Field Type
        cosDict.setItem(COSName.TYPE, COSName.ANNOT);
        cosDict.setItem(COSName.SUBTYPE, COSName.getPDFName("Widget"));
        cosDict.setItem(COSName.TU, new COSString("Test Checkbox with PDFBox"));
        cosDict.setItem(COSName.T, new COSString("testChk"));
        cosDict.setItem(COSName.DA, new COSString("/F0 10 Tf 0 0.4 0 rg"));
//        cosDict.setInt(COSName.FF, 49152);        //Radio Button Symbol
        cosDict.setInt(COSName.F, 4);
//        cosDict.setInt(COSName.FF, 16384);

        PDCheckbox checkbox = new PDCheckbox(acroForm, cosDict);
        checkbox.setFieldFlags(PDCheckbox.FLAG_READ_ONLY);
        checkbox.setValue("Yes");
//        checkbox.setValue("Off");

        checkbox.getWidget().setAppearanceCharacteristics(fieldAppearance);

        page.getAnnotations().add(checkbox.getWidget());                          
        acroForm.getFields().add(checkbox); 

        yCurrent = yCurrent - 20 - yOffset;

        File file = new File("C:\pdf\CheckBoxSample.pdf");
        System.out.println("Sample file saved at : " + file.getAbsolutePath());
        document.save(file);
        document.close();
    }

}

PDFBox - 如果设置为只读则不显示复选框

PDFBox - checkbox is not displayed if set readonly

java

pdf