Popup Toolbar Customization

1
/*
2
 *   Copyright © 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.content.Context
11
import android.graphics.PointF
12
import android.graphics.RectF
13
import android.net.Uri
14
import android.os.Bundle
15
import android.widget.Toast
16
import com.pspdfkit.annotations.NoteAnnotation
17
import com.pspdfkit.catalog.R
18
import com.pspdfkit.catalog.SdkExample
19
import com.pspdfkit.catalog.tasks.ExtractAssetTask
20
import com.pspdfkit.configuration.activity.PdfActivityConfiguration
21
import com.pspdfkit.listeners.OnPreparePopupToolbarListener
22
import com.pspdfkit.ui.PdfActivity
23
import com.pspdfkit.ui.PdfActivityIntentBuilder
24
import com.pspdfkit.ui.PopupToolbar
25
import com.pspdfkit.ui.toolbar.popup.AnnotationPopupToolbar
26
import com.pspdfkit.ui.toolbar.popup.PopupToolbarMenuItem
27
import com.pspdfkit.ui.toolbar.popup.TextSelectionPopupToolbar
28

29
/**
30
 * Example showing how to customise all popup toolbar types using [OnPreparePopupToolbarListener].
31
 */
32
class PopupToolbarCustomisationExample(context: Context) :
33
    SdkExample(
34
        context,
35
        R.string.popupToolbarCustomisationTitle,
36
        R.string.popupToolbarCustomisationDescription,
37
    ) {
38
    override fun launchExample(context: Context, configuration: PdfActivityConfiguration.Builder) {
39
        ExtractAssetTask.extract(WELCOME_DOC, title, context) { documentFile ->
40
            val intent =
41
                PdfActivityIntentBuilder
42
                    .fromUri(context, Uri.fromFile(documentFile))
43
                    .configuration(configuration.build())
44
                    .activityClass(PopupToolbarCustomisationActivity::class)
45
                    .build()
46
            context.startActivity(intent)
47
        }
48
    }
49
}
50

51
class PopupToolbarCustomisationActivity :
52
    PdfActivity(),
