org.apache.pdfbox.ImportFDF Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pdfbox Show documentation
Show all versions of pdfbox Show documentation
The Apache PDFBox library is an open source Java tool for working with PDF documents.
/*
* 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;
import java.io.IOException;
import org.apache.pdfbox.cos.COSDictionary;
import org.apache.pdfbox.cos.COSName;
import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.pdmodel.PDDocumentCatalog;
import org.apache.pdfbox.pdmodel.fdf.FDFDocument;
import org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm;
/**
* This example will take a PDF document and fill the fields with data from the
* FDF fields.
*
* @author Ben Litchfield
* @version $Revision: 1.2 $
*/
public class ImportFDF
{
/**
* Creates a new instance of ImportFDF.
*/
public ImportFDF()
{
}
/**
* This will takes the values from the fdf document and import them into the
* PDF document.
*
* @param pdfDocument The document to put the fdf data into.
* @param fdfDocument The FDF document to get the data from.
*
* @throws IOException If there is an error setting the data in the field.
*/
public void importFDF( PDDocument pdfDocument, FDFDocument fdfDocument ) throws IOException
{
PDDocumentCatalog docCatalog = pdfDocument.getDocumentCatalog();
PDAcroForm acroForm = docCatalog.getAcroForm();
if (acroForm == null)
{
return;
}
acroForm.setCacheFields(true);
acroForm.importFDF( fdfDocument );
//TODO this can be removed when we create appearance streams
((COSDictionary) acroForm.getCOSObject()).setBoolean(COSName.getPDFName("NeedAppearances"), true);
}
/**
* This will import an fdf document and write out another pdf.
*
* see usage() for commandline
*
* @param args command line arguments
*
* @throws Exception If there is an error importing the FDF document.
*/
public static void main(String[] args) throws Exception
{
ImportFDF importer = new ImportFDF();
importer.importFDF( args );
}
private void importFDF( String[] args ) throws Exception
{
PDDocument pdf = null;
FDFDocument fdf = null;
try
{
if( args.length != 3 )
{
usage();
}
else
{
ImportFDF importer = new ImportFDF();
pdf = PDDocument.load( args[0] );
fdf = FDFDocument.load( args[1] );
importer.importFDF( pdf, fdf );
pdf.save( args[2] );
}
}
finally
{
close( fdf );
close( pdf );
}
}
/**
* This will print out a message telling how to use this example.
*/
private static void usage()
{
System.err.println( "usage: org.apache.pdfbox.ImportFDF " );
}
/**
* Close the document.
*
* @param doc The doc to close.
*
* @throws IOException If there is an error closing the document.
*/
public void close( FDFDocument doc ) throws IOException
{
if( doc != null )
{
doc.close();
}
}
/**
* Close the document.
*
* @param doc The doc to close.
*
* @throws IOException If there is an error closing the document.
*/
public void close( PDDocument doc ) throws IOException
{
if( doc != null )
{
doc.close();
}
}
}