Instant JSON Attachment

1
/*
2
 *   Copyright © 2022-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.graphics.Bitmap
12
import android.graphics.BitmapFactory
13
import android.graphics.RectF
14
import android.net.Uri
15
import androidx.activity.viewModels
16
import com.pspdfkit.annotations.StampAnnotation
17
import com.pspdfkit.catalog.R
18
import com.pspdfkit.catalog.SdkExample
19
import com.pspdfkit.catalog.tasks.ExtractAssetTask
20
import com.pspdfkit.configuration.activity.PdfActivityConfiguration
21
import com.pspdfkit.document.PdfDocument
22
import com.pspdfkit.document.providers.InputStreamDataProvider
23
import com.pspdfkit.ui.PdfActivity
24
import com.pspdfkit.ui.PdfActivityIntentBuilder
25
import kotlinx.coroutines.runBlocking
26
import java.io.File
27
import java.io.FileOutputStream
28
import java.io.FileWriter
29
import java.io.IOException
30
import java.io.InputStream
31
import kotlin.getValue
32

33
/**
34
 * Example showing how to export and import instant JSON attachment binaries.
35
 *
36
 */
37
class InstantJsonAttachmentExample(context: Context) :
38
    SdkExample(
39
        context,
40
        R.string.instantJsonAttachmentTitle,
41
        R.string.instantJsonAttachmentDescription,
42
    ) {
43
    override fun launchExample(context: Context, configuration: PdfActivityConfiguration.Builder) {
44
        // We turn off auto save to avoid saving redundant annotations.
45
        configuration.autosaveEnabled(false)
46

47
        // We use a custom utility class to extract the example document from the assets.
48
        ExtractAssetTask.extract(WELCOME_DOC, title, context) { documentFile ->
49
            // To start the `InstantJsonAttachmentExampleActivity` create a launch intent using the builder.
50
            val intent =
51
                PdfActivityIntentBuilder
52
                    .fromUri(context, Uri.fromFile(documentFile))
53
                    .configuration(configuration.build())
54
                    .activityClass(InstantJsonAttachmentExampleActivity::class)
55
                    .build()
56
            context.startActivity(intent)
57
        }
58
    }
59
}
60

61
/**
62
 * This example activity subclasses [PdfActivity], and it demonstrates how to export and import instant JSON attachment binaries using
63
 * instant JSON Attachment APIs.
64
 */
65
class InstantJsonAttachmentExampleActivity : PdfActivity() {
66
    private val viewModel: AnnotationCreationViewModel by viewModels()
67

68
    override fun onDocumentLoaded(document: PdfDocument) {
69
        super.onDocumentLoaded(document)
70

71
        viewModel.createObjects {
72
            // Create a stamp annotation from an image bitmap.
73
            val annotationBitmap = getBitmapFromAsset()
74
            val stampAnnotation =
75
                StampAnnotation(
76
                    0,
77
                    RectF(100f, (annotationBitmap.height / 2) + 100f, (annotationBitmap.width / 2) + 100f, 100f),
78
                    annotationBitmap,
79
                )
80

81
            // Add the stamp annotation to the document.
82
            runBlocking { document.annotationProvider.addAnnotationToPage(stampAnnotation) }
83

84
            // Export START.
85

86
            // Convert annotation to instant JSON.
87
            val jsonData = stampAnnotation.toInstantJson()
88

89
            // Prepare a file to store the image attachment.
90
            val tempBinaryAttachmentJsonFile = File.createTempFile("tmp_", "stampAnnotationBinaryJsonAttachment.jpeg")
91
            val outputStream = FileOutputStream(tempBinaryAttachmentJsonFile)
92

93
            // Write the Instant JSON attachment data to the file.
94
            if (stampAnnotation.hasBinaryInstantJsonAttachment()) {
95
                stampAnnotation.fetchBinaryInstantJsonAttachment(outputStream)
96
            }
97

98
            // Save the JSON data in a file.
99
            val tempJsonFile = File.createTempFile("tmp_", "stampAnnotationJson.txt")
100
            FileWriter(tempJsonFile).use { w -> w.write(jsonData) }
101
            // Export END.
102

103
            // Let's remove the annotation to try the import feature.
104
            runBlocking { document.annotationProvider.removeAnnotationFromPage(stampAnnotation) }
105

106
            // Import START.
107
            val anotherStampAnnotation = runBlocking { document.annotationProvider.createAnnotationFromInstantJson(jsonData) }
108

109
            anotherStampAnnotation.attachBinaryInstantJsonAttachment(FileDataProvider(tempBinaryAttachmentJsonFile), "image/jpeg")
110
            // Import END.
111
        }
112
    }
113

114
    /** Decodes bitmap from application's assets. */
115
    private fun getBitmapFromAsset(): Bitmap = try {
116
        val inputStream = assets.open("images/android.png")
117
        BitmapFactory.decodeStream(inputStream)
118
    } catch (ioException: IOException) {
119
        throw RuntimeException("Error while trying to load PNG from assets: images/android.png", ioException)
120
    }
121
}
122

123
/**
124
 * Data provider that handles serving data from [File].
125
 */
126
open class FileDataProvider(val file: File) : InputStreamDataProvider() {
127
    override fun getSize(): Long = file.length()
128

129
    override fun getUid(): String = file.canonicalPath
130

131
    override fun openInputStream(): InputStream = file.inputStream()
132

133
    override fun getTitle(): String? = file.nameWithoutExtension
134
}