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

PdfScriptHandler

What a viewer needs from a document's scripts, without knowing how they run.

kitepdf-javascript implements this over KiteJS, and a host may implement it over any other engine. The viewer talks to this interface only, so an app that shows PDFs does not carry a JavaScript engine unless it asks for one.

Every method is allowed to do nothing: a handler that runs no scripts is a valid handler, and a viewer with no handler behaves as it always did.

Properties

formState

abstract val formState: PdfFormState

Where the form's live values are, which the viewer draws and the scripts write.

hasTimers

open val hasTimers: Boolean

True when a script is waiting on a timer.

Functions

blur

open fun blur(fieldName: String)

A field lost the caret.

commit

open fun commit(fieldName: String, value: String): Boolean

The reader finished with a field, so its value is committed: validate, store, recalculate and format. Returns false when a script refused the value.

documentOpened

open fun documentOpened()

The document opened: run its own scripts and its open action.

focus

open fun focus(fieldName: String)

A field took the caret.

keystroke

open fun keystroke(fieldName: String, change: String, selectionStart: Int, selectionEnd: Int): String?

The reader typed into a field. change is what is being inserted, replacing the text between selectionStart and selectionEnd.

mouseDown

open fun mouseDown(fieldName: String)

A pointer went down on a widget.

mouseUp

open fun mouseUp(fieldName: String)

A pointer came up on a widget.

pageClosed

open fun pageClosed(pageIndex: Int)

The reader left this page: run its close script.

pageOpened

open fun pageOpened(pageIndex: Int)

The reader reached this page: run its open script.

pumpTimers

open fun pumpTimers(nowMillis: Long): Long?

Runs the timers a script set, and answers how long to wait before the next one, or null when none is waiting. The viewer calls this once a frame while hasTimers is true.

runAction

open fun runAction(action: PdfAction.JavaScript)

The reader tapped something whose action is a script, such as a link.