PdfFragment

1
/*
2
 *   Copyright © 2024-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 androidx.appcompat.app.AppCompatActivity
15
import com.pspdfkit.catalog.R
16
import com.pspdfkit.catalog.SdkExample
17
import com.pspdfkit.catalog.ui.DocumentPickerActivity
18
import com.pspdfkit.configuration.PdfConfiguration
19
import com.pspdfkit.configuration.activity.PdfActivityConfiguration
20
import com.pspdfkit.document.PdfDocument
21
import com.pspdfkit.listeners.DocumentListener
22
import com.pspdfkit.ui.PdfFragment
23
import com.pspdfkit.utils.getSupportParcelableExtra
24

25
/**
26
 * A very simple [PdfFragment] example with minimum configuration.
27
 * Adds a document listener to give access to the document.
28
 */
29
class SimpleFragmentExample(context: Context) :
30
    SdkExample(context, R.string.simpleFragmentExampleTitle, R.string.simpleFragmentExampleDescription) {
31
    override fun launchExample(context: Context, configuration: PdfActivityConfiguration.Builder) {
32
        // Launch the picker activity to let users choose between default or custom document.
33
        val intent = Intent(context, SimpleFragmentExamplePickerActivity::class.java)
34
        intent.putExtra(DocumentPickerActivity.EXTRA_CONFIGURATION, configuration.build())
35
        context.startActivity(intent)
36
    }
37
}
38

39
/**
40
 * Picker that launches [SimpleFragmentActivity] with the selected document.
41
 *
42
 * [SimpleFragmentActivity] is a plain [AppCompatActivity] hosting a [PdfFragment],
43
 * so we override [buildLaunchIntent] to build the intent ourselves instead of
44
 * relying on the default [com.pspdfkit.ui.PdfActivityIntentBuilder] path.
45
 */
46
class SimpleFragmentExamplePickerActivity : DocumentPickerActivity() {
47
    override val targetActivityClass = SimpleFragmentActivity::class.java
48

49
    override fun buildLaunchIntent(uri: Uri, configuration: PdfActivityConfiguration, isImageFile: Boolean): Intent =
50
        Intent(this, SimpleFragmentActivity::class.java).apply {
51
            putExtra(SimpleFragmentActivity.EXTRA_URI, uri)
52
            putExtra(SimpleFragmentActivity.EXTRA_CONFIGURATION, configuration.configuration)
53
        }
54
}
55

56
class SimpleFragmentActivity :
57
    AppCompatActivity(),
58
    DocumentListener {
59
    private lateinit var fragment: PdfFragment
60
    private lateinit var configuration: PdfConfiguration
61

62
    override fun onCreate(savedInstanceState: Bundle?) {
63
        super.onCreate(savedInstanceState)
64
        setContentView(R.layout.activity_simple_fragment)
65

66
        // Get the Uri provided when launching the activity.
67
        val documentUri =
68
            intent.getSupportParcelableExtra(EXTRA_URI, Uri::class.java)
69
                ?: throw IllegalStateException("Activity Intent was missing Uri extra!")
70

71
        // Get the configuration from the provided Intent.
72
        configuration = intent.getSupportParcelableExtra(EXTRA_CONFIGURATION, PdfConfiguration::class.java)
73
            ?: throw IllegalStateException("Activity Intent was missing configuration extra!")
74

75
        fragment = PdfFragment.newInstance(documentUri, configuration)
76
        supportFragmentManager
77
            .beginTransaction()
78
            .replace(R.id.fragmentContainer, fragment)
79
            .commit()
80
        fragment.addDocumentListener(this)
81
    }
82

83
    override fun onDocumentLoaded(document: PdfDocument) {
84
        println("Document loaded!")
85
        // Do your magic here...
86
    }
87

88
    companion object {
89
        const val EXTRA_CONFIGURATION = "SimpleFragmentActivity.EXTRA_CONFIGURATION"
90
        const val EXTRA_URI = "SimpleFragmentActivity.EXTRA_URI"
91
    }
92
}