pspdfkit/com.pspdfkit.ui/PdfUiFragmentBuilder

PdfUiFragmentBuilder

class PdfUiFragmentBuilder : BasePdfUiBuilder<T>

Builder used for creating an PdfUiFragment. Allows setting the document and all of the necessary configuration such as document sources, passwords, etc.

Functions

Link copied to clipboard
@NonNull
open fun build(): PdfUiFragment
Builds PdfUiFragment with the values provided in the PdfUiFragmentBuilder.
Link copied to clipboard
@NonNull
open fun configuration(@Nullable configuration: PdfActivityConfiguration): PdfUiFragmentBuilder
Sets PdfActivityConfiguration to be set on the target PdfUiFragment in which the document(s) will be displayed.
Link copied to clipboard
@NonNull
open fun contentSignatures(@Nullable contentSignatures: Array<String>): PdfUiFragmentBuilder
Sets list of content signatures for when the opened document is merged from several documents or for a single document.
Link copied to clipboard
@NonNull
open fun emptyFragment(@NonNull context: Context): PdfUiFragmentBuilder
Creates a new fragment builder with no document, this is useful if you provide custom UI inside your PdfUiFragment subclass to open new documents.
Link copied to clipboard
@NonNull
open fun fragmentClass(@Nullable fragmentClass: Class<out PdfUiFragment>): PdfUiFragmentBuilder
Sets a custom fragment class used for document display.
Link copied to clipboard
open fun fromDataProvider(@NonNull context: Context, @NonNull dataProviders: Array<DataProvider>): PdfUiFragmentBuilder
Creates a new fragment builder with document being loaded from data provider.
Link copied to clipboard
@NonNull
open fun fromDocumentDescriptor(@NonNull context: Context, @NonNull documentDescriptor: Array<DocumentDescriptor>): PdfUiFragmentBuilder
Creates a new fragment builder with document describe by DocumentDescriptor.
Link copied to clipboard
open fun fromImageProvider(@NonNull context: Context, @NonNull dataProvider: DataProvider): PdfUiFragmentBuilder
Creates a new fragment builder with an image document being loaded from data provider.
Link copied to clipboard
open fun fromImageUri(@NonNull context: Context, @NonNull uri: Uri): PdfUiFragmentBuilder
Creates a new fragment builder with image document being loaded from Uri.
Link copied to clipboard
open fun fromUri(@NonNull context: Context, @NonNull uris: Array<Uri>): PdfUiFragmentBuilder
Creates a new fragment builder with document being loaded from URI.
Link copied to clipboard
@NonNull
open fun passwords(@Nullable passwords: Array<String>): PdfUiFragmentBuilder
Sets list of passwords for when the opened document is merged from several documents or for a single document.
Link copied to clipboard
@NonNull
open fun pdfFragmentTag(@Nullable pdfFragmentTag: String): PdfUiFragmentBuilder
Sets a custom fragment tag to be used with the internal PdfFragment.
Link copied to clipboard
@NonNull
open fun visibleDocument(visibleDocumentIndex: Int): PdfUiFragmentBuilder
Sets index of the document that should be visible after opening the fragment.