Runtime configuration activity

1
/*
2
 *   Copyright © 2020-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.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) : SdkExample(context, R.string.runtimeConfigurationChangeExampleTitle, R.string.runtimeConfigurationChangeExampleDescription) {
27
    override fun launchExample(context: Context, configuration: PdfActivityConfiguration.Builder) {
28
        // We use a custom utility class to extract the example document from the assets.
29
        ExtractAssetTask.extract(WELCOME_DOC, title, context) { documentFile ->
30
            // Launch the custom example activity using the document and configuration.
31
            val intent = PdfActivityIntentBuilder.fromUri(context, Uri.fromFile(documentFile))
32
                .configuration(configuration.build())
33
                .activityClass(RuntimeConfigurationActivity::class)
34
                .build()
35

36
            // Start the DynamicConfigurationActivity for the extracted document.
37
            context.startActivity(intent)
38
        }
39
    }
40
}
41

42
class RuntimeConfigurationActivity : PdfActivity() {
43

44
    override fun onCreateOptionsMenu(menu: Menu): Boolean {
45
        super.onCreateOptionsMenu(menu)
46

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

50
        return true
51
    }
52

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

62
                // Provide theme resource id when constructing the configuration builder.
63
                PdfActivityConfiguration.Builder(configuration)
64
                    // Invert document colors in night mode.
65
                    .invertColors(!isNightMode)
66
                    .theme(themeId)
67
                    .build()
68
            }
69
            R.id.toggle_scroll_direction -> {
70
                // This example toggles between horizontal and vertical page scroll direction.
71
                PdfActivityConfiguration.Builder(configuration)
72
                    .scrollDirection(
73
                        if (configuration.configuration.scrollDirection == PageScrollDirection.HORIZONTAL) PageScrollDirection.VERTICAL else PageScrollDirection.HORIZONTAL
74
                    )
75
                    .build()
76
            }
77
            R.id.toggle_scroll_mode -> {
78
                // This example toggles between paginated and continuous scroll mode.
79
                PdfActivityConfiguration.Builder(configuration)
80
                    .scrollMode(if (configuration.configuration.scrollMode == PageScrollMode.PER_PAGE) PageScrollMode.CONTINUOUS else PageScrollMode.PER_PAGE)
81
                    .build()
82
            }
83
            else -> null
84
        } ?: return super.onOptionsItemSelected(item)
85

86
        // Set configuration on the activity. This will recreate the
87
        // activity similar to changing the screen orientation or language.
88
        this.configuration = newConfiguration
89

90
        // Return true to consume the action.
91
        return true
92
    }
93
}