Uses of Class
org.sejda.sambox.pdmodel.interactive.form.PDField

Packages that use PDField

Package	Description
org.sejda.sambox.pdmodel.interactive.form	The interactive package contains classes for handling Interactive Forms, also known as "AcroForms".

Uses of PDField in org.sejda.sambox.pdmodel.interactive.form

Subclasses of PDField in org.sejda.sambox.pdmodel.interactive.form

Modifier and Type	Class and Description
class	PDButton A button field represents an interactive control on the screen that the user can manipulate with the mouse.
class	PDCheckBox A check box toggles between two states, on and off.
class	PDChoice A choice field contains several text items, one or more of which shall be selected as the field value.
class	PDComboBox A combo box consisting of a drop-down list.
class	PDListBox A scrollable list box.
class	PDNonTerminalField A non terminal field in an interactive form.
class	PDPushButton A pushbutton is a purely interactive control that responds immediately to user input without retaining a permanent value.
class	PDRadioButton Radio button fields contain a set of related buttons that can each be on or off.
class	PDSignatureField A signature field is a form field that contains a digital signature.
class	PDTerminalField A field in an interactive form.
class	PDTextField A text field is a box or space for text fill-in data typically entered from a keyboard.
class	PDVariableText Base class for fields which use "Variable Text".

Methods in org.sejda.sambox.pdmodel.interactive.form that return PDField

Modifier and Type	Method and Description
static PDField	PDFieldFactory.createField(PDAcroForm form, COSDictionary field, PDNonTerminalField parent) Creates a PDField subclass from the given field.
static PDField	PDFieldFactory.createFieldAddingChildToParent(PDAcroForm form, COSDictionary field, PDNonTerminalField parent) Creates and sets it as a child of the given parent PDNonTerminalField
PDField	PDAcroForm.getField(String fullyQualifiedName) This will get a field by name, possibly using the cache if setCache is true.

Methods in org.sejda.sambox.pdmodel.interactive.form that return types with arguments of type PDField

Modifier and Type	Method and Description
List<PDField>	PDAcroForm.getCalculationOrder()
List<PDField>	PDNonTerminalField.getChildren()
Iterator<PDField>	PDAcroForm.getFieldIterator() Returns an iterator which walks all fields in the field tree, post-order.
List<PDField>	PDAcroForm.getFields() This will return all of the documents root fields.
Iterator<PDField>	PDFieldTree.iterator()
Stream<PDField>	PDFieldTree.stream()

Methods in org.sejda.sambox.pdmodel.interactive.form with parameters of type PDField

Modifier and Type	Method and Description
void	PDNonTerminalField.addChild(PDField field) Adds a child to the array of children
COSBase	PDNonTerminalField.removeChild(PDField field) Removes the given node from the children list
COSBase	PDAcroForm.removeField(PDField remove) removes the given field from the root fields of the form

Method parameters in org.sejda.sambox.pdmodel.interactive.form with type arguments of type PDField

Modifier and Type	Method and Description
void	PDAcroForm.addFields(List<PDField> toAdd) Adds the fields to the root fields of the form
void	PDAcroForm.flatten(List<PDField> fields, boolean refreshAppearances) This will flatten the specified form fields.
void	PDAcroForm.refreshAppearances(List<PDField> fields) Refreshes the appearance streams and appearance dictionaries for the widget annotations of the specified fields.
void	PDNonTerminalField.setChildren(List<PDField> children) Sets the child fields.
void	PDAcroForm.setFields(List<PDField> fields) Set the documents root fields.