Cómo rellenar anotaciones de cuadro de texto PDF

Aug 21 2020

Puedo completar una anotación de cuadro de texto con el siguiente código, pero el texto no aparecerá en ciertos lectores como Adobe Acrobat, aunque sí aparece en Chrome y otros navegadores basados ​​en Webkit. Los archivos PDF que estoy tratando de llenar no usan AcroForms o FDF. Estoy usando Apache PDFBox, pero no creo que haya mucha diferencia en las bibliotecas de PDF, incluso entre idiomas/plataformas.

// edited for brevity
PDAnnotation annotation = doc.getPages().get(0).getAnnotations().get(0);
COSDictionary cosObject = annotation.getCOSObject();
cosObject.setString(COSName.V, content);

Un ejemplo de documento es el formulario W-4 del IRS .

Lo que he probado hasta ahora

Intenté comparar mi salida PDF con un documento completado en Chrome, pero la única diferencia que veo está en la propiedad de apariencia predeterminada (DA). Intenté establecer el contenido de texto de apariencia predeterminado de esta manera, pero fue en vano:

COSString defaultAppearance = (COSString)cosObject.getItem(COSName.DA);
COSString newAppearance = new COSString(defaultAppearance.getString() + "0 0 Td (" + value + ") Tj");
cosObject.setItem(COSName.DA, newAppearance);

También me he metido con algunas banderas que sonaban prometedoras:

int FLAG_PRINT = 4;
int FLAG_READ_ONLY = 64;
annotation.setAnnotationFlags(annotation.getAnnotationFlags() | FLAG_PRINT | FLAG_READ_ONLY);

También he probado otras propiedades:

cosObject.setString(COSName.CONTENTS, content);

Creo que la sección relevante en la especificación PDF 1.7 es 12.7.4.3.


¿Qué me estoy perdiendo?

Respuestas

TilmanHausherr Aug 21 2020 at 01:12

Su PDF utiliza campos acroform. Las anotaciones de los widgets son la representación visual del campo. Lo que quieres hacer es configurar el campo. Aquí está el ejemplo de SetField.java de la descarga del código fuente. Llámelo con estos parámetros: nombre de archivo, nombre de campo (el primer nombre es "topmostSubform[0].Page1[0].Step1a[0].f1_01[0]") y un valor.

Para obtener los nombres de los campos, descargue PDFDebugger y pase el mouse sobre los campos que desea configurar.

Y así es como se ve el campo después de configurarse:

/*
 * 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>");
    }
}