nutrient/com.pspdfkit.ui.thumbnail/PdfThumbnailBarController

PdfThumbnailBarController

interface PdfThumbnailBarController

Thumbnail bar controller used to control properties and actions of scrollable and static thumbnail bar.

Functions

Link copied to clipboard
abstract fun addOnVisibilityChangedListener(@NonNull listener: OnVisibilityChangedListener)
Adds a listener to be notified of visibility change.
Link copied to clipboard
abstract fun clearDocument()
Clears the currently loaded document and releases associated resources.
Link copied to clipboard
@ColorInt
abstract fun getBackgroundColor(): Int
Returns the background color of the thumbnail bar.
Link copied to clipboard
@NonNull
abstract fun getDocumentListener(): DocumentListener
Returns the document listener that should be registered to receive document events.
Link copied to clipboard
@ColorInt
abstract fun getSelectedThumbnailBorderColor(): Int
Returns the border color for the selected thumbnail in the thumbnail bar.
Link copied to clipboard
@ColorInt
abstract fun getThumbnailBorderColor(): Int
Returns the border color for the thumbnails in the thumbnail bar.
Link copied to clipboard
@IntRange(from = 1)
abstract fun getThumbnailHeight(): Int
Returns the height of the thumbnails in thumbnail bar.
Link copied to clipboard
@IntRange(from = 1)
abstract fun getThumbnailWidth(): Int
Returns the width of the thumbnails in thumbnail bar.
Link copied to clipboard
abstract fun isBackgroundTransparent(): Boolean
Checks whether the thumbnail bar background is transparent.
Link copied to clipboard
abstract fun isRedactionAnnotationPreviewEnabled(): Boolean
Returns redaction annotation preview mode, false by default.
Link copied to clipboard
abstract fun isUsingPageAspectRatio(): Boolean
Returns whether the page aspect ratio is used to determine the thumbnail width.
Link copied to clipboard
abstract fun removeOnVisibilityChangedListener(@NonNull listener: OnVisibilityChangedListener)
Removes a previously added visibility change listener.
Link copied to clipboard
abstract fun setBackgroundColor(@ColorInt backgroundColor: Int)
Sets the background color for the thumbnail bar.
Link copied to clipboard
abstract fun setDocument(@NonNull document: PdfDocument, @NonNull configuration: PdfConfiguration)
Sets the document to be displayed in the thumbnail bar.
Link copied to clipboard
abstract fun setDrawableProviders(drawableProviders: List<PdfDrawableProvider>)
Sets PdfDrawableProviders to provide custom PdfDrawable to be displayed in a thumbnail bar page items.
Link copied to clipboard
abstract fun setOnPageChangedListener(@Nullable onPageChangedListener: PdfThumbnailBar.OnPageChangedListener)
Sets a listener to be notified of page changing events.
Link copied to clipboard
abstract fun setRedactionAnnotationPreviewEnabled(enable: Boolean)
Sets redaction annotations preview as redacted.
Link copied to clipboard
abstract fun setSelectedThumbnailBorderColor(@ColorInt borderColor: Int)
Sets the border color for the selected thumbnail in the thumbnail bar.
Link copied to clipboard
abstract fun setThumbnailBorderColor(@ColorInt borderColor: Int)
Sets the border color for the thumbnails in the thumbnail bar.
Link copied to clipboard
abstract fun setThumbnailHeight(@IntRange(from = 1) thumbnailHeight: Int)
Sets the height of the thumbnails in thumbnail bar.
Link copied to clipboard
abstract fun setThumbnailWidth(@IntRange(from = 1) thumbnailWidth: Int)
Sets the width of the thumbnails in thumbnail bar.
Link copied to clipboard
abstract fun setUsePageAspectRatio(usePageAspectRatio: Boolean)
Configures the thumbnail bar to use the page aspect ratio to calculate the thumbnail width.
Generated by Dokka
© 2026 Copyright