JavaScript Form Filling

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
package com.pspdfkit.catalog.examples.kotlin
8

9
import android.content.Context
10
import android.net.Uri
11
import android.view.Menu
12
import android.view.MenuItem
13
import androidx.annotation.UiThread
14
import com.pspdfkit.annotations.actions.JavaScriptAction
15
import com.pspdfkit.catalog.R
16
import com.pspdfkit.catalog.SdkExample
17
import com.pspdfkit.catalog.tasks.ExtractAssetTask
18
import com.pspdfkit.configuration.activity.PdfActivityConfiguration
19
import com.pspdfkit.document.PdfDocument
20
import com.pspdfkit.ui.PdfActivity
21
import com.pspdfkit.ui.PdfActivityIntentBuilder
22
import java.io.File
23

24
/** Shows how to fill forms via JavaScript.  */
25
class JavaScriptFormFillingExample(context: Context) : SdkExample(context, R.string.formFillingJavaScriptExampleTitle, R.string.formFillingJavaScriptExampleDescription) {
26
    override fun launchExample(
27
        context: Context,
28
        configuration: PdfActivityConfiguration.Builder
29
    ) {
30
        configuration // Turn off saving, so we have the clean original document every time the example is launched.
31
            .autosaveEnabled(false)
32
            .formEditingEnabled(true)
33
            .build()
34

35
        // Extract the document from the assets.
36
        ExtractAssetTask.extract("Form_example.pdf", title, context) { documentFile: File? ->
37
            val intent = PdfActivityIntentBuilder.fromUri(context, Uri.fromFile(documentFile))
38
                .configuration(configuration.build())
39
                .activityClass(JavaScriptFormFillingActivity::class.java)
40
                .build()
41
            context.startActivity(intent)
42
        }
43
    }
44
}
45

46
/** This activity shows how to fill document forms via JavaScript */
47
class JavaScriptFormFillingActivity : PdfActivity() {
48

49
    companion object {
50
        private const val RESET_FORM_MENU_ITEM_ID = 1
51
    }
52

53
    override fun onCreateOptionsMenu(menu: Menu): Boolean {
54
        super.onCreateOptionsMenu(menu)
55
        menu.add(0, RESET_FORM_MENU_ITEM_ID, 0, "Reset form")
56
        return true
57
    }
58

59
    override fun onOptionsItemSelected(item: MenuItem): Boolean = when (item.itemId) {
60
        RESET_FORM_MENU_ITEM_ID -> {
61
            resetForm()
62
            true
63
        }
64
        else -> super.onOptionsItemSelected(item)
65
    }
66

67
    @UiThread
68
    override fun onDocumentLoaded(document: PdfDocument) {
69
        super.onDocumentLoaded(document)
70
        fillForms()
71
    }
72

73
    /** Shows how to fill form fields via JavaScript. */
74
    private fun fillForms() {
75
        executeJavaScript("var f = doc.getField('Sex'); f.checkThisBox(0, true);")
76
        executeJavaScript("var f = doc.getField('Name_Last'); f.value = 'John';")
77
        executeJavaScript("var f = doc.getField('Name_First'); f.value = 'Appleseed';")
78
    }
79

80
    /** Resets all form fields in the document to their default values. */
81
    private fun resetForm() {
82
        executeJavaScript("doc.resetForm()")
83
    }
84

85
    /** Executes a JavaScript script on the [com.pspdfkit.ui.PdfFragment]. */
86
    private fun executeJavaScript(script: String) {
87
        pdfFragment?.executeAction(JavaScriptAction(script))
88
    }
89
}