nutrient/com.pspdfkit.ui/PdfFragment/Companion

Companion

object Companion

Factory methods and bundle argument keys for PdfFragment.

Properties

const val DEFAULT_ZOOM: Float = 1.0f

Default zoom scale.

DOCUMENT_VIEW_ID

val DOCUMENT_VIEW_ID: Int

Resource ID for the document view within the fragment layout.

DOCUMENTSTORE_KEY_LAST_VIEWED_PAGE_INDEX

const val DOCUMENTSTORE_KEY_LAST_VIEWED_PAGE_INDEX: String

Key for storing the last viewed page index inside the DocumentDataStore of the loaded document. The last viewed page index is only read or written if PdfConfiguration.isLastViewedPageRestorationEnabled is set to true. If page restoration is disabled, the fragment won't access or modify the document store and any previously written value. The value is saved to the store inside onStop.

const val MAX_ZOOM: Float = 40.0f

Maximum zoom scale. configurable in PdfConfiguration see maxZoomScale.

const val MIN_ZOOM: Float = 0.9f

Min allowed zoom (before snapping back).

PARAM_CONFIGURATION

const val PARAM_CONFIGURATION: String

Bundle argument key for the PDF configuration.

PARAM_IMAGE_DOCUMENT_SOURCE

const val PARAM_IMAGE_DOCUMENT_SOURCE: String

Bundle argument key for image document source.

const val PARAM_SOURCES: String

Bundle argument key for document sources.

Functions

newImageInstance

fun newImageInstance(documentUri: Uri, configuration: PdfConfiguration): PdfFragment

fun newImageInstance(source: DocumentSource, configuration: PdfConfiguration): PdfFragment

fun newImageInstance(source: DataProvider, configuration: PdfConfiguration): PdfFragment

Creates and returns a new Fragment to display a converted PDF document from a supported image format.

fun newInstance(documentUri: Uri, configuration: PdfConfiguration): PdfFragment

fun newInstance(documentUri: Uri, password: String?, configuration: PdfConfiguration): PdfFragment

fun newInstance(documentUri: Uri, password: String?, contentSignature: String?, configuration: PdfConfiguration): PdfFragment

Creates and returns a new Fragment to display a PDF document.

fun newInstance(document: PdfDocument, configuration: PdfConfiguration): PdfFragment

Creates and returns a new Fragment to display a PDF document from an already opened PdfDocument instance. This will not reload the document.

fun newInstance(fragment: PdfFragment, configuration: PdfConfiguration): PdfFragment

Creates and returns a new Fragment to display a PDF document from an PdfFragment. This will copy the state of the given Fragment while applying the new configuration.

fun newInstance(documentUris: List<Uri>, configuration: PdfConfiguration): PdfFragment

fun newInstance(documentUris: List<Uri>, documentPasswords: List<String>?, configuration: PdfConfiguration): PdfFragment

fun newInstance(documentUris: List<Uri>, documentPasswords: List<String>?, documentContentSignatures: List<String>?, configuration: PdfConfiguration): PdfFragment

Creates and returns a new Fragment to display passed list of PDF documents as a single compound document.

fun newInstance(source: DataProvider, password: String?, configuration: PdfConfiguration): PdfFragment

Creates and returns a new Fragment to display a PDF document from a custom data source.

fun newInstance(source: DataProvider, password: String?, contentSignature: String?, configuration: PdfConfiguration): PdfFragment

Creates and returns a new Fragment to display a PDF document from a custom data source

newInstanceFromDocumentSources

fun newInstanceFromDocumentSources(sources: List<DocumentSource>, configuration: PdfConfiguration): PdfFragment

Creates and returns a new Fragment to display a PDF document from the given DocumentSources.

newInstanceFromSources

fun newInstanceFromSources(sources: List<DataProvider>, configuration: PdfConfiguration): PdfFragment

fun newInstanceFromSources(sources: List<DataProvider>, passwords: List<String>?, configuration: PdfConfiguration): PdfFragment

fun newInstanceFromSources(sources: List<DataProvider>, passwords: List<String>?, contentSignatures: List<String>?, configuration: PdfConfiguration): PdfFragment

Creates and returns a new Fragment to display a PDF document from a custom data source as a compound document.