Uses of Class
com.itextpdf.forms.fields.PdfFormField
-
Packages that use PdfFormField Package Description com.itextpdf.forms com.itextpdf.forms.fields com.itextpdf.forms.fields.merging com.itextpdf.forms.form.renderer com.itextpdf.signatures -
-
Uses of PdfFormField in com.itextpdf.forms
Fields in com.itextpdf.forms with type parameters of type PdfFormField Modifier and Type Field Description protected java.util.Map<java.lang.String,PdfFormField>
PdfAcroForm. fields
A map of field names and their associatedform field
objects.private java.util.Set<PdfFormField>
PdfAcroForm. fieldsForFlattening
Methods in com.itextpdf.forms that return PdfFormField Modifier and Type Method Description PdfFormField
PdfAcroForm. copyField(java.lang.String name)
Creates an in-memory copy of aPdfFormField
.private PdfFormField
PdfPageFormCopier. createParentFieldCopy(PdfDictionary fieldDict, PdfDocument pdfDoc)
PdfFormField
PdfAcroForm. getField(java.lang.String fieldName)
Gets aform field
by its name.private static PdfFormField
PdfPageFormCopier. getParentField(PdfDictionary parent, PdfDocument pdfDoc)
Methods in com.itextpdf.forms that return types with arguments of type PdfFormField Modifier and Type Method Description java.util.Map<java.lang.String,PdfFormField>
PdfAcroForm. getAllFormFields()
Gets allform field
s as aMap
including fields kids.private java.util.Set<PdfFormField>
PdfAcroForm. getAllFormFieldsWithoutNames()
java.util.Collection<PdfFormField>
PdfAcroForm. getFieldsForFlattening()
Gets a collection ofform field
s, prepared for flattening usingPdfAcroForm.partialFormFlattening(java.lang.String)
method.java.util.Map<java.lang.String,PdfFormField>
PdfAcroForm. getRootFormFields()
Gets root fields (i.e.private java.util.Map<java.lang.String,PdfFormField>
PdfAcroForm. populateFormFieldsMap()
private java.util.Set<PdfFormField>
PdfAcroForm. prepareFieldsForFlattening(PdfFormField field)
Methods in com.itextpdf.forms with parameters of type PdfFormField Modifier and Type Method Description void
PdfAcroForm. addField(PdfFormField field)
This method adds the field to the last page in the document.void
PdfAcroForm. addField(PdfFormField field, PdfPage page)
This method adds the field to a specific page.void
PdfAcroForm. addField(PdfFormField field, PdfPage page, boolean throwExceptionOnError)
This method adds the field to a specific page.void
PdfAcroForm. addFieldAppearanceToPage(PdfFormField field, PdfPage page)
This method merges field with its annotation and places it on the given page.private void
PdfPageFormCopier. copyParentFormField(java.util.Map<java.lang.String,PdfFormField> fieldsTo, PdfAnnotation annot, PdfFormField parentField)
private boolean
PdfAcroForm. needToAddToAcroform(PdfFormField field, boolean throwExceptionOnError)
private java.util.Set<PdfFormField>
PdfAcroForm. prepareFieldsForFlattening(PdfFormField field)
private void
PdfAcroForm. processKids(PdfFormField field, PdfPage page)
void
PdfAcroForm. replaceField(java.lang.String name, PdfFormField field)
Replaces thePdfFormField
of a certain name with anotherPdfFormField
.Method parameters in com.itextpdf.forms with type arguments of type PdfFormField Modifier and Type Method Description private void
PdfPageFormCopier. copyField(java.util.Map<java.lang.String,PdfFormField> fieldsFrom, java.util.Map<java.lang.String,PdfFormField> fieldsTo, PdfAnnotation currentAnnot)
private void
PdfPageFormCopier. copyParentFormField(java.util.Map<java.lang.String,PdfFormField> fieldsTo, PdfAnnotation annot, PdfFormField parentField)
-
Uses of PdfFormField in com.itextpdf.forms.fields
Subclasses of PdfFormField in com.itextpdf.forms.fields Modifier and Type Class Description class
PdfButtonFormField
An interactive control on the screen that raises events and/or can retain data.class
PdfChoiceFormField
An AcroForm field type representing any type of choice field.class
PdfSignatureFormField
An AcroForm field containing signature data.class
PdfTextFormField
An AcroForm field containing textual data.Fields in com.itextpdf.forms.fields declared as PdfFormField Modifier and Type Field Description protected PdfFormField
AbstractPdfFormField. parent
Parent form field.Methods in com.itextpdf.forms.fields that return PdfFormField Modifier and Type Method Description PdfFormField
PdfButtonFormField. addKid(AbstractPdfFormField kid)
Adds a new kid to theKids
array property from aAbstractPdfFormField
.PdfFormField
PdfFormField. addKid(AbstractPdfFormField kid)
Adds a new kid to theKids
array property from aAbstractPdfFormField
.PdfFormField
PdfFormField. addKid(AbstractPdfFormField kid, boolean throwExceptionOnError)
Adds a new kid to theKids
array property from aAbstractPdfFormField
.PdfFormField
PdfFormField. addKid(PdfWidgetAnnotation kid)
Adds a new kid to theKids
array property from aPdfWidgetAnnotation
.static PdfFormField
PdfFormCreator. createFormField(PdfWidgetAnnotation widget, PdfDocument document)
Creates a form field as a parent of aPdfWidgetAnnotation
using provided factory.static PdfFormField
PdfFormCreator. createFormField(PdfDictionary dictionary)
Creates a form field as a wrapper object around aPdfDictionary
using provided factory.static PdfFormField
PdfFormCreator. createFormField(PdfDocument document)
Create a minimal, emptyPdfFormField
using provided factory.PdfFormField
PdfFormFactory. createFormField(PdfWidgetAnnotation widget, PdfDocument document)
Creates a form field as a parent of aPdfWidgetAnnotation
.PdfFormField
PdfFormFactory. createFormField(PdfDictionary dictionary)
Creates a form field as a wrapper object around aPdfDictionary
.PdfFormField
PdfFormFactory. createFormField(PdfDocument document)
Create a minimal, emptyPdfFormField
.PdfFormField
NonTerminalFormFieldBuilder. createNonTerminalFormField()
Creates non-terminal form field based on provided parameters.PdfFormField
PdfFormField. getChildField(java.lang.String fieldName)
Gets the child field of form field.PdfFormField
AbstractPdfFormField. getParentField()
Gets the parent field.static PdfFormField
PdfFormField. makeFormField(PdfObject pdfObject, PdfDocument document)
Creates a (subtype of)PdfFormField
object.PdfFormField
PdfFormField. setAdditionalAction(PdfName key, PdfAction action)
Sets an additional action for the form field.PdfFormField
PdfFormField. setAlternativeName(java.lang.String name)
Changes the alternate name of the field to the specified value.PdfFormField
PdfFormField. setCheckType(CheckBoxType checkType)
Changes the type of graphical marker used to mark a checkbox as 'on'.PdfFormField
PdfFormField. setDefaultStyle(PdfString defaultStyleString)
Sets a default style string, as described in "Rich Text Strings" section of Pdf spec.PdfFormField
PdfFormField. setDefaultValue(PdfObject value)
Sets the default fallback value for the form field.PdfFormField
PdfFormField. setFieldFlag(int flag)
Adds a flag, or combination of flags, for the form field.PdfFormField
PdfFormField. setFieldFlag(int flag, boolean value)
Adds or removes a flag, or combination of flags, for the form field.PdfFormField
PdfFormField. setFieldFlags(int flags)
Sets a flag, or combination of flags, for the form field.PdfFormField
PdfFormField. setFieldName(java.lang.String name)
Changes the name of the field to the specified value.private PdfFormField
PdfFormField. setFieldValue(java.lang.String value, boolean generateAppearance)
PdfFormField
PdfFormField. setJustification(TextAlignment justification)
Sets a code specifying the form of quadding (justification) to be used in displaying the text: 0 Left-justified 1 Centered 2 Right-justifiedPdfFormField
PdfFormField. setMappingName(java.lang.String name)
Changes the mapping name of the field to the specified value.PdfFormField
PdfFormField. setNoExport(boolean noExport)
Sets the NoExport flag, specifying whether or not exporting is forbidden.PdfFormField
PdfFormField. setOptions(PdfArray options)
Sets options for the form field.PdfFormField
PdfFormField. setReadOnly(boolean readOnly)
Sets the ReadOnly flag, specifying whether or not the field can be changed.PdfFormField
PdfFormField. setRequired(boolean required)
Sets the Required flag, specifying whether or not the field must be filled in.PdfFormField
PdfFormField. setRichText(PdfObject richText)
Sets a rich text string, as described in "Rich Text Strings" section of Pdf spec.PdfFormField
PdfFormField. setValue(java.lang.String value)
Sets a value to the field and generating field appearance if needed.PdfFormField
PdfFormField. setValue(java.lang.String value, boolean generateAppearance)
Sets a value to the field (and fields with the same names) and generates field appearance if needed.PdfFormField
PdfFormField. setValue(java.lang.String value, PdfFont font, float fontSize)
Set text field value with given font and size.PdfFormField
PdfFormField. setValue(java.lang.String value, java.lang.String displayValue)
Sets the field value and the display string.Methods in com.itextpdf.forms.fields that return types with arguments of type PdfFormField Modifier and Type Method Description java.util.List<PdfFormField>
PdfFormField. getAllChildFormFields()
Gets all childFields of this object, including the children of the children but not annotations.java.util.List<PdfFormField>
PdfFormField. getChildFormFields()
Gets all child form fields of this form field.Methods in com.itextpdf.forms.fields with parameters of type PdfFormField Modifier and Type Method Description static void
PdfFormFieldMergeUtil. mergeFormFields(PdfFormField firstField, PdfFormField secondField, boolean throwExceptionOnError)
This method combines two form fields.static void
PdfFormFieldMergeUtil. mergeKidsWithSameNames(PdfFormField parentField, boolean throwExceptionOnError)
This method merges all kids with the same names for the given parent field dictionary (recursively).static boolean
PdfFormFieldMergeUtil. mergeTwoFieldsWithTheSameNames(PdfFormField firstField, PdfFormField secondField, boolean throwExceptionOnError)
This method merges different values from two field dictionaries into the first one and combines kids.static void
PdfFormAnnotationUtil. mergeWidgetWithParentField(PdfFormField field)
Merge single widget annotation with its parent field.static void
PdfFormFieldMergeUtil. processDirtyAnnotations(PdfFormField parentField, boolean throwExceptionOnError)
Sometimes widgets contain field related keys, and they are the same as these field keys at parent.static void
PdfFormAnnotationUtil. separateWidgetAndField(PdfFormField field)
Separate merged field to form field and pure widget annotation.(package private) void
TerminalFormFieldBuilder. setPageToField(PdfFormField field)
void
AbstractPdfFormField. setParent(PdfFormField parent)
Sets a parentPdfFormField
for the current object. -
Uses of PdfFormField in com.itextpdf.forms.fields.merging
Methods in com.itextpdf.forms.fields.merging with parameters of type PdfFormField Modifier and Type Method Description boolean
AddIndexStrategy. execute(PdfFormField firstField, PdfFormField secondField, boolean throwExceptionOnError)
Renames the second field by adding an index to its name.boolean
AlwaysThrowExceptionStrategy. execute(PdfFormField firstField, PdfFormField secondField, boolean throwExceptionOnError)
executes the strategy.boolean
MergeFieldsStrategy. execute(PdfFormField firstField, PdfFormField secondField, boolean throwExceptionOnError)
executes the strategy.boolean
OnDuplicateFormFieldNameStrategy. execute(PdfFormField firstField, PdfFormField secondField, boolean throwExceptionOnError)
executes the strategy. -
Uses of PdfFormField in com.itextpdf.forms.form.renderer
Methods in com.itextpdf.forms.form.renderer with parameters of type PdfFormField Modifier and Type Method Description protected void
AbstractFormFieldRenderer. applyAccessibilityProperties(PdfFormField formField, PdfDocument pdfDocument)
Applies the accessibility properties to the form field.protected void
AbstractSelectFieldRenderer. applyAccessibilityProperties(PdfFormField formField, PdfDocument pdfDocument)
Applies the accessibility properties to the form field.(package private) void
AbstractTextFieldRenderer. applyDefaultFieldProperties(PdfFormField inputField)
Applies the default field properties. -
Uses of PdfFormField in com.itextpdf.signatures
Methods in com.itextpdf.signatures with parameters of type PdfFormField Modifier and Type Method Description boolean
SignatureUtil.ContentsChecker. checkWhetherSignatureCoversWholeDocument(PdfFormField signatureField)
-