Add form elements with JavaScript actions attached on Android

1
/*
2
 *   Copyright © 2018-2025 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.java;
9

10
import android.annotation.SuppressLint;
11
import android.content.Context;
12
import android.content.Intent;
13
import android.net.Uri;
14
import android.util.Log;
15
import androidx.annotation.NonNull;
16
import com.pspdfkit.catalog.R;
17
import com.pspdfkit.catalog.SdkExample;
18
import com.pspdfkit.catalog.examples.java.activities.FormsJavaScriptActivity;
19
import com.pspdfkit.configuration.activity.PdfActivityConfiguration;
20
import com.pspdfkit.document.processor.NewPage;
21
import com.pspdfkit.document.processor.PdfProcessor;
22
import com.pspdfkit.document.processor.PdfProcessorTask;
23
import com.pspdfkit.ui.PdfActivityIntentBuilder;
24
import io.reactivex.rxjava3.android.schedulers.AndroidSchedulers;
25
import io.reactivex.rxjava3.schedulers.Schedulers;
26
import java.io.File;
27
import java.io.IOException;
28

29
/** This example showcases forms JavaScript functionality. */
30
public class FormsJavaScriptExample extends SdkExample {
31

32
    private static final String LOG_TAG = "FormsJavaScriptExample";
33
    private static final String PSPDFKIT_DIRECTORY_NAME = "catalog-pspdfkit";
34

35
    public FormsJavaScriptExample(@NonNull Context context) {
36
        super(
37
                context.getString(R.string.javaScriptFormsExampleTitle),
38
                context.getString(R.string.javaScriptFormsExampleDescription));
39
    }
40

41
    @SuppressLint("SetJavaScriptEnabled")
42
    @Override
43
    public void launchExample(
44
            @NonNull final Context context, @NonNull final PdfActivityConfiguration.Builder configuration) {
45
        configuration
46
                // JavaScript is enabled by default. It can be disabled in configuration.
47
                .setJavaScriptEnabled(true)
48
                // Turn off saving, so we have the clean original document every time the example is
49
                // launched.
50
                .autosaveEnabled(false);
51

52
        // Create an empty document from scratch with multiple pages.
53
        NewPage blankPage = NewPage.emptyPage(NewPage.PAGE_SIZE_A4).build();
54
        final PdfProcessorTask task = PdfProcessorTask.empty();
55

56
        // Create multiple blank pages - we'll create example form fields on these pages.
57
        for (int i = 0; i < 4; ++i) {
58
            task.addNewPage(blankPage, i);
59
        }
60

61
        final File outputFile;
62
        try {
63
            outputFile = new File(getCatalogCacheDirectory(context), "FormsJavaScriptExample.pdf").getCanonicalFile();
64
        } catch (IOException exception) {
65
            throw new IllegalStateException("Couldn't create FormsJavaScriptExample.pdf file.", exception);
66
        }
67

68
        PdfProcessor.processDocumentAsync(task, outputFile)
69
                .ignoreElements()
70
                .subscribeOn(Schedulers.io())
71
                .observeOn(AndroidSchedulers.mainThread())
72
                .subscribe(
73
                        () -> {
74
                            final Intent intent = PdfActivityIntentBuilder.fromUri(context, Uri.fromFile(outputFile))
75
                                    .configuration(configuration.build())
76
                                    .activityClass(FormsJavaScriptActivity.class)
77
                                    .build();
78

79
                            context.startActivity(intent);
80
                        },
81
                        throwable -> Log.e(LOG_TAG, "Error while trying to create PDF document.", throwable));
82
    }
83

84
    @NonNull
85
    private static File getCatalogCacheDirectory(@NonNull Context ctx) throws IOException {
86
        File dir = new File(ctx.getCacheDir(), PSPDFKIT_DIRECTORY_NAME);
87
        if (!dir.exists()) {
88
            if (!dir.mkdirs()) {
89
                throw new IOException("Failed to create Catalog cache directory.");
90
            }
91
        }
92
        return dir;
93
    }
94
}