PdfUiFragment Example

1
/*
2
 *   Copyright © 2019-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.view.View
15
import android.view.ViewGroup
16
import androidx.appcompat.app.AppCompatActivity
17
import androidx.core.view.ViewCompat
18
import androidx.core.view.WindowInsetsCompat
19
import androidx.core.view.updateLayoutParams
20
import androidx.lifecycle.DefaultLifecycleObserver
21
import androidx.lifecycle.LifecycleOwner
22
import com.pspdfkit.catalog.R
23
import com.pspdfkit.catalog.SdkExample
24
import com.pspdfkit.catalog.tasks.ExtractAssetTask.extract
25
import com.pspdfkit.configuration.activity.PdfActivityConfiguration
26
import com.pspdfkit.document.PdfDocument
27
import com.pspdfkit.listeners.DocumentListener
28
import com.pspdfkit.ui.PdfUiFragment
29
import com.pspdfkit.ui.PdfUiFragmentBuilder
30
import com.pspdfkit.utils.getSupportParcelableExtra
31

32
/**
33
 * This example shows how to use the [PdfUiFragment] to display PDFs.
34
 */
35
class PdfUiFragmentExample(context: Context) : SdkExample(context, R.string.pdfUiFragmentExampleTitle, R.string.pdfUiFragmentExampleDescription) {
36
    override fun launchExample(context: Context, configuration: PdfActivityConfiguration.Builder) {
37
        extract(WELCOME_DOC, title, context) { documentFile ->
38
            val intent = Intent(context, PdfUiFragmentExampleActivity::class.java)
39
            intent.putExtra(PdfUiFragmentExampleActivity.EXTRA_URI, Uri.fromFile(documentFile))
40
            intent.putExtra(PdfUiFragmentExampleActivity.EXTRA_CONFIGURATION, configuration.build())
41
            context.startActivity(intent)
42
        }
43
    }
44
}
45

46
/**
47
 * This example shows you how to use the [PdfUiFragment] to display PDFs in your activities.
48
 */
49
class PdfUiFragmentExampleActivity : AppCompatActivity(), DocumentListener {
50

51
    private lateinit var pdfUiFragment: PdfUiFragment
52

53
    private var observer: PdfUiFragmentLifecycleObserver? = null
54
    override fun onCreate(savedInstanceState: Bundle?) {
55
        super.onCreate(savedInstanceState)
56
        setContentView(R.layout.activity_pdfuifragment_example)
57

58
        val rootView = this.findViewById<View>(android.R.id.content)
59
        ViewCompat.setOnApplyWindowInsetsListener(rootView) { v, windowInsets ->
60
            val insets = windowInsets.getInsets(WindowInsetsCompat.Type.systemBars())
61
            v.updateLayoutParams<ViewGroup.MarginLayoutParams> {
62
                leftMargin = insets.left
63
                topMargin = insets.top
64
                rightMargin = insets.right
65
                bottomMargin = insets.bottom
66
            }
67
            WindowInsetsCompat.CONSUMED
68
        }
69

70
        if (supportFragmentManager.findFragmentByTag("pdfUiFragment") == null) {
71
            // PdfFragment configuration is provided with the launching intent.
72
            var configuration: PdfActivityConfiguration? = intent.getSupportParcelableExtra(EXTRA_CONFIGURATION, PdfActivityConfiguration::class.java)
73
            if (configuration == null) {
74
                configuration = PdfActivityConfiguration.Builder(this).build()
75
            }
76

77
            // The actual document Uri is provided with the launching intent. You can simply change that inside the PdfUiFragmentExample class.
78
            val uri = intent.getSupportParcelableExtra(EXTRA_URI, Uri::class.java)
79

80
            // Create our PdfUiFragment if it doesn't exist yet.
81
            pdfUiFragment = PdfUiFragmentBuilder.fromUri(this, uri)
82
                .configuration(configuration)
83
                .build()
84
            supportFragmentManager.beginTransaction().add(R.id.fragmentContainer, pdfUiFragment, "pdfUiFragment").commit()
85
        } else {
86
            pdfUiFragment = supportFragmentManager.findFragmentByTag("pdfUiFragment") as PdfUiFragment
87
        }
88

89
        observer = PdfUiFragmentLifecycleObserver(pdfUiFragment, this)
90
    }
91

92
    override fun onDocumentLoaded(document: PdfDocument) {
93
        super.onDocumentLoaded(document)
94
        println("Loaded!")
95
        // Do some fun stuff with the document here.
96
    }
97

98
    @Suppress("DEPRECATION", "OVERRIDE_DEPRECATION")
99
    override fun onBackPressed() {
100
        // If you want the UI to properly respond to backpresses you need to forward this call to the fragment.
101
        if (!pdfUiFragment.onBackPressed()) {
102
            super.onBackPressed()
103
        }
104
    }
105

106
    // We need a LifecycleObserver to observe the fragment lifecycle
107
    class PdfUiFragmentLifecycleObserver(
108
        private val pdfUiFragment: PdfUiFragment,
109
        private val documentListener: DocumentListener
110
    ) : DefaultLifecycleObserver {
111

112
        init {
113
            // Add observer
114
            pdfUiFragment.lifecycle.addObserver(this)
115
        }
116

117
        override fun onStart(owner: LifecycleOwner) {
118
            // Do stuff on start (add listener etc)
119
            pdfUiFragment.pdfFragment?.addDocumentListener(documentListener)
120
        }
121

122
        override fun onDestroy(owner: LifecycleOwner) {
123
            // remember to remove listeners on destroy
124
            pdfUiFragment.pdfFragment?.removeDocumentListener(documentListener)
125
            pdfUiFragment.lifecycle.removeObserver(this)
126
        }
127
    }
128

129
    companion object {
130
        const val EXTRA_URI = "PdfUiFragmentExampleActivity.DocumentUri"
131
        const val EXTRA_CONFIGURATION = "PdfUiFragmentExampleActivity.PdfConfiguration"
132
    }
133
}