Getting started with iText - Part 15 (Register.java)

The next installation in Getting started with iText translates the Register example. It is a simple example that demonstrates how to fill in form fields with iText.

You can run the example "as is" with either MX7 or CF8. Though if you are using CF8 you could use the new cfpdf and cfpdfform tags instead. From what I understand CF8 does make use of iText behind the scenes for some of the PDF functionality. Though I do not know to what extent. For comparison purposes I have also included a CF8 example below.

The iText example fills in a form and creates two output files. The only difference between them is that one of the output files is flattened. Meaning the form field values can no longer be modified.

What you will need for this example

A sample form from the iText site: SimpleRegistrationForm.pdf. Download the file and place it in the same directory as your .cfm script.

Code

Documentation: Manipulating existing PDF documents
Source: Register.java

iText Example

<h1>Fill in Registration Form Fields Example</h1>
<cfscript>
    savedErrorMessage = "";

    // cfSearching: All file paths are relative to the current directory
    fullPathToInputFile = ExpandPath("./SimpleRegistrationForm.pdf");
    fullPathToOutputFile1 = ExpandPath("./Registered.pdf");
    fullPathToOutputFile2 = ExpandPath("./Registered_Flat.pdf");

    try {
        // we create a reader for a certain document
        pdfReader1 = createObject("java", "com.lowagie.text.pdf.PdfReader").init(fullPathToInputFile);
        //cfSearching: fill in the form fields but do not flatten the form
        outputStream1 = createObject("java", "java.io.FileOutputStream").init(fullPathToOutputFile1);
        pdfStamper1 = createObject("java", "com.lowagie.text.pdf.PdfStamper").init(pdfReader1, outputStream1);
        form1 = pdfStamper1.getAcroFields();
        form1.setField("name", "Bruno Lowagie");
        form1.setField("address", "Baeyensstraat 121, Sint-Amandsberg");
        form1.setField("postal_code", "BE-9040");
        form1.setField("email", "bruno@lowagie.com");
        
        //cfSearching: fill in the form fields AND flatten the form
        pdfReader2 = createObject("java", "com.lowagie.text.pdf.PdfReader").init(fullPathToInputFile);
        outputStream2 = createObject("java", "java.io.FileOutputStream").init(fullPathToOutputFile2);
        pdfStamper2 = createObject("java", "com.lowagie.text.pdf.PdfStamper").init(pdfReader2, outputStream2);
        form2 = pdfStamper2.getAcroFields();
        form2.setField("name", "Bruno Lowagie");
        form2.setField("address", "Baeyensstraat 121, Sint-Amandsberg");
        form2.setField("postal_code", "BE-9040");
        form2.setField("email", "bruno@lowagie.com");
        pdfStamper2.setFormFlattening(true);

        WriteOutput("Finished!");

    } 
    catch (java.language.Exception de) {
        savedErrorMessage = de;
    }
    // cfSearching: close the stamper and output stream objects
    pdfStamper1.close();
    outputStream1.close();
    pdfStamper2.close();
    outputStream2.close();
</cfscript>


<!--- show any errors --->
<cfif len(savedErrorMessage) gt 0>
    Error - unable to create document
    <cfdump var="#savedErrorMessage#">
</cfif>

ColdFusion 8 Example

<h1>Fill in Registration Form Fields CF8 Example</h1>

<cfset fullPathToInputFile = ExpandPath("./SimpleRegistrationForm.pdf")>
<cfset fullPathToOutputFile1 = ExpandPath("./Registered.pdf")>
<cfset fullPathToOutputFile2 = ExpandPath("./Registered_Flat.pdf")>

<!--- fill in the form fields. will NOT overwrite existing file ---->
<cfpdfform action="populate" source="#fullPathToInputFile#" destination="#fullPathToOutputFile1#">
    <cfpdfformparam name="name" value="Bruno Lowagie">
    <cfpdfformparam name="address" value="Baeyensstraat 121, Sint-Amandsberg">
    <cfpdfformparam name="postal_code" value="BE-9040">
    <cfpdfformparam name="email" value="bruno@lowagie.com">
</cfpdfform>

<!--- use completed form created in previous step and flatten it ---->
<cfpdf action="write" source="#fullPathToOutputFile1#" 
    destination="#fullPathToOutputFile2#" 
    flatten="true" >
Finished!