| Package | Description |
|---|---|
| com.itextpdf.forms | |
| com.itextpdf.forms.fields |
| Modifier and Type | Field and Description |
|---|---|
protected Map<String,PdfFormField> |
PdfAcroForm.fields
A map of field names and their associated
form field
objects. |
| Modifier and Type | Method and Description |
|---|---|
PdfFormField |
PdfAcroForm.copyField(String name)
Creates an in-memory copy of a
PdfFormField. |
PdfFormField |
PdfAcroForm.getField(String fieldName)
Gets a
form field by its name. |
| Modifier and Type | Method and Description |
|---|---|
Map<String,PdfFormField> |
PdfAcroForm.getFormFields()
Gets the
form fields as a Map. |
| Modifier and Type | Method and 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.addFieldAppearanceToPage(PdfFormField field,
PdfPage page)
This method merges field with its annotation and place it on the given
page.
|
void |
PdfAcroForm.replaceField(String name,
PdfFormField field)
Replaces the
PdfFormField of a certain name with another
PdfFormField. |
| Modifier and Type | Class and 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.
|
| Modifier and Type | Method and Description |
|---|---|
PdfFormField |
PdfFormField.addKid(PdfFormField kid)
Adds a new kid to the
Kids array property from a
PdfFormField. |
PdfFormField |
PdfFormField.addKid(PdfWidgetAnnotation kid)
Adds a new kid to the
Kids array property from a
PdfWidgetAnnotation. |
static PdfFormField |
PdfFormField.createEmptyField(PdfDocument doc)
Creates an empty form field without a predefined set of layout or
behavior.
|
static PdfFormField |
PdfFormField.createRadioButton(PdfDocument doc,
Rectangle rect,
PdfButtonFormField radioGroup,
String value)
Creates a generic
PdfFormField that is added to a radio group. |
static PdfFormField |
PdfFormField.createRadioButton(PdfDocument doc,
Rectangle rect,
PdfButtonFormField radioGroup,
String value,
PdfAConformanceLevel pdfAConformanceLevel)
Creates a generic
PdfFormField that is added to a radio group. |
static PdfFormField |
PdfFormField.makeFormField(PdfObject pdfObject,
PdfDocument document)
Creates a (subtype of)
PdfFormField object. |
PdfFormField |
PdfFormField.put(PdfName key,
PdfObject value) |
PdfFormField |
PdfFormField.setAction(PdfAction action)
Sets the action on all
widgets of this form field. |
PdfFormField |
PdfFormField.setAdditionalAction(PdfName key,
PdfAction action)
Sets an additional action for the form field.
|
PdfFormField |
PdfFormField.setAlternativeName(String name)
Changes the alternate name of the field to the specified value.
|
PdfFormField |
PdfFormField.setAppearance(PdfName appearanceType,
String appearanceState,
PdfStream appearanceStream)
Sets an appearance for (the widgets related to) the form field.
|
PdfFormField |
PdfFormField.setBackgroundColor(Color backgroundColor)
Basic setter for the
backgroundColor property. |
PdfFormField |
PdfFormField.setBorderColor(Color color)
Sets the Border Color.
|
PdfFormField |
PdfFormField.setBorderStyle(PdfDictionary style) |
PdfFormField |
PdfFormField.setBorderWidth(float borderWidth)
Sets the border width for the field.
|
PdfFormField |
PdfFormField.setCheckType(int checkType)
Changes the type of graphical marker used to mark a checkbox as 'on'.
|
PdfFormField |
PdfFormField.setColor(Color color)
Sets the text color.
|
PdfFormField |
PdfFormField.setDefaultAppearance(String defaultAppearance)
Sets default appearance string containing a sequence of valid page-content graphics or text state operators that
define such properties as the field's text size and color.
|
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(String name)
Changes the name of the field to the specified value.
|
PdfFormField |
PdfFormField.setFont(PdfFont font)
Basic setter for the
font property. |
PdfFormField |
PdfFormField.setFontAndSize(PdfFont font,
int fontSize)
Combined setter for the
font and fontSize
properties. |
PdfFormField |
PdfFormField.setFontSize(float fontSize)
Basic setter for the
fontSize property. |
PdfFormField |
PdfFormField.setFontSize(int fontSize)
Basic setter for the
fontSize property. |
PdfFormField |
PdfFormField.setFontSizeAutoScale()
Sets zero font size which will be interpreted as auto-size according to ISO 32000-1, 12.7.3.3.
|
PdfFormField |
PdfFormField.setJustification(int justification)
Sets a code specifying the form of quadding (justification) to be used in displaying the text:
0 Left-justified
1 Centered
2 Right-justified
|
PdfFormField |
PdfFormField.setMappingName(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.setPage(int pageNum)
Specifies on which page the form field's widget must be shown.
|
PdfFormField |
PdfFormField.setParent(PdfFormField parent)
Sets a parent
PdfFormField for the current object. |
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.setRotation(int degRotation)
Basic setter for the
degRotation property. |
PdfFormField |
PdfFormField.setValue(String value)
Sets a value to the field and generating field appearance if needed.
|
PdfFormField |
PdfFormField.setValue(String value,
boolean generateAppearance)
Sets a value to the field and generating field appearance if needed.
|
PdfFormField |
PdfFormField.setValue(String value,
PdfFont font,
float fontSize)
Set text field value with given font and size
|
PdfFormField |
PdfFormField.setValue(String value,
PdfFont font,
int fontSize)
Deprecated.
Use
setValue(String, PdfFont, float) instead |
PdfFormField |
PdfFormField.setValue(String value,
String display)
Sets the field value and the display string.
|
PdfFormField |
PdfFormField.setVisibility(int visibility)
Set the visibility flags of the form field annotation
Options are: HIDDEN, HIDDEN_BUT_PRINTABLE, VISIBLE, VISIBLE_BUT_DOES_NOT_PRINT
|
| Modifier and Type | Method and Description |
|---|---|
PdfFormField |
PdfFormField.addKid(PdfFormField kid)
Adds a new kid to the
Kids array property from a
PdfFormField. |
PdfFormField |
PdfFormField.setParent(PdfFormField parent)
Sets a parent
PdfFormField for the current object. |
Copyright © 1998–2017 iText Group NV. All rights reserved.