Custom Outline Provider

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.graphics.Color
12
import android.graphics.Typeface
13
import android.net.Uri
14
import com.pspdfkit.annotations.actions.GoToAction
15
import com.pspdfkit.annotations.actions.UriAction
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.document.OutlineElement
21
import com.pspdfkit.document.PdfDocument
22
import com.pspdfkit.ui.PdfActivity
23
import com.pspdfkit.ui.PdfActivityIntentBuilder
24
import io.reactivex.rxjava3.core.Single
25

26
/**
27
 * This example shows how to display a custom outline in [com.pspdfkit.ui.PdfOutlineView].
28
 */
29
class OutlineProviderExample(context: Context) :
30
    SdkExample(context, R.string.outlineProviderExample, R.string.outlineProviderExampleDescription) {
31

32
    override fun launchExample(context: Context, configuration: PdfActivityConfiguration.Builder) {
33
        // We use a custom utility class to extract the example document from the assets.
34
        ExtractAssetTask.extract(WELCOME_DOC, title, context) { documentFile ->
35
            val intent = PdfActivityIntentBuilder.fromUri(context, Uri.fromFile(documentFile))
36
                .configuration(configuration.build())
37
                .activityClass(OutlineProviderActivity::class)
38
                .build()
39

40
            // Start the OutlineProviderActivity for the extracted document.
41
            context.startActivity(intent)
42
        }
43
    }
44
}
45

46
/**
47
 * This subclass of [PdfActivity] sets a custom outline that replaces default document outline.
48
 */
49
class OutlineProviderActivity : PdfActivity() {
50

51
    override fun onDocumentLoaded(document: PdfDocument) {
52
        super.onDocumentLoaded(document)
53

54
        // Set outline provider that returns our custom outline elements on Activity's outline view.
55
        pspdfKitViews.outlineView?.setDocumentOutlineProvider { Single.just(getCustomOutline(document)) }
56
    }
57

58
    private fun getCustomOutline(document: PdfDocument): List<OutlineElement> {
59
        val outlineElements = mutableListOf<OutlineElement>()
60

61
        // The simplest outline elements is just a title with no action.
62
        outlineElements.add(OutlineElement.Builder("No Action").build())
63

64
        // Outline elements can have children - outline is a tree structure.
65
        outlineElements.add(
66
            OutlineElement.Builder("With Children")
67
                .setChildren(
68
                    listOf(
69
                        OutlineElement.Builder("Children 1").build(),
70
                        OutlineElement.Builder("Children 2").build(),
71
                        OutlineElement.Builder("Children 3").build()
72
                    )
73
                )
74
                // This property controls whether this element will be expanded or not when shown.
75
                .setExpanded(true)
76
                .build()
77
        )
78

79
        // Outline elements can have arbitrary actions.
80
        outlineElements.add(
81
            OutlineElement.Builder("Uri Action")
82
                // Outline text color and style are configurable.
83
                .setColor(Color.BLUE)
84
                .setStyle(Typeface.ITALIC)
85
                // Set action that opens Nutrient's website after clicking on the outline element.
86
                .setAction(UriAction("https://nutrient.io"))
87
                .build()
88
        )
89

90
        // You can directly create outline elements using their constructor too.
91
        outlineElements.add(OutlineElement.Builder(document, "Go to page 3", 3).build())
92
        // This is equivalent to the above outline element.
93
        outlineElements.add(
94
            OutlineElement.Builder("Go to page 3")
95
                .setAction(GoToAction(3))
96
                // The page label is optional. If set, it will be displayed in addition to title.
97
                .setPageLabel(document.getPageLabel(3, false))
98
                .build()
99
        )
100

101
        return outlineElements
102
    }
103
}