Interface PdfAcroFormService

All Known Implementing Classes:

PdfAcroFormServiceImpl

public interface PdfAcroFormService

Method Summary

Modifier and Type	Method	Description
void	fillAcroForm(InputStream is, OutputStream os, Map<String,String> fieldValues)	Reads a pdf containing a AcroForm from the given input stream, sets all field values and returns the resulting PDF in the given OutputStream Fields are handled as follows: - if null is passed as value, the field is skipped - if the field is a PDCheckbox, the value is parsed as boolean, pass "true" to check it - if the field is a PDRadiobutton, the value is parsed as int (the index of the option to be selected) - else the string value is set as is
void	findAcroFieldnames(InputStream is, OutputStream os)	This is a helper function that can be used to find the FullyQualified field names of an AcroForm - logs all fieldnames with some type information - prints the fieldname of all textfields into the field itself This method should probably not be used in production code, but it is very handy when implementing an automatic AcroForm field mapping

Method Details

fillAcroForm

void fillAcroForm(InputStream is,
 OutputStream os,
 Map<String,String> fieldValues)
           throws IOException

Reads a pdf containing a AcroForm from the given input stream, sets all field values and returns the resulting PDF in the given OutputStream Fields are handled as follows: - if null is passed as value, the field is skipped - if the field is a PDCheckbox, the value is parsed as boolean, pass "true" to check it - if the field is a PDRadiobutton, the value is parsed as int (the index of the option to be selected) - else the string value is set as is

Parameters:

is - InputStream containing the pdf

os - OutputStream where the result is written to

fieldValues - a map of all field values to be replaced, use the FullyQualifiedName as key

Throws:

IllegalArgumentException - is thrown when the pdf does not contain a AcroForm or a field was not found

IOException

findAcroFieldnames

void findAcroFieldnames(InputStream is,
 OutputStream os)
                 throws IOException

This is a helper function that can be used to find the FullyQualified field names of an AcroForm - logs all fieldnames with some type information - prints the fieldname of all textfields into the field itself This method should probably not be used in production code, but it is very handy when implementing an automatic AcroForm field mapping

Parameters:

is - InputStream containing the pdf

os - OutputStream where the result is written to

Throws:

IllegalArgumentException - is thrown when the pdf does not contain a AcroForm

IOException