com.snowtide.pdf.forms

Interface Form<T extends FormField>

All Superinterfaces:

java.lang.Iterable<T>

All Known Subinterfaces:

AcroForm

public interface Form<T extends FormField>
extends java.lang.Iterable<T>

Provides access to form data available in a PDF document. Currently, the only implementation of this interface is AcroForm, which represents form data held in an interactive AcroForm embedded in some PDF documents.

Conceptually, Forms are collections of key/value pairs, represented by FormFields.

Version:

©2004-2014 Snowtide

Method Summary

Modifier and Type	Method and Description
Document	getDocument() Returns the source Document from which this Form was extracted.
T	getField(java.lang.String fieldName) Returns the field held by this form with the given name.
java.util.Collection	getFieldNames() Returns a Collection of the names of all of the fields held by this form.
java.util.Iterator<T>	iterator() Returns an Iterator over the FormFields held by this form.

Method Detail

getDocument

Document getDocument()

Returns the source Document from which this Form was extracted.

getField

T getField(java.lang.String fieldName)

Returns the field held by this form with the given name. The specific way in which field names are mapped to FormField instances is implementation-dependant.

getFieldNames

java.util.Collection getFieldNames()

Returns a Collection of the names of all of the fields held by this form.

iterator

java.util.Iterator<T> iterator()

Returns an Iterator over the FormFields held by this form.