kitepdf/io.github.yuroyami.kitepdf/PdfAcroForm

PdfAcroForm

data class PdfAcroForm(val fieldCount: Int, val needAppearances: Boolean, val signatureFlags: Int, val defaultAppearance: String?, val defaultQuadding: Int, val raw: PdfDictionary)

Top-level interactive form metadata — catalog /AcroForm (ISO 32000-1 §12.7.2).

KitePDF v0.0.x exposes the catalog-level view only: how many fields, what the default appearance and quadding are, and the document-level signing flags. The full field tree (the per-field /Fields entries with their parent/kid relationships and widget links) is a deliberate follow-up; we want to land form filling and form appearance generation as a coherent feature rather than dribble fields in piece by piece.

Constructors

PdfAcroForm

constructor(fieldCount: Int, needAppearances: Boolean, signatureFlags: Int, defaultAppearance: String?, defaultQuadding: Int, raw: PdfDictionary)

Types

Companion

object Companion

Properties

appendOnly

val appendOnly: Boolean

True if /SigFlags & 2 — modifications must be append-only (the signed-bytes invariant). Save-side enforcement is on a future round's docket.

defaultAppearance

val defaultAppearance: String?

Default field-text appearance string (the same syntax as a content stream).

defaultQuadding

val defaultQuadding: Int

Default quadding for variable text: 0 = left, 1 = centre, 2 = right.

fieldCount

val fieldCount: Int

Number of root fields (top of the field tree).

hasSignatures

val hasSignatures: Boolean

True if /SigFlags & 1 — at least one signature field exists.

hasXfa

val hasXfa: Boolean

True if the document carries an XFA payload (PDF 1.5 dynamic forms, deprecated in PDF 2.0). Most modern viewers ignore XFA; we expose the flag for compatibility scanning but don't parse the payload.

needAppearances

val needAppearances: Boolean

If true, the conforming reader must regenerate field appearances on open — the document's /AP streams are out of date. PDF readers that don't regenerate (like our current renderer) should not display stale appearance streams when this is true.

raw

val raw: PdfDictionary

Raw dict for callers needing fields we didn't model (DR, CO, XFA, …).

signatureFlags

val signatureFlags: Int

Document-level signing flags. Bit 1 = SignaturesExist; bit 2 = AppendOnly.