Package com.snowtide.pdf.forms

The com.snowtide.pdf.forms package is home to a variety of classes that support PDFTextStream's form extraction functionality.

See: Description

Interface Summary

Interface	Description
AcroForm	A Form implementation that represents the contents of an interactive PDF form, available via PDFTextStream.getFormData().
AcroFormField	Interface implmented by all form fields held by AcroForm instances.
Form	Provides access to form data available in a PDF document.
FormField	Base interface for objects representing fields within a Form.

Class Summary

Class	Description
AcroButtonField	Represents a button form field in an interactive AcroForm.
AcroCheckboxField	Instances of this class represent individual checkboxes in an interactive forms.
AcroChoiceField	Represents a multiple-choice form field in an interactive AcroForm.
AcroRadioButtonGroupField	Instances of this class represent a group of radio buttons in an interactive forms.
AcroSignatureField	Represents a digital signature field in an interactive AcroForm.
AcroTextField	Represents a text field in an interactive AcroForm.

Package com.snowtide.pdf.forms Description

The com.snowtide.pdf.forms package is home to a variety of classes that support PDFTextStream's form extraction functionality. Items of note:

• Forms may be accessed using the PDFTextStream.getFormData() function
• All top-level form objects returned by PDFTextStream.getFormData() implement the Form interface
• All top-level form objects representing interactive AcroForm data (the only type of form currently supported) implement the AcroForm interface
• AcroForm form objects contain form fields that implement the AcroFormField interface, an extension of the base FormField interface.
• Each AcroFormField has one public concrete type: AcroButtonField, AcroCheckboxField, AcroRadioButtonGroupField, AcroChoiceField, AcroTextField, or AcroSignatureField. These concrete types provide field-type-specific functionality in addition to that defined by the FormField and AcroFormField.
• The values of text, checkbox, radio button group, and choice fields may be changed using AcroFormField.setValue(String) or type-specific value-setting functions.
• After changing form field values, those changes can be written out into an updated PDF document using AcroForm.writeUpdatedDocument(File) or AcroForm.writeUpdatedDocument(OutputStream) as appropriate.