nutrient/com.pspdfkit.ui/DocumentDescriptor

DocumentDescriptor

open class DocumentDescriptor : Parcelable

Describes a document and its UI state. The DocumentDescriptor is used by the PdfActivity's DocumentCoordinator to handle multiple loaded documents and to manage their state.

Document is represented by the list of parcelable DocumentSources. Descriptor also holds loaded PdfDocument after it's loaded by the DocumentCoordinator. Note that this PdfDocument instance won't be restored after reading from the parcel - it must be loaded again in this case.

Properties

val CREATOR: Parcelable.Creator<DocumentDescriptor>

Creator for Parcelable implementation.

open val customTitle: String

Custom title that will be displayed in the UI instead of document title.

open var document: PdfDocument

The loaded PDF document instance, or null if not yet loaded.

documentSources

val documentSources: List<DocumentSource>

The list of document sources from which the document is loaded.

isImageDocument

val isImageDocument: Boolean

Whether this descriptor represents an image document rather than a PDF.

open var state: Bundle

The UI state bundle associated with this document.

Functions

describeContents

open fun describeContents(): Int

Describes the kinds of special objects contained in this Parcelable instance.

fromDataProvider

open fun fromDataProvider(@NonNull dataProvider: DataProvider): DocumentDescriptor

open fun fromDataProvider(@NonNull dataProvider: DataProvider, @Nullable password: String): DocumentDescriptor

open fun fromDataProvider(@NonNull dataProvider: DataProvider, @Nullable password: String, @Nullable contentSignature: String): DocumentDescriptor

Creates descriptor for document loaded from data provider.

fromDataProviders

open fun fromDataProviders(@NonNull dataProviders: List<DataProvider>, @Nullable passwords: List<String>, @Nullable contentSignatures: List<String>): DocumentDescriptor

Creates descriptor for compound document loaded from data providers.

open fun fromDocument(@NonNull document: PdfDocument): DocumentDescriptor

Creates descriptor for loaded document.

fromDocumentSource

open fun fromDocumentSource(@NonNull documentSource: DocumentSource): DocumentDescriptor

Creates descriptor for document loaded from document source.

fromDocumentSources

open fun fromDocumentSources(@NonNull documentSources: List<DocumentSource>): DocumentDescriptor

Creates descriptor for compound document loaded from document sources.

open fun fromUri(@NonNull documentUri: Uri): DocumentDescriptor

open fun fromUri(@NonNull documentUri: Uri, @Nullable password: String): DocumentDescriptor

Creates descriptor for document loaded from URI.

open fun fromUris(@NonNull documentUris: List<Uri>, @Nullable passwords: List<String>, @Nullable contentSignatures: List<String>): DocumentDescriptor

Creates descriptor for compound document loaded from multiple URIs.

getDocumentSource

open fun getDocumentSource(): DocumentSource

Returns source from which the document should be loaded.

open fun getTitle(@NonNull context: Context): String

Returns displayable document title.

open fun getUid(): String

Returns unique document ID.

imageDocumentFromDataProvider

open fun imageDocumentFromDataProvider(@NonNull dataProvider: DataProvider): DocumentDescriptor

Creates descriptor for image document loaded from data provider.

imageDocumentFromDocumentSource

open fun imageDocumentFromDocumentSource(@NonNull documentSource: DocumentSource): DocumentDescriptor

Creates descriptor for image document loaded from a document source.

imageDocumentFromUri

open fun imageDocumentFromUri(@NonNull uri: Uri): DocumentDescriptor

Creates descriptor for image document loaded from URI.

open fun setTitle(@Nullable title: String)

Sets a custom displayable document title.

open fun writeToParcel(@NonNull dest: Parcel, flags: Int)

Writes this document descriptor to a Parcel.