Playground Example

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
package com.pspdfkit.catalog.examples.kotlin
8

9
import android.content.Context
10
import android.net.Uri
11
import android.util.Log
12
import android.view.Menu
13
import android.view.MenuItem
14
import android.widget.Toast
15
import com.pspdfkit.catalog.R
16
import com.pspdfkit.catalog.SdkExample
17
import com.pspdfkit.catalog.SdkExample.Companion.TAG
18
import com.pspdfkit.catalog.tasks.ExtractAssetTask
19
import com.pspdfkit.configuration.activity.PdfActivityConfiguration
20
import com.pspdfkit.document.PdfDocument
21
import com.pspdfkit.ui.PdfActivity
22
import com.pspdfkit.ui.PdfActivityIntentBuilder
23

24
/**
25
 * Playground example that opens an activity extending the [PdfActivity] class.
26
 */
27
class PlaygroundExample(context: Context) : SdkExample(context, R.string.playgroundExampleTitle, R.string.playgroundExampleDescription) {
28

29
    override fun launchExample(context: Context, configuration: PdfActivityConfiguration.Builder) {
30
        // We use a custom utility class to extract the example document from the assets.
31
        ExtractAssetTask.extract(WELCOME_DOC, title, context) { documentFile ->
32
            // To start the `CustomLayoutActivity` create a launch intent using the builder.
33
            val intent = PdfActivityIntentBuilder.fromUri(context, Uri.fromFile(documentFile))
34
                .configuration(configuration.build())
35
                .activityClass(PlaygroundActivity::class)
36
                .build()
37
            context.startActivity(intent)
38
        }
39
    }
40
}
41

42
/**
43
 * Playground activity that provides an options menu accessible via the overflow menu (the three dots)
44
 * with a customizable button action, see [menuItemClicked]; and a callback when the document is successfully
45
 * loaded, see [onDocumentLoaded].
46
 */
47
class PlaygroundActivity : PdfActivity() {
48

49
    override fun onCreateOptionsMenu(menu: Menu): Boolean {
50
        super.onCreateOptionsMenu(menu)
51
        menu.add(0, CUSTOM_MENU_ITEM_ID, 0, "Custom Menu Item")
52
        return true
53
    }
54

55
    override fun onOptionsItemSelected(item: MenuItem): Boolean {
56
        return if (item.itemId == CUSTOM_MENU_ITEM_ID) {
57
            menuItemClicked()
58
            true
59
        } else {
60
            super.onOptionsItemSelected(item)
61
        }
62
    }
63

64
    override fun onDocumentLoaded(document: PdfDocument) {
65
        super.onDocumentLoaded(document)
66
        Log.d(TAG, "Document loaded.")
67
        // Do your magic here...
68
    }
69

70
    private fun menuItemClicked() {
71
        Toast.makeText(this, "Menu item clicked!", Toast.LENGTH_SHORT).show()
72
    }
73

74
    companion object {
75
        private const val CUSTOM_MENU_ITEM_ID = 1
76
    }
77
}