AbstractPdfFormField (iText - forms 9.4.0 API)

java.lang.Object
- com.itextpdf.kernel.pdf.PdfObjectWrapper<PdfDictionary>
- - com.itextpdf.forms.fields.AbstractPdfFormField

Direct Known Subclasses:

PdfFormAnnotation, PdfFormField
```
public abstract class AbstractPdfFormField
extends PdfObjectWrapper<PdfDictionary>
```
This class represents a single field or field group in an AcroForm.
To be able to be wrapped with this PdfObjectWrapper the PdfObject must be indirect.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Color`	`color`
`static int`	`DEFAULT_FONT_SIZE` Size of text in form fields when font size is not explicitly set.
`protected PdfFont`	`font`
`protected float`	`fontSize`
`static int`	`MIN_FONT_SIZE` Minimal size of text in form fields.
`protected PdfFormField`	`parent` Parent form field.
`protected PdfConformance`	`pdfConformance`

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractPdfFormField(PdfDictionary pdfObject)
Creates a form field as a wrapper object around a PdfDictionary.

Constructors
Modifier	Constructor and Description
`protected`	`AbstractPdfFormField(PdfDictionary pdfObject)` Creates a form field as a wrapper object around a `PdfDictionary`.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`disableCurrentFieldRegeneration()` This method disables regeneration of the current field appearance stream.
`void`	`disableFieldRegeneration()` This method disables regeneration of the field and its children appearance stream.
`void`	`enableCurrentFieldRegeneration()` This method enables regeneration of the current field appearance stream and regenerates it.
`void`	`enableFieldRegeneration()` This method enables regeneration of the field appearance stream.
`boolean`	`equals(Object o)` Indicate whether some other object is "equal to" this one.
`abstract String[]`	`getAppearanceStates()` Gets the appearance state names.
`Color`	`getColor()` Gets the current color of the form field.
`abstract PdfString`	`getDefaultAppearance()` Gets 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.
`PdfDocument`	`getDocument()` Gets the `PdfDocument` that owns that form field.
`PdfString`	`getFieldName()` Gets the current field name.
`PdfFont`	`getFont()` Gets the current font of the form field.
`float`	`getFontSize()` Gets the current fontSize of the form field.
`PdfDictionary`	`getParent()` Gets the parent dictionary.
`PdfFormField`	`getParentField()` Gets the parent field.
`PdfConformance`	`getPdfConformance()` Gets the declared conformance.
`PdfDictionary`	`getPdfObject()` Gets the wrapped dictionary.
`int`	`hashCode()` Generate a hash code for this object.
`boolean`	`isFieldRegenerationEnabled()` This method checks if field appearance stream regeneration is enabled.
`boolean`	`isTerminalFormField()` Determines whether current form field is terminal or not.
`protected boolean`	`isWrappedObjectMustBeIndirect()`
`AbstractPdfFormField`	`put(PdfName key, PdfObject value)` Inserts the value into the `PdfDictionary` of this field and associates it with the specified key.
`abstract boolean`	`regenerateField()` This method regenerates appearance stream of the field.
`void`	`release()` Releases underlying pdf object and other pdf entities used by wrapper.
`AbstractPdfFormField`	`remove(PdfName key)` Removes the specified key from the `PdfDictionary` of this field.
`AbstractPdfFormField`	`setColor(Color color)` Sets the text color and regenerates appearance stream.
`AbstractPdfFormField`	`setFont(PdfFont font)` Basic setter for the `font` property.
`AbstractPdfFormField`	`setFontAndSize(PdfFont font, float fontSize)` Combined setter for the `font` and `fontSize` properties.
`AbstractPdfFormField`	`setFontSize(float fontSize)` Basic setter for the `fontSize` property.
`AbstractPdfFormField`	`setFontSize(int fontSize)` Basic setter for the `fontSize` property.
`AbstractPdfFormField`	`setFontSizeAutoScale()` Sets zero font size which will be interpreted as auto-size according to ISO 32000-1, 12.7.3.3.
`void`	`setParent(PdfFormField parent)` Sets a parent `PdfFormField` for the current object.

Methods inherited from class com.itextpdf.kernel.pdf.PdfObjectWrapper
ensureObjectIsAddedToDocument, ensureUnderlyingObjectHasIndirectReference, flush, isFlushed, makeIndirect, makeIndirect, markObjectAsIndirect, setForbidRelease, setModified, setPdfObject, unsetForbidRelease

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_FONT_SIZE
```
public static final int DEFAULT_FONT_SIZE
```
    Size of text in form fields when font size is not explicitly set.
    
    See Also:
    
    Constant Field Values
  - MIN_FONT_SIZE
```
public static final int MIN_FONT_SIZE
```
    Minimal size of text in form fields.
    
    See Also:
    
    Constant Field Values
  - font
```
protected PdfFont font
```
  - fontSize
```
protected float fontSize
```
  - color
```
protected Color color
```
  - pdfConformance
```
protected PdfConformance pdfConformance
```
  - parent
```
protected PdfFormField parent
```
    Parent form field.
- Constructor Detail
  - AbstractPdfFormField
```
protected AbstractPdfFormField(PdfDictionary pdfObject)
```
    Creates a form field as a wrapper object around a PdfDictionary. This PdfDictionary must be an indirect object.
    
    Parameters:
    
    pdfObject - the dictionary to be wrapped, must have an indirect reference.
- Method Detail
  - getPdfObject
```
public PdfDictionary getPdfObject()
```
    Gets the wrapped dictionary.
    
    Overrides:
    
    getPdfObject in class PdfObjectWrapper<PdfDictionary>
    
    Returns:
    
    the wrapped dictionary.
  - setParent
```
public void setParent(PdfFormField parent)
```
    Sets a parent PdfFormField for the current object.
    
    Parameters:
    
    parent - another form field that this field belongs to, usually a group field.
  - getParent
```
public PdfDictionary getParent()
```
    Gets the parent dictionary.
    
    Returns:
    
    another form field that this field belongs to.
  - getParentField
```
public PdfFormField getParentField()
```
    Gets the parent field.
    
    Returns:
    
    another form field that this field belongs to.
  - getFieldName
```
public PdfString getFieldName()
```
    Gets the current field name.
    
    Returns:
    
    the current field name, as a PdfString.
  - getDefaultAppearance
```
public abstract PdfString getDefaultAppearance()
```
    Gets 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.
    
    Returns:
    
    the default appearance graphics, as a PdfString.
  - getFontSize
```
public float getFontSize()
```
    Gets the current fontSize of the form field.
    
    Returns:
    
    the current fontSize.
  - getFont
```
public PdfFont getFont()
```
    Gets the current font of the form field.
    
    Returns:
    
    the current font
  - getColor
```
public Color getColor()
```
    Gets the current color of the form field.
    
    Returns:
    
    the current color
  - getPdfConformance
```
public PdfConformance getPdfConformance()
```
    Gets the declared conformance.
    
    Returns:
    
    the PdfConformance
  - regenerateField
```
public abstract boolean regenerateField()
```
    This method regenerates appearance stream of the field. Use it if you changed any field parameters and didn't use setValue method which generates appearance by itself.
    
    Returns:
    
    whether or not the regeneration was successful.
  - disableFieldRegeneration
```
public void disableFieldRegeneration()
```
    This method disables regeneration of the field and its children appearance stream. So all of its children in the hierarchy will also not be regenerated.
    Note that after this method is called field will be regenerated only during enableFieldRegeneration() call.
  - enableFieldRegeneration
```
public void enableFieldRegeneration()
```
    This method enables regeneration of the field appearance stream. Please note that this method enables regeneration for the children of the field. Also, appearance will be regenerated during this method call.
    Should be called after disableFieldRegeneration() method call.
  - disableCurrentFieldRegeneration
```
public void disableCurrentFieldRegeneration()
```
    This method disables regeneration of the current field appearance stream.
  - enableCurrentFieldRegeneration
```
public void enableCurrentFieldRegeneration()
```
    This method enables regeneration of the current field appearance stream and regenerates it.
  - isFieldRegenerationEnabled
```
public boolean isFieldRegenerationEnabled()
```
    This method checks if field appearance stream regeneration is enabled.
    
    Returns:
    
    true if regeneration is enabled for this field (and all of its ancestors), false otherwise.
  - getAppearanceStates
```
public abstract String[] getAppearanceStates()
```
    Gets the appearance state names.
    
    Returns:
    
    an array of Strings containing the names of the appearance states.
  - put
```
public AbstractPdfFormField put(PdfName key,
                                PdfObject value)
