Uses of Class
org.apache.pdfbox.pdmodel.interactive.form.PDField

Packages that use PDField

Package	Description
org.apache.pdfbox.pdmodel	The PDModel package represents a high level API for creating and manipulating PDF documents.
org.apache.pdfbox.pdmodel.fixup.processor
org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible	This is the visual signature part that help creating the visual representation for the digital signature.
org.apache.pdfbox.pdmodel.interactive.form	The interactive package contains classes for handling Interactive Forms, also known as "AcroForms".
org.apache.pdfbox.preflight.process

Uses of PDField in org.apache.pdfbox.pdmodel

Method parameters in org.apache.pdfbox.pdmodel with type arguments of type PDField

Modifier and Type	Method	Description
private boolean	PDDocument.checkSignatureField(java.util.Iterator<PDField> fieldIterator, PDSignatureField signatureField)	Check if the field already exists in the field list.
private PDSignatureField	PDDocument.findSignatureField(java.util.Iterator<PDField> fieldIterator, PDSignature sigObject)	Search acroform fields for signature field with specific signature dictionary.

Uses of PDField in org.apache.pdfbox.pdmodel.fixup.processor

Methods in org.apache.pdfbox.pdmodel.fixup.processor that return PDField

Modifier and Type	Method	Description
private PDField	AcroFormOrphanWidgetsProcessor.resolveNonRootField(PDAcroForm acroForm, COSDictionary parent, java.util.Map<java.lang.String,PDField> nonTerminalFieldsMap)

Method parameters in org.apache.pdfbox.pdmodel.fixup.processor with type arguments of type PDField

Modifier and Type	Method	Description
private void	AcroFormOrphanWidgetsProcessor.handleAnnotations(PDAcroForm acroForm, PDResources acroFormResources, java.util.List<PDField> fields, java.util.List<PDAnnotation> annotations, java.util.Map<java.lang.String,PDField> nonTerminalFieldsMap)
private void	AcroFormOrphanWidgetsProcessor.handleAnnotations(PDAcroForm acroForm, PDResources acroFormResources, java.util.List<PDField> fields, java.util.List<PDAnnotation> annotations, java.util.Map<java.lang.String,PDField> nonTerminalFieldsMap)
private PDField	AcroFormOrphanWidgetsProcessor.resolveNonRootField(PDAcroForm acroForm, COSDictionary parent, java.util.Map<java.lang.String,PDField> nonTerminalFieldsMap)

Uses of PDField in org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible

Fields in org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible with type parameters of type PDField

Modifier and Type	Field	Description
private java.util.List<PDField>	PDFTemplateStructure.acroFormFields

Methods in org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible that return types with arguments of type PDField

Modifier and Type	Method	Description
java.util.List<PDField>	PDFTemplateStructure.getAcroFormFields()	Gets acroFormFields

Method parameters in org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible with type arguments of type PDField

Modifier and Type	Method	Description
void	PDFTemplateStructure.setAcroFormFields(java.util.List<PDField> acroFormFields)	Sets acroFormFields

Uses of PDField in org.apache.pdfbox.pdmodel.interactive.form

Subclasses of PDField in org.apache.pdfbox.pdmodel.interactive.form

Modifier and Type	Class	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".

Fields in org.apache.pdfbox.pdmodel.interactive.form with type parameters of type PDField

Modifier and Type	Field	Description
private java.util.Map<java.lang.String,PDField>	PDAcroForm.fieldCache
private java.util.Queue<PDField>	PDFieldTree.FieldIterator.queue

Methods in org.apache.pdfbox.pdmodel.interactive.form that return PDField

Modifier and Type	Method	Description
private static PDField	PDFieldFactory.createButtonSubType(PDAcroForm form, COSDictionary field, PDNonTerminalField parent)
private static PDField	PDFieldFactory.createChoiceSubType(PDAcroForm form, COSDictionary field, PDNonTerminalField parent)
static PDField	PDFieldFactory.createField(PDAcroForm form, COSDictionary field, PDNonTerminalField parent)	Creates a COSField subclass from the given field.
(package private) PDField	PDField.findKid(java.lang.String[] name, int nameIndex)	This will find one of the child elements.
(package private) static PDField	PDField.fromDictionary(PDAcroForm form, COSDictionary field, PDNonTerminalField parent)	Creates a COSField subclass from the given COS field.
PDField	PDAcroForm.getField(java.lang.String fullyQualifiedName)	This will get a field by name, possibly using the cache if setCache is true.
PDField	PDFieldTree.FieldIterator.next()

Methods in org.apache.pdfbox.pdmodel.interactive.form that return types with arguments of type PDField

Modifier and Type	Method	Description
java.util.List<PDField>	PDAcroForm.getCalcOrder()	Return the calculation order in which field values should be recalculated when the value of any field changes.
java.util.List<PDField>	PDNonTerminalField.getChildren()	Returns this field's children.
java.util.Iterator<PDField>	PDAcroForm.getFieldIterator()	Returns an iterator which walks all fields in the field tree, in order.
java.util.List<PDField>	PDAcroForm.getFields()	This will return all of the documents root fields.
java.util.Iterator<PDField>	PDFieldTree.iterator()	Returns an iterator which walks all fields in the tree, in order.

Methods in org.apache.pdfbox.pdmodel.interactive.form with parameters of type PDField

Modifier and Type	Method	Description
private void	PDFieldTree.FieldIterator.enqueueKids(PDField node)

Method parameters in org.apache.pdfbox.pdmodel.interactive.form with type arguments of type PDField

Modifier and Type	Method	Description
private java.util.Map<COSDictionary,java.util.Set<COSDictionary>>	PDAcroForm.buildPagesWidgetsMap(java.util.List<PDField> fields, PDPageTree pages)	Build a map of pages => widgets
private java.util.Set<COSDictionary>	PDAcroForm.createWidgetDictionarySet(java.util.List<PDField> fields)	Return a set of all annotation widget dictionaries related to the fields to be flattened.
void	PDAcroForm.flatten(java.util.List<PDField> fields, boolean refreshAppearances)	This will flatten the specified form fields.
void	PDAcroForm.refreshAppearances(java.util.List<PDField> fields)	Refreshes the appearance streams and appearance dictionaries for the widget annotations of the specified fields.
private void	PDAcroForm.removeFields(java.util.List<PDField> fields)
void	PDAcroForm.setCalcOrder(java.util.List<PDField> fields)	Set the calculation order in which field values should be recalculated when the value of any field changes.
void	PDNonTerminalField.setChildren(java.util.List<PDField> children)	Sets the child fields.
void	PDAcroForm.setFields(java.util.List<PDField> fields)	Set the documents root fields.

Uses of PDField in org.apache.pdfbox.preflight.process

Methods in org.apache.pdfbox.preflight.process with parameters of type PDField

Modifier and Type	Method	Description
protected boolean	AcroFormValidationProcess.validateField(PreflightContext ctx, PDField field)	A and AA field are forbidden, this method checks if they are present and checks all children of this field.

Method parameters in org.apache.pdfbox.preflight.process with type arguments of type PDField

Modifier and Type	Method	Description
protected boolean	AcroFormValidationProcess.exploreFields(PreflightContext ctx, java.util.List<PDField> fields)	This function explores all fields and their children to validate them.