More languages
Some test text!
More languages
Sample Java code for using Apryse SDK to programmatically merge forms data with the PDF in order to fill forms, or to extract form field data from the PDF. Apryse SDK has full support for Forms Data Format (FDF). Learn more about our Java PDF Library and PDF Form Filler SDK.
Get Started Samples DownloadTo run this sample, get started with a free trial of Apryse SDK.
//---------------------------------------------------------------------------------------
// Copyright (c) 2001-2019 by PDFTron Systems Inc. All Rights Reserved.
// Consult legal.txt regarding legal and license information.
//---------------------------------------------------------------------------------------
package com.pdftron.android.pdfnetsdksamples.samples;
import com.pdftron.android.pdfnetsdksamples.OutputListener;
import com.pdftron.android.pdfnetsdksamples.PDFNetSample;
import com.pdftron.android.pdfnetsdksamples.R;
import com.pdftron.android.pdfnetsdksamples.util.Utils;
import com.pdftron.fdf.FDFDoc;
import com.pdftron.fdf.FDFField;
import com.pdftron.fdf.FDFFieldIterator;
import com.pdftron.pdf.Field;
import com.pdftron.pdf.FieldIterator;
import com.pdftron.pdf.PDFDoc;
import com.pdftron.sdf.SDFDoc;
import java.util.ArrayList;
public class FDFTest extends PDFNetSample {
private static OutputListener mOutputListener;
private static ArrayList<String> mFileList = new ArrayList<>();
public FDFTest() {
setTitle(R.string.sample_fdf_title);
setDescription(R.string.sample_fdf_description);
}
@Override
public void run(OutputListener outputListener) {
super.run(outputListener);
mOutputListener = outputListener;
mFileList.clear();
printHeader(outputListener);
// Example 1)
// Iterate over all form fields in the document. Display all field names.
try (PDFDoc doc = new PDFDoc((Utils.getAssetTempFile(INPUT_PATH + "form1.pdf").getAbsolutePath()))) {
doc.initSecurityHandler();
for (FieldIterator itr = doc.getFieldIterator(); itr.hasNext(); ) {
Field current = itr.next();
mOutputListener.println("Field name: " + current.getName());
mOutputListener.println("Field partial name: " + current.getPartialName());
mOutputListener.print("Field type: ");
int type = current.getType();
switch (type) {
case Field.e_button:
mOutputListener.println("Button");
break;
case Field.e_check:
mOutputListener.println("Check");
break;
case Field.e_radio:
mOutputListener.println("Radio");
break;
case Field.e_text:
mOutputListener.println("Text");
break;
case Field.e_choice:
mOutputListener.println("Choice");
break;
case Field.e_signature:
mOutputListener.println("Signature");
break;
case Field.e_null:
mOutputListener.println("Null");
break;
}
mOutputListener.println("------------------------------");
}
mOutputListener.println("Done.");
} catch (Exception e) {
mOutputListener.printError(e.getStackTrace());
}
// Example 2) Import XFDF into FDF, then merge data from FDF into PDF
try (PDFDoc doc = new PDFDoc((Utils.getAssetTempFile(INPUT_PATH + "form1.pdf").getAbsolutePath()))) {
// XFDF to FDF
// form fields
mOutputListener.println("Import form field data from XFDF to FDF.");
FDFDoc fdf_doc1 = FDFDoc.createFromXFDF((Utils.getAssetTempFile(INPUT_PATH + "form1_data.xfdf").getAbsolutePath()));
fdf_doc1.save(Utils.createExternalFile("form1_data.fdf", mFileList).getAbsolutePath());
// annotations
mOutputListener.println("Import annotations from XFDF to FDF.");
FDFDoc fdf_doc2 = FDFDoc.createFromXFDF((Utils.getAssetTempFile(INPUT_PATH + "form1_annots.xfdf").getAbsolutePath()));
fdf_doc2.save(Utils.createExternalFile("form1_annots.fdf", mFileList).getAbsolutePath());
// FDF to PDF
// form fields
mOutputListener.println("Merge form field data from FDF.");
doc.initSecurityHandler();
doc.fdfMerge(fdf_doc1);
// Refreshing missing appearances is not required here, but is recommended to make them
// visible in PDF viewers with incomplete annotation viewing support. (such as Chrome)
doc.refreshAnnotAppearances();
doc.save((Utils.createExternalFile("form1_filled.pdf", mFileList).getAbsolutePath()), SDFDoc.SaveMode.LINEARIZED, null);
// annotations
mOutputListener.println("Merge annotations from FDF.");
doc.fdfMerge(fdf_doc2);
// Refreshing missing appearances is not required here, but is recommended to make them
// visible in PDF viewers with incomplete annotation viewing support. (such as Chrome)
doc.refreshAnnotAppearances();
doc.save(Utils.createExternalFile("form1_filled_with_annots.pdf", mFileList).getAbsolutePath(), SDFDoc.SaveMode.LINEARIZED, null);
mOutputListener.println("Done.");
} catch (Exception e) {
mOutputListener.printError(e.getStackTrace());
}
// Example 3) Extract data from PDF to FDF, then export FDF as XFDF
try (PDFDoc in_doc = new PDFDoc((Utils.createExternalFile("form1_filled_with_annots.pdf", mFileList).getAbsolutePath()))) {
// PDF to FDF
in_doc.initSecurityHandler();
// form fields only
mOutputListener.println("Extract form fields data to FDF.");
FDFDoc doc_fields = in_doc.fdfExtract(PDFDoc.e_forms_only);
doc_fields.setPDFFileName(Utils.createExternalFile("form1_filled_with_annots.pdf", mFileList).getAbsolutePath());
doc_fields.save(Utils.createExternalFile("form1_filled_data.fdf", mFileList).getAbsolutePath());
// annotations only
mOutputListener.println("Extract annotations to FDF.");
FDFDoc doc_annots = in_doc.fdfExtract(PDFDoc.e_annots_only);
doc_annots.setPDFFileName(Utils.createExternalFile("form1_filled_with_annots.pdf", mFileList).getAbsolutePath());
doc_annots.save(Utils.createExternalFile("form1_filled_annot.fdf", mFileList).getAbsolutePath());
// both form fields and annotations
mOutputListener.println("Extract both form fields and annotations to FDF.");
FDFDoc doc_both = in_doc.fdfExtract(PDFDoc.e_both);
doc_both.setPDFFileName(Utils.createExternalFile("form1_filled_with_annots.pdf", mFileList).getAbsolutePath());
doc_both.save(Utils.createExternalFile("form1_filled_both.fdf", mFileList).getAbsolutePath());
// FDF to XFDF
// form fields
mOutputListener.println("Export form field data from FDF to XFDF.");
doc_fields.saveAsXFDF((Utils.createExternalFile("form1_filled_data.xfdf", mFileList).getAbsolutePath()));
// annotations
mOutputListener.println("Export annotations from FDF to XFDF.");
doc_annots.saveAsXFDF((Utils.createExternalFile("form1_filled_annot.xfdf", mFileList).getAbsolutePath()));
// both form fields and annotations
mOutputListener.println("Export both form fields and annotations from FDF to XFDF.");
doc_both.saveAsXFDF((Utils.createExternalFile("form1_filled_both.xfdf", mFileList).getAbsolutePath()));
mOutputListener.println("Done.");
} catch (Exception e) {
mOutputListener.printError(e.getStackTrace());
}
// Example 4) Merge/Extract XFDF into/from PDF
try (PDFDoc in_doc = new PDFDoc((Utils.getAssetTempFile(INPUT_PATH + "numbered.pdf").getAbsolutePath()))) {
// Merge XFDF from string
in_doc.initSecurityHandler();
mOutputListener.println("Merge XFDF string into PDF.");
String str = "<?xml version=\"1.0\" encoding=\"UTF-8\" ?><xfdf xmlns=\"http://ns.adobe.com/xfdf\" xml:space=\"preserve\"><square subject=\"Rectangle\" page=\"0\" name=\"cf4d2e58-e9c5-2a58-5b4d-9b4b1a330e45\" title=\"user\" creationdate=\"D:20120827112326-07'00'\" date=\"D:20120827112326-07'00'\" rect=\"227.7814207650273,597.6174863387978,437.07103825136608,705.0491803278688\" color=\"#000000\" interior-color=\"#FFFF00\" flags=\"print\" width=\"1\"><popup flags=\"print,nozoom,norotate\" open=\"no\" page=\"0\" rect=\"0,792,0,792\" /></square></xfdf>";
FDFDoc fdoc = FDFDoc.createFromXFDF(str);
in_doc.fdfMerge(fdoc);
in_doc.save(Utils.createExternalFile("numbered_modified.pdf", mFileList).getAbsolutePath(), SDFDoc.SaveMode.LINEARIZED, null);
mOutputListener.println("Merge complete.");
// Extract XFDF as string
mOutputListener.println("Extract XFDF as a string.");
FDFDoc fdoc_new = in_doc.fdfExtract(PDFDoc.e_both);
String XFDF_str = fdoc_new.saveAsXFDF();
mOutputListener.println("Extracted XFDF: ");
mOutputListener.println(XFDF_str);
mOutputListener.println("Extract complete.");
} catch (Exception e) {
mOutputListener.printError(e.getStackTrace());
}
// Example 5) Read FDF files directly
try {
FDFDoc doc = new FDFDoc((Utils.createExternalFile("form1_filled_data.fdf", mFileList).getAbsolutePath()));
for (FDFFieldIterator itr = doc.getFieldIterator(); itr.hasNext(); ) {
FDFField current = itr.next();
mOutputListener.println("Field name: " + current.getName());
mOutputListener.println("Field partial name: " + current.getPartialName());
mOutputListener.println("------------------------------");
}
doc.close();
mOutputListener.println("Done.");
} catch (Exception e) {
mOutputListener.printError(e.getStackTrace());
}
// Example 6) Direct generation of FDF.
try {
FDFDoc doc = new FDFDoc();
// Create new fields (i.e. key/value pairs).
doc.fieldCreate("Company", Field.e_text, "PDFTron Systems");
doc.fieldCreate("First Name", Field.e_text, "John");
doc.fieldCreate("Last Name", Field.e_text, "Doe");
// ...
// doc.setPdfFileName("mydoc.pdf");
doc.save(Utils.createExternalFile("sample_output.fdf", mFileList).getAbsolutePath());
doc.close();
mOutputListener.println("Done. Results saved in sample_output.fdf");
} catch (Exception e) {
mOutputListener.printError(e.getStackTrace());
}
for (String file : mFileList) {
addToFileList(file);
}
printFooter(outputListener);
}
}