com.lowagie.text.pdf
Class AcroFields

java.lang.Object
  |
  +--com.lowagie.text.pdf.AcroFields

public class AcroFields

extends Object

Query and change fields in existing documents either by method call or by FDF merging.

Author:

Paulo Soares (psoares@consiste.pt)

Nested Class Summary

class

AcroFields.Item The field representations for retrieval and modification.

Field Summary

(package private) HashMap	fields
(package private) PdfReader	reader
private int	topFirst
(package private) PdfWriter	writer

Constructor Summary

(package private)

AcroFields(PdfReader reader, PdfWriter writer)

Method Summary

(package private) void	fill()
(package private) PdfAppearance	getAppearance(PdfDictionary merged, String text)
String	getField(String name) Gets the field value.
HashMap	getFields() Gets all the fields.
(package private) Color	getMKColor(PdfArray ar)
(package private) boolean	isInAP(PdfDictionary dic, PdfName check)
boolean	setField(String name, String value) Sets the field value.
boolean	setField(String name, String value, String display) Sets the field value and the display string.
void	setFields(FdfReader fdf) Sets the fields by FDF merging.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

reader

PdfReader reader

writer

PdfWriter writer

fields

HashMap fields

topFirst

private int topFirst

Constructor Detail

AcroFields

AcroFields(PdfReader reader,
           PdfWriter writer)

Method Detail

fill

void fill()

getAppearance

PdfAppearance getAppearance(PdfDictionary merged,
                            String text)
                      throws IOException,
                             DocumentException

IOException

DocumentException

getMKColor

Color getMKColor(PdfArray ar)

getField

public String getField(String name)

Gets the field value.

Parameters:

name - the fully qualified field name

Returns:

the field value

setFields

public void setFields(FdfReader fdf)
               throws IOException,
                      DocumentException

Sets the fields by FDF merging.

Parameters:

fdf - the FDF form

Throws:

IOException - on error

DocumentException - on error

setField

public boolean setField(String name,
                        String value)
                 throws IOException,
                        DocumentException

Sets the field value.

Parameters:

name - the fully qualified field name

value - the field value

Returns:

true if the field was found and changed, false otherwise

Throws:

IOException - on error

DocumentException - on error

setField

public boolean setField(String name,
                        String value,
                        String display)
                 throws IOException,
                        DocumentException

Sets the field value and the display string. The display string is used to build the appearance in the cases where the value is modified by Acrobat with JavaScript and the algorithm is known.

Parameters:

name - the fully qualified field name

value - the field value

display - the string that is used for the appearance

Returns:

true if the field was found and changed, false otherwise

Throws:

IOException - on error

DocumentException - on error

isInAP

boolean isInAP(PdfDictionary dic,
               PdfName check)

getFields

public HashMap getFields()

Gets all the fields. The fields are keyed by the fully qualified field name and the value is an instance of AcroFields.Item.

Returns:

all the fields