nutrient/com.pspdfkit.ui/PdfUi

PdfUi

interface PdfUi : PdfActivityListener, PdfActivityComponentsApi

The API that is shared between PdfActivity and PdfUiFragment.

Inheritors

Properties

Link copied to clipboard
val TIMEOUT_DEFAULT: Long = 0
Parameter for setScreenTimeout used for restoring screen timeout to its default system value.
Link copied to clipboard
val TIMEOUT_INFINITE: Long = 9223372036854775807
Parameter for setScreenTimeout used for disabling screen timeout.

Functions

Link copied to clipboard
open fun addPropertyInspectorLifecycleListener(@NonNull lifecycleListener: PropertyInspectorCoordinatorLayoutController.PropertyInspectorLifecycleListener)
Adds the listener for lifecycle changes of the PropertyInspector as it goes through the PropertyInspectorCoordinatorLayout - preparing, displaying, removing.
Link copied to clipboard
@NonNull
abstract fun getConfiguration(): PdfActivityConfiguration
Returns the PdfActivityConfiguration that was provided while launching this pdf UI.
Link copied to clipboard
@Nullable
open fun getDocument(): PdfDocument
Returns the PdfDocument that is loaded into this pdf UI, or null if no document has been loaded yet.
Link copied to clipboard
@NonNull
open fun getDocumentCoordinator(): DocumentCoordinator
Returns the coordinator responsible for displaying documents and switching between multiple loaded documents.
Link copied to clipboard
@IntRange(from = "-1")
open fun getPageIndex(): Int
Returns current page index set on the document.
Link copied to clipboard
@Nullable
open fun getPdfFragment(): PdfFragment
Returns the PdfFragment that is used to show the document.
Link copied to clipboard
@NonNull
open fun getPropertyInspectorCoordinator(): PropertyInspectorCoordinatorLayout
Returns property inspector coordinator layout.
Link copied to clipboard
@NonNull
open fun getPSPDFKitViews(): PSPDFKitViews
Returns object with inflated PSPDFKit views.
Link copied to clipboard
open fun getScreenTimeout(): Long
Gets screen timeout in milliseconds that has been added to the predefined system timeout, TIMEOUT_DEFAULT or TIMEOUT_INFINITE.
Link copied to clipboard
@IntRange(from = "-1")
open fun getSiblingPageIndex(@IntRange(from = 0) pageIndex: Int): Int
Gets page sibling index (usable in double page mode).
Link copied to clipboard
@NonNull
open fun getUserInterfaceViewMode(): UserInterfaceViewMode
Return current user interface view mode that activity is using.
Link copied to clipboard
open fun hideUserInterface()
Animates user interface controls out of view.
Link copied to clipboard
open fun invalidateToolbarItems()
Re-runs the ToolbarItemsProvider and refreshes the main-toolbar items — the declarative analogue of invalidateOptionsMenu().
Link copied to clipboard
open fun isDocumentInteractionEnabled(): Boolean
Indicates whether interaction with the document is enabled right now.
Link copied to clipboard
open fun isImageDocument(): Boolean
Indicates whether the displayed document is an image or not.
Link copied to clipboard
open fun isInlineSearchActive(): Boolean
Checks whether the inline search bar is currently open.
Link copied to clipboard
open fun isUserInterfaceEnabled(): Boolean
Indicates whether UI is enabled right now.
Link copied to clipboard
open fun isUserInterfaceVisible(): Boolean
Checks whether user interface controls are currently visible.
Link copied to clipboard
open fun onConfigurationChanged(@NonNull newConfiguration: Configuration)
Called when a device configuration change occurs.
Link copied to clipboard
open fun removePropertyInspectorLifecycleListener(@NonNull lifecycleListener: PropertyInspectorCoordinatorLayoutController.PropertyInspectorLifecycleListener)
Removes previously registered listener for lifecycle changes of the PropertyInspector as it goes through the PropertyInspectorCoordinatorLayout - preparing, displaying, removing.
Link copied to clipboard
@NonNull
open fun requirePdfFragment(): PdfFragment
Returns the PdfFragment that is used to show the document.
Link copied to clipboard
abstract fun setConfiguration(@NonNull configuration: PdfActivityConfiguration)
Replaces activity configuration.
Link copied to clipboard
open fun setCreationInspectorController(@NonNull creationInspectorController: AnnotatingInspectorController)
Sets controller of the annotation inspector used when creating annotations.
Link copied to clipboard
open fun setDocumentFromDataProvider(@NonNull dataProvider: DataProvider, @Nullable password: String)
Loads a new document in this activity and replaces the existing one.
Link copied to clipboard
open fun setDocumentFromDataProviders(@NonNull dataProviders: List<DataProvider>, @Nullable passwords: List<String>)
Loads a new document in this pdf UI and replaces the existing one.
Link copied to clipboard
open fun setDocumentFromUri(@NonNull documentUri: Uri, @Nullable password: String)
Loads a new document in this activity and replaces the existing one.
Link copied to clipboard
open fun setDocumentFromUris(@NonNull documentUris: List<Uri>, @Nullable passwords: List<String>)
Loads a new document in this activity and replaces the existing one.
Link copied to clipboard
open fun setDocumentInteractionEnabled(documentInteractionEnabled: Boolean)
Enables or disables interaction with the document.
Link copied to clipboard
open fun setDocumentPrintDialogFactory(@Nullable factory: DocumentPrintDialogFactory)
Sets the creator for document print dialogs.
Link copied to clipboard
open fun setDocumentSharingDialogFactory(@Nullable factory: DocumentSharingDialogFactory)
Sets the creator for document sharing dialogs.
Link copied to clipboard
open fun setEditingInspectorController(@NonNull editingInspectorController: AnnotatingInspectorController)
Sets controller of the annotation inspector used when editing annotations.
Link copied to clipboard
open fun setOnToolbarItemClickListener(@Nullable listener: OnToolbarItemClickListener)
Sets the main-toolbar item click listener — the replacement for intercepting onOptionsItemSelected.
Link copied to clipboard
open fun setOnToolbarNavigationClickListener(@Nullable listener: OnToolbarNavigationClickListener)
Sets the handler for taps on the main toolbar's navigation icon — the replacement for Toolbar.setNavigationOnClickListener.
Link copied to clipboard
open fun setPageIndex(@IntRange(from = 0) pageIndex: Int)
open fun setPageIndex(@IntRange(from = 0) pageIndex: Int, animate: Boolean)
Sets page to be displayed in the current document.
Link copied to clipboard
open fun setPrintOptionsProvider(@Nullable provider: PrintOptionsProvider)
Sets the provider for print options.
Link copied to clipboard
open fun setScreenTimeout(screenTimeoutMillis: Long)
Sets screen timeout in milliseconds that will be added to the predefined system timeout (that is usually 1 minute).
Link copied to clipboard
open fun setSharingActionMenuListener(@Nullable listener: ActionMenuListener)
Sets the listener for sharing menu lifecycle and click events.
Link copied to clipboard
open fun setSharingOptionsProvider(@Nullable provider: SharingOptionsProvider)
Sets the provider for sharing options.
Link copied to clipboard
open fun setToolbarItemsProvider(@Nullable provider: ToolbarItemsProvider)
Customizes the main-toolbar items declaratively — the replacement for the removed onCreateOptionsMenu/onPrepareOptionsMenu/OnMenuItemsGenerateListener path.
Link copied to clipboard
open fun setToolbarNavigationIcon(@Nullable icon: ToolbarIcon, @Nullable contentDescription: String)
Sets the main toolbar's navigation (up / back) icon and its accessibility label — the replacement for Toolbar.setNavigationIcon on the removed View toolbar.
Link copied to clipboard
open fun setUserInterfaceEnabled(userInterfaceEnabled: Boolean)
Enables or disables the user interface.
Link copied to clipboard
open fun setUserInterfaceViewMode(@NonNull userInterfaceViewMode: UserInterfaceViewMode)
Sets the activity user interface view mode at a runtime.
Link copied to clipboard
open fun setUserInterfaceVisible(show: Boolean, animate: Boolean)
Show or hide user interface controls.
Link copied to clipboard
open fun showSaveAsDialog()
Shows the "Save As" dialog, letting the user choose a name and a page range for a copy of the current document and then pick where it is written.
Link copied to clipboard
open fun showUserInterface()
Animates user interface controls into view.
Link copied to clipboard
open fun toggleUserInterface()
Toggles the visibility of user interface controls.
Generated by Dokka
© 2026 Copyright