0.1.0

kitepdf/io.github.yuroyami.kitepdf/PdfFormField

PdfFormField

class 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

object Companion

enum FieldType : Enum<PdfFormField.FieldType>

Properties

defaultAppearance

val defaultAppearance: String?

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

val fieldReference: PdfReference?

Indirect reference to the field dictionary, for editing.

Field flags (/Ff), inherited if absent.

fullyQualifiedName

val fullyQualifiedName: String

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

val isMultiline: Boolean

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

val isReadOnly: Boolean

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

val partialName: String?

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

val quadding: Int

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

val rect: Rectangle?

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

val type: PdfFormField.FieldType

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).

Functions

open override fun toString(): String