com.itextpdf.text.pdf
Class FdfWriter

java.lang.Object
  extended by com.itextpdf.text.pdf.FdfWriter

public class FdfWriter
extends Object

Writes an FDF form.

Author:
Paulo Soares

Nested Class Summary
(package private) static class FdfWriter.Wrt
           
 
Field Summary
(package private)  HashMap<String,Object> fields
           
private  String file
          The PDF file associated with the FDF.
private static byte[] HEADER_FDF
           
 
Constructor Summary
FdfWriter()
          Creates a new FdfWriter.
 
Method Summary
 String getField(String field)
          Gets the field value.
 HashMap<String,Object> getFields()
          Gets all the fields.
 String getFile()
          Gets the PDF file name associated with the FDF.
(package private)  void iterateFields(HashMap<String,Object> values, HashMap<String,Object> map, String name)
           
 boolean removeField(String field)
          Removes the field value.
(package private)  boolean setField(String field, PdfObject value)
           
 boolean setFieldAsAction(String field, PdfAction action)
          Sets the field value as a PDFAction.
 boolean setFieldAsName(String field, String value)
          Sets the field value as a name.
 boolean setFieldAsString(String field, String value)
          Sets the field value as a string.
 void setFields(AcroFields af)
          Sets all the fields from this AcroFields
 void setFields(FdfReader fdf)
          Sets all the fields from this FdfReader
 void setFields(PdfReader pdf)
          Sets all the fields from this PdfReader
 void setFile(String file)
          Sets the PDF file name associated with the FDF.
 void writeTo(OutputStream os)
          Writes the content to a stream.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

HEADER_FDF

private static final byte[] HEADER_FDF

fields

HashMap<String,Object> fields

file

private String file
The PDF file associated with the FDF.

Constructor Detail

FdfWriter

public FdfWriter()
Creates a new FdfWriter.

Method Detail

writeTo

public void writeTo(OutputStream os)
             throws IOException
Writes the content to a stream.

Parameters:
os - the stream
Throws:
IOException - on error

setField

boolean setField(String field,
                 PdfObject value)

iterateFields

void iterateFields(HashMap<String,Object> values,
                   HashMap<String,Object> map,
                   String name)

removeField

public boolean removeField(String field)
Removes the field value.

Parameters:
field - the field name
Returns:
true if the field was found and removed, false otherwise

getFields

public HashMap<String,Object> getFields()
Gets all the fields. The map is keyed by the fully qualified field name and the values are PdfObject.

Returns:
a map with all the fields

getField

public String getField(String field)
Gets the field value.

Parameters:
field - the field name
Returns:
the field value or null if not found

setFieldAsName

public boolean setFieldAsName(String field,
                              String value)
Sets the field value as a name.

Parameters:
field - the fully qualified field name
value - the value
Returns:
true if the value was inserted, false if the name is incompatible with an existing field

setFieldAsString

public boolean setFieldAsString(String field,
                                String value)
Sets the field value as a string.

Parameters:
field - the fully qualified field name
value - the value
Returns:
true if the value was inserted, false if the name is incompatible with an existing field

setFieldAsAction

public boolean setFieldAsAction(String field,
                                PdfAction action)
Sets the field value as a PDFAction. For example, this method allows setting a form submit button action using PdfAction.createSubmitForm(String, Object[], int). This method creates an A entry for the specified field in the underlying FDF file. Method contributed by Philippe Laflamme (plaflamme)

Parameters:
field - the fully qualified field name
action - the field's action
Returns:
true if the value was inserted, false if the name is incompatible with an existing field
Since:
2.1.5

setFields

public void setFields(FdfReader fdf)
Sets all the fields from this FdfReader

Parameters:
fdf - the FdfReader

setFields

public void setFields(PdfReader pdf)
Sets all the fields from this PdfReader

Parameters:
pdf - the PdfReader

setFields

public void setFields(AcroFields af)
Sets all the fields from this AcroFields

Parameters:
af - the AcroFields

getFile

public String getFile()
Gets the PDF file name associated with the FDF.

Returns:
the PDF file name associated with the FDF

setFile

public void setFile(String file)
Sets the PDF file name associated with the FDF.

Parameters:
file - the PDF file name associated with the FDF

Hosted by Hostbasket