Form text field suggestions

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 androidx.annotation.UiThread
14
import com.pspdfkit.catalog.R
15
import com.pspdfkit.catalog.SdkExample
16
import com.pspdfkit.catalog.tasks.ExtractAssetTask
17
import com.pspdfkit.configuration.activity.PdfActivityConfiguration
18
import com.pspdfkit.document.PdfDocument
19
import com.pspdfkit.ui.PdfActivity
20
import com.pspdfkit.ui.PdfActivityIntentBuilder
21

22
/**
23
 * Showcases how to provide suggestions for text form fields.
24
 */
25
class FormTextFieldSuggestionExample(context: Context) : SdkExample(context, R.string.formTextFieldSuggestionsExampleTitle, R.string.formTextFieldSuggestionsExampleDescription) {
26
    override fun launchExample(context: Context, configuration: PdfActivityConfiguration.Builder) {
27
        // Turn off saving, so we have the clean original document every time the example is launched.
28
        configuration.autosaveEnabled(false)
29

30
        // Enable form editing UI.
31
        configuration.formEditingEnabled(true)
32

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

44
/**
45
 * An activity that demonstrates how to provide suggestions for text form fields.
46
 */
47
class FormTextFieldSuggestionsActivity : PdfActivity() {
48
    @SuppressLint("CheckResult")
49
    @UiThread
50
    override fun onDocumentLoaded(document: PdfDocument) {
51
        super.onDocumentLoaded(document)
52
        pdfFragment?.let {
53
            it.addOnTextFormElementSuggestionRequestListener { formElement ->
54
                // Provide suggestions for first and last name fields.
55
                when (formElement.name) {
56
                    "First Name" -> {
57
                        listOf(
58
                            "Alice", "Andrew", "Anna", "Anthony",
59
                            "Bob", "Barbara", "Brian",
60
                            "Catherine", "Charles",
61
                            "Diana", "David",
62
                            "Emily", "Emma",
63
                            "Frank",
64
                            "George",
65
                            "Helen",
66
                            "Jack", "Jane", "John", "Julia",
67
                            "Katherine",
68
                            "Linda",
69
                            "Mark", "Mary", "Michael",
70
                            "Nancy",
71
                            "Oliver",
72
                            "Patricia",
73
                            "Robert",
74
                            "Sarah",
75
                            "Thomas",
76
                            "Victoria",
77
                            "William",
78
                            "Agent"
79
                        )
80
                    }
81
                    "Last Name" -> {
82
                        listOf(
83
                            "A. Anderson",
84
                            "Brown",
85
                            "Davis",
86
                            "Doe",
87
                            "Garcia",
88
                            "Johnson", "Jones",
89
                            "Lee",
90
                            "Martin", "Martinez",
91
                            "Mayer", "Miller", "Moore",
92
                            "Rodriguez",
93
                            "Smith",
94
                            "Taylor", "Thomas", "Thompson",
95
                            "White", "Williams", "Wilson"
96
                        )
97
                    }
98
                    else -> emptyList()
99
                }
100
            }
101
        }
102
    }
103
}