Runtime Configuration

1
/*
2
 *   Copyright © 2020-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 com.pspdfkit.catalog.R
14
import com.pspdfkit.catalog.SdkExample
15
import com.pspdfkit.catalog.tasks.ExtractAssetTask
16
import com.pspdfkit.compose.toolbar.state.ToolbarItem
17
import com.pspdfkit.compose.toolbar.state.ToolbarItem.ItemEdge
18
import com.pspdfkit.compose.toolbar.state.ToolbarItem.OverflowBehavior
19
import com.pspdfkit.configuration.activity.PdfActivityConfiguration
20
import com.pspdfkit.configuration.page.PageScrollDirection
21
import com.pspdfkit.configuration.page.PageScrollMode
22
import com.pspdfkit.ui.PdfActivity
23
import com.pspdfkit.ui.PdfActivityIntentBuilder
24

25
/**
26
 * This example shows how to change [PdfActivityConfiguration] dynamically when [PdfActivity] is displayed.
27
 */
28
class RuntimeConfigurationExample(context: Context) :
29
    SdkExample(context, R.string.runtimeConfigurationChangeExampleTitle, R.string.runtimeConfigurationChangeExampleDescription) {
30
    override fun launchExample(context: Context, configuration: PdfActivityConfiguration.Builder) {
31
        // We use a custom utility class to extract the example document from the assets.
32
        ExtractAssetTask.extract(WELCOME_DOC, title, context) { documentFile ->
33
            // Launch the custom example activity using the document and configuration.
34
            val intent =
35
                PdfActivityIntentBuilder
36
                    .fromUri(context, Uri.fromFile(documentFile))
37
                    .configuration(configuration.build())
38
                    .activityClass(RuntimeConfigurationActivity::class)
39
                    .build()
40

41
            // Start the DynamicConfigurationActivity for the extracted document.
42
            context.startActivity(intent)
43
        }
44
    }
45
}
46

47
class RuntimeConfigurationActivity : PdfActivity() {
48
    companion object {
49
        private const val TOGGLE_NIGHT_MODE = 90
50
        private const val TOGGLE_SCROLL_MODE = 91
51
        private const val TOGGLE_SCROLL_DIRECTION = 92
52
    }
53

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

57
        // We are adding toolbar items as specific examples of how to change activity configuration from within the UI.
58
        setToolbarItemsProvider { defaultItems ->
59
            defaultItems + ToolbarItem.Button(
60
                id = TOGGLE_NIGHT_MODE,
61
                actionId = "toggle_night_mode",
62
                contentDescription = getString(R.string.runtime_configuration_change_toggle_night_mode),
63
                position = ItemEdge.End,
64
                overflowBehavior = OverflowBehavior.Never,
65
            ) + ToolbarItem.Button(
66
                id = TOGGLE_SCROLL_MODE,
67
                actionId = "toggle_scroll_mode",
68
                contentDescription = getString(R.string.runtime_configuration_change_toggle_scroll_mode),
69
                position = ItemEdge.End,
70
                overflowBehavior = OverflowBehavior.Never,
71
            ) + ToolbarItem.Button(
72
                id = TOGGLE_SCROLL_DIRECTION,
73
                actionId = "toggle_scroll_direction",
74
                contentDescription = getString(R.string.runtime_configuration_change_toggle_scroll_direction),
75
                position = ItemEdge.End,
76
                overflowBehavior = OverflowBehavior.Never,
77
            )
78
        }
79

80
        setOnToolbarItemClickListener { itemId -> onToolbarItemClick(itemId) }
81
    }
82

83
    private fun onToolbarItemClick(itemId: Int): Boolean {
84
        // Create the new configuration based on the clicked toolbar item.
85
        val newConfiguration: PdfActivityConfiguration =
86
            when (itemId) {
87
                TOGGLE_NIGHT_MODE -> {
88
                    // This example toggles activity display between day and night modes.
89
                    // We'll base our state on the invert colors property of the configuration.
90
                    val isNightMode = configuration.configuration.isInvertColors
91
                    val themeId = if (!isNightMode) R.style.PSPDFCatalog_Theme_Dark else R.style.PSPDFCatalog_Theme
92

93
                    // Provide theme resource id when constructing the configuration builder.
94
                    PdfActivityConfiguration
95
                        .Builder(configuration)
96
                        // Invert document colors in night mode.
97
                        .invertColors(!isNightMode)
98
                        .theme(themeId)
99
                        .build()
100
                }
101

102
                TOGGLE_SCROLL_DIRECTION -> {
103
                    // This example toggles between horizontal and vertical page scroll direction.
104
                    PdfActivityConfiguration
105
                        .Builder(configuration)
106
                        .scrollDirection(
107
                            if (configuration.configuration.scrollDirection ==
108
                                PageScrollDirection.HORIZONTAL
109
                            ) {
110
                                PageScrollDirection.VERTICAL
111
                            } else {
112
                                PageScrollDirection.HORIZONTAL
113
                            },
114
                        ).build()
115
                }
116

117
                TOGGLE_SCROLL_MODE -> {
118
                    // This example toggles between paginated and continuous scroll mode.
119
                    PdfActivityConfiguration
120
                        .Builder(configuration)
121
                        .scrollMode(
122
                            if (configuration.configuration.scrollMode ==
123
                                PageScrollMode.PER_PAGE
124
                            ) {
125
                                PageScrollMode.CONTINUOUS
126
                            } else {
127
                                PageScrollMode.PER_PAGE
128
                            },
129
                        ).build()
130
                }
131

132
                else -> {
133
                    null
134
                }
135
            } ?: return false
136

137
        // Set configuration on the activity. This will recreate the
138
        // activity similar to changing the screen orientation or language.
139
        this.configuration = newConfiguration
140

141
        // Return true to consume the action.
142
        return true
143
    }
144
}