kitepdf-pdf/io.github.yuroyami.kitepdf/PdfFormField

PdfFormField

One terminal interactive-form field (ISO 32000-1 §12.7.3), flattened from the AcroForm field tree with inheritable attributes (/FT, /DA, /Ff, /V, /Q) resolved down from ancestors.

A field and its single widget annotation are frequently merged into one dictionary; when they are separate (e.g. one logical field with widgets on several pages) fieldReference and widgetReference differ. The writer's form-fill uses these references plus rect (the widget's /Rect) to set the value and regenerate the appearance.

Types

Companion

object Companion

FieldType

enum FieldType : Enum<PdfFormField.FieldType>

Widget

class Widget

One place a field is drawn: its annotation, its rectangle, and the reference to reach it.

Properties

additionalActions

val additionalActions: PdfWidgetActions?

The scripts of the field's first widget, or of the field itself when the two are merged.

defaultAppearance

val defaultAppearance: String?

Variable-text default appearance string (/DA), inherited if absent.

defaultValue

val defaultValue: String?

The value the field goes back to when the form is reset (/DV), or null when it has none.

fieldReference

val fieldReference: PdfReference?

Indirect reference to the field dictionary, for editing.

flags

val flags: Int

Field flags (/Ff), inherited if absent.

fullyQualifiedName

val fullyQualifiedName: String

Fully-qualified name: ancestor partial names joined by '.'.

isMultiline

val isMultiline: Boolean

/Ff bit 13 (text fields): multi-line.

isReadOnly

val isReadOnly: Boolean

/Ff bit 1: the field is read-only.

maxLength

val maxLength: Int?

How many characters a text field takes (/MaxLen), or null when it does not say.

options

val options: List<String>

The choices of a list box or a combo box, in the order the file lists them (/Opt, ISO 32000-1 §12.7.4.4). Empty for every other kind of field.

partialName

val partialName: String?

This field's own /T, or null for an anonymous node.

quadding

val quadding: Int

Quadding for variable text (/Q): 0 left, 1 centre, 2 right.

rect

val rect: KiteRectangle?

The first widget's /Rect, or null when this terminal field has no widget.

tooltip

val tooltip: String?

The text a viewer shows when the pointer rests on the field (/TU), or null.

type

val type: PdfFormField.FieldType

value

val value: String?

/V rendered as text (text fields) or the selected name (buttons/choices).

widgetReference

val widgetReference: PdfReference?

Indirect reference to the widget annotation (== fieldReference when merged).

widgets

val widgets: List<PdfFormField.Widget>

Every widget annotation this field owns, in the order the field declares them. One field may be shown in several places: a radio group has one widget per button, and a field may repeat on several pages (ISO 32000-1 §12.7.3.1). The first entry is the one rect, widgetReference and widgetDict describe.

Functions

toString

open override fun toString(): String