Annotation Selection Customization

1
/*
2
 *   Copyright © 2014-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 android.os.Bundle;
14
import androidx.annotation.NonNull;
15
import com.pspdfkit.annotations.Annotation;
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.ui.PdfActivity;
21
import com.pspdfkit.ui.PdfActivityIntentBuilder;
22
import com.pspdfkit.ui.annotations.OnAnnotationSelectedListener;
23
import com.pspdfkit.ui.special_mode.controller.AnnotationSelectionController;
24

25
/**
26
 * This example showcases how to use {@link AnnotationSelectionController} to dynamically modify
27
 * properties of current annotation selection.
28
 */
29
public class AnnotationSelectionCustomizationExample extends SdkExample {
30

31
    public AnnotationSelectionCustomizationExample(@NonNull final Context context) {
32
        super(
33
                context,
34
                R.string.annotationSelectionControllerExampleTitle,
35
                R.string.annotationSelectionControllerExampleDescription);
36
    }
37

38
    @Override
39
    public void launchExample(
40
            @NonNull final Context context, @NonNull final PdfActivityConfiguration.Builder configuration) {
41
        // Extract the document from the assets.
42
        ExtractAssetTask.extract(WELCOME_DOC, getTitle(), context, documentFile -> {
43
            // To start the AnnotationSelectionCustomizationActivity create a launch intent
44
            // using the builder.
45
            final Intent intent = PdfActivityIntentBuilder.fromUri(context, Uri.fromFile(documentFile))
46
                    .configuration(configuration.build())
47
                    .activityClass(AnnotationSelectionCustomizationActivity.class)
48
                    .build();
49

50
            context.startActivity(intent);
51
        });
52
    }
53

54
    /** Shows how to use {@link AnnotationSelectionController} to control annotation selection. */
55
    public static class AnnotationSelectionCustomizationActivity extends PdfActivity
56
            implements OnAnnotationSelectedListener {
57

58
        @Override
59
        public void onCreate(Bundle savedInstanceState) {
60
            super.onCreate(savedInstanceState);
61

62
            // Register annotation selection listener.
63
            getPdfFragment().addOnAnnotationSelectedListener(this);
64
        }
65

66
        @Override
67
        protected void onDestroy() {
68
            super.onDestroy();
69
            getPdfFragment().removeOnAnnotationSelectedListener(this);
70
        }
71

72
        @Override
73
        public boolean onPrepareAnnotationSelection(
74
                @NonNull AnnotationSelectionController controller,
75
                @NonNull Annotation annotation,
76
                boolean annotationCreated) {
77
            switch (annotation.getType()) {
78
                case STAMP:
79
                    // Allow dragging and resizing stamp annotations only when being created. Afterwards
80
                    // they are fixed in place.
81
                    if (!annotationCreated) {
82
                        // Disable resizing and dragging for selected stamp annotation.
83
                        controller.setResizeEnabled(false);
84
                        controller.setDraggingEnabled(false);
85
                    }
86
                    break;
87
                case INK:
88
                    // Keep aspect ratio when resizing ink annotations.
89
                    controller.setKeepAspectRatioEnabled(true);
90
                    break;
91
                case FREETEXT:
92
                    // Prevent selection for free-text annotations that are not being created.
93
                    return annotationCreated;
94
                default:
95
            }
96
            // Return true here to proceed with selection. Returning false will prevent the selection.
97
            return true;
98
        }
99

100
        @Override
101
        public void onAnnotationSelected(@NonNull Annotation annotation, boolean annotationCreated) {
102
            // Nothing to do here.
103
        }
104
    }
105
}