User Interface View Modes Example

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

25
/**
26
 * This example shows how to change user interface view modes. To do so, it subclasses the
27
 * [PdfActivity] and calls [PdfActivity.setUserInterfaceViewMode] method
28
 * to toggle between various user interface view modes.
29
 */
30
class UserInterfaceViewModesExample(context: Context) : SdkExample(context, R.string.userInterfaceViewModesExampleTitle, R.string.userInterfaceViewModesExampleDescription) {
31
    override fun launchExample(context: Context, configuration: PdfActivityConfiguration.Builder) {
32
        // Configure the PdfActivity to use the examples subclass. This is
33
        // important if your app wants to tweak the default behavior of its implementation.
34
        configuration.layout(R.layout.user_interface_view_modes_activity)
35

36
        // Hide navigation buttons and tab bar since they are not used by this example.
37
        configuration.navigationButtonsEnabled(false)
38
        configuration.setTabBarHidingMode(TabBarHidingMode.HIDE)
39

40
        // The custom layout has no content editor. In order to prevent the activity from accessing
41
        // it we have to deactivate it in the configuration.
42
        configuration.contentEditingEnabled(false)
43

44
        // Disable measurements as well
45
        configuration.setMeasurementToolsEnabled(false)
46

47
        // We use a custom utility class to extract the example document from the assets.
48
        ExtractAssetTask.extract(WELCOME_DOC, title, context) { documentFile ->
49
            // Launch the custom example activity using the document and configuration.
50
            val intent = PdfActivityIntentBuilder.fromUri(context, Uri.fromFile(documentFile))
51
                .configuration(configuration.build())
52
                .activityClass(UserInterfaceViewModesActivity::class)
53
                .build()
54

55
            // Start the UserInterfaceViewModesActivity for the extracted document.
56
            context.startActivity(intent)
57
        }
58
    }
59
}
60

61
/**
62
 * This subclass of [PdfActivity] adds a set of actions to change user interface view modes.
63
 */
64
class UserInterfaceViewModesActivity : PdfActivity() {
65

66
    override fun onCreate(savedInstanceState: Bundle?) {
67
        super.onCreate(savedInstanceState)
68

69
        findViewById<View>(R.id.show_user_interface_button).setOnClickListener {
70
            // This method overrides all restraints on showing user interface.
71
            // Shows user interface even when using USER_INTERFACE_VIEW_MODE_HIDDEN.
72
            setUserInterfaceVisible(true, true)
73
        }
74

75
        findViewById<View>(R.id.hide_user_interface_button).setOnClickListener {
76
            // This method overrides all restraints on hiding user interface.
77
            // Hides user interface even when using USER_INTERFACE_MODE_VISIBLE.
78
            setUserInterfaceVisible(false, true)
79
        }
80
    }
81

82
    override fun onCreateOptionsMenu(menu: Menu): Boolean {
83
        super.onCreateOptionsMenu(menu)
84
        menuInflater.inflate(R.menu.user_interface_view_modes_menu, menu)
85
        return true
86
    }
87

88
    override fun onOptionsItemSelected(item: MenuItem): Boolean {
89
        val newUserInterfaceViewMode = when (item.itemId) {
90
            R.id.user_interface_view_mode_automatic -> {
91
                UserInterfaceViewMode.USER_INTERFACE_VIEW_MODE_AUTOMATIC
92
            }
93
            R.id.user_interface_view_mode_automatic_border_pages -> {
94
                UserInterfaceViewMode.USER_INTERFACE_VIEW_MODE_AUTOMATIC_BORDER_PAGES
95
            }
96
            R.id.user_interface_view_mode_visible -> {
97
                UserInterfaceViewMode.USER_INTERFACE_VIEW_MODE_VISIBLE
98
            }
99
            R.id.user_interface_view_mode_hidden -> {
100
                UserInterfaceViewMode.USER_INTERFACE_VIEW_MODE_HIDDEN
101
            }
102
            R.id.user_interface_view_mode_manual -> {
103
                UserInterfaceViewMode.USER_INTERFACE_VIEW_MODE_MANUAL
104
            }
105
            else -> null
106
        } ?: return super.onOptionsItemSelected(item)
107

108
        this.userInterfaceViewMode = newUserInterfaceViewMode
109
        return true
110
    }
111

112
    override fun onUserInterfaceVisibilityChanged(visible: Boolean) {
113
        super.onUserInterfaceVisibilityChanged(visible)
114
        // You can monitor UI visibility changes by overriding this method.
115
    }
116
}