Annotation Flags

1
/*
2
 *   Copyright © 2017-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 android.util.Log
14
import android.view.Menu
15
import android.view.MenuItem
16
import com.google.android.material.dialog.MaterialAlertDialogBuilder
17
import com.pspdfkit.annotations.Annotation
18
import com.pspdfkit.annotations.AnnotationFlags
19
import com.pspdfkit.annotations.AnnotationType
20
import com.pspdfkit.catalog.R
21
import com.pspdfkit.catalog.SdkExample
22
import com.pspdfkit.catalog.tasks.ExtractAssetTask
23
import com.pspdfkit.configuration.activity.PdfActivityConfiguration
24
import com.pspdfkit.listeners.OnPreparePopupToolbarListener
25
import com.pspdfkit.ui.PdfActivity
26
import com.pspdfkit.ui.PdfActivityIntentBuilder
27
import com.pspdfkit.ui.toolbar.popup.AnnotationPopupToolbar
28
import com.pspdfkit.ui.toolbar.popup.PopupToolbarMenuItem
29
import kotlinx.coroutines.CoroutineScope
30
import kotlinx.coroutines.Dispatchers
31
import kotlinx.coroutines.launch
32
import java.util.EnumSet
33

34
/**
35
 * Shows how to use [com.pspdfkit.annotations.AnnotationFlags] to modify annotation
36
 * characteristics.
37
 */
38
class AnnotationFlagsExample(context: Context) :
39
    SdkExample(
40
        context,
41
        R.string.annotationFlagsExampleTitle,
42
        R.string.annotationFlagsExampleDescription,
43
    ) {
44
    override fun launchExample(context: Context, configuration: PdfActivityConfiguration.Builder) {
45
        configuration
46
            // Turn off saving, so we have the clean original document every time the example is
47
            // launched.
48
            .autosaveEnabled(false)
49
            // Notes are treated as if they had the NOZOOM flag set by default.
50
            // We override this behavior here by enabling NOZOOM flag handling for note
51
            // annotations.
52
            .setEnableNoteAnnotationNoZoomHandling(true)
53

54
        // Extract the document from the assets.
55
        ExtractAssetTask.extract(ANNOTATIONS_EXAMPLE, title, context) { documentFile ->
56
            // To start the AnnotationFlagsActivity create a launch intent using the
57
            // builder.
58
            val intent =
59
                PdfActivityIntentBuilder
60
                    .fromUri(context, Uri.fromFile(documentFile))
61
                    .configuration(configuration.build())
62
                    .activityClass(AnnotationFlagsActivity::class.java)
63
                    .build()
64

65
            context.startActivity(intent)
66
        }
67
    }
68
}
69

70
/** This example showcases supported [AnnotationFlags]. */
71
class AnnotationFlagsActivity :
72
    PdfActivity(),
73
    OnPreparePopupToolbarListener {
74

75
    override fun onCreate(savedInstanceState: Bundle?) {
76
        super.onCreate(savedInstanceState)
77
        pdfFragment?.setOnPreparePopupToolbarListener(this)
78
    }
79

80
    override fun onCreateOptionsMenu(menu: Menu): Boolean {
81
        super.onCreateOptionsMenu(menu)
82
        menu.add(0, R.id.reset_all_flags, 0, "Reset All Flags")
83
        return true
84
    }
85

86
    override fun onOptionsItemSelected(item: MenuItem): Boolean {
87
        if (item.itemId == R.id.reset_all_flags) {
88
            setFlagsOnAllAnnotations(EnumSet.of(AnnotationFlags.PRINT, AnnotationFlags.NOZOOM))
89
            return true
90
        }
91
        return super.onOptionsItemSelected(item)
92
    }
93

94
    override fun onPrepareAnnotationPopupToolbar(toolbar: AnnotationPopupToolbar) {
95
        // Only show the flags button for single annotation selection.
96
        if (toolbar.annotations.size != 1) return
97

98
        val items = toolbar.menuItems.toMutableList()
99
        items.add(PopupToolbarMenuItem(R.id.annotation_flags_popup_button, R.string.annotationFlagsExamplePopupButton))
100
        toolbar.menuItems = items
101

102
        toolbar.setOnPopupToolbarItemClickedListener { item ->
103
            if (item.id == R.id.annotation_flags_popup_button) {
104
                showAnnotationFlagsDialog(toolbar.annotations.first())
105
                true
106
            } else {
107
                false
108
            }
109
        }
110
    }
111

112
    private fun showAnnotationFlagsDialog(annotation: Annotation) {
113
        val flagEntries = buildList {
114
            add(FlagEntry("Read-Only", AnnotationFlags.READONLY))
115
            add(FlagEntry("Hidden", AnnotationFlags.HIDDEN))
116
            add(FlagEntry("Print", AnnotationFlags.PRINT))
117
            add(FlagEntry("No-View", AnnotationFlags.NOVIEW))
118
            add(FlagEntry("Locked", AnnotationFlags.LOCKED))
119
            add(FlagEntry("Locked-Contents", AnnotationFlags.LOCKEDCONTENTS))
120
            if (annotation.type == AnnotationType.NOTE ||
121
                annotation.type == AnnotationType.FREETEXT ||
122
                annotation.type == AnnotationType.FILE ||
123
                annotation.type == AnnotationType.STAMP
124
            ) {
125
                add(FlagEntry("No-Zoom", AnnotationFlags.NOZOOM))
126
            }
127
        }
128

129
        val names = flagEntries.map { it.name }.toTypedArray()
130
        val checked = flagEntries.map { annotation.hasFlag(it.flag) }.toBooleanArray()
131

132
        MaterialAlertDialogBuilder(this)
133
            .setTitle("Annotation Flags")
134
            .setMultiChoiceItems(names, checked) { _, which, isChecked ->
135
                setFlagOnAnnotation(annotation, flagEntries[which].flag, isChecked)
136
            }
137
            .setPositiveButton("Done", null)
138
            .show()
139
    }
140

141
    /** Sets/unsets [AnnotationFlags] on single annotation. */
142
    private fun setFlagOnAnnotation(annotation: Annotation, flag: AnnotationFlags, isSet: Boolean) {
143
        val flags = annotation.flags
144
        if (isSet) {
145
            flags.add(flag)
146
        } else {
147
            flags.remove(flag)
148
        }
149
        annotation.flags = flags
150
    }
151

152
    /** Set flags on all annotations in document. */
153
    private fun setFlagsOnAllAnnotations(newFlags: EnumSet<AnnotationFlags>) {
154
        val doc = document ?: return
155

156
        CoroutineScope(Dispatchers.Main).launch {
157
            try {
158
                val annotations =
159
                    doc.annotationProvider.getAllAnnotationsOfType(
160
                        EnumSet.allOf(AnnotationType::class.java),
161
                    )
162
                annotations.forEach { annotation -> annotation.flags = newFlags }
163
            } catch (e: Exception) {
164
                Log.e(LOG_TAG, "Failed to set flags on annotations", e)
165
            }
166
        }
167
    }
168

169
    private data class FlagEntry(val name: String, val flag: AnnotationFlags)
170

171
    companion object {
172
        private const val LOG_TAG = "AnnotationFlagsActivity"
173
    }
174
}