nutrient/com.pspdfkit.document

Package-level declarations

PDF document API (classes for accessing document content and meta-data).

Types

data class Destination(val pageIndex: Int, val type: DestinationType, val left: Float, val top: Float, val width: Float, val height: Float, val zoom: Float)

A destination defines a particular view of a document, consisting of the following items:

DestinationType

enum DestinationType : Enum<DestinationType>

This enumeration defines a particular view of a document, part of a Destination.

DocumentActionListener

interface DocumentActionListener

Handles PDF actions triggered inside the PDF document - these are usually things like button presses, form submission, etc.

DocumentPermissions

enum DocumentPermissions

A set of flags specifying which operations shall be permitted when the document is opened with user access.

DocumentSaveOptions

open class DocumentSaveOptions

Configures options for saving a document.

DocumentSource

class DocumentSource

Represents a document source which may be a DataProvider or a file Uri.

ImageDocument

interface ImageDocument

An image document.

ImageDocumentLoader

object ImageDocumentLoader

Helper class for loading ImageDocument from a DocumentSource.

ImageDocumentUtils

open class ImageDocumentUtils

Collection of helper methods for working with ImageDocuments.

OutlineElement

data class OutlineElement(val title: String, val color: Int = DEFAULT_COLOR, val style: Int = Typeface.NORMAL, val typeface: Typeface? = Typeface.DEFAULT, val isExpanded: Boolean = false, val action: Action? = null, val pageLabel: String? = null, val children: List<OutlineElement> = emptyList())

A document outline element (or "table of contents entry"), usually the header of a chapter. Outline elements can be retrieved via PdfDocument.getOutline. They can carry an Action and thus allow quick navigation to document pages, or even external resources.

OutlineElementState

enum OutlineElementState : Enum<OutlineElementState>

State to manage if outline elements are expanded or collapsed

PageBinding

enum PageBinding : Enum<PageBinding>

Enum of the possible page bindings deciding how the document will be displayed.

PdfBox

enum PdfBox

Types of supported PDF page boxes.

PdfDocument

interface PdfDocument

A PDF document.