Customized ActionBar Actions

1
/*
2
 *   Copyright © 2018-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.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) : SdkExample(context, R.string.customActionsExampleTitle, R.string.customActionsExampleDescription) {
32

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

137
        return true
138
    }
139

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

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

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

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

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

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

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