JavaScript Actions Example

1
/*
2
 *   Copyright © 2025-2026 PSPDFKit GmbH. All rights reserved.
3
 *
4
 *   The PSPDFKit Sample applications are licensed with a modified BSD license.
5
 *   Please see License for details. This notice may not be removed from this file.
6
 */
7

8
package com.pspdfkit.catalog.examples.kotlin
9

10
import android.annotation.SuppressLint
11
import android.content.Context
12
import android.net.Uri
13
import android.view.Menu
14
import android.view.MenuItem
15
import com.pspdfkit.annotations.actions.JavaScriptAction
16
import com.pspdfkit.catalog.R
17
import com.pspdfkit.catalog.SdkExample
18
import com.pspdfkit.catalog.tasks.ExtractAssetTask.extract
19
import com.pspdfkit.configuration.activity.PdfActivityConfiguration
20
import com.pspdfkit.ui.PdfActivity
21
import com.pspdfkit.ui.PdfActivityIntentBuilder
22

23
/** This example shows how to create and execute JavaScript actions programmatically. */
24
class JavaScriptActionsExample(context: Context) : SdkExample(context, R.string.javaScriptActionExampleTitle, R.string.javaScriptActionExampleDescription) {
25

26
    @SuppressLint("SetJavaScriptEnabled")
27
    override fun launchExample(
28
        context: Context,
29
        configuration: PdfActivityConfiguration.Builder
30
    ) {
31
        configuration
32
            // JavaScript is enabled by default. It can be disabled in configuration.
33
            .setJavaScriptEnabled(true)
34
            // Turn off saving, so we have the clean original document every time the example is launched.
35
            .autosaveEnabled(false)
36

37
        extract(WELCOME_DOC, title, context) { documentFile ->
38
            // Launch the custom example activity using the document and configuration.
39
            val intent = PdfActivityIntentBuilder.fromUri(context, Uri.fromFile(documentFile))
40
                .configuration(configuration.build())
41
                .activityClass(JavaScriptActionsActivity::class.java)
42
                .build()
43
            context.startActivity(intent)
44
        }
45
    }
46
}
47

48
/**
49
 * This activity shows how to create and execute JavaScript actions programmatically.
50
 *
51
 * @see JavaScriptActionsExample
52
 */
53
class JavaScriptActionsActivity : PdfActivity() {
54

55
    override fun onCreateOptionsMenu(menu: Menu): Boolean {
56
        super.onCreateOptionsMenu(menu)
57
        menu.add(0, SHOW_ALERT, 0, "Show Alert")
58
        menu.add(0, GO_TO_NEXT_PAGE, 0, "Go To Next Page")
59
        menu.add(0, SHOW_FORM_FIELDS, 0, "Show Form Fields")
60
        menu.add(0, MAIL_TO, 0, "Mail to")
61
        return true
62
    }
63

64
    override fun onOptionsItemSelected(item: MenuItem): Boolean =
65
        when (item.itemId) {
66
            SHOW_ALERT -> {
67
                executeShowAlertAction()
68
                true
69
            }
70
            GO_TO_NEXT_PAGE -> {
71
                executeGoToNextPageAction()
72
                true
73
            }
74
            SHOW_FORM_FIELDS -> {
75
                executeShowFormFieldsAction()
76
                true
77
            }
78
            MAIL_TO -> {
79
                executeMailDocumentAction()
80
                true
81
            }
82
            else -> super.onOptionsItemSelected(item)
83
        }
84

85
    /** Shows simple alert dialog through JavaScript. */
86
    private fun executeShowAlertAction() {
87
        executeJavaScript("app.alert('This is a JavaScript alert!')")
88
    }
89

90
    /** Changes to next page via JavaScript. */
91
    private fun executeGoToNextPageAction() {
92
        executeJavaScript("doc.pageNum = doc.pageNum + 1")
93
    }
94

95
    /** Prints list of form field names via JavaScript. */
96
    private fun executeShowFormFieldsAction() {
97
        executeJavaScript(
98
            """
99
            var message = 'There are ' + this.numFields + ' form fields in this document.\n';
100
            for (var i = 0; i < this.numFields; i++) {
101
               message += 'Field[' + i + '] = ' + this.getNthFieldName(i) + '\n';
102
            };
103
            app.alert(message);
104
            """.trimIndent()
105
        )
106
    }
107

108
    /** Opens default mail client with document as attachment via JavaScript. */
109
    private fun executeMailDocumentAction() {
110
        executeJavaScript(
111
            """
112
            doc.mailDoc(true,
113
                "john@nutrient.io",
114
                "cc@nutrient.io",
115
                "bcc@nutrient.io",
116
                "subject",
117
                "This is a message");
118
            """.trimIndent()
119
        )
120
    }
121

122
    /**
123
     * Shows how to execute JavaScript scripts on the [com.pspdfkit.ui.PdfFragment] without attaching
124
     * them to annotations.
125
     */
126
    private fun executeJavaScript(script: String) {
127
        val javaScriptAction = JavaScriptAction(script)
128
        pdfFragment?.executeAction(javaScriptAction)
129
    }
130

131
    private companion object {
132
        private const val SHOW_ALERT = 1
133
        private const val GO_TO_NEXT_PAGE = 2
134
        private const val SHOW_FORM_FIELDS = 3
135
        private const val MAIL_TO = 4
136
    }
137
}