Custom Document Sharing Dialog

1
/*
2
 *   Copyright © 2017-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.app.Dialog;
13
import android.content.Context;
14
import android.content.Intent;
15
import android.net.Uri;
16
import android.os.Bundle;
17
import android.view.View;
18
import android.widget.CheckBox;
19
import android.widget.EditText;
20
import android.widget.TextView;
21
import androidx.annotation.NonNull;
22
import androidx.appcompat.app.AlertDialog;
23
import com.pspdfkit.catalog.R;
24
import com.pspdfkit.catalog.SdkExample;
25
import com.pspdfkit.configuration.activity.PdfActivityConfiguration;
26
import com.pspdfkit.datastructures.Range;
27
import com.pspdfkit.document.printing.PrintOptions;
28
import com.pspdfkit.document.processor.PdfProcessorTask;
29
import com.pspdfkit.document.sharing.SharingOptions;
30
import com.pspdfkit.ui.PdfActivity;
31
import com.pspdfkit.ui.PdfActivityIntentBuilder;
32
import com.pspdfkit.ui.dialog.BaseDocumentPrintDialog;
33
import com.pspdfkit.ui.dialog.BaseDocumentSharingDialog;
34
import com.pspdfkit.ui.dialog.DocumentSharingDialogConfiguration;
35
import com.pspdfkit.ui.dialog.DocumentSharingDialogFactory;
36
import java.util.Collections;
37

38
/** Shows you how to create a custom document share dialog. */
39
public class CustomShareDialogExample extends SdkExample {
40

41
    public CustomShareDialogExample(Context context) {
42
        super(context, R.string.customShareDialogExampleTitle, R.string.customShareDialogExampleDescription);
43
    }
44

45
    @Override
46
    public void launchExample(
47
            @NonNull final Context context, @NonNull final PdfActivityConfiguration.Builder configuration) {
48
        // We use a custom utility class to extract the example document from the assets.
49
        extract(WELCOME_DOC, getTitle(), context, documentFile -> {
50
            // To start the CustomShareDialogActivity create a launch intent using the
51
            // builder.
52
            final Intent intent = PdfActivityIntentBuilder.fromUri(context, Uri.fromFile(documentFile))
53
                    .configuration(configuration.build())
54
                    .activityClass(CustomShareDialogActivity.class)
55
                    .build();
56

57
            // Start the CustomShareDialogActivity for the extracted document.
58
            context.startActivity(intent);
59
        });
60
    }
61

62
    /**
63
     * This example shows how to create a custom share dialog using {@link
64
     * DocumentSharingDialogFactory}.
65
     */
66
    public static class CustomShareDialogActivity extends PdfActivity {
67

68
        /** A custom share dialog that always only shares the current page. */
69
        public static class CustomSharingDialog extends BaseDocumentSharingDialog {
70

71
            private DialogLayout dialogLayout;
72

73
            public CustomSharingDialog() {}
74

75
            @Override
76
            @NonNull
77
            public Dialog onCreateDialog(Bundle savedInstanceState) {
78
                dialogLayout = new DialogLayout(getConfiguration(), getContext());
79

80
                dialogLayout.positiveButton.setOnClickListener(v -> {
81
                    // Once the user is done making changes be sure to call the listener with
82
                    // your SharingOptions.
83
                    if (getListener() != null) {
84
                        getListener().onAccept(getSharingOptions());
85
                        dismiss();
86
                    }
87
                });
88

89
                return dialogLayout.createDialog();
90
            }
91

92
            private SharingOptions getSharingOptions() {
93
                // If the checkbox is checked we flatten the annotations so they can't be edited in the
94
                // shared document.
95
                PdfProcessorTask.AnnotationProcessingMode annotationProcessingMode =
96
                        PdfProcessorTask.AnnotationProcessingMode.KEEP;
97
                if (dialogLayout.flattenAnnotations.isChecked()) {
98
                    annotationProcessingMode = PdfProcessorTask.AnnotationProcessingMode.FLATTEN;
99
                }
100
                return new SharingOptions(
101
                        annotationProcessingMode,
102
                        // So only the current page is shared.
103
                        Collections.singletonList(new Range(getConfiguration().getCurrentPage(), 1)),
104
                        // The document title the user chose.
105
                        dialogLayout.documentNameEditText.getText().toString());
106
            }
107
        }
108

109
        /** A custom print dialog that always only prints the current page. */
110
        public static class CustomPrintDialog extends BaseDocumentPrintDialog {
111

112
            private DialogLayout dialogLayout;
113

114
            private PrintOptions getPrintOptions() {
115
                // If the checkbox is checked we print the annotations.
116
                return new PrintOptions(
117
                        dialogLayout.flattenAnnotations.isChecked(),
118
                        Collections.singletonList(new Range(getConfiguration().getCurrentPage(), 1)),
119
                        dialogLayout.documentNameEditText.getText().toString());
120
            }
121

122
            @Override
123
            @NonNull
124
            public Dialog onCreateDialog(Bundle savedInstanceState) {
125
                dialogLayout = new DialogLayout(getConfiguration(), getContext());
126

127
                dialogLayout.flattenAnnotations.setText(R.string.print_annotations);
128
                dialogLayout.positiveButton.setOnClickListener(v -> {
129
                    // Once the user is done making changes be sure to call the listener with
130
                    // your SharingOptions.
131
                    if (getListener() != null) {
132
                        getListener().onAccept(getPrintOptions());
133
                        dismiss();
134
                    }
135
                });
136

137
                return dialogLayout.createDialog();
138
            }
139
        }
140

141
        @Override
142
        protected void onCreate(Bundle savedInstanceState) {
143
            super.onCreate(savedInstanceState);
144
            // Tell the activity about our dialog creators.
145
            setDocumentSharingDialogFactory(CustomSharingDialog::new);
146
            setDocumentPrintDialogFactory(CustomPrintDialog::new);
147

148
            // Tell the activity about our option providers.
149
            // By providing options we prevent the share/print dialog from appearing.
150
            setSharingOptionsProvider((document, currentPage) -> {
151
                if (currentPage == 2) {
152
                    return new SharingOptions(PdfProcessorTask.AnnotationProcessingMode.DELETE);
153
                } else {
154
                    // Returning null causes the the sharing dialog to appear.
155
                    return null;
156
                }
157
            });
158
            setPrintOptionsProvider((document, currentPage) -> {
159
                if (currentPage == 2) {
160
                    return new PrintOptions(true);
161
                } else {
162
                    // Returning null causes the the printing dialog to appear.
163
                    return null;
164
                }
165
            });
166
        }
167

168
        /** Wraps the UI so it can be used in both the sharing and printing dialog. */
169
        static class DialogLayout {
170
            DocumentSharingDialogConfiguration configuration;
171
            Context context;
172

173
            View root;
174
            EditText documentNameEditText;
175
            TextView positiveButton;
176
            CheckBox flattenAnnotations;
177

178
            DialogLayout(DocumentSharingDialogConfiguration configuration, Context context) {
179
                this.configuration = configuration;
180
                this.context = context;
181

182
                root = View.inflate(context, R.layout.custom_document_sharing_dialog, null);
183

184
                // EditText to enter the title of the printed document.
185
                documentNameEditText = root.findViewById(R.id.share_dialog_document_name);
186
                documentNameEditText.setText(configuration.getInitialDocumentName());
187
                documentNameEditText.clearFocus();
188

189
                // Changes the annotation processing behaviour.
190
                flattenAnnotations = root.findViewById(R.id.share_dialog_flatten_annotations);
191

192
                positiveButton = root.findViewById(R.id.share_button);
193
                // Use the button text from the passed configuration.
194
                positiveButton.setText(configuration.getPositiveButtonText());
195
            }
196

197
            /** Creates a dialog to be used in the custom sharing and printing dialogs. */
198
            Dialog createDialog() {
199
                return new AlertDialog.Builder(context)
200
                        .setCancelable(true)
201
                        // You also get the dialog title from the configuration.
202
                        .setTitle(configuration.getDialogTitle())
203
                        .setView(root)
204
                        .create();
205
            }
206
        }
207
    }
208
}