Uses of Class
org.apache.pdfbox.pdmodel.interactive.form.PDField
Packages that use PDField
Package
Description
The PDModel package represents a high level API for creating and manipulating PDF documents.
This is the visual signature part that help creating the visual representation for the digital signature.
The interactive package contains classes for handling Interactive Forms, also known as "AcroForms".
-
Uses of PDField in org.apache.pdfbox.multipdf
Methods in org.apache.pdfbox.multipdf with parameters of type PDFieldModifier and TypeMethodDescriptionprivate void
PDFMergerUtility.mergeFields
(PDFCloneUtility cloner, PDField destField, PDField srcField) -
Uses of PDField in org.apache.pdfbox.pdmodel
Method parameters in org.apache.pdfbox.pdmodel with type arguments of type PDFieldModifier and TypeMethodDescriptionprivate boolean
PDDocument.checkSignatureField
(Iterator<PDField> fieldIterator, PDSignatureField signatureField) Check if the field already exists in the field list.private PDSignatureField
PDDocument.findSignatureField
(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 PDFieldModifier and TypeMethodDescriptionprivate PDField
AcroFormOrphanWidgetsProcessor.resolveNonRootField
(PDAcroForm acroForm, PDAnnotationWidget widget, Map<String, PDField> nonTerminalFieldsMap) Method parameters in org.apache.pdfbox.pdmodel.fixup.processor with type arguments of type PDFieldModifier and TypeMethodDescriptionprivate void
AcroFormOrphanWidgetsProcessor.handleAnnotations
(PDAcroForm acroForm, List<PDField> fields, List<PDAnnotation> annotations, Map<String, PDField> nonTerminalFieldsMap) private void
AcroFormOrphanWidgetsProcessor.handleAnnotations
(PDAcroForm acroForm, List<PDField> fields, List<PDAnnotation> annotations, Map<String, PDField> nonTerminalFieldsMap) private PDField
AcroFormOrphanWidgetsProcessor.resolveNonRootField
(PDAcroForm acroForm, PDAnnotationWidget widget, Map<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 PDFieldMethods in org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible that return types with arguments of type PDFieldMethod parameters in org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible with type arguments of type PDFieldModifier and TypeMethodDescriptionvoid
PDFTemplateStructure.setAcroFormFields
(List<PDField> acroFormFields) Sets acroFormFields -
Uses of PDField in org.apache.pdfbox.pdmodel.interactive.form
Subclasses of PDField in org.apache.pdfbox.pdmodel.interactive.formModifier and TypeClassDescriptionclass
A button field represents an interactive control on the screen that the user can manipulate with the mouse.final class
A check box toggles between two states, on and off.class
A choice field contains several text items, one or more of which shall be selected as the field value.final class
A combo box consisting of a drop-down list.final class
A scrollable list box.class
A non terminal field in an interactive form.class
A pushbutton is a purely interactive control that responds immediately to user input without retaining a permanent value.final class
Radio button fields contain a set of related buttons that can each be on or off.class
A signature field is a form field that contains a digital signature.class
A field in an interactive form.final class
A text field is a box or space for text fill-in data typically entered from a keyboard.class
Base class for fields which use "Variable Text".Fields in org.apache.pdfbox.pdmodel.interactive.form with type parameters of type PDFieldMethods in org.apache.pdfbox.pdmodel.interactive.form that return PDFieldModifier and TypeMethodDescriptionprivate 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
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.This will get a field by name, possibly using the cache if setCache is true.PDFieldTree.FieldIterator.next()
Methods in org.apache.pdfbox.pdmodel.interactive.form that return types with arguments of type PDFieldModifier and TypeMethodDescriptionPDNonTerminalField.getChildren()
Returns this field's children.PDAcroForm.getFieldIterator()
Returns an iterator which walks all fields in the field tree, in order.PDAcroForm.getFields()
This will return all of the documents root fields.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 PDFieldModifier and TypeMethodDescriptionprivate void
PDFieldTree.FieldIterator.enqueueKids
(PDField node) Method parameters in org.apache.pdfbox.pdmodel.interactive.form with type arguments of type PDFieldModifier and TypeMethodDescriptionprivate Map<COSDictionary,
Set<COSDictionary>> PDAcroForm.buildPagesWidgetsMap
(List<PDField> fields) void
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.private void
PDAcroForm.removeFields
(List<PDField> fields) void
PDNonTerminalField.setChildren
(List<PDField> children) Sets the child fields.void
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 PDFieldModifier and TypeMethodDescriptionprotected 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 PDFieldModifier and TypeMethodDescriptionprotected boolean
AcroFormValidationProcess.exploreFields
(PreflightContext ctx, List<PDField> fields) This function explores all fields and their children to validate them.