Disabled Annotation Property

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.java;
9

10
import android.content.Context;
11
import android.content.Intent;
12
import android.net.Uri;
13
import androidx.annotation.NonNull;
14
import androidx.annotation.UiThread;
15
import com.pspdfkit.annotations.AnnotationType;
16
import com.pspdfkit.annotations.configuration.AnnotationConfiguration;
17
import com.pspdfkit.annotations.configuration.AnnotationConfigurationRegistry;
18
import com.pspdfkit.annotations.configuration.AnnotationProperty;
19
import com.pspdfkit.catalog.R;
20
import com.pspdfkit.catalog.SdkExample;
21
import com.pspdfkit.catalog.tasks.ExtractAssetTask;
22
import com.pspdfkit.configuration.activity.PdfActivityConfiguration;
23
import com.pspdfkit.document.PdfDocument;
24
import com.pspdfkit.ui.PdfActivity;
25
import com.pspdfkit.ui.PdfActivityIntentBuilder;
26
import java.util.Arrays;
27
import java.util.List;
28

29
/**
30
 * Showcases how to change {@link AnnotationConfiguration} in order to disable annotation note
31
 * option in the annotation editing toolbar.
32
 */
33
public class DisabledAnnotationPropertyExample extends SdkExample {
34
    public DisabledAnnotationPropertyExample(@NonNull final Context context) {
35
        super(
36
                context,
37
                R.string.disabledAnnotationPropertyExampleTitle,
38
                R.string.disabledAnnotationPropertyExampleDescription);
39
    }
40

41
    @Override
42
    public void launchExample(@NonNull Context context, @NonNull PdfActivityConfiguration.Builder configuration) {
43
        // We use a custom utility class to extract the example document from the assets.
44
        ExtractAssetTask.extract(WELCOME_DOC, getTitle(), context, documentFile -> {
45
            // To start the CustomAnnotationDefaultsManagerActivity we create a launch
46
            // intent using the builder.
47
            final Intent intent = PdfActivityIntentBuilder.fromUri(context, Uri.fromFile(documentFile))
48
                    .configuration(configuration.build())
49
                    .activityClass(DisabledAnnotationPropertyActivity.class)
50
                    .build();
51

52
            context.startActivity(intent);
53
        });
54
    }
55

56
    /**
57
     * Shows how to use {@link AnnotationConfiguration} to disable annotation note option from the
58
     * annotation editing toolbar by removing the {@link AnnotationProperty#ANNOTATION_NOTE} from the
59
     * supported properties.
60
     */
61
    public static class DisabledAnnotationPropertyActivity extends PdfActivity {
62

63
        @UiThread
64
        @Override
65
        public void onDocumentLoaded(@NonNull PdfDocument document) {
66
            super.onDocumentLoaded(document);
67

68
            //noinspection ConstantConditions - When a document is successfully loaded fragment won't be
69
            // null.
70
            AnnotationConfigurationRegistry annotationConfigurationRegistry =
71
                    getPdfFragment().getAnnotationConfiguration();
72

73
            List<AnnotationType> annotationTypesWithNotes = Arrays.asList(
74
                    AnnotationType.INK,
75
                    AnnotationType.LINE,
76
                    AnnotationType.POLYLINE,
77
                    AnnotationType.SQUARE,
78
                    AnnotationType.CIRCLE,
79
                    AnnotationType.POLYGON,
80
                    AnnotationType.FREETEXT,
81
                    AnnotationType.UNDERLINE,
82
                    AnnotationType.SQUIGGLY,
83
                    AnnotationType.STRIKEOUT,
84
                    AnnotationType.HIGHLIGHT,
85
                    AnnotationType.STAMP,
86
                    AnnotationType.FILE,
87
                    AnnotationType.REDACT);
88

89
            // Disable ANNOTATION_NOTE property for every annotation type that supports notes.
90
            for (AnnotationType annotationType : annotationTypesWithNotes) {
91
                annotationConfigurationRegistry.put(
92
                        annotationType,
93
                        AnnotationConfiguration.builder(this, annotationType)
94
                                .disableProperty(AnnotationProperty.ANNOTATION_NOTE)
95
                                .build());
96
            }
97
        }
98
    }
99
}