Custom Activity with Form Editing UI

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

10
import static com.pspdfkit.catalog.tasks.ExtractAssetTask.extract;
11

12
import android.content.Context;
13
import android.content.Intent;
14
import android.net.Uri;
15
import android.os.Bundle;
16
import androidx.annotation.NonNull;
17
import androidx.annotation.Nullable;
18
import androidx.appcompat.app.AppCompatActivity;
19
import com.pspdfkit.catalog.R;
20
import com.pspdfkit.catalog.SdkExample;
21
import com.pspdfkit.configuration.PdfConfiguration;
22
import com.pspdfkit.configuration.activity.PdfActivityConfiguration;
23
import com.pspdfkit.forms.ComboBoxFormElement;
24
import com.pspdfkit.forms.ListBoxFormElement;
25
import com.pspdfkit.ui.PdfFragment;
26
import com.pspdfkit.ui.forms.FormEditingBar;
27
import com.pspdfkit.ui.inspector.PropertyInspectorCoordinatorLayout;
28
import com.pspdfkit.ui.inspector.forms.FormEditingInspectorController;
29
import com.pspdfkit.ui.special_mode.controller.FormEditingController;
30
import com.pspdfkit.ui.special_mode.manager.FormManager;
31

32
/**
33
 * This example shows how to use form editing UI with custom activity that uses {@link PdfFragment}.
34
 */
35
public class FormEditingInFragmentExample extends SdkExample {
36

37
    public FormEditingInFragmentExample(@NonNull Context context) {
38
        super(context, R.string.formEditingInFragmentExampleTitle, R.string.formEditingInFragmentExampleDescription);
39
    }
40

41
    @Override
42
    public void launchExample(
43
            @NonNull final Context context, @NonNull final PdfActivityConfiguration.Builder configuration) {
44
        extract("Form-fields.pdf", getTitle(), context, documentFile -> {
45
            final Intent intent = new Intent(context, FormEditingInFragmentActivity.class);
46
            intent.putExtra(FormEditingInFragmentActivity.EXTRA_URI, Uri.fromFile(documentFile));
47
            intent.putExtra(
48
                    FormEditingInFragmentActivity.EXTRA_CONFIGURATION,
49
                    configuration.build().getConfiguration());
50
            context.startActivity(intent);
51
        });
52
    }
53

54
    /**
55
     * This example shows how to incorporate form editing UI into the custom activity using {@link
56
     * PdfFragment}. This includes 2 UI components:
57
     *
58
     * <ul>
59
     *   <li>Form editing bar - helps with form filling, provides buttons for navigating between form
60
     *       elements when editing forms. Usually displayed above soft-keyboard or at the bottom of the
61
     *       screen.
62
     *   <li>Form editing inspector - bottom sheet showing options of choice form elements ({@link
63
     *       ComboBoxFormElement} and {@link ListBoxFormElement})
64
     * </ul>
65
     */
66
    public static class FormEditingInFragmentActivity extends AppCompatActivity
67
            implements FormManager.OnFormElementEditingModeChangeListener {
68

69
        public static final String EXTRA_URI = "FormEditingInFragmentActivity.DocumentUri";
70
        public static final String EXTRA_CONFIGURATION = "FormEditingInFragmentActivity.PdfConfiguration";
71

72
        /** Fragment that displays the PDF document. */
73
        private PdfFragment fragment;
74

75
        /**
76
         * Coordinator for property inspectors displayed in bottom sheet. Needs to be part of the
77
         * activity layout.
78
         */
79
        private PropertyInspectorCoordinatorLayout inspectorCoordinatorLayout;
80

81
        /**
82
         * Controller managing lifecycle of form editing inspector while form editing mode is active.
83
         */
84
        private FormEditingInspectorController formEditingInspectorController;
85

86
        /**
87
         * Auxiliary view that provides buttons for navigating between form fields in tab order,
88
         * clearing form field and finishing form editing.
89
         */
90
        private FormEditingBar formEditingBar;
91

92
        @Override
93
        protected void onCreate(@Nullable Bundle savedInstanceState) {
94
            super.onCreate(savedInstanceState);
95
            setContentView(R.layout.activity_form_editing_fragment);
96
            setSupportActionBar(null);
97

98
            // Use this if you want to use form inspector when editing form fields.
99
            inspectorCoordinatorLayout = findViewById(R.id.inspectorCoordinatorLayout);
100
            formEditingInspectorController = new FormEditingInspectorController(this, inspectorCoordinatorLayout);
101

102
            // Use this if you want to use form editing bar at the bottom of the screen.
103
            formEditingBar = findViewById(R.id.formEditingBar);
104

105
            // The actual document Uri is provided with the launching intent.
106
            // This is a check that the example is not accidentally launched without a document Uri.
107
            final Uri uri = getIntent().getParcelableExtra(EXTRA_URI);
108
            if (uri == null) {
109
                finish();
110
                return;
111
            }
112

113
            // PdfFragment configuration is provided with the launching intent.
114
            PdfConfiguration configuration = getIntent().getParcelableExtra(EXTRA_CONFIGURATION);
115
            if (configuration == null) {
116
                configuration = new PdfConfiguration.Builder().build();
117
            }
118

119
            // Initialize PdfFragment now
120
            initPdfFragment(uri, configuration);
121
        }
122

123
        private void initPdfFragment(@NonNull Uri uri, @NonNull PdfConfiguration configuration) {
124
            // Initialize PdfFragment.
125
            fragment = (PdfFragment) getSupportFragmentManager().findFragmentById(R.id.fragmentContainer);
126
            if (fragment == null) {
127
                fragment = PdfFragment.newInstance(uri, configuration);
128
                getSupportFragmentManager()
129
                        .beginTransaction()
130
                        .add(R.id.fragmentContainer, fragment)
131
                        .commit();
132
            }
133

134
            // Register listener for form element editing mode changes. We'll use this to bind our form
135
            // editing UI to form editing controller.
136
            fragment.addOnFormElementEditingModeChangeListener(this);
137
        }
138

139
        @Override
140
        protected void onDestroy() {
141
            super.onDestroy();
142
            fragment.removeOnFormElementEditingModeChangeListener(this);
143
        }
144

145
        @Override
146
        public void onEnterFormElementEditingMode(@NonNull FormEditingController controller) {
147
            // When entering the form editing mode we need to bind required UI components to provided
148
            // form editing controller.
149
            // These will animate form inspector and form editing bar into view if necessary.
150
            formEditingInspectorController.bindFormEditingController(controller);
151
            formEditingBar.bindController(controller);
152
        }
153

154
        @Override
155
        public void onChangeFormElementEditingMode(@NonNull FormEditingController controller) {
156
            // Nothing to be done here, bound form editing bar and form editing inspector controller
157
            // will pick up the changes.
158
        }
159

160
        @Override
161
        public void onExitFormElementEditingMode(@NonNull FormEditingController controller) {
162
            // Once we're done with form editing, unbind the editing controller
163
            // from the UI, this will animate form editing bar and inspector from view.
164
            formEditingInspectorController.unbindFormEditingController();
165
            formEditingBar.unbindController();
166
        }
167
    }
168
}