Forms JavaScript

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.content.res.AssetManager
13
import android.graphics.Bitmap
14
import android.graphics.BitmapFactory
15
import android.graphics.RectF
16
import android.net.Uri
17
import android.util.Log
18
import androidx.annotation.UiThread
19
import com.pspdfkit.annotations.actions.AnnotationTriggerEvent
20
import com.pspdfkit.annotations.actions.JavaScriptAction
21
import com.pspdfkit.catalog.R
22
import com.pspdfkit.catalog.SdkExample
23
import com.pspdfkit.configuration.activity.PdfActivityConfiguration
24
import com.pspdfkit.document.PdfDocument
25
import com.pspdfkit.document.processor.NewPage
26
import com.pspdfkit.document.processor.PdfProcessor
27
import com.pspdfkit.document.processor.PdfProcessorTask
28
import com.pspdfkit.forms.CheckBoxFormConfiguration
29
import com.pspdfkit.forms.PushButtonFormConfiguration
30
import com.pspdfkit.forms.TextFormConfiguration
31
import com.pspdfkit.ui.PdfActivity
32
import com.pspdfkit.ui.PdfActivityIntentBuilder
33
import io.reactivex.rxjava3.android.schedulers.AndroidSchedulers
34
import io.reactivex.rxjava3.schedulers.Schedulers
35
import java.io.File
36
import java.io.IOException
37
import kotlin.collections.component1
38
import kotlin.collections.component2
39
import kotlin.collections.forEach
40

41
/** This example showcases forms JavaScript functionality. */
42
class FormsJavaScriptExample(context: Context) : SdkExample(context, R.string.javaScriptFormsExampleTitle, R.string.javaScriptFormsExampleDescription) {
43

44
    @SuppressLint("SetJavaScriptEnabled", "CheckResult")
45
    override fun launchExample(
46
        context: Context,
47
        configuration: PdfActivityConfiguration.Builder
48
    ) {
49
        configuration
50
            // JavaScript is enabled by default. It can be disabled in configuration.
51
            .setJavaScriptEnabled(true)
52
            // Turn off saving, so we have the clean original document every time the example is launched.
53
            .autosaveEnabled(false)
54

55
        // Create an empty document from scratch with multiple pages.
56
        val blankPage = NewPage.emptyPage(NewPage.PAGE_SIZE_A4).build()
57
        val task = PdfProcessorTask.empty()
58

59
        // Create multiple blank pages - we'll create example form fields on these pages.
60
        repeat(4) { index ->
61
            task.addNewPage(blankPage, index)
62
        }
63

64
        val outputFile = try {
65
            File(getCatalogCacheDirectory(context), "FormsJavaScriptExample.pdf").canonicalFile
66
        } catch (exception: IOException) {
67
            throw IllegalStateException("Couldn't create FormsJavaScriptExample.pdf file.", exception)
68
        }
69

70
        PdfProcessor.processDocumentAsync(task, outputFile)
71
            .ignoreElements()
72
            .subscribeOn(Schedulers.io())
73
            .observeOn(AndroidSchedulers.mainThread())
74
            .subscribe(
75
                {
76
                    val intent = PdfActivityIntentBuilder.fromUri(context, Uri.fromFile(outputFile))
77
                        .configuration(configuration.build())
78
                        .activityClass(FormsJavaScriptActivity::class.java)
79
                        .build()
80

81
                    context.startActivity(intent)
82
                },
83
                { throwable ->
84
                    Log.e(TAG, "Error while trying to create PDF document.", throwable)
85
                }
86
            )
87
    }
88

89
    companion object {
90
        private const val PSPDFKIT_DIRECTORY_NAME = "catalog-pspdfkit"
91

92
        @Throws(IOException::class)
93
        private fun getCatalogCacheDirectory(ctx: Context): File {
94
            val dir = File(ctx.cacheDir, PSPDFKIT_DIRECTORY_NAME)
95
            if (!dir.exists() && !dir.mkdirs()) {
96
                throw IOException("Failed to create Catalog cache directory.")
97
            }
98
            return dir
99
        }
100
    }
101
}
102

103
/**
104
 * This activity shows how to create custom forms with JavaScript actions attached.
105
 *
106
 * Note: For more information about JavaScript API refer to our guides or Adobe's
107
 * JavaScript for Acrobat API Reference.
108
 */