```
    Inserts the value into the PdfDictionary of this field and associates it with the specified key. If the key is already present in this field dictionary, this method will override the old value with the specified one.
    
    Parameters:
    
    key - key to insert or to override.
    
    value - the value to associate with the specified key.
    
    Returns:
    
    the edited field.
  - remove
```
public AbstractPdfFormField remove(PdfName key)
```
    Removes the specified key from the PdfDictionary of this field.
    
    Parameters:
    
    key - key to be removed.
    
    Returns:
    
    the edited field.
  - release
```
public void release()
```
    Releases underlying pdf object and other pdf entities used by wrapper. This method should be called instead of direct call to PdfObject.release() if the wrapper is used.
  - getDocument
```
public PdfDocument getDocument()
```
    Gets the PdfDocument that owns that form field.
    
    Returns:
    
    the PdfDocument that owns that form field.
  - isWrappedObjectMustBeIndirect
```
protected boolean isWrappedObjectMustBeIndirect()
```
    Specified by:
    
    isWrappedObjectMustBeIndirect in class PdfObjectWrapper<PdfDictionary>
    
    Returns:
  - setColor
```
public AbstractPdfFormField setColor(Color color)
```
    Sets the text color and regenerates appearance stream.
    
    Parameters:
    
    color - the new value for the Color.
    
    Returns:
    
    the edited AbstractPdfFormField.
  - setFont
```
public AbstractPdfFormField setFont(PdfFont font)
```
    Basic setter for the font property. Regenerates the field appearance after setting the new value. Note that the font will be added to the document so ensure that the font is embedded if it's a pdf/a document.
    
    Parameters:
    
    font - The new font to be set.
    
    Returns:
    
    The edited AbstractPdfFormField.
  - setFontSize
```
public AbstractPdfFormField setFontSize(float fontSize)
```
    Basic setter for the fontSize property. Regenerates the field appearance after setting the new value.
    
    Parameters:
    
    fontSize - The new font size to be set.
    
    Returns:
    
    The edited AbstractPdfFormField.
  - setFontSize
```
public AbstractPdfFormField setFontSize(int fontSize)
```
    Basic setter for the fontSize property. Regenerates the field appearance after setting the new value.
    
    Parameters:
    
    fontSize - The new font size to be set.
    
    Returns:
    
    The edited AbstractPdfFormField.
  - setFontSizeAutoScale
```
public AbstractPdfFormField setFontSizeAutoScale()
```
    Sets zero font size which will be interpreted as auto-size according to ISO 32000-1, 12.7.3.3.
    
    Returns:
    
    the edited AbstractPdfFormField.
  - setFontAndSize
```
public AbstractPdfFormField setFontAndSize(PdfFont font,
                                           float fontSize)
