Basic Example

1
/*
2
 *   Copyright © 2021-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.content.Intent
12
import android.net.Uri
13
import android.os.Bundle
14
import android.util.Log
15
import androidx.activity.compose.setContent
16
import androidx.appcompat.app.AppCompatActivity
17
import androidx.compose.foundation.background
18
import androidx.compose.foundation.layout.Arrangement
19
import androidx.compose.foundation.layout.Box
20
import androidx.compose.foundation.layout.Row
21
import androidx.compose.foundation.layout.Spacer
22
import androidx.compose.foundation.layout.fillMaxSize
23
import androidx.compose.foundation.layout.navigationBarsPadding
24
import androidx.compose.foundation.layout.padding
25
import androidx.compose.foundation.layout.statusBarsPadding
26
import androidx.compose.material.icons.Icons
27
import androidx.compose.material.icons.filled.Save
28
import androidx.compose.material3.Button
29
import androidx.compose.material3.FloatingActionButton
30
import androidx.compose.material3.Icon
31
import androidx.compose.material3.MaterialTheme
32
import androidx.compose.material3.Scaffold
33
import androidx.compose.material3.Text
34
import androidx.compose.ui.Modifier
35
import androidx.compose.ui.unit.dp
36
import com.pspdfkit.catalog.R
37
import com.pspdfkit.catalog.SdkExample
38
import com.pspdfkit.catalog.SdkExample.Companion.TAG
39
import com.pspdfkit.catalog.tasks.ExtractAssetTask
40
import com.pspdfkit.catalog.ui.theming.CatalogTheme
41
import com.pspdfkit.configuration.activity.PdfActivityConfiguration
42
import com.pspdfkit.configuration.activity.UserInterfaceViewMode
43
import com.pspdfkit.jetpack.compose.interactors.DefaultListeners
44
import com.pspdfkit.jetpack.compose.interactors.getDefaultDocumentManager
45
import com.pspdfkit.jetpack.compose.interactors.rememberDocumentState
46
import com.pspdfkit.jetpack.compose.views.DocumentView
47
import com.pspdfkit.ui.PdfUiFragment
48
import com.pspdfkit.utils.getSupportParcelableExtra
49

50
/**
51
 * Opens the example document using Jetpack Compose.
52
 */
53
class JetpackComposeExample(context: Context) : SdkExample(context, R.string.jetpackExampleTitle, R.string.jetpackExampleDescription) {
54
    /** Configuration is handled inside [JetpackComposeActivity] */
55
    override fun launchExample(context: Context, configuration: PdfActivityConfiguration.Builder) {
56
        ExtractAssetTask.extract(WELCOME_DOC, title, context) { documentFile ->
57
            val intent = Intent(context, JetpackComposeActivity::class.java)
58
            intent.putExtra(JetpackComposeActivity.EXTRA_URI, Uri.fromFile(documentFile))
59
            context.startActivity(intent)
60
        }
61
    }
62
}
63

64
/**
65
 * This example shows you how to use the [PdfUiFragment] to display PDFs in your activities.
66
 */
67
class JetpackComposeActivity : AppCompatActivity() {
68

69
    override fun onCreate(savedInstanceState: Bundle?) {
70
        super.onCreate(savedInstanceState)
71

72
        val uri = intent.getSupportParcelableExtra(EXTRA_URI, Uri::class.java)!!
73

74
        setContent {
75
            CatalogTheme {
76
                val pdfActivityConfiguration = PdfActivityConfiguration
77
                    .Builder(this)
78
                    .setUserInterfaceViewMode(UserInterfaceViewMode.USER_INTERFACE_VIEW_MODE_HIDDEN)
79
                    .build()
80

81
                val documentState = rememberDocumentState(uri, pdfActivityConfiguration)
82

83
                var currentPage = pdfActivityConfiguration.page
84

85
                Scaffold(
86
                    modifier = Modifier
87
                        .background(color = MaterialTheme.colorScheme.onPrimary)
88
                        .statusBarsPadding()
89
                        .navigationBarsPadding(),
90
                    floatingActionButton = {
91
                        FloatingActionButton(
92
                            onClick = {
93
                                documentState.documentConnection.save()
94
                            }
95
                        ) {
96
                            Icon(imageVector = Icons.Default.Save, contentDescription = "save")
97
                        }
98
                    },
99
                    bottomBar = {
100
                        Row(
101
                            horizontalArrangement = Arrangement.SpaceAround
102
                        ) {
103
                            Button(
104
                                onClick = {
105
                                    documentState.documentConnection.setPageIndex(
106
                                        (currentPage - 1).coerceAtLeast(
107
                                            0
108
                                        )
109
                                    )
110
                                },
111
                                modifier = Modifier.padding(8.dp)
112
                            ) {
113
                                Text("Previous page")
114
                            }
115

116
                            Spacer(modifier = Modifier.weight(1f))
117

118
                            Button(
119
                                onClick = {
120
                                    documentState.documentConnection.setPageIndex(
121
                                        (currentPage + 1).coerceAtMost(
122
                                            17
123
                                        )
124
                                    )
125
                                },
126
                                modifier = Modifier.padding(8.dp)
127
                            ) {
128
                                Text("Next page")
129
                            }
130
                        }
131
                    }
132
                ) { paddingValues ->
133
                    Box(Modifier.padding(paddingValues)) {
134
                        DocumentView(
135
                            documentState = documentState,
136
                            modifier = Modifier.fillMaxSize(),
137
                            documentManager = getDefaultDocumentManager(
138
                                documentListener = DefaultListeners.documentListeners(
139
                                    onDocumentLoaded = {
140
                                        Log.e(TAG, "onDocumentLoaded ${it.title}")
141
                                    },
142
                                    onPageChanged = { document, page ->
143
                                        currentPage = page
144
                                        Log.e(TAG, "onPageChanged: ${document.title} - $page")
145
                                    },
146
                                    onDocumentSave = { document, _ ->
147
                                        Log.e(TAG, "onDocumentSave ${document.title}")
148
                                        true
149
                                    },
150
                                    onDocumentSaved = {
151
                                        Log.e(TAG, "onDocumentSaved ${it.title}")
152
                                    },
153
                                    onDocumentZoomed = { document, pageIndex, scaleFactor ->
154
                                        Log.e(
155
                                            TAG,
156
                                            "onDocumentZoomed: ${document.title}  $pageIndex $scaleFactor"
157
                                        )
158
                                    }
159
                                ),
160
                                annotationListener = DefaultListeners.annotationListeners(
161
                                    onAnnotationSelected = { annotation, created ->
162
                                        Log.e(
163
                                            TAG,
164
                                            "onAnnotationSelected: ${annotation.type.name} $created"
165
                                        )
166
                                    },
167
                                    onAnnotationDeselected = { annotation, created ->
168
                                        Log.e(
169
                                            TAG,
170
                                            "onAnnotationDeselected: ${annotation.type.name} $created"
171
                                        )
172
                                    }
173
                                )
174
                            )
175
                        )
176
                    }
177
                }
178
            }
179
        }
180
    }
181

182
    companion object {
183
        const val EXTRA_URI = "JetpackComposeActivity.DocumentUri"
184
    }
185
}