109
class FormsJavaScriptActivity : PdfActivity() {
110

111
    @SuppressLint("CheckResult")
112
    @UiThread
113
    override fun onDocumentLoaded(document: PdfDocument) {
114
        super.onDocumentLoaded(document)
115

116
        document.formProvider.formElementsAsync.subscribe { formElements, _ ->
117
            if (!formElements.isNullOrEmpty()) return@subscribe
118
            createSimpleCalculationExample()
119
            createManualCalculationExample()
120
            createFormattingExample()
121
            createPushButtonWithImageImportAction()
122
            createCheckboxWithHideAction()
123
        }
124
    }
125

126
    private fun addTextField(
127
        name: String,
128
        pageIndex: Int,
129
        rect: RectF,
130
        text: String,
131
        actions: Map<AnnotationTriggerEvent, String> = emptyMap(),
132
        readOnly: Boolean = false
133
    ) {
134
        document?.formProvider?.addFormElementToPage(
135
            name,
136
            TextFormConfiguration.Builder(pageIndex, rect)
137
                .apply {
138
                    setText(text)
139
                    actions.forEach { (event, script) ->
140
                        setAdditionalAction(event, JavaScriptAction(script))
141
                    }
142
                    if (readOnly) setReadOnly(true)
143
                }
144
                .build()
145
        )
146
    }
147

148
    private fun createSimpleCalculationExample() {
149
        addTextField(
150
            "sum-operand1",
151
            0,
152
            RectF(30f, 750f, 200f, 720f),
153
            "3.0",
154
            mapOf(
155
                AnnotationTriggerEvent.FORM_CHANGED to "AFNumber_Keystroke(2,0,0,0,'',true);",
156
                AnnotationTriggerEvent.FIELD_FORMAT to "AFNumber_Format(2,0,0,0,'',true);"
157
            )
158
        )
159

160
        addTextField(
161
            "sum-operand2",
162
            0,
163
            RectF(30f, 690f, 200f, 660f),
164
            "4",
165
            mapOf(
166
                AnnotationTriggerEvent.FORM_CHANGED to "AFNumber_Keystroke(0,1,0,0,'',true);",
167
                AnnotationTriggerEvent.FIELD_FORMAT to "AFNumber_Format(0,1,0,0,'',true);"
168
            )
169
        )
170

171
        addTextField(
172
            "sum-result",
173
            0,
174
            RectF(30f, 630f, 200f, 600f),
175
            "",
176
            mapOf(
177
                AnnotationTriggerEvent.FORM_CALCULATE to
178
                    "AFSimple_Calculate('SUM', new Array('sum-operand1','sum-operand2'));",
179
                AnnotationTriggerEvent.FIELD_FORMAT to "AFNumber_Format(2,1,0,0,'',true);"
180
            ),
181
            readOnly = true
182
        )
183
    }
184

185
    private fun createManualCalculationExample() {
186
        addTextField("concat-operand1", 1, RectF(30f, 750f, 200f, 720f), "First")
187
        addTextField("concat-operand2", 1, RectF(30f, 690f, 200f, 660f), "Second")
188
        addTextField(
189
            "concat-result",
190
            1,
191
            RectF(30f, 630f, 200f, 600f),
192
            "",
193
            mapOf(
194
                AnnotationTriggerEvent.FORM_CALCULATE to """
195
                    var operand1 = doc.getField('concat-operand1');
196
                    var operand2 = doc.getField('concat-operand2');
197
                    var result = doc.getField('concat-result');
198
                    result.value = operand1.value + ' ' + operand2.value;
199
                """.trimIndent()
200
            ),
201
            readOnly = true
202
        )
203
    }
204

205
    private fun createFormattingExample() {
206
        addTextField(
207
            "Number format",
208
            2,
209
            RectF(30f, 750f, 200f, 720f),
210
            "3.2293",
211
            mapOf(
212
                AnnotationTriggerEvent.FORM_CHANGED to "AFNumber_Keystroke(2,0,0,0,'',true);",
213
                AnnotationTriggerEvent.FIELD_FORMAT to "AFNumber_Format(2,0,0,0,'',true);"
214
            )
215
        )
216

217
        addTextField(
218
            "Currency format",
219
            2,
220
            RectF(30f, 690f, 200f, 660f),
221
            "33,99",
222
            mapOf(
223
                AnnotationTriggerEvent.FORM_CHANGED to "AFNumber_Keystroke(2,3,0,0,'€',true);",
224
                AnnotationTriggerEvent.FIELD_FORMAT to "AFNumber_Format(2,3,0,0,'€',true);"
225
            )
226
        )
227

228
        addTextField(
229
            "Date format",
230
            2,
231
            RectF(30f, 630f, 200f, 600f),
232
            "02/07/2018",
233
            mapOf(
234
                AnnotationTriggerEvent.FORM_CHANGED to "AFDate_KeystrokeEx('mm/dd/yyyy');",
235
                AnnotationTriggerEvent.FIELD_FORMAT to "AFDate_FormatEx('mm/dd/yyyy');"
236
            )
237
        )
238

239
        addTextField(
240
            "Time format",
241
            2,
242
            RectF(30f, 570f, 200f, 540f),
243
            "12:00:20",
244
            mapOf(
245
                AnnotationTriggerEvent.FORM_CHANGED to "AFTime_Keystroke('HH:MM::ss');",
246
                AnnotationTriggerEvent.FIELD_FORMAT to "AFTime_Format('HH:MM::ss');"
247
            )
248
        )
249
    }
250

251
    private fun createPushButtonWithImageImportAction() {
252
        document?.formProvider?.addFormElementToPage(
253
            "pushbuttonfield",
254
            PushButtonFormConfiguration.Builder(
255
                3,
256
                RectF(30f, 750f, 120f, 660f),
257
                getBitmapFromAsset(assets, "images/android.png")
258
            )
259
                .setAction(JavaScriptAction("var f=this.getField('pushbuttonfield'); f.buttonImportIcon();"))
260
                .build()
261
        )
262
    }
263

264
    private fun createCheckboxWithHideAction() {
265
        document?.formProvider?.addFormElementToPage(
266
            "checkboxfield",
267
            CheckBoxFormConfiguration.Builder(3, RectF(150f, 690f, 180f, 660f))
268
                .deselect()
269
                .setAdditionalAction(
270
                    AnnotationTriggerEvent.MOUSE_UP,
271
                    JavaScriptAction(
272
                        """
273
                        var pushButtonField = doc.getField('pushbuttonfield');
274
                        pushButtonField.display = (pushButtonField.display == display.hidden) ? display.visible : display.hidden;
275
                        """.trimIndent()
276
                    )
277
                )
278
                .build()
279
        )
280
    }
281

282
    private fun getBitmapFromAsset(assets: AssetManager, path: String): Bitmap =
283
        assets.open(path).use { BitmapFactory.decodeStream(it) }
284
            ?: throw IllegalStateException("Failed to decode bitmap from assets: $path")
285
}