Nutrient Java SDK/io.nutrient.sdk.editors.pdf.formfields/PdfFormField

PdfFormField

public class PdfFormField

Represents a form field in a PDF document. Form fields can be terminal (with widget annotations) or non-terminal (with child fields). This is the base class for all form field types. Use the specific subclasses (, , , etc.) for type-specific functionality.

Inheritors

PdfListBoxField

PdfCheckBoxField

PdfPushButtonField

PdfComboBoxField

PdfSignatureField

PdfRadioButtonField

Constructors

public void PdfFormField()

Functions

public PdfFormField getChild(int index)

Gets a child field by index.

public int getChildCount()

Gets the number of child fields.

getDefaultValue

public String getDefaultValue()

Gets the default value of the field.

public PdfFormFieldType getFieldType()

Gets the type of this form field.

public String getFullName()

Gets the fully qualified name of this field (dot-separated path from root).

public boolean getIsReadOnly()

Gets whether the field is read-only.

public boolean getIsRequired()

Gets whether the field is required.

public boolean getIsTerminal()

Gets whether this is a terminal field (has widget annotations instead of child fields).

public String getName()

Gets the partial name of this field (T entry).

public PdfFormField getParent()

Gets the parent field of this field, or null if this is a top-level field.

public String getValue()

Gets the current value of the field.

public PdfWidgetAnnotation getWidget(int index)

Gets a widget annotation by index.

public int getWidgetCount()

Gets the number of widget annotations.

public void removeChildAt(int index)

Removes a child field at the specified index.

public void setIsReadOnly(boolean value)

Sets whether the field is read-only.

public void setIsRequired(boolean value)

Sets whether the field is required.

public void setValue(String value)

Sets the current value of the field.