Add file to PDF in Kotlin for Android

1
/*
2
 *   Copyright © 2020-2025 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.Color
12
import android.graphics.RectF
13
import android.net.Uri
14
import androidx.activity.viewModels
15
import androidx.annotation.UiThread
16
import com.pspdfkit.annotations.FileAnnotation
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.files.EmbeddedFileSource
23
import com.pspdfkit.document.providers.AssetDataProvider
24
import com.pspdfkit.ui.PdfActivity
25
import com.pspdfkit.ui.PdfActivityIntentBuilder
26

27
/**
28
 * This example shows how to create file annotations programmatically.
29
 */
30
class FileAnnotationCreationExample(context: Context) : SdkExample(
31
    context,
32
    R.string.fileAnnotationCreationExampleTitle,
33
    R.string.fileAnnotationCreationExampleDescription
34
) {
35
    override fun launchExample(context: Context, configuration: PdfActivityConfiguration.Builder) {
36
        // Turn off saving, so we have the clean original document every time the example is launched.
37
        configuration.autosaveEnabled(false)
38

39
        // Extract the document from the assets. The launched activity will add file annotations to that document.
40
        ExtractAssetTask.extract(WELCOME_DOC, title, context) { documentFile ->
41
            val intent = PdfActivityIntentBuilder.fromUri(context, Uri.fromFile(documentFile))
42
                .configuration(configuration.build())
43
                .activityClass(FileAnnotationCreationActivity::class.java)
44
                .build()
45
            context.startActivity(intent)
46
        }
47
    }
48
}
49

50
class FileAnnotationCreationActivity : PdfActivity() {
51

52
    private val viewModel: AnnotationCreationViewModel by viewModels()
53

54
    @UiThread
55
    override fun onDocumentLoaded(document: PdfDocument) {
56
        viewModel.createObjects {
57
            val pageIndex = 0
58

59
            // Create file annotation with embedded pdf file.
60
            // File description and modification date is optional.
61
            val fileAnotation = FileAnnotation(
62
                pageIndex,
63
                RectF(180f, 692f, 212f, 660f),
64
                EmbeddedFileSource(
65
                    AssetDataProvider("Annotations.pdf"),
66
                    "Annotations.pdf",
67
                    null
68
                )
69
            ).apply {
70
                iconName = FileAnnotation.GRAPH
71
                color = Color.GREEN
72
            }
73
            requirePdfFragment().addAnnotationToPage(fileAnotation, false)
74

75
            // Create file annotation with embedded image file.
76
            val imageFileAnnotation = FileAnnotation(
77
                pageIndex,
78
                RectF(244f, 692f, 276f, 660f),
79
                EmbeddedFileSource(
80
                    AssetDataProvider("images/android.png"),
81
                    "android.png",
82
                    null
83
                )
84
            ).apply {
85
                iconName = FileAnnotation.PAPERCLIP
86
                color = Color.BLUE
87
            }
88
            requirePdfFragment().addAnnotationToPage(imageFileAnnotation, false)
89

90
            // Create file annotation with embedded video file.
91
            val videoFileAnnotation = FileAnnotation(
92
                pageIndex,
93
                RectF(308f, 692f, 340f, 660f),
94
                EmbeddedFileSource(
95
                    AssetDataProvider("media/videos/small.mp4"),
96
                    "small.mp4",
97
                    "Example of an annotation with embedded video file."
98
                )
99
            ).apply {
100
                iconName = FileAnnotation.PUSH_PIN
101
                color = Color.RED
102
            }
103
            requirePdfFragment().addAnnotationToPage(videoFileAnnotation, false)
104

105
            // File source can also be directly specified as byte array with file's data.
106
            // In this case we create file annotation from UTF-8 encoded string.
107
            val textFileAnnotation = FileAnnotation(
108
                pageIndex,
109
                RectF(372f, 692f, 404f, 660f),
110
                EmbeddedFileSource(
111
                    "Plain text data".toByteArray(),
112
                    "note.txt",
113
                    "Example of an annotation with embedded plain-text file."
114
                )
115
            ).apply {
116
                iconName = FileAnnotation.TAG
117
                color = Color.YELLOW
118
            }
119
            requirePdfFragment().addAnnotationToPage(textFileAnnotation, false)
120
        }
121
    }
122
}