public interface

JavaScriptProvider

com.pspdfkit.javascript.JavaScriptProvider

Class Overview

Handles all JavaScript related operations on the owning document. Retrieve it with getJavaScriptProvider()

Summary

Public Methods
abstract void executeDocumentLevelScripts()
Loads and evaluates top level JavaScript scripts that are associated with the document.
abstract Completable executeDocumentLevelScriptsAsync()
Loads and evaluates top level JavaScript scripts that are associated with the document, asynchronously.
abstract boolean isJavaScriptEnabled()
Returns true if JavaScript processing is enabled for this document.
abstract void setJavaScriptEnabled(boolean isJavaScriptEnabled)
Controls whether JavaScript processing is enabled for this document.

Public Methods

public abstract void executeDocumentLevelScripts ()

Loads and evaluates top level JavaScript scripts that are associated with the document. Note: this call may block for a while and should not be invoked on the main thread.

public abstract Completable executeDocumentLevelScriptsAsync ()

Loads and evaluates top level JavaScript scripts that are associated with the document, asynchronously.

Returns
  • Completable emitting complete event once the document level scripts are executed.

public abstract boolean isJavaScriptEnabled ()

Returns true if JavaScript processing is enabled for this document.

Returns
  • true when JavaScript processing is enabled, false otherwise.

public abstract void setJavaScriptEnabled (boolean isJavaScriptEnabled)

Controls whether JavaScript processing is enabled for this document. Defaults to false. Note: Processing JavaScript can be slow for documents with a large number of document providers or scripts. Disabling in most cases will not have any negative effects.

Parameters
isJavaScriptEnabled true to enable JavaScript processing, false to disable.