Class PRAcroForm

java.lang.Object

com.itextpdf.text.pdf.PdfObject

com.itextpdf.text.pdf.PdfDictionary

com.itextpdf.text.pdf.PRAcroForm

All Implemented Interfaces:

Serializable

public class PRAcroForm
extends PdfDictionary

This class captures an AcroForm on input. Basically, it extends Dictionary by indexing the fields of an AcroForm

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PRAcroForm.FieldInformation	This class holds the information for a single field

Field Summary

Fields

Modifier and Type	Field	Description
(package private) HashMap<String, PRAcroForm.FieldInformation>	fieldByName
(package private) ArrayList<PRAcroForm.FieldInformation>	fields
(package private) PdfReader	reader
(package private) ArrayList<PdfDictionary>	stack

Fields inherited from class PdfDictionary

CATALOG, FONT, hashMap, OUTLINES, PAGE, PAGES

Fields inherited from class PdfObject

ARRAY, BOOLEAN, bytes, DICTIONARY, INDIRECT, indRef, NAME, NOTHING, NULL, NUMBER, STREAM, STRING, TEXT_PDFDOCENCODING, TEXT_UNICODE, type

Constructor Summary

Constructors

Constructor	Description
PRAcroForm(PdfReader reader)	Constructor

Method Summary

Modifier and Type	Method	Description
PRAcroForm.FieldInformation	getField(String name)
ArrayList<PRAcroForm.FieldInformation>	getFields()
PRIndirectReference	getRefByName(String name)	Given the title (/T) of a reference, return the associated reference
protected void	iterateFields(PdfArray fieldlist, PRIndirectReference fieldDict, String parentPath)	After reading, we index all of the fields.
protected PdfDictionary	mergeAttrib(PdfDictionary parent, PdfDictionary child)	merge field attributes from two dictionaries
protected void	pushAttrib(PdfDictionary dict)	stack a level of dictionary.
void	readAcroForm(PdfDictionary root)	Read, and comprehend the acroform
int	size()	Number of fields found

Methods inherited from class PdfDictionary

checkType, clear, contains, get, getAsArray, getAsBoolean, getAsDict, getAsIndirectObject, getAsName, getAsNumber, getAsStream, getAsString, getDirectObject, getKeys, isCatalog, isFont, isOutlineTree, isPage, isPages, merge, mergeDifferent, put, putAll, putEx, remove, toPdf, toString

Methods inherited from class PdfObject

canBeInObjStm, getBytes, getIndRef, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, length, setContent, setIndRef, type

Methods inherited from class Object

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

Field Details

fields

ArrayList<PRAcroForm.FieldInformation> fields

stack

ArrayList<PdfDictionary> stack

fieldByName

HashMap<String, PRAcroForm.FieldInformation> fieldByName

reader

PdfReader reader

Constructor Details

PRAcroForm

public PRAcroForm(PdfReader reader)

Constructor

Parameters:

reader - reader of the input file

Method Details

size

public int size()

Number of fields found

Overrides:

size in class PdfDictionary

Returns:

size

getFields

public ArrayList<PRAcroForm.FieldInformation> getFields()

getField

public PRAcroForm.FieldInformation getField(String name)

getRefByName

public PRIndirectReference getRefByName(String name)

Given the title (/T) of a reference, return the associated reference

Parameters:

name - a string containing the path

Returns:

a reference to the field, or null

readAcroForm

public void readAcroForm(PdfDictionary root)

Read, and comprehend the acroform

Parameters:

root - the document root

iterateFields

protected void iterateFields(PdfArray fieldlist,
 PRIndirectReference fieldDict,
 String parentPath)

After reading, we index all of the fields. Recursive.

Parameters:

fieldlist - An array of fields

fieldDict - the last field dictionary we encountered (recursively)

parentPath - the pathname of the field, up to this point or null

mergeAttrib

protected PdfDictionary mergeAttrib(PdfDictionary parent,
 PdfDictionary child)

merge field attributes from two dictionaries

Parameters:

parent - one dictionary

child - the other dictionary

Returns:

a merged dictionary

pushAttrib

protected void pushAttrib(PdfDictionary dict)

stack a level of dictionary. Merge in a dictionary from this level