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

PdfWidgetActions

data class PdfWidgetActions(val mouseEnter: PdfAction? = null, val mouseExit: PdfAction? = null, val mouseDown: PdfAction? = null, val mouseUp: PdfAction? = null, val focus: PdfAction? = null, val blur: PdfAction? = null, val pageOpen: PdfAction? = null, val pageClose: PdfAction? = null, val pageVisible: PdfAction? = null, val pageInvisible: PdfAction? = null, val keystroke: PdfAction? = null, val format: PdfAction? = null, val validate: PdfAction? = null, val calculate: PdfAction? = null, val raw: PdfDictionary)

The scripts an annotation runs when the reader touches it, from its /AA dictionary (ISO 32000-1 §12.6.3, Table 194 and Table 196).

An interactive PDF puts its behaviour here: a text field filters what is typed with keystroke, a button runs mouseDown when it is pressed, and a total is recomputed by the calculate script of the field that shows it. Each entry is a parsed PdfAction, usually PdfAction.JavaScript, and null when the document does not define that trigger.

The four form triggers (keystroke, format, validate, calculate) only have meaning on a widget of a form field. The six mouse and focus triggers apply to any annotation.

Constructors

PdfWidgetActions

constructor(mouseEnter: PdfAction? = null, mouseExit: PdfAction? = null, mouseDown: PdfAction? = null, mouseUp: PdfAction? = null, focus: PdfAction? = null, blur: PdfAction? = null, pageOpen: PdfAction? = null, pageClose: PdfAction? = null, pageVisible: PdfAction? = null, pageInvisible: PdfAction? = null, keystroke: PdfAction? = null, format: PdfAction? = null, validate: PdfAction? = null, calculate: PdfAction? = null, raw: PdfDictionary)