Customize ActionBar of PDF document in Kotlin for Android

1
/*
2
 *   Copyright © 2018-2025 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.net.Uri
12
import android.os.Bundle
13
import android.view.Menu
14
import android.view.MenuItem
15
import android.widget.Toast
16
import androidx.core.content.ContextCompat
17
import androidx.core.graphics.drawable.DrawableCompat
18
import androidx.core.view.get
19
import androidx.core.view.size
20
import com.pspdfkit.catalog.R
21
import com.pspdfkit.catalog.SdkExample
22
import com.pspdfkit.catalog.tasks.ExtractAssetTask
23
import com.pspdfkit.configuration.activity.PdfActivityConfiguration
24
import com.pspdfkit.ui.PdfActivity
25
import com.pspdfkit.ui.PdfActivityIntentBuilder
26

27
/**
28
 * This example shows how to use the Kotlin language to configure a custom [com.pspdfkit.ui.PdfActivity]. Kotlin is a JVM-compatible programming language and
29
 * the second by Google supported programming language for developing Android apps (see introduction: https://developer.android.com/kotlin/index.html).
30
 */
31
class CustomActionsExample(context: Context) :
32
    SdkExample(context.getString(R.string.customActionsExampleTitle), context.getString(R.string.customActionsExampleDescription)) {
33

34
    override fun launchExample(context: Context, configuration: PdfActivityConfiguration.Builder) {
35
        // We use a custom utility class to extract the example document from the assets.
36
        ExtractAssetTask.extract(SdkExample.WELCOME_DOC, title, context) { documentFile ->
37
            val intent = PdfActivityIntentBuilder.fromUri(context, Uri.fromFile(documentFile))
38
                .configuration(configuration.build())
39
                .activityClass(CustomActionsActivity::class)
40
                .build()
41

42
            // You can add your own intent extras to the activity too.
43
            intent.putExtra(CustomActionsActivity.STRING_SAMPLE_ARG, "This toast message is passed via intent extras.")
44

45
            // Start the CustomActionsActivity for the extracted document.
46
            context.startActivity(intent)
47
        }
48
    }
49
}
50

51
/**
52
 * This subclass of [PdfActivity] adds a set of custom actions.
53
 */
