Custom Document Sharing Menu

1
/*
2
 *   Copyright © 2014-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.core.app.ShareCompat;
19
import com.google.android.material.bottomsheet.BottomSheetDialog;
20
import com.pspdfkit.catalog.R;
21
import com.pspdfkit.catalog.SdkExample;
22
import com.pspdfkit.configuration.activity.PdfActivityConfiguration;
23
import com.pspdfkit.document.processor.PdfProcessorTask;
24
import com.pspdfkit.document.sharing.DefaultDocumentSharingController;
25
import com.pspdfkit.document.sharing.DocumentSharingIntentHelper;
26
import com.pspdfkit.document.sharing.DocumentSharingManager;
27
import com.pspdfkit.document.sharing.ShareTarget;
28
import com.pspdfkit.document.sharing.SharingOptions;
29
import com.pspdfkit.ui.PdfActivity;
30
import com.pspdfkit.ui.PdfActivityIntentBuilder;
31
import com.pspdfkit.ui.actionmenu.ActionMenu;
32
import com.pspdfkit.ui.actionmenu.ActionMenuItem;
33
import com.pspdfkit.ui.actionmenu.ActionMenuListener;
34
import com.pspdfkit.ui.actionmenu.FixedActionMenuItem;
35
import com.pspdfkit.ui.actionmenu.SharingMenu;
36
import com.pspdfkit.ui.actionmenu.SimpleActionMenuListener;
37
import java.util.Collections;
38

39
public class CustomSharingMenuExample extends SdkExample {
40

41
    public CustomSharingMenuExample(Context context) {
42
        super(context, R.string.documentSharingMenuExampleTitle, R.string.documentSharingMenuExampleDescription);
43
    }
44

45
    @Override
46
    public void launchExample(
47
            @NonNull final Context context, @NonNull final PdfActivityConfiguration.Builder configuration) {
48
        // This example uses a custom activity which shows how to implement custom sharing.
49

50
        // For sake of simplicity, deactivate actions.
51
        configuration
52
                .annotationListEnabled(false)
53
                .searchEnabled(false)
54
                .outlineEnabled(false)
55
                .thumbnailGridEnabled(false);
56

57
        // First extract the document from the assets.
58
        extract(ANNOTATIONS_EXAMPLE, getTitle(), context, documentFile -> {
59
            // To start CustomSharingMenuActivity create a launch intent using this builder.
60
            final Intent intent = PdfActivityIntentBuilder.fromUri(context, Uri.fromFile(documentFile))
61
                    .configuration(configuration.build())
62
                    .activityClass(CustomSharingMenuActivity.class)
63
                    .build();
64

65
            // Start the CustomSharingMenuActivity for the extracted document.
66
            context.startActivity(intent);
67
        });
68
    }
69

70
    /**
71
     * This activity showcases how to add custom sharing action to sharing menu displayed in a {@link
72
     * BottomSheetDialog}.
73
     */
74
    public static class CustomSharingMenuActivity extends PdfActivity implements ActionMenuListener {
75

76
        private static final String STATE_SHOWING_MAIL_TO_SHARING_MENU = "STATE_SHOWING_MAIL_TO_SHARING_MENU";
77

78
        @Nullable
79
        private SharingMenu mailToActionMenu;
80

81
        @Override
82
        public void onCreate(Bundle savedInstanceState) {
83
            super.onCreate(savedInstanceState);
84

85
            // Set listener for sharing menu.
86
            setSharingActionMenuListener(this);
87

88
            // Restore "Mail to" sharing menu if shown before orientation change.
89
            if (savedInstanceState != null) {
90
                if (savedInstanceState.getBoolean(STATE_SHOWING_MAIL_TO_SHARING_MENU, false)) {
91
                    showMailToSharingMenu();
92
                }
93
            }
94
        }
95

96
        @Override
97
        public void onSaveInstanceState(@NonNull Bundle outState) {
98
            super.onSaveInstanceState(outState);
99
            outState.putBoolean(STATE_SHOWING_MAIL_TO_SHARING_MENU, mailToActionMenu != null);
100
        }
101

102
        /** Override onPrepareActionMenu(ActionMenu) to modify sharing menu contents. */
103
        @Override
104
        public boolean onPrepareActionMenu(@NonNull ActionMenu actionMenu) {
105
            // Add fixed menu item to action menu.
106
            actionMenu.addMenuItem(
107
                    new FixedActionMenuItem(this, R.id.item_send_mail, R.drawable.ic_custom_sharing, R.string.mail));
108
            // Make sure to return true, if you want sharing menu to display your actions.
109
            return true;
110
        }
111

112
        @Override
113
        public void onDisplayActionMenu(@NonNull ActionMenu actionMenu) {}
114

115
        @Override
116
        public void onRemoveActionMenu(@NonNull ActionMenu actionMenu) {}
117

118
        @Override
119
        public boolean onActionMenuItemClicked(@NonNull ActionMenu actionMenu, @NonNull ActionMenuItem menuItem) {
120
            if (menuItem.getItemId() == R.id.item_send_mail) {
121
                actionMenu.dismiss();
122
                // Show new sharing menu with "Mail to" action.
123
                showMailToSharingMenu();
124
                return true;
125
            }
126
            return false;
127
        }
128

129
        /** Override to handle click events for your custom sharing menu items. */
130
        @Override
131
        public boolean onActionMenuItemLongClicked(
132
                @NonNull ActionMenu actionMenu, @NonNull ActionMenuItem clickedItem) {
133
            return false;
134
        }
135

136
        private void showMailToSharingMenu() {
137
            mailToActionMenu = new SharingMenu(this, shareTarget -> {
138
                // Start sharing flow.
139
                DocumentSharingManager.shareDocument(
140
                        new MailToDocumentSharingController(CustomSharingMenuActivity.this, shareTarget),
141
                        getDocument(),
142
                        new SharingOptions(PdfProcessorTask.AnnotationProcessingMode.FLATTEN));
143
            });
144
            // Register listener for action menu to get notified when menu is hidden.
145
            mailToActionMenu.addActionMenuListener(new SimpleActionMenuListener() {
146
                @Override
147
                public void onRemoveActionMenu(@NonNull ActionMenu actionMenu) {
148
                    mailToActionMenu = null;
149
                }
150
            });
151
            // Set menu title.
152
            mailToActionMenu.setTitle(R.string.mail_to);
153
            // Make sharing menu show apps that handle mail to action.
154
            mailToActionMenu.setShareIntents(Collections.singletonList(getMailToIntent(Uri.EMPTY)));
155
            // Show dialog.
156
            mailToActionMenu.show();
157
        }
158

159
        @NonNull
160
        private Intent getMailToIntent(@NonNull Uri shareUri) {
161
            Intent mailToIntent = ShareCompat.IntentBuilder.from(CustomSharingMenuActivity.this)
162
                    // Use "application/pdf" as mime type.
163
                    .setType(DocumentSharingIntentHelper.MIME_TYPE_PDF)
164
                    // Add shared document uri as data stream.
165
                    .addStream(shareUri)
166
                    // Optionally specify initial email data - to, cc, subject, body text etc.
167
                    .addEmailTo("mail@to.com")
168
                    .setSubject("Subject")
169
                    .setText("I'm email body.")
170
                    // Build share intent.
171
                    .getIntent();
172

173
            // Target email apps by changing the Intent action to SENDTO and
174
            // by limiting the Intent to apps that can handle mailto:// URIs.
175
            mailToIntent.setAction(Intent.ACTION_SENDTO);
176
            mailToIntent.setData(Uri.parse("mailto:"));
177

178
            return mailToIntent;
179
        }
180

181
        /**
182
         * Example implementation of a custom share controller that shares document to single {@link
183
         * ShareTarget}.
184
         */
185
        private class MailToDocumentSharingController extends DefaultDocumentSharingController {
186

187
            public MailToDocumentSharingController(@NonNull Context context, @NonNull ShareTarget shareTarget) {
188
                super(context, shareTarget);
189
            }
190

191
            @Override
192
            public void onDocumentPrepared(@NonNull Uri shareUri) {
193
                // Guard for null context. This can happen when sharing controller is detached
194
                // from it's owning activity (for example while changing orientation).
195
                if (getContext() == null) return;
196

197
                // Build share intent.
198
                final Intent shareIntent = getMailToIntent(shareUri);
199
                if (getShareTarget() != null) {
200
                    // Set package to share target package.
201
                    shareIntent.setPackage(getShareTarget().getPackageName());
202
                    // Finally start share intent.
203
                    getContext().startActivity(shareIntent);
204
                }
205
            }
206
        }
207
    }
208
}