FormField (PDFxStream API Reference)

All Known Subinterfaces:

AcroFormField

All Known Implementing Classes:

AcroButtonField, AcroCheckboxField, AcroChoiceField, AcroRadioButtonGroupField, AcroSignatureField, AcroTextField
```
public interface FormField
```
Base interface for objects representing fields within a Form.

Version:

©2004-2024 Snowtide

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getName()`	Returns the canonical name of this field.
`String`	`getUIName()`	Returns a user-friendly name for this field, typically used to identify the field to users or in extracts of form data.
`Object`	`getValue()`	Returns the current value of the field.

- Method Detail
  - getName
```
String getName()
```
    Returns the canonical name of this field. Only one FormField instance with a particular name should be available from a Form instance.
  - getUIName
```
String getUIName()
```
    Returns a user-friendly name for this field, typically used to identify the field to users or in extracts of form data. This function may return null if a particular FormField does not specify a user-friendly name, or if a particular FormField implementation does not support the specification of a user-friendly name. In the latter case, the field's name is always available via getName().
  - getValue
```
Object getValue()
```
    Returns the current value of the field. The type of the return value is dependant upon the type of this field, but is almost always a String.