Form (PDFxStream API Reference)

All Superinterfaces:

Iterable<T>

All Known Subinterfaces:

AcroForm
```
public interface Form<T extends FormField>
extends 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-2024 Snowtide

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Document`	`getDocument()`	Returns the source `Document` from which this `Form` was extracted.
`T`	`getField(String fieldName)`	Returns the field held by this form with the given name.
`Collection<String>`	`getFieldNames()`	Returns a `Collection` of the names of all of the fields held by this form.
`Iterator<T>`	`iterator()`	Returns an `Iterator` over the `FormField`s held by this form.

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Method Detail
  - getDocument
```
Document getDocument()
```
    Returns the source Document from which this Form was extracted.
  - getField
```
T getField(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
```
Collection<String> getFieldNames()
```
    Returns a Collection of the names of all of the fields held by this form.
  - iterator
```
Iterator<T> iterator()
```
    Returns an Iterator over the FormFields held by this form.
    
    Specified by:
    
    iterator in interface Iterable<T extends FormField>