nutrient/com.pspdfkit.ui.thumbnail/PdfScrollableThumbnailBar

PdfScrollableThumbnailBar

open class PdfScrollableThumbnailBar : ViewGroup, DocumentListener, PSPDFKitViews.PSPDFView, ThumbnailAdapter.OnThumbnailClickListener, PdfThumbnailBarController

Scrollable bar showing thumbnails of pages, with larger images.

Constructors

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)

Properties

backgroundColor

open var backgroundColor: Int

The background color of the thumbnail bar.

thumbnailHeight

@get:IntRange(from = 1)

open var thumbnailHeight: Int

The height of each thumbnail in pixels.

thumbnailWidth

@get:IntRange(from = 1)

open var thumbnailWidth: Int

The width of each thumbnail in pixels.

Functions

addOnVisibilityChangedListener

open fun addOnVisibilityChangedListener(@NonNull listener: OnVisibilityChangedListener)

clearDocument

open fun clearDocument()

Called by the activity when the view should unbind the previously set document.

getDocumentListener

@NonNull

open fun getDocumentListener(): DocumentListener

Returns the document listener that should be registered to receive document events.

getItemCount

open fun getItemCount(): Int

Returns the number of page thumbnails in the thumbnail bar.

getPSPDFViewType

@NonNull

open fun getPSPDFViewType(): PSPDFKitViews.Type

Returns the current type of this view.

getSelectedPage

open fun getSelectedPage(): Int

Returns the currently selected page index in the thumbnail bar.

getSelectedThumbnailBorderColor

@ColorInt

open fun getSelectedThumbnailBorderColor(): Int

Returns the border color for the selected thumbnail in the thumbnail bar.

getThumbnailBorderColor

@ColorInt

open fun getThumbnailBorderColor(): Int

Returns the border color for the thumbnails in the thumbnail bar.

hide

open fun hide()

No-op for PdfScrollableThumbnailBar.

isBackgroundTransparent

open fun isBackgroundTransparent(): Boolean

Checks whether the thumbnail bar background is transparent.

isDisplayed

open fun isDisplayed(): Boolean

Returns whether the thumbnail bar is currently displayed.

isRedactionAnnotationPreviewEnabled

open fun isRedactionAnnotationPreviewEnabled(): Boolean

Returns redaction annotation preview mode, false by default.

isUsingPageAspectRatio

open fun isUsingPageAspectRatio(): Boolean

Returns whether the page aspect ratio is used to determine the thumbnail width.

onPageChanged

open fun onPageChanged(@NonNull document: PdfDocument, pageIndex: Int)

Called when user scrolled to a new page.

onPageUpdated

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).

onThumbnailChanged

open fun onThumbnailChanged(@NonNull view: View, @IntRange(from = 0) pageIndex: Int)

Called whenever the user touched on a thumbnail, selecting a different page.

removeOnVisibilityChangedListener

open fun removeOnVisibilityChangedListener(@NonNull listener: OnVisibilityChangedListener)

Unregister a previously registered listener that no longer wants to receive visibility change events.

setDocument

@UiThread

open fun setDocument(@NonNull document: PdfDocument, @NonNull configuration: PdfConfiguration)

Called when the document has been loaded and is going to be displayed.

setDrawableProviders

open fun setDrawableProviders(drawableProviders: List<PdfDrawableProvider>)

Sets PdfDrawableProviders to provide custom PdfDrawable to be displayed in a thumbnail bar page items.

setOnPageChangedListener

open fun setOnPageChangedListener(@Nullable onPageChangedListener: PdfThumbnailBar.OnPageChangedListener)

Sets a listener to be notified of page changing events.

setRedactionAnnotationPreviewEnabled

open fun setRedactionAnnotationPreviewEnabled(enable: Boolean)

Sets redaction annotations preview as redacted.

setSelectedThumbnailBorderColor

open fun setSelectedThumbnailBorderColor(@ColorInt borderColor: Int)

Sets the border color for the selected thumbnail in the thumbnail bar.

setThumbnailBorderColor

open fun setThumbnailBorderColor(@ColorInt borderColor: Int)

Sets the border color for the thumbnails in the thumbnail bar.

setUsePageAspectRatio

open fun setUsePageAspectRatio(usePageAspectRatio: Boolean)

Configures the thumbnail bar to use the page aspect ratio to calculate the thumbnail width.

show

open fun show()

No-op for PdfScrollableThumbnailBar.