54
class CustomActionsActivity : PdfActivity() {
55

56
    override fun onCreate(savedInstanceState: Bundle?) {
57
        super.onCreate(savedInstanceState)
58

59
        // Access any previously added intent extras as with normal activities.
60
        val receivedString = intent.getStringExtra(STRING_SAMPLE_ARG)
61
        Toast.makeText(this, receivedString, Toast.LENGTH_SHORT).show()
62
    }
63

64
    /**
65
     * Override this method to get the list od menu item ids as they're gonna be ordered by default
66
     * so you can add your own menu item ids that you can later edit in [.onCreateOptionsMenu]
67
     * or [.onPrepareOptionsMenu].
68
     */
69
    override fun onGenerateMenuItemIds(menuItems: MutableList<Int>): List<Int> {
70
        // For example let's say we want to add custom menu items after the outline button.
71
        // First, we get an index of outline button (all default button ids can be retrieved
72
        // via MENU_OPTION_* variables defined in the PdfActivity.
73
        val indexOfOutlineButton = menuItems.indexOf(PdfActivity.MENU_OPTION_OUTLINE)
74

75
        // Generate our custom item ids.
76
        val customItems = ArrayList<Int>()
77
        customItems.add(R.id.custom_action1)
78
        customItems.add(R.id.custom_action2)
79
        customItems.add(R.id.custom_action3)
80

81
        // Add items after the outline button.
82
        menuItems.addAll(indexOfOutlineButton + 1, customItems)
83

84
        // Return new menu items order.
85
        return menuItems
86
    }
87

88
    override fun onCreateOptionsMenu(menu: Menu): Boolean {
89
        // This will populate menu with items ordered as specified in onGenerateMenuItemIds().
90
        super.onCreateOptionsMenu(menu)
91

92
        // Edit first button.
93
        val menuItem1 = menu.findItem(R.id.custom_action1)
94
        menuItem1.title = "Menu Item 1"
95
        menuItem1.setIcon(R.drawable.ic_arrow_left)
96

97
        // Edit second button.
98
        val menuItem2 = menu.findItem(R.id.custom_action2)
99
        menuItem2.title = "Menu Item 2"
100
        menuItem2.setIcon(R.drawable.ic_arrow_right)
101

102
        // Edit third button.
103
        val menuItem3 = menu.findItem(R.id.custom_action3)
104
        menuItem3.title = "Menu Item 3"
105
        menuItem3.setIcon(R.drawable.ic_collaborate)
106

107
        // Let's say we want to tint icons same as the default ones). We can read the color
108
        // from the theme, or specify the same color we have in theme. Reading from theme is a bit
109
        // more complex but a better way to do it, so here's how to:
110
        val a = theme.obtainStyledAttributes(
111
            null,
112
            com.pspdfkit.R.styleable.pspdf__ActionBarIcons,
113
            com.pspdfkit.R.attr.pspdf__actionBarIconsStyle,
114
            com.pspdfkit.R.style.PSPDFKit_ActionBarIcons
115
        )
116
        val mainToolbarIconsColor = a.getColor(com.pspdfkit.R.styleable.pspdf__ActionBarIcons_pspdf__iconsColor, ContextCompat.getColor(this, com.pspdfkit.R.color.pspdf__onPrimary))
117
        a.recycle()
118

119
        // Tinting all custom menu drawables (you can do it the easier way if you iterate over your ids).
120
        val icon1 = menuItem1.icon
121
        icon1?.let { DrawableCompat.setTint(it, mainToolbarIconsColor) }
122
        menuItem1.icon = icon1
123

124
        val icon2 = menuItem2.icon
125
        icon2?.let { DrawableCompat.setTint(it, mainToolbarIconsColor) }
126
        menuItem2.icon = icon2
127

128
        val icon3 = menuItem3.icon
129
        icon3?.let { DrawableCompat.setTint(it, mainToolbarIconsColor) }
130
        menuItem3.icon = icon3
131

132
        // All our menu items are marked as SHOW_AS_ALWAYS. If you want to just show the first 4
133
        // items for example and send others to the overflow, you can simply do:
134
        for (i in 0 until menu.size) {
135
            menu[i].setShowAsAction(if (i < 4) MenuItem.SHOW_AS_ACTION_IF_ROOM else MenuItem.SHOW_AS_ACTION_NEVER)
136
        }
137

138
        return true
139
    }
140

141
    override fun onPrepareOptionsMenu(menu: Menu): Boolean {
142
        // Here, you can edit your items when the menu is being invalidated.
143
        // To invalidate menu, call supportInvalidateOptionsMenu();
144
        return super.onPrepareOptionsMenu(menu)
145
    }
146

147
    /**
148
     * Override onOptionsItemSelected(MenuItem) to handle click events for your custom menu items.
149
     */
150
    override fun onOptionsItemSelected(item: MenuItem): Boolean {
151
        val handled = when (item.itemId) {
152
            R.id.custom_action1 -> {
153
                Toast.makeText(this, "Selected Action 1", Toast.LENGTH_SHORT).show()
154
                true
155
            }
156

157
            R.id.custom_action2 -> {
158
                Toast.makeText(this, "Selected Action 2", Toast.LENGTH_SHORT).show()
159
                true
160
            }
161

162
            R.id.custom_action3 -> {
163
                Toast.makeText(this, "Selected Action 3", Toast.LENGTH_SHORT).show()
164
                true
165
            }
166

167
            else -> {
168
                false
169
            }
170
        }
171

172
        // Return true if you have handled the current event. If your code has not handled the event,
173
        // pass it on to the superclass. This is important or standard Nutrient actions won't work.
174
        return handled || super.onOptionsItemSelected(item)
175
    }
176

177
    companion object {
178
        const val STRING_SAMPLE_ARG = "some_string_extra"
179
    }
180
}