Runtime configuration fragment

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.content.Intent
12
import android.net.Uri
13
import android.os.Bundle
14
import android.view.View
15
import androidx.appcompat.app.AppCompatActivity
16
import com.pspdfkit.catalog.R
17
import com.pspdfkit.catalog.SdkExample
18
import com.pspdfkit.catalog.tasks.ExtractAssetTask
19
import com.pspdfkit.configuration.PdfConfiguration
20
import com.pspdfkit.configuration.activity.PdfActivityConfiguration
21
import com.pspdfkit.configuration.page.PageScrollDirection
22
import com.pspdfkit.ui.PdfFragment
23
import com.pspdfkit.utils.getSupportParcelableExtra
24
import java.io.File
25

26
/**
27
 * Shows how to dynamically change [PdfFragment] configuration at runtime when used with custom activity.
28
 */
29
class CustomFragmentRuntimeConfigurationExample(context: Context) : SdkExample(context, R.string.runtimeConfigurationFragmentExampleTitle, R.string.runtimeConfigurationFragmentExampleDescription) {
30
    override fun launchExample(context: Context, configuration: PdfActivityConfiguration.Builder) {
31
        ExtractAssetTask.extract(WELCOME_DOC, title, context) { documentFile: File? ->
32
            val intent = Intent(context, CustomFragmentRuntimeConfigurationActivity::class.java)
33
            intent.putExtra(CustomFragmentRuntimeConfigurationActivity.EXTRA_URI, Uri.fromFile(documentFile))
34
            context.startActivity(intent)
35
        }
36
    }
37
}
38

39
/**
40
 * This activity shows how to change [PdfFragment] configuration at runtime when used with custom activity.
41
 */
42
class CustomFragmentRuntimeConfigurationActivity : AppCompatActivity() {
43

44
    private lateinit var configuration: PdfConfiguration
45
    private lateinit var fragment: PdfFragment
46

47
    override fun onCreate(savedInstanceState: Bundle?) {
48
        super.onCreate(savedInstanceState)
49

50
        // Get the Uri provided when launching the activity.
51
        val documentUri = intent.getSupportParcelableExtra(EXTRA_URI, Uri::class.java)
52
            ?: throw IllegalStateException("Extras bundle was missing document URI")
53

54
        // Extract the existing fragment. The fragment only exist if it has been created previously (like if the activity is recreated).
55
        // If no fragment was found, create a new one providing it with the configuration and document Uri.
56
        var fragment = supportFragmentManager.findFragmentById(R.id.fragmentContainer) as PdfFragment?
57
        if (fragment == null) {
58
            // Create a new configuration and fragment.
59
            configuration = PdfConfiguration.Builder().build()
60
            fragment = PdfFragment.newInstance(documentUri, configuration)
61
        } else {
62
            // Use existing configuration.
63
            configuration = fragment.configuration
64
        }
65

66
        // Set theme according to invert colors property in the configuration.
67
        setTheme(getNightModeTheme(configuration.isInvertColors))
68

69
        // Set activity layout. Must be called after setTheme for configured theme to work properly.
70
        setContentView(R.layout.activity_custom_fragment_runtime_configuration)
71

72
        // Bind example configuration change actions to buttons in layout.
73
        findViewById<View>(R.id.toggle_scroll_direction).setOnClickListener { toggleScrollDirection() }
74
        findViewById<View>(R.id.toggle_night_mode_button).setOnClickListener { toggleNightMode() }
75

76
        // Add the fragment to the activity and register all needed listeners.
77
        setFragment(fragment)
78
    }
79

80
    private fun setFragment(fragment: PdfFragment) {
81
        // Replace previous fragment.
82
        this.fragment = fragment
83

84
        // Replace old fragment with a new one in Activity's fragment manager.
85
        supportFragmentManager
86
            .beginTransaction()
87
            .replace(R.id.fragmentContainer, fragment)
88
            .commit()
89
    }
90

91
    /**
92
     * When changing fragment configuration we need to replace fragment with a new instance with updated configuration.
93
     */
94
    private fun toggleScrollDirection() {
95
        val scrollDirection = fragment.configuration.scrollDirection
96

97
        // Copy existing configuration to a new configuration builder.
98
        val newConfig = fragment.configuration.copy(
99
            scrollDirection = if (scrollDirection == PageScrollDirection.HORIZONTAL) PageScrollDirection.VERTICAL else PageScrollDirection.HORIZONTAL
100
        )
101

102
        // Create a new fragment based on the current fragment and the new configuration.
103
        // This copies the state (loaded document, scrolled page, selected annotations etc.) of the
104
        // current fragment while applying the new configuration.
105
        val newFragment = PdfFragment.newInstance(fragment, newConfig)
106

107
        // Replace the current fragment with it.
108
        setFragment(newFragment)
109
    }
110

111
    /**
112
     * Here we show how to implement the night mode. We replace existing fragment with
113
     * configuration that inverts rendering colors and set dark theme on the activity.
114
     */
115
    private fun toggleNightMode() {
116
        // In this example, we will use invert colors property to control night mode to make things simple.
117
        val isNightModeActive = fragment.configuration.isInvertColors
118

119
        // Copy existing configuration to a new configuration builder.
120
        val newConfig = fragment.configuration.copy(
121
            // Toggle invert colors property.
122
            isInvertColors = !isNightModeActive
123
        )
124

125
        // Create a new fragment based on the current fragment and the new configuration.
126
        // This copies the state (loaded document, scrolled page, selected annotations etc.) of the
127
        // current fragment while applying the new configuration.
128
        val newFragment = PdfFragment.newInstance(fragment, newConfig)
129
        setFragment(newFragment)
130

131
        // Activity theme must be applied before setContentView. Thus we need to restart the activity.
132
        // When activity is restarted, we set the theme according to invertColors configuration property (see onCreate above).
133
        recreate()
134
    }
135

136
    companion object {
137
        const val EXTRA_URI = "CustomFragmentRuntimeConfigurationActivity.EXTRA_URI"
138

139
        private fun getNightModeTheme(isNightMode: Boolean): Int {
140
            return if (isNightMode) R.style.PSPDFCatalog_Theme_Dark else R.style.PSPDFCatalog_Theme
141
        }
142
    }
143
}