53
    OnPreparePopupToolbarListener {
54

55
    override fun onCreate(savedInstanceState: Bundle?) {
56
        super.onCreate(savedInstanceState)
57
        pdfFragment?.setOnPreparePopupToolbarListener(this)
58
    }
59

60
    /**
61
     * Customise the text selection popup toolbar.
62
     * Here we remove most items and keep only Copy, Highlight, and a custom "Word Count" action.
63
     * The custom item uses text only (no icon) to demonstrate text-based menu items.
64
     */
65
    override fun onPrepareTextSelectionPopupToolbar(toolbar: TextSelectionPopupToolbar) {
66
        val keepIds = setOf(
67
            com.pspdfkit.R.id.pspdf__text_selection_toolbar_item_copy,
68
            com.pspdfkit.R.id.pspdf__text_selection_toolbar_item_highlight,
69
        )
70
        val filtered = toolbar.menuItems.filter { it.id in keepIds }
71

72
        // Add a custom text-only item (no icon). Using the two-arg constructor omits the icon,
73
        // so the toolbar displays the item's title as text instead.
74
        val wordCountItem = PopupToolbarMenuItem(R.id.popup_custom_word_count, R.string.popupToolbarWordCount)
75

76
        toolbar.menuItems = filtered + wordCountItem
77

78
        toolbar.setOnPopupToolbarItemClickedListener { item ->
79
            if (item.id == R.id.popup_custom_word_count) {
80
                val selectedText = pdfFragment?.textSelection?.text ?: ""
81
                val count = selectedText.split("\\s+".toRegex()).filter { it.isNotEmpty() }.size
82
                Toast.makeText(this, "Word count: $count", Toast.LENGTH_SHORT).show()
83
                true
84
            } else {
85
                // Return false to let the SDK handle default actions (copy, highlight).
86
                false
87
            }
88
        }
89
    }
90

91
    /**
92
     * Customise the annotation selection popup toolbar.
93
     * Here we add a custom "Info" button that shows annotation details.
94
     */
95
    override fun onPrepareAnnotationPopupToolbar(toolbar: AnnotationPopupToolbar) {
96
        // Add a custom item with an icon.
97
        val infoItem = PopupToolbarMenuItem(
98
            R.id.popup_custom_annotation_info,
99
            R.string.popupToolbarAnnotationInfo,
100
            com.pspdfkit.R.drawable.pspdf__ic_info,
101
            true,
102
        )
103

104
        toolbar.menuItems += infoItem
105

106
        toolbar.setOnPopupToolbarItemClickedListener { item ->
107
            if (item.id == R.id.popup_custom_annotation_info) {
108
                val annotations = toolbar.annotations
109
                val message = annotations.joinToString("\n") { annotation ->
110
                    "${annotation.type.name} by ${annotation.creator ?: "unknown"}"
111
                }
112
                Toast.makeText(this, message, Toast.LENGTH_LONG).show()
113
                true
114
            } else {
115
                false
116
            }
117
        }
118
    }
119

120
    /**
121
     * Customise the long-press popup toolbar.
122
     * This toolbar appears when long-pressing an empty area. By default it shows icon-only items
123
     * (Paste, Annotate, Content Editing). Here we add a custom "Add Note" action
124
     * with both icon and text visible using [PopupToolbarMenuItem.isShowIconAndText].
125
     */
126
    override fun onPrepareLongPressPopupToolbar(toolbar: PopupToolbar, pageIndex: Int, pdfPoint: PointF) {
127
        val addNoteItem = PopupToolbarMenuItem(
128
            R.id.popup_custom_add_note,
129
            R.string.popupToolbarAddNote,
130
            com.pspdfkit.R.drawable.pspdf__ic_note,
131
            isShowIconAndText = true,
132
        )
133
        toolbar.menuItems += addNoteItem
134

135
        toolbar.setOnPopupToolbarItemClickedListener { item ->
136
            if (item.id == R.id.popup_custom_add_note) {
137
                // Create a note annotation directly at the long-press location.
138
                val noteSize = 24f
139
                val noteRect = RectF(
140
                    pdfPoint.x,
141
                    pdfPoint.y - noteSize,
142
                    pdfPoint.x + noteSize,
143
                    pdfPoint.y,
144
                )
145
                val note = NoteAnnotation(pageIndex, noteRect, "New note", NoteAnnotation.COMMENT)
146
                pdfFragment?.addAnnotationToPage(note, false)
147
                toolbar.dismiss()
148
                true
149
            } else {
150
                false
151
            }
152
        }
153
    }
154

155
    /**
156
     * Customise the content editing popup toolbar.
157
     * This toolbar appears when long-pressing in content editing mode. Here we remove the
158
     * "Clear" action from text block toolbars, and add a custom "Select All" text-only action.
159
     */
160
    override fun onPrepareContentEditingPopupToolbar(toolbar: PopupToolbar, pageIndex: Int, pdfPoint: PointF) {
161
        val removeIds = setOf(
162
            com.pspdfkit.R.id.pspdf__content_editing_popuptoolbar_clear,
163
        )
164
        val filtered = toolbar.menuItems.filter { it.id !in removeIds }
165

166
        val selectAllItem = PopupToolbarMenuItem(
167
            R.id.popup_custom_select_all,
168
            R.string.popupToolbarSelectAll,
169
        )
170

171
        toolbar.menuItems = filtered + selectAllItem
172

173
        toolbar.setOnPopupToolbarItemClickedListener { item ->
174
            if (item.id == R.id.popup_custom_select_all) {
175
                Toast.makeText(this, "Select All tapped!", Toast.LENGTH_SHORT).show()
176
                true
177
            } else {
178
                false
179
            }
180
        }
181
    }
182
}