kitepdf/io.github.yuroyami.kitepdf/PdfAction

PdfAction

A PDF action — ISO 32000-1 §12.6. Actions describe what happens when the user activates a link, button, form field, or document open/close event.

Common variants:

GoTo — jump to a destination in this document
GoToR — jump to a destination in another PDF
Launch — open an external file/application
Uri — open a URL
Named — execute a predefined viewer action (NextPage, Print, …)
JavaScript — run an embedded script
SubmitForm / ResetForm — interactive-form actions

Any action type we don't classify (Sound, Movie, Hide, SetOCGState, SetState, Trans, GoTo3DView, Rendition, ImportData, …) is exposed as Unknown with its raw dict preserved for caller inspection.

Each variant carries the source raw dict so callers can pick up fields we didn't extract (notably the /Next chain for compound actions).

Inheritors

Types

Companion

object Companion

GoTo

data class GoTo(val destination: PdfObject, val raw: PdfDictionary) : PdfAction

GoToE

data class GoToE(val target: PdfDictionary?, val destination: PdfObject?, val newWindow: Boolean, val raw: PdfDictionary) : PdfAction

GoToR

data class GoToR(val filename: String, val destination: PdfObject?, val newWindow: Boolean, val raw: PdfDictionary) : PdfAction

JavaScript

data class JavaScript(val script: String, val raw: PdfDictionary) : PdfAction

Launch

data class Launch(val filename: String, val newWindow: Boolean, val raw: PdfDictionary) : PdfAction

Named

data class Named(val name: PdfAction.NamedActionType, val nameRaw: String, val raw: PdfDictionary) : PdfAction

NamedActionType

enum NamedActionType : Enum<PdfAction.NamedActionType>

Standard /Named action types (ISO 32000-1 §12.6.4.11 Table 211).

ResetForm

data class ResetForm(val fields: List<PdfObject>?, val flags: Int, val raw: PdfDictionary) : PdfAction

SubmitForm

data class SubmitForm(val url: String?, val fields: List<PdfObject>?, val flags: Int, val raw: PdfDictionary) : PdfAction

Thread

data class Thread(val threadRef: PdfObject?, val beadRef: PdfObject?, val raw: PdfDictionary) : PdfAction

Unknown

data class Unknown(val type: String, val raw: PdfDictionary) : PdfAction

Any action whose /S is unknown to this version of the parser, or which we decided not to fully model. The dict is preserved verbatim.

Uri

data class Uri(val uri: String, val isMap: Boolean, val raw: PdfDictionary) : PdfAction

Properties

raw

abstract val raw: PdfDictionary