PdfAcroFormAccess class

Single access point to the document /AcroForm during editing.

The roadmap (§3, item D3) records that PdfAcroForm, PdfSignatureFieldEditor, PdfAnnotWidget and PdfCatalog.prepare() touch /AcroForm and /Fields through different paths, which produces a duplicated field, an orphan one, or one removed from a single tree. This class is the single path of the two new deliveries — the annotation collection and the flattener — until the PdfFormEditor from phase F6 actually exists.

Constructors

PdfAcroFormAccess(PdfDocument document, PdfLoadedObjectMutator mutator)
Creates the access to the form of document.
PdfAcroFormAccess.forDocument(PdfDocument document)
Creates the access with a materializer of its own.
factory

Properties

dictionary → PdfDict<PdfDataType>?
The resolved /AcroForm dictionary, read only.
no setter
document → PdfDocument
The edited document.
final
exists → bool
Whether the catalog declares an /AcroForm.
no setter
fields → PdfArray<PdfDataType>?
The resolved /Fields array, read only.
no setter
hashCode → int
The hash code for this object.
no setterinherited
mutator → PdfLoadedObjectMutator
The materializer of loaded objects.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
removeField(PdfIndirect reference) → bool
Removes from /Fields the entry that points to reference.
removeNeedAppearances() → void
Deletes /NeedAppearances: after flattening there is no appearance to regenerate.
removeWhenEmpty() → bool
Takes the /AcroForm out of the catalog when no field is left.
toString() → String
A string representation of this object.
inherited
writableDictionary() → PdfDict<PdfDataType>?
The /AcroForm dictionary ready for writing, or null if there is none.
writableFields() → PdfArray<PdfDataType>?
The /Fields array ready for writing, or null if there is none.

Operators

operator ==(Object other) → bool
The equality operator.
inherited