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

PdfFormFieldCollection

public final class PdfFormFieldCollection implements Iterable<T>

Represents a collection of form fields in a PDF document. Provides access to the top-level form fields in the document's AcroForm.

Constructors

public void PdfFormFieldCollection()

Functions

addCheckBoxField

public final PdfCheckBoxField addCheckBoxField(String name, PdfPage page, float x, float y, float width, float height)

Adds a new check box field to the document on the specified page.

addComboBoxField

public final PdfComboBoxField addComboBoxField(String name, PdfPage page, float x, float y, float width, float height)

Adds a new combo box (drop-down list) field to the document on the specified page.

addListBoxField

public final PdfListBoxField addListBoxField(String name, PdfPage page, float x, float y, float width, float height)

Adds a new list box field to the document on the specified page.

addPushButtonField

public final PdfPushButtonField addPushButtonField(String name, PdfPage page, float x, float y, float width, float height)

Adds a new push button field to the document on the specified page.

addRadioButtonField

public final PdfRadioButtonField addRadioButtonField(String groupName, String optionName, PdfPage page, float x, float y, float width, float height)

Adds a new radio button to an existing or new radio button group on the specified page.

addSignatureField

public final PdfSignatureField addSignatureField(String name, PdfPage page, float x, float y, float width, float height)

Adds a new signature field to the document on the specified page.

addTextField

public final PdfTextField addTextField(String name, PdfPage page, float x, float y, float width, float height)

Adds a new text field to the document on the specified page.

clear

public final void clear()

Removes all form fields from the document.

findByFullName

public final PdfFormField findByFullName(String fullName)

Finds a form field by its full name (dot-separated path).

forEach

public void forEach(Consumer<? super T> action)

get

public final PdfFormField get(int index)

Returns the element at the specified position in this collection.

getCount

public final int getCount()

Gets the number of top-level form fields in the document.

getEnumerator

public final long getEnumerator()

Returns an enumerator that iterates through the form fields collection.

iterator

public final Iterator<PdfFormField> iterator()

Returns an iterator over the elements in this collection.

removeAt

public final void removeAt(int index)

Removes the form field at the specified index.

size

public final int size()

Returns the number of elements in this collection.

spliterator

public Spliterator<T> spliterator()