com.lowagie.text.pdf

Class FdfWriter

java.lang.Object

com.lowagie.text.pdf.FdfWriter

public class FdfWriter
extends Object

Writes an FDF form.

Author:

Paulo Soares (psoares@consiste.pt)

Constructor Summary

Constructors

Constructor and Description
FdfWriter() Creates a new FdfWriter.

Method Summary

Modifier and Type	Method and Description
String	getField(String field) Gets the field value.
HashMap	getFields() Gets all the fields.
String	getFile() Gets the PDF file name associated with the FDF.
boolean	removeField(String field) Removes the field 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

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

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 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