```
    Combined setter for the font and fontSize properties. Regenerates the field appearance after setting the new value.
    
    Parameters:
    
    font - The new font to be set.
    
    fontSize - The new font size to be set.
    
    Returns:
    
    The edited AbstractPdfFormField.
  - isTerminalFormField
```
public boolean isTerminalFormField()
```
    Determines whether current form field is terminal or not.
    
    Returns:
    
    true if this form field is a terminal one, false otherwise.
  - equals
```
public boolean equals(Object o)
```
    Indicate whether some other object is "equal to" this one. Compares wrapped objects.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Generate a hash code for this object.
    
    Overrides:
    
    hashCode in class Object

Class AbstractPdfFormField

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.itextpdf.kernel.pdf.PdfObjectWrapper

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_FONT_SIZE

MIN_FONT_SIZE

font

fontSize

color

pdfConformance

parent

Constructor Detail

AbstractPdfFormField

Method Detail

getPdfObject

setParent

getParent

getParentField

getFieldName

getDefaultAppearance

getFontSize

getFont

getColor

getPdfConformance

regenerateField

disableFieldRegeneration

enableFieldRegeneration

disableCurrentFieldRegeneration

enableCurrentFieldRegeneration

isFieldRegenerationEnabled

getAppearanceStates

put

remove

release

getDocument

isWrappedObjectMustBeIndirect

setColor

setFont

setFontSize

setFontSize

setFontSizeAutoScale

setFontAndSize

isTerminalFormField

equals

hashCode