Custom Stamp Annotations

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.graphics.Bitmap;
13
import android.graphics.BitmapFactory;
14
import android.net.Uri;
15
import androidx.annotation.NonNull;
16
import androidx.annotation.Nullable;
17
import androidx.annotation.UiThread;
18
import com.pspdfkit.annotations.Annotation;
19
import com.pspdfkit.annotations.AnnotationProvider;
20
import com.pspdfkit.annotations.AnnotationType;
21
import com.pspdfkit.annotations.appearance.AppearanceStreamGenerator;
22
import com.pspdfkit.annotations.appearance.AssetAppearanceStreamGenerator;
23
import com.pspdfkit.annotations.configuration.StampAnnotationConfiguration;
24
import com.pspdfkit.annotations.stamps.CustomStampAppearanceStreamGenerator;
25
import com.pspdfkit.annotations.stamps.PredefinedStampType;
26
import com.pspdfkit.annotations.stamps.StampPickerItem;
27
import com.pspdfkit.catalog.R;
28
import com.pspdfkit.catalog.SdkExample;
29
import com.pspdfkit.catalog.tasks.ExtractAssetTask;
30
import com.pspdfkit.configuration.activity.PdfActivityConfiguration;
31
import com.pspdfkit.document.PdfDocument;
32
import com.pspdfkit.ui.PdfActivity;
33
import com.pspdfkit.ui.PdfActivityIntentBuilder;
34
import java.io.IOException;
35
import java.util.ArrayList;
36
import java.util.List;
37

38
/**
39
 * Showcases how customize the `StampPickerDialog` with custom set of stamps.
40
 */
41
public class CustomStampAnnotationsExample extends SdkExample {
42

43
    public CustomStampAnnotationsExample(@NonNull final Context context) {
44
        super(
45
                context,
46
                R.string.annotationCustomStampAnnotationExampleTitle,
47
                R.string.annotationCustomStampAnnotationExampleDescription);
48
    }
49

50
    @Override
51
    public void launchExample(
52
            @NonNull final Context context, @NonNull final PdfActivityConfiguration.Builder configuration) {
53
        // Extract the document from the assets. The launched activity will add annotations to that
54
        // document.
55
        ExtractAssetTask.extract(WELCOME_DOC, getTitle(), context, documentFile -> {
56
            // To start the CustomStampAnnotationsActivity create a launch intent using the
57
            // builder.
58
            final Intent intent = PdfActivityIntentBuilder.fromUri(context, Uri.fromFile(documentFile))
59
                    .configuration(configuration.build())
60
                    .activityClass(CustomStampAnnotationsActivity.class)
61
                    .build();
62

63
            // Start the CustomStampAnnotationsActivity for the extracted document.
64
            context.startActivity(intent);
65
        });
66
    }
67

68
    /**
69
     * Shows how to implement custom set of annotations for the `StampPickerDialog`.
70
     */
71
    public static class CustomStampAnnotationsActivity extends PdfActivity {
72

73
        @NonNull
74
        private final String CUSTOM_AP_STREAM_SUBJECT = "CustomApStream";
75

76
        @NonNull
77
        private final CustomStampAppearanceStreamGenerator customStampAppearanceStreamGenerator =
78
                new CustomStampAppearanceStreamGenerator();
79

80
        /**
81
         * Appearance stream generator instance set via {@link
82
         * Annotation#setAppearanceStreamGenerator(AppearanceStreamGenerator)} is not retained after
83
         * reloading the document. Custom appearance stream generated for stamps created via stamp
84
         * picker item created in {@link #createCustomApStreamStampItem} will be retained in he reloaded
85
         * document (and in other PDF viewers), however its appearance will be regenerated with default
86
         * appearance stream after the annotation is modified. This has to be called on the main thread.
87
         *
88
         * <p>We register an instance of {@link CustomStampAppearanceStreamGenerator} on {@link
89
         * AnnotationProvider} to regenerate proper appearance for modified stamps based on their custom
90
         * subject.
91
         *
92
         * @param document Loaded document instance.
93
         */
94
        @UiThread
95
        @Override
96
        public void onDocumentLoaded(@NonNull PdfDocument document) {
97
            super.onDocumentLoaded(document);
98
            document.getAnnotationProvider().addAppearanceStreamGenerator(customStampAppearanceStreamGenerator);
99
            if (getPdfFragment() != null) {
100
                configureStampAnnotationsDefaults();
101
            }
102
        }
103

104
        /**
105
         * Shows how to configure annotation defaults and control which properties are going to be
106
         * displayed in annotation inspector.
107
         */
108
        private void configureStampAnnotationsDefaults() {
109
            // Create list of stamps that are going to be added to the picker.
110
            final List<StampPickerItem> items = new ArrayList<>();
111

112
            // Adding built in stamps.
113
            items.add(StampPickerItem.fromPredefinedType(this, PredefinedStampType.ACCEPTED)
114
                    .build());
115
            items.add(StampPickerItem.fromPredefinedType(this, PredefinedStampType.REJECTED)
116
                    .build());
117

118
            // Adding custom subject stamps.
119
            items.add(StampPickerItem.fromTitle(this, "Great!").build());
120
            items.add(StampPickerItem.fromTitle(this, "Stamp!").build());
121

122
            // Adding custom subject stamps with date-time subtext.
123
            items.add(StampPickerItem.fromTitle(this, "Like")
124
                    .withDateTimeSubtitle(true, true)
125
                    .build());
126

127
            // Adding custom bitmap based stamps.
128
            StampPickerItem bitmapStampItem = createBitmapStampItem();
129
            if (bitmapStampItem != null) {
130
                items.add(bitmapStampItem);
131
            }
132

133
            // Adding custom AP stream based stamps.
134
            items.add(createCustomApStreamStampItem());
135

136
            // Defaults can be configured through PdfFragment for each annotation type.
137
            getPdfFragment()
138
                    .getAnnotationConfiguration()
139
                    .put(
140
                            AnnotationType.STAMP,
141
                            StampAnnotationConfiguration.builder(this)
142
                                    // Here you return list of stamp picker items that are going to be
143
                                    // available in the stamp picker.
144
                                    .setAvailableStampPickerItems(items)
145
                                    .build());
146
        }
147

148
        /** This example shows how to create stamp picker item from bitmap image. */
149
        @Nullable
150
        private StampPickerItem createBitmapStampItem() {
151
            try {
152
                final Bitmap bitmap = BitmapFactory.decodeStream(getAssets().open("media/images/exampleimage.jpg"));
153
                return StampPickerItem.fromBitmap(bitmap)
154
                        .withSize(StampPickerItem.DEFAULT_STAMP_ANNOTATION_PDF_WIDTH)
155
                        .build();
156
            } catch (IOException e) {
157
                e.printStackTrace();
158
            }
159
            return null;
160
        }
161

162
        /**
163
         * This example shows how to create stamp picker item from PDF file containing transparent
164
         * vector image.
165
         */
166
        @NonNull
167
        private StampPickerItem createCustomApStreamStampItem() {
168
            // We supply our logo image from assets.
169
            AssetAppearanceStreamGenerator appearanceStreamGenerator =
170
                    new AssetAppearanceStreamGenerator("images/Nutrient_Logo.pdf");
171

172
            // Create picker item from custom subject with appearance stream generator set.
173
            StampPickerItem stampPickerItem = StampPickerItem.fromTitle(this, CUSTOM_AP_STREAM_SUBJECT)
174
                    .withSize(StampPickerItem.DEFAULT_STAMP_ANNOTATION_PDF_WIDTH)
175
                    .withAppearanceStreamGenerator(appearanceStreamGenerator)
176
                    .build();
177

178
            // We want to generate the same AP stream for all stamps with CUSTOM_AP_STREAM_SUBJECT even
179
            // after the document is reloaded.
180
            // customStampAppearanceStreamGenerator will be registered as appearance
181
            // stream generator for document annotations once the document is loaded.
182
            // see onDocumentLoaded below.
183
            customStampAppearanceStreamGenerator.addAppearanceStreamGenerator(
184
                    CUSTOM_AP_STREAM_SUBJECT, appearanceStreamGenerator);
185

186
            return stampPickerItem;
187
        }
188
    }
189
}