Customize annotation selection in Android with Kotlin

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

8
package com.pspdfkit.catalog.examples.kotlin
9

10
import android.content.Context
11
import android.graphics.drawable.Drawable
12
import android.net.Uri
13
import android.os.Bundle
14
import androidx.appcompat.content.res.AppCompatResources
15
import com.pspdfkit.annotations.Annotation
16
import com.pspdfkit.annotations.AnnotationType
17
import com.pspdfkit.catalog.R
18
import com.pspdfkit.catalog.SdkExample
19
import com.pspdfkit.catalog.tasks.ExtractAssetTask
20
import com.pspdfkit.configuration.activity.PdfActivityConfiguration
21
import com.pspdfkit.configuration.theming.AnnotationSelectionViewThemeConfiguration
22
import com.pspdfkit.document.PdfDocument
23
import com.pspdfkit.ui.PdfActivity
24
import com.pspdfkit.ui.PdfActivityIntentBuilder
25
import com.pspdfkit.ui.annotations.OnAnnotationSelectedListener
26
import com.pspdfkit.ui.special_mode.controller.AnnotationSelectionController
27

28
/**
29
 * This example shows how to customize the annotation selection layout.
30
 */
31
class AnnotationSelectionViewStylingExample(context: Context) : SdkExample(context, R.string.annotationSelectionViewStylingExampleTitle, R.string.annotationSelectionViewStylingExampleDescription) {
32

33
    override fun launchExample(context: Context, configuration: PdfActivityConfiguration.Builder) {
34
        // Set the new theme that overrides annotation selection color,
35
        // scale handle drawables and background drawable.
36
        configuration.theme(R.style.AnnotationSelectionExample_Theme)
37

38
        // Extract the example document from the app's assets.
39
        ExtractAssetTask.extract("Annotation-Selection.pdf", title, context) { documentFile ->
40
            val intent = PdfActivityIntentBuilder.fromUri(context, Uri.fromFile(documentFile))
41
                .configuration(configuration.build())
42
                .activityClass(AnnotationSelectionViewStylingActivity::class)
43
                .build()
44

45
            context.startActivity(intent)
46
        }
47
    }
48
}
49

50
/**
51
 * This activity shows how to customize the annotation selection view programmatically.
52
 */
53
class AnnotationSelectionViewStylingActivity : PdfActivity(), OnAnnotationSelectedListener {
54

55
    private var collaborate: Drawable? = null
56
    override fun onCreate(savedInstanceState: Bundle?) {
57
        super.onCreate(savedInstanceState)
58
        collaborate = AppCompatResources.getDrawable(this, R.drawable.ic_collaborate)
59
    }
60

61
    override fun onDocumentSaved(document: PdfDocument) {
62
        // When a document is saved it's important to remove
63
        // the previous listener otherwise setting it again
64
        // in the `onDocumentLoaded` callback will be a no-op.
65
        requirePdfFragment().removeOnAnnotationSelectedListener(this)
66
    }
67

68
    override fun onDocumentLoaded(document: PdfDocument) {
69
        super.onDocumentLoaded(document)
70
        requirePdfFragment().addOnAnnotationSelectedListener(this)
71
    }
72

73
    /**
74
     * Called immediately before annotation is going to be selected.
75
     *
76
     * @param controller Selection controller that is performing the selection.
77
     * @param annotation Annotation that is going to be selected.
78
     * @param annotationCreated `true` if the annotation is being created.
79
     * @return `true` when you want [AnnotationSelectionController] to proceed with the selection. Returning `false`
80
     * will prevent annotation from being selected.
81
     */
82
    override fun onPrepareAnnotationSelection(controller: AnnotationSelectionController, annotation: Annotation, annotationCreated: Boolean): Boolean {
83
        // Extract current annotation selection view theme configuration.
84
        val extractedCurrentConfiguration = controller.annotationSelectionViewThemeConfiguration
85
        // Build a new annotation selection view theme configuration using the current configuration as a base configuration.
86
        val annotationSelectionViewThemeConfiguration = build(extractedCurrentConfiguration) {
87
            // Customize the bottom right scale handle drawable depending on the annotation type.
88
            if (annotation.type == AnnotationType.STAMP) {
89
                setRotationHandleDrawable(null)
90
                setBottomRightScaleHandleDrawable(collaborate)
91
            }
92
        }
93
        // Apply the new configuration to the annotation selection view.
94
        controller.annotationSelectionViewThemeConfiguration = annotationSelectionViewThemeConfiguration
95
        return true
96
    }
97

98
    override fun onAnnotationSelected(annotation: Annotation, annotationCreated: Boolean) {
99
        // Not used.
100
    }
101
}
102

103
/**
104
 * Returns an [AnnotationSelectionViewThemeConfiguration] with all options supplied to the build block, e.g:
105
 * ```
106
 * val annotationSelectionViewThemeConfiguration = AnnotationSelectionViewThemeConfiguration.build() {
107
 *     setSelectionPadding(8)
108
 * }
109
 * ```
110
 */
111
private inline fun build(block: AnnotationSelectionViewThemeConfiguration.Builder.() -> Unit) = AnnotationSelectionViewThemeConfiguration.Builder().apply(block).build()
112

113
/**
114
 * Returns an [AnnotationSelectionViewThemeConfiguration] from an existing annotation view theme configuration
115
 * with all options supplied to the build block, e.g:
116
 * ```
117
 * val annotationSelectionViewThemeConfiguration = AnnotationSelectionViewThemeConfiguration.build(extractedCurrentConfiguration) {
118
 *     setSelectionPadding(8)
119
 * }
120
 * ```
121
 */
122
private inline fun build(
123
    annotationSelectionViewThemeConfiguration: AnnotationSelectionViewThemeConfiguration,
124
    block: AnnotationSelectionViewThemeConfiguration.Builder.() -> Unit
125
) = AnnotationSelectionViewThemeConfiguration.Builder(annotationSelectionViewThemeConfiguration).apply(block).build()