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.view.Menu
13
import android.view.MenuItem
14
import com.pspdfkit.catalog.R
15
import com.pspdfkit.catalog.SdkExample
16
import com.pspdfkit.catalog.tasks.ExtractAssetTask
17
import com.pspdfkit.configuration.activity.PdfActivityConfiguration
18
import com.pspdfkit.configuration.page.PageScrollDirection
19
import com.pspdfkit.configuration.page.PageScrollMode
20
import com.pspdfkit.ui.PdfActivity
21
import com.pspdfkit.ui.PdfActivityIntentBuilder
22

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

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

45
class RuntimeConfigurationActivity : PdfActivity() {
46
    override fun onCreateOptionsMenu(menu: Menu): Boolean {
47
        super.onCreateOptionsMenu(menu)
48

49
        // We are adding menu items as specific examples of how to change activity configuration from within the UI.
50
        menuInflater.inflate(R.menu.runtime_configuration_example_menu, menu)
51

52
        return true
53
    }
54

55
    override fun onOptionsItemSelected(item: MenuItem): Boolean {
56
        // Create the new configuration based on the clicked menu item.
57
        val newConfiguration =
58
            when (item.itemId) {
59
                R.id.toggle_night_mode -> {
60
                    // This example toggles activity display between day and night modes.
61
                    // We'll base our state on the invert colors property of the configuration.
62
                    val isNightMode = configuration.configuration.isInvertColors
63
                    val themeId = if (!isNightMode) R.style.PSPDFCatalog_Theme_Dark else R.style.PSPDFCatalog_Theme
64

65
                    // Provide theme resource id when constructing the configuration builder.
66
                    PdfActivityConfiguration
67
                        .Builder(configuration)
68
                        // Invert document colors in night mode.
69
                        .invertColors(!isNightMode)
70
                        .theme(themeId)
71
                        .build()
72
                }
73

74
                R.id.toggle_scroll_direction -> {
75
                    // This example toggles between horizontal and vertical page scroll direction.
76
                    PdfActivityConfiguration
77
                        .Builder(configuration)
78
                        .scrollDirection(
79
                            if (configuration.configuration.scrollDirection ==
80
                                PageScrollDirection.HORIZONTAL
81
                            ) {
82
                                PageScrollDirection.VERTICAL
83
                            } else {
84
                                PageScrollDirection.HORIZONTAL
85
                            },
86
                        ).build()
87
                }
88

89
                R.id.toggle_scroll_mode -> {
90
                    // This example toggles between paginated and continuous scroll mode.
91
                    PdfActivityConfiguration
92
                        .Builder(configuration)
93
                        .scrollMode(
94
                            if (configuration.configuration.scrollMode ==
95
                                PageScrollMode.PER_PAGE
96
                            ) {
97
                                PageScrollMode.CONTINUOUS
98
                            } else {
99
                                PageScrollMode.PER_PAGE
100
                            },
101
                        ).build()
102
                }
103

104
                else -> {
105
                    null
106
                }
107
            } ?: return super.onOptionsItemSelected(item)
108

109
        // Set configuration on the activity. This will recreate the
110
        // activity similar to changing the screen orientation or language.
111
        this.configuration = newConfiguration
112

113
        // Return true to consume the action.
114
        return true
115
    }
116
}