pspdfkit/com.pspdfkit.ui.thumbnail/PdfStaticThumbnailBar

PdfStaticThumbnailBar

open class PdfStaticThumbnailBar : DocumentListenerViewGroup, PSPDFKitViews.PSPDFView, PdfThumbnailBarController

Bar showing thumbnails of pages for quick selection.

Constructors

Link copied to clipboard
constructor(@NonNull context: Context)
constructor(@NonNull context: Context, @Nullable attrs: AttributeSet)
constructor(@NonNull context: Context, @Nullable attrs: AttributeSet, defStyleAttr: Int)
constructor(@NonNull context: Context, @Nullable attrs: AttributeSet, defStyleAttr: Int, defStyleRes: Int)

Types

Link copied to clipboard
enum LayoutStyle
A PdfStaticThumbnailBar has two possible layout styles, depending on how it's planned to be used.

Properties

Link copied to clipboard
@get:NonNull
open var layoutStyle: PdfStaticThumbnailBar.LayoutStyle
Currently used layout style.
Link copied to clipboard
@Nullable
@get:Nullable
open val leftSelectedImage: ImageView
Enlarged currently selected image (left one in double page mode).
Link copied to clipboard
@get:IntRange(from = 1)
open var thumbnailHeight: Int
Final thumbnail height after calculations (in pixels).
Link copied to clipboard
@get:IntRange(from = 1)
open var thumbnailWidth: Int
Final thumbnail width after calculations (in pixels).

Functions

Link copied to clipboard
open fun addOnVisibilityChangedListener(@NonNull listener: OnVisibilityChangedListener)
Register a listener that would like to receive visibility change events.
Link copied to clipboard
open fun clearDocument()
Called by the activity when the view should unbind the previously set document.
Link copied to clipboard
open fun focusSearch(@NonNull focused: View, direction: Int): View
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@NonNull
open fun getPSPDFViewType(): PSPDFKitViews.Type
Returns the current type of this view.
Link copied to clipboard
open fun getSelectedThumbnailBorderColor(): Int
Returns the border color for the selected thumbnail in the thumbnail bar.
Link copied to clipboard
@ColorInt
open fun getThumbnailBorderColor(): Int
Returns the border color for the thumbnails in the thumbnail bar.
Link copied to clipboard
open fun getThumbnailOffsetX(@IntRange(from = 0) pageIndex: Int): Int
Link copied to clipboard
open fun hide()
No-op for PdfStaticThumbnailBar.
Link copied to clipboard
Link copied to clipboard
open fun isDisplayed(): Boolean
Called when the activity needs to know the visibility of this view.
Link copied to clipboard
open fun isRedactionAnnotationPreviewEnabled(): Boolean
Returns redaction annotation preview mode, false by default.
Link copied to clipboard
open fun isUsingPageAspectRatio(): Boolean
Returns whether the page aspect ratio is used to determine the thumbnail width.
Link copied to clipboard
Link copied to clipboard
open fun onPageChanged(@NonNull document: PdfDocument, pageIndex: Int)
Called when user scrolled to a new page.
Link copied to clipboard
open fun onPageUpdated(@NonNull document: PdfDocument, @IntRange(from = 0) pageIndex: Int)
Called when content of page with pageIndex has changed (for example due to annotation or form field being updated).
Link copied to clipboard
open fun onTouchEvent(@NonNull event: MotionEvent): Boolean
Link copied to clipboard
open fun removeOnVisibilityChangedListener(@NonNull listener: OnVisibilityChangedListener)
Unregister a previously registered listener that no longer wants to receive visibility change events.
Link copied to clipboard
open fun setBackgroundColor(@ColorInt backgroundColor: Int)
Link copied to clipboard
@UiThread
open fun setDocument(@NonNull document: PdfDocument, @NonNull configuration: PdfConfiguration)
Called when the document has been loaded and is going to be displayed.
Link copied to clipboard
open fun setDrawableProviders(drawableProviders: List<PdfDrawableProvider>)
Sets PdfDrawableProviders to provide custom PdfDrawable to be displayed in a thumbnail bar page items.
Link copied to clipboard
open fun setOnPageChangedListener(@Nullable onPageChangedListener: PdfThumbnailBar.OnPageChangedListener)
Sets a listener to be notified of page changing events.
Link copied to clipboard
open fun setRedactionAnnotationPreviewEnabled(enable: Boolean)
Sets redaction annotations preview as redacted.
Link copied to clipboard
open fun setSelectedThumbnailBorderColor(@ColorInt borderColor: Int)
Sets the border color for the selected thumbnail in the thumbnail bar.
Link copied to clipboard
open fun setThumbnailBorderColor(@ColorInt borderColor: Int)
Sets the border color for the thumbnails in the thumbnail bar.
Link copied to clipboard
open fun setUsePageAspectRatio(usePageAspectRatio: Boolean)
Configures the thumbnail bar to use the page aspect ratio to calculate the thumbnail width.
Link copied to clipboard
open fun show()
No-op for PdfStaticThumbnailBar.