Generate PDF report 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
// We're temporarily suppressing the ProgressDialog being deprecated warning.
9
// Issue: https://github.com/PSPDFKit/PSPDFKit/issues/32215
10
@file:Suppress("DEPRECATION")
11

12
package com.pspdfkit.catalog.examples.kotlin
13

14
import android.app.ProgressDialog
15
import android.content.Context
16
import android.graphics.BitmapFactory
17
import android.graphics.Color
18
import android.graphics.Paint
19
import android.graphics.RectF
20
import android.net.Uri
21
import android.text.TextPaint
22
import com.pspdfkit.annotations.FreeTextAnnotation
23
import com.pspdfkit.annotations.StampAnnotation
24
import com.pspdfkit.annotations.appearance.AssetAppearanceStreamGenerator
25
import com.pspdfkit.catalog.R
26
import com.pspdfkit.catalog.SdkExample
27
import com.pspdfkit.configuration.activity.PdfActivityConfiguration
28
import com.pspdfkit.document.DocumentPermissions
29
import com.pspdfkit.document.DocumentSaveOptions
30
import com.pspdfkit.document.DocumentSource
31
import com.pspdfkit.document.PdfDocument
32
import com.pspdfkit.document.PdfDocumentLoader
33
import com.pspdfkit.document.processor.NewPage
34
import com.pspdfkit.document.processor.PageCanvas
35
import com.pspdfkit.document.processor.PagePattern
36
import com.pspdfkit.document.processor.PdfProcessor
37
import com.pspdfkit.document.processor.PdfProcessorTask
38
import com.pspdfkit.document.providers.AssetDataProvider
39
import com.pspdfkit.ui.PdfActivity
40
import com.pspdfkit.utils.Size
41
import io.reactivex.rxjava3.android.schedulers.AndroidSchedulers
42
import io.reactivex.rxjava3.core.Single
43
import io.reactivex.rxjava3.disposables.Disposable
44
import io.reactivex.rxjava3.schedulers.Schedulers
45
import java.io.File
46
import java.io.IOException
47
import java.util.EnumSet
48

49
/**
50
 * This example shows how to programmatically create a PDF report.
51
 */
52
class GenerateReportExample(context: Context) : SdkExample(context, R.string.generateReportExampleTitle, R.string.generateReportExampleDescription) {
53

54
    /**
55
     * Disposable used to cancel the [com.pspdfkit.document.processor.PdfProcessor]
56
     * report generation when canceling the progress dialog.
57
     */
58
    private var generationDisposable: Disposable? = null
59

60
    override fun launchExample(context: Context, configuration: PdfActivityConfiguration.Builder) {
61
        val dialog = ProgressDialog.show(context, "Generating Report", "Please wait", true, true) {
62
            generationDisposable?.dispose()
63
        }
64

65
        generationDisposable = Single.fromCallable {
66
            // Open the document we are going to take the first and last page from.
67
            val sourceDocument = PdfDocumentLoader.openDocument(context, DocumentSource(AssetDataProvider("AnnualReport.pdf")))
68
            val pageSize = sourceDocument.getPageSize(0)
69

70
            // Create PDF processor task from the document.
71
            val task = PdfProcessorTask.fromDocument(sourceDocument)
72

73
            // Keep only the first and the last page of the original document.
74
            // Keep only the first and the last page of the original document.
75
            val pagesToRemove = mutableSetOf<Int>()
76
            for (i in 1 until sourceDocument.pageCount - 1) {
77
                pagesToRemove.add(i)
78
            }
79
            task.removePages(pagesToRemove)
80

81
            // Add a newly created single-paged document as the second page of the report
82
            val secondPageDocument = generateSecondPage(pageSize, context)
83
            task.addNewPage(NewPage.fromPage(secondPageDocument, 0).build(), 1)
84

85
            // Add a new page with a pattern grid as the third page of the report.
86
            task.addNewPage(
87
                NewPage.patternPage(pageSize, PagePattern.GRID_5MM)
88
                    .backgroundColor(Color.WHITE)
89
                    .build(),
90
                2
91
            )
92

93
            // Add a page from an existing document.
94
            val importDocument = PdfDocumentLoader.openDocument(context, DocumentSource(AssetDataProvider("Aviation.pdf")))
95
            task.addNewPage(NewPage.fromPage(importDocument, 0).build(), 3)
96

97
            // Scale the recently added page to the first page size
98
            task.resizePage(3, pageSize)
99

100
            // Draw "Generated for John Doe. Page X" watermark on every page
101
            drawWatermark("John Doe", task, pageSize, 5)
102

103
            // Flatten all annotations.
104
            task.changeAllAnnotations(PdfProcessorTask.AnnotationProcessingMode.FLATTEN)
105

106
            // Only allow opening by users that know the password.
107
            val password = "password"
108
            val saveOptions = DocumentSaveOptions(
109
                password,
110
                EnumSet.of(DocumentPermissions.PRINTING),
111
                false,
112
                null
113
            )
114

115
            // Finally create the resulting document.
116
            val generatedReportFile = File(context.getDir("documents", Context.MODE_PRIVATE), "generated-report.pdf")
117
            PdfProcessor.processDocument(task, generatedReportFile, saveOptions)
118

119
            return@fromCallable Uri.fromFile(generatedReportFile)
120
        }.subscribeOn(Schedulers.io())
121
            .observeOn(AndroidSchedulers.mainThread())
122
            .doFinally { dialog.cancel() }
123
            // Open the produced document in PdfActivity.
124
            .subscribe { uri -> PdfActivity.showDocument(context, uri, configuration.build()) }
125
    }
126

127
    @Throws(IOException::class)
128
    private fun generateSecondPage(pageSize: Size, context: Context): PdfDocument {
129
        // Create a separate single-paged document, which will be added as the second page of the report.
130

131
        // Start with the empty page.
132
        val task = PdfProcessorTask.newPage(NewPage.emptyPage(pageSize).backgroundColor(Color.WHITE).build())
133

134
        // Invoke processor to create new document.
135
        val tempFile = File.createTempFile("second_page", null, context.cacheDir)
136
        PdfProcessor.processDocument(task, tempFile)
137

138
        // Create the document which will be the report's second page
139
        val pageDocument = PdfDocumentLoader.openDocument(context, Uri.fromFile(tempFile))
140

141
        // Create a free text annotation as the title of the page.
142
        FreeTextAnnotation(
143
            0,
144
            RectF(228f, 1024f, 828f, 964f),
145
            "Some Annotations"
146
        ).apply {
147
            textSize = 40f
148

149
            pageDocument.annotationProvider.addAnnotationToPage(this)
150
        }
151

152
        // Create a vector stamp annotation.
153
        StampAnnotation(
154
            0,
155
            RectF(50f, 724f, 250f, 524f),
156
            "Stamp with custom AP stream"
157
        ).apply {
158
            // Set PDF from assets containing vector logo as annotation's appearance stream generator.
159
            appearanceStreamGenerator = AssetAppearanceStreamGenerator("images/Nutrient_Logo.pdf")
160

161
            pageDocument.annotationProvider.addAnnotationToPage(this)
162
        }
163

164
        // Create a free-text annotation as a label of the vector stamp.
165
        FreeTextAnnotation(
166
            0,
167
            RectF(67f, 520f, 667f, 420f),
168
            "The logo above is a vector stamp annotation."
169
        ).apply {
170
            textSize = 18f
171
            pageDocument.annotationProvider.addAnnotationToPage(this)
172
        }
173

174
        // Create an image stamp annotation.
175
        val image = BitmapFactory.decodeStream(context.assets.open("images/android.png"))
176
        StampAnnotation(
177
            0,
178
            RectF(60f, 400f, (60 + image.width / 4).toFloat(), (400 - image.height / 4).toFloat()),
179
            image
180
        ).let { pageDocument.annotationProvider.addAnnotationToPage(it) }
181

182
        // Create a free-text annotation as a label of the image stamp
183
        FreeTextAnnotation(
184
            0,
185
            RectF(67f, 240f, 667f, 160f),
186
            "The image above is an image stamp annotation."
187
        ).apply {
188
            textSize = 18f
189
            pageDocument.annotationProvider.addAnnotationToPage(this)
190
        }
191

192
        // Flatten all annotations
193
        val flattenedTempFile = File.createTempFile("flattened_second_page", null, context.cacheDir)
194
        val flattenTask = PdfProcessorTask.fromDocument(pageDocument)
195
        flattenTask.changeAllAnnotations(PdfProcessorTask.AnnotationProcessingMode.FLATTEN)
196
        PdfProcessor.processDocument(flattenTask, flattenedTempFile)
197

198
        return PdfDocumentLoader.openDocument(context, Uri.fromFile(flattenedTempFile))
199
    }
200

201
    private fun drawWatermark(name: String, task: PdfProcessorTask, pageSize: Size, pageCount: Int) {
202
        val textPaint = TextPaint().apply {
203
            textSize = 30f
204
            color = Color.argb(128, 255, 0, 0)
205
            textAlign = Paint.Align.CENTER
206
        }
207

208
        for (pageIndex in 0 until pageCount) {
209
            val canvas = PageCanvas(pageSize) { canvas ->
210
                canvas.drawText(
211
                    "Generated for $name. Page ${pageIndex + 1}",
212
                    pageSize.width / 2,
213
                    pageSize.height - 100,
214
                    textPaint
215
                )
216
            }
217
            task.addCanvasDrawingToPage(canvas, pageIndex)
218
        }
219
    }
220

221
    override fun onDestroy() {
222
        super.onDestroy()
223
        generationDisposable?.dispose()
224
    }
225
}