Custom Annotation Toolbar Grouping

1
/*
2
 *   Copyright © 2016-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.graphics.Color;
15
import android.net.Uri;
16
import android.os.Bundle;
17
import android.view.View;
18
import android.widget.Toast;
19
import androidx.annotation.NonNull;
20
import androidx.core.content.ContextCompat;
21
import com.pspdfkit.catalog.R;
22
import com.pspdfkit.catalog.SdkExample;
23
import com.pspdfkit.catalog.ui.CustomAnnotationCreationToolbarGroupingRule;
24
import com.pspdfkit.configuration.activity.PdfActivityConfiguration;
25
import com.pspdfkit.ui.PdfActivity;
26
import com.pspdfkit.ui.PdfActivityIntentBuilder;
27
import com.pspdfkit.ui.toolbar.AnnotationCreationToolbar;
28
import com.pspdfkit.ui.toolbar.AnnotationEditingToolbar;
29
import com.pspdfkit.ui.toolbar.ContextualToolbar;
30
import com.pspdfkit.ui.toolbar.ContextualToolbarMenuItem;
31
import com.pspdfkit.ui.toolbar.DocumentEditingToolbar;
32
import com.pspdfkit.ui.toolbar.ToolbarCoordinatorLayout;
33
import java.util.List;
34

35
/**
36
 * Example of how to alter contextual toolbar menu items structure. Displayed on
37
 * AnnotationCreationToolbar.
38
 */
39
public class CustomToolbarIconGroupingExample extends SdkExample {
40

41
    public CustomToolbarIconGroupingExample(@NonNull Context context) {
42
        super(
43
                context,
44
                R.string.customToolbarItemGroupingExampleTitle,
45
                R.string.customToolbarItemGroupingExampleDescription);
46
    }
47

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

59
            // Start the DarkThemeActivity for the extracted document.
60
            context.startActivity(intent);
61
        });
62
    }
63

64
    /**
65
     * This examples shows how to add items to the toolbar and apply a custom grouping rule. See {@link
66
     * CustomAnnotationCreationToolbarGroupingRule} for the applied grouping.
67
     */
68
    public static class CustomToolbarIconGroupingActivity extends PdfActivity
69
            implements ToolbarCoordinatorLayout.OnContextualToolbarLifecycleListener {
70

71
        @Override
72
        protected void onCreate(Bundle savedInstanceState) {
73
            super.onCreate(savedInstanceState);
74
            setOnContextualToolbarLifecycleListener(this);
75
        }
76

77
        @Override
78
        public void onPrepareContextualToolbar(@NonNull ContextualToolbar toolbar) {
79
            if (toolbar instanceof AnnotationCreationToolbar annotationCreationToolbar) {
80
                annotationCreationToolbar.setDraggable(false);
81
                annotationCreationToolbar.setUseBackButtonForCloseWhenHorizontal(true);
82
                annotationCreationToolbar.setMenuItemGroupingRule(
83
                        new CustomAnnotationCreationToolbarGroupingRule(this));
84

85
                // Get the existing menu items so we can add our item later.
86
                final List<ContextualToolbarMenuItem> menuItems = annotationCreationToolbar.getMenuItems();
87

88
                // Create our custom menu item.
89
                final ContextualToolbarMenuItem customItem = ContextualToolbarMenuItem.createSingleItem(
90
                        this,
91
                        R.id.pspdf_menu_custom,
92
                        ContextCompat.getDrawable(this, R.drawable.ic_bookmark),
93
                        "Bookmark",
94
                        Color.WHITE,
95
                        Color.WHITE,
96
                        ContextualToolbarMenuItem.Position.START,
97
                        false);
98

99
                // Tell the toolbar about our new item.
100
                menuItems.add(customItem);
101
                annotationCreationToolbar.setMenuItems(menuItems);
102

103
                // Add a listener so we can handle clicking on our item.
104
                annotationCreationToolbar.setOnMenuItemClickListener((toolbar1, menuItem) -> {
105
                    if (menuItem.getId() == R.id.pspdf_menu_custom) {
106
                        Toast.makeText(
107
                                        CustomToolbarIconGroupingActivity.this,
108
                                        "Custom Action clicked",
109
                                        Toast.LENGTH_SHORT)
110
                                .show();
111

112
                        // You can even hide menu items. This shows how to toggle image menu
113
                        // item by clicking on the custom button.
114
                        ContextualToolbarMenuItem imageItem =
115
                                toolbar1.findItemById(com.pspdfkit.R.id.pspdf__annotation_creation_toolbar_item_image);
116
                        if (imageItem != null) {
117
                            toolbar1.setMenuItemVisibility(
118
                                    com.pspdfkit.R.id.pspdf__annotation_creation_toolbar_item_image,
119
                                    imageItem.getVisibility() == View.GONE ? View.VISIBLE : View.GONE);
120
                        }
121
                        return true;
122
                    }
123
                    return false;
124
                });
125

126
                // Demonstrating how you can disable the stylus button with this API.
127
                annotationCreationToolbar.setShouldShowStylusButton(false);
128
            } else if (toolbar instanceof AnnotationEditingToolbar) {
129
                // This shows how to hide annotation note button for all annotations.
130
                toolbar.setMenuItemVisibility(
131
                        com.pspdfkit.R.id.pspdf__annotation_creation_toolbar_item_note, View.GONE);
132
            } else if (toolbar instanceof DocumentEditingToolbar) {
133
                // This shows how to hide close button in document editor.
134
                toolbar.getCloseButton().setVisibility(View.GONE);
135
            }
136
        }
137

138
        @Override
139
        public void onDisplayContextualToolbar(@NonNull ContextualToolbar toolbar) {}
140

141
        @Override
142
        public void onRemoveContextualToolbar(@NonNull ContextualToolbar toolbar) {}
143
    }
144
}