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) :
26
    SdkExample(context, R.string.formTextFieldSuggestionsExampleTitle, R.string.formTextFieldSuggestionsExampleDescription) {
27
    override fun launchExample(context: Context, configuration: PdfActivityConfiguration.Builder) {
28
        // Turn off saving, so we have the clean original document every time the example is launched.
29
        configuration.autosaveEnabled(false)
30

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

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

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

98
                    "Last Name" -> {
99
                        listOf(
100
                            "A. Anderson",
101
                            "Brown",
102
                            "Davis",
103
                            "Doe",
104
                            "Garcia",
105
                            "Johnson",
106
                            "Jones",
107
                            "Lee",
108
                            "Martin",
109
                            "Martinez",
110
                            "Mayer",
111
                            "Miller",
112
                            "Moore",
113
                            "Rodriguez",
114
                            "Smith",
115
                            "Taylor",
116
                            "Thomas",
117
                            "Thompson",
118
                            "White",
119
                            "Williams",
120
                            "Wilson",
121
                        )
122
                    }
123

124
                    else -> {
125
                        emptyList()
126
                    }
127
                }
128
            }
129
        }
130
    }
131
}