如何填写PDF文本框注释
How to fill PDF textbox annotations
我可以使用以下代码填充文本框注释,但文本不会出现在某些阅读器(如 Adobe Acrobat)中,尽管它会出现在 Chrome 和其他基于 Webkit 的浏览器中。我尝试填写的 PDF 不使用 AcroForms 或 FDF。我正在使用 Apache PDFBox,但我认为 PDF 库没有太大差异,即使 languages/platforms.
// edited for brevity
PDAnnotation annotation = doc.getPages().get(0).getAnnotations().get(0);
COSDictionary cosObject = annotation.getCOSObject();
cosObject.setString(COSName.V, content);
示例文档是 IRS form W-4。
到目前为止我尝试了什么
我尝试将我的 PDF 输出与填写 Chrome 的文档进行比较,但我看到的唯一区别在于默认外观 (DA) 属性。我试过像这样设置默认外观文本内容,但没有用:
COSString defaultAppearance = (COSString)cosObject.getItem(COSName.DA);
COSString newAppearance = new COSString(defaultAppearance.getString() + "0 0 Td (" + value + ") Tj");
cosObject.setItem(COSName.DA, newAppearance);
我还弄乱了一些听起来很有希望的标志:
int FLAG_PRINT = 4;
int FLAG_READ_ONLY = 64;
annotation.setAnnotationFlags(annotation.getAnnotationFlags() | FLAG_PRINT | FLAG_READ_ONLY);
我也尝试过其他属性:
cosObject.setString(COSName.CONTENTS, content);
我认为 the PDF 1.7 spec 中的相关部分是 12.7.4.3。
我错过了什么?
您的 PDF 确实使用了 acroform 字段。小部件注释是该字段的可视化表示。您要做的是设置字段。这是源代码下载中的 SetField.java 示例。使用以下参数调用它:文件名、字段名(第一个名称是“topmostSubform[0].Page1[0].Step1a[0].f1_01[0]”)和一个值。
要获取字段名称,请下载 PDFDebugger 并将鼠标悬停在您要设置的字段上。
下面是字段设置后的样子:
/*
* 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.interactive.form;
import java.io.File;
import java.io.IOException;
import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.pdmodel.PDDocumentCatalog;
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;
/**
* This example will take a PDF document and set a form field in it.
*
* @author Ben Litchfield
*
*/
public class SetField
{
/**
* This will set a single field in the document.
*
* @param pdfDocument The PDF to set the field in.
* @param name The name of the field to set.
* @param value The new value of the field.
*
* @throws IOException If there is an error setting the field.
*/
public void setField(PDDocument pdfDocument, String name, String value) throws IOException
{
PDDocumentCatalog docCatalog = pdfDocument.getDocumentCatalog();
PDAcroForm acroForm = docCatalog.getAcroForm();
PDField field = acroForm.getField(name);
if (field != null)
{
if (field instanceof PDCheckBox)
{
if (value.isEmpty())
((PDCheckBox) field).unCheck();
else
((PDCheckBox) field).check();
}
else if (field instanceof PDComboBox)
{
field.setValue(value);
}
else if (field instanceof PDListBox)
{
field.setValue(value);
}
else if (field instanceof PDRadioButton)
{
field.setValue(value);
}
else if (field instanceof PDTextField)
{
field.setValue(value);
}
}
else
{
System.err.println("No field found with name:" + name);
}
}
/**
* This will read a PDF file and set a field and then write it the pdf out
* again. <br>
* see usage() for commandline
*
* @param args command line arguments
*
* @throws IOException If there is an error importing the FDF document.
*/
public static void main(String[] args) throws IOException
{
SetField setter = new SetField();
setter.setField(args);
}
private void setField(String[] args) throws IOException
{
PDDocument pdf = null;
try
{
if (args.length != 3)
{
usage();
}
else
{
SetField example = new SetField();
pdf = PDDocument.load(new File(args[0]));
example.setField(pdf, args[1], args[2]);
pdf.save(args[0]);
}
}
finally
{
if (pdf != null)
{
pdf.close();
}
}
}
/**
* This will print out a message telling how to use this example.
*/
private static void usage()
{
System.err.println("usage: org.apache.pdfbox.examples.interactive.form.SetField <pdf-file> <field-name> <field-value>");
}
}
我可以使用以下代码填充文本框注释,但文本不会出现在某些阅读器(如 Adobe Acrobat)中,尽管它会出现在 Chrome 和其他基于 Webkit 的浏览器中。我尝试填写的 PDF 不使用 AcroForms 或 FDF。我正在使用 Apache PDFBox,但我认为 PDF 库没有太大差异,即使 languages/platforms.
// edited for brevity
PDAnnotation annotation = doc.getPages().get(0).getAnnotations().get(0);
COSDictionary cosObject = annotation.getCOSObject();
cosObject.setString(COSName.V, content);
示例文档是 IRS form W-4。
到目前为止我尝试了什么
我尝试将我的 PDF 输出与填写 Chrome 的文档进行比较,但我看到的唯一区别在于默认外观 (DA) 属性。我试过像这样设置默认外观文本内容,但没有用:
COSString defaultAppearance = (COSString)cosObject.getItem(COSName.DA);
COSString newAppearance = new COSString(defaultAppearance.getString() + "0 0 Td (" + value + ") Tj");
cosObject.setItem(COSName.DA, newAppearance);
我还弄乱了一些听起来很有希望的标志:
int FLAG_PRINT = 4;
int FLAG_READ_ONLY = 64;
annotation.setAnnotationFlags(annotation.getAnnotationFlags() | FLAG_PRINT | FLAG_READ_ONLY);
我也尝试过其他属性:
cosObject.setString(COSName.CONTENTS, content);
我认为 the PDF 1.7 spec 中的相关部分是 12.7.4.3。
我错过了什么?
您的 PDF 确实使用了 acroform 字段。小部件注释是该字段的可视化表示。您要做的是设置字段。这是源代码下载中的 SetField.java 示例。使用以下参数调用它:文件名、字段名(第一个名称是“topmostSubform[0].Page1[0].Step1a[0].f1_01[0]”)和一个值。
要获取字段名称,请下载 PDFDebugger 并将鼠标悬停在您要设置的字段上。
下面是字段设置后的样子:
/*
* 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.interactive.form;
import java.io.File;
import java.io.IOException;
import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.pdmodel.PDDocumentCatalog;
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;
/**
* This example will take a PDF document and set a form field in it.
*
* @author Ben Litchfield
*
*/
public class SetField
{
/**
* This will set a single field in the document.
*
* @param pdfDocument The PDF to set the field in.
* @param name The name of the field to set.
* @param value The new value of the field.
*
* @throws IOException If there is an error setting the field.
*/
public void setField(PDDocument pdfDocument, String name, String value) throws IOException
{
PDDocumentCatalog docCatalog = pdfDocument.getDocumentCatalog();
PDAcroForm acroForm = docCatalog.getAcroForm();
PDField field = acroForm.getField(name);
if (field != null)
{
if (field instanceof PDCheckBox)
{
if (value.isEmpty())
((PDCheckBox) field).unCheck();
else
((PDCheckBox) field).check();
}
else if (field instanceof PDComboBox)
{
field.setValue(value);
}
else if (field instanceof PDListBox)
{
field.setValue(value);
}
else if (field instanceof PDRadioButton)
{
field.setValue(value);
}
else if (field instanceof PDTextField)
{
field.setValue(value);
}
}
else
{
System.err.println("No field found with name:" + name);
}
}
/**
* This will read a PDF file and set a field and then write it the pdf out
* again. <br>
* see usage() for commandline
*
* @param args command line arguments
*
* @throws IOException If there is an error importing the FDF document.
*/
public static void main(String[] args) throws IOException
{
SetField setter = new SetField();
setter.setField(args);
}
private void setField(String[] args) throws IOException
{
PDDocument pdf = null;
try
{
if (args.length != 3)
{
usage();
}
else
{
SetField example = new SetField();
pdf = PDDocument.load(new File(args[0]));
example.setField(pdf, args[1], args[2]);
pdf.save(args[0]);
}
}
finally
{
if (pdf != null)
{
pdf.close();
}
}
}
/**
* This will print out a message telling how to use this example.
*/
private static void usage()
{
System.err.println("usage: org.apache.pdfbox.examples.interactive.form.SetField <pdf-file> <field-name> <field-value>");
}
}