Annotation Overlay Visibility

1
/*
2
 *   Copyright © 2025-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.net.Uri
12
import android.os.Bundle
13
import com.google.android.material.floatingactionbutton.FloatingActionButton
14
import com.pspdfkit.catalog.R
15
import com.pspdfkit.catalog.SdkExample
16
import com.pspdfkit.catalog.tasks.ExtractAssetTask
17
import com.pspdfkit.configuration.activity.PdfActivityConfiguration
18
import com.pspdfkit.document.PdfDocument
19
import com.pspdfkit.ui.PdfActivity
20
import com.pspdfkit.ui.PdfActivityIntentBuilder
21

22
/**
23
 * Showcases how to toggle annotation overlay visibility using
24
 * [com.pspdfkit.ui.PdfFragment.setAnnotationOverlayEnabled].
25
 */
26
class AnnotationOverlayVisibilityExample(context: Context) : SdkExample(
27
    context,
28
    R.string.annotationOverlayVisibilityExampleTitle,
29
    R.string.annotationOverlayVisibilityExampleDescription
30
) {
31
    override fun launchExample(context: Context, configuration: PdfActivityConfiguration.Builder) {
32
        configuration.layout(R.layout.activity_annotation_overlay_visibility)
33

34
        ExtractAssetTask.extract(ANNOTATIONS_EXAMPLE, title, context) { documentFile ->
35
            val intent = PdfActivityIntentBuilder.fromUri(context, Uri.fromFile(documentFile))
36
                .configuration(configuration.build())
37
                .activityClass(AnnotationOverlayVisibilityActivity::class.java)
38
                .build()
39
            context.startActivity(intent)
40
        }
41
    }
42
}
43

44
/**
45
 * Activity that displays a PDF with a FAB to toggle annotation overlay visibility.
46
 */
47
class AnnotationOverlayVisibilityActivity : PdfActivity() {
48

49
    private lateinit var toggleOverlayFab: FloatingActionButton
50
    private var overlayEnabled = true
51

52
    override fun onCreate(savedInstanceState: Bundle?) {
53
        super.onCreate(savedInstanceState)
54

55
        toggleOverlayFab = findViewById(R.id.fab_toggle_overlay)
56
        updateFabIcon()
57

58
        toggleOverlayFab.setOnClickListener {
59
            overlayEnabled = !overlayEnabled
60
            requirePdfFragment().setAnnotationOverlayEnabled(overlayEnabled)
61
            updateFabIcon()
62
        }
63
    }
64

65
    override fun onDocumentLoaded(document: PdfDocument) {
66
        super.onDocumentLoaded(document)
67
        // Sync state with fragment once views are ready
68
        overlayEnabled = requirePdfFragment().isAnnotationOverlayEnabled
69
        updateFabIcon()
70
    }
71

72
    private fun updateFabIcon() {
73
        toggleOverlayFab.setImageResource(if (overlayEnabled) R.drawable.ic_show else R.drawable.ic_hide)
74
    }
75
}