fluid-pdf/io.fluidsonic.pdf

Package-level declarations

Types

ChromiumPdfGenerator

interface ChromiumPdfGenerator : PdfGenerator, Closeable

LazyChromiumPdfGenerator

interface LazyChromiumPdfGenerator : ChromiumPdfGenerator

PdfDocumentId

data class PdfDocumentId(val initial: String, val revision: String = initial)

PdfEncryption

data class PdfEncryption(val ownerPassword: String, val permissions: PdfPermissions, val userPassword: String? = null)

PdfGenerationInput

data class PdfGenerationInput(val source: PdfGenerationSource, val settings: PdfGenerationSettings = PdfGenerationSettings.default)

PdfGenerationOutput

interface PdfGenerationOutput

PdfGenerationSettings

data class PdfGenerationSettings(val encryption: PdfEncryption? = null, val footerHtml: String? = null, val headerHtml: String? = null, val includeBackgrounds: Boolean, val metadata: PdfMetadata? = null, val pageMargins: PdfMargins, val pageOrientation: PdfOrientation, val pageSize: PdfSize, val preferCssPageSize: Boolean)

PdfGenerationSource

sealed class PdfGenerationSource

PdfGenerator

interface PdfGenerator

PdfLengthUnit

@JvmInline

value class PdfLengthUnit

PdfMargins

data class PdfMargins(val top: PdfLengthUnit, val right: PdfLengthUnit, val bottom: PdfLengthUnit, val left: PdfLengthUnit)

PdfMetadata

data class PdfMetadata(val author: String? = null, val creationDate: Instant? = null, val creator: String? = null, val documentId: PdfDocumentId? = null, val keywords: String? = null, val modificationDate: Instant? = null, val producer: String? = null, val subject: String? = null, val title: String? = null)

PdfOrientation

enum PdfOrientation : Enum<PdfOrientation>

PdfPermissions

data class PdfPermissions(val annotationAndFormFieldModificationAllowed: Boolean, val assemblyAllowed: Boolean, val contentExtractionAllowed: Boolean, val contentExtractionForAccessibilityAllowed: Boolean, val contentModificationAllowed: Boolean, val formFieldFillingAllowed: Boolean, val printQuality: PdfPermissions.PrintQuality)

Permissions that apply to the user if the PDF is encrypted.

PdfSize

data class PdfSize(val width: PdfLengthUnit, val height: PdfLengthUnit)

Functions

generate

suspend fun PdfGenerator.generate(source: PdfGenerationSource, settings: PdfGenerationSettings = PdfGenerationSettings.default): PdfGenerationOutput