pspdfkit/com.pspdfkit.ui/PdfOutlineView

PdfOutlineView

open class PdfOutlineView : FrameLayout, OutlinePagerBaseView.OnHideListener, PSPDFKitViews.PSPDFView, PdfDrawableManager

A layout containing the tab on the top and a view pager for switching between the outline, the list of annotations and the bookmarks.

Inheritors

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
interface DocumentOutlineProvider
Interface to objects that provide outline elements.
Link copied to clipboard
interface OnAnnotationTapListener
Annotation list tap listener.
Link copied to clipboard
interface OnEmbeddedFileTapListener
Embedded file tap listener.
Link copied to clipboard
interface OnOutlineElementTapListener
Outline element tap listener.
Link copied to clipboard
inner class OutlinePagerAdapter : ViewStatePagerAdapter, ViewPager.OnPageChangeListener
A state pager adapter controlling the pager items (outline view and annotation list view) that saves and restores View states.

Properties

Link copied to clipboard
Link copied to clipboard
open val isDisplayed: Boolean
Tracks visibility before the animation ends (view considered not visible when it starts to hide).
Link copied to clipboard

Functions

Link copied to clipboard
open fun addDrawableProvider(@NonNull drawableProvider: PdfDrawableProvider)
Adds a PdfDrawableProvider to be managed by this object.
Link copied to clipboard
open fun addOnDocumentInfoViewModeChangeListener(@NonNull listener: OnDocumentInfoViewModeChangeListener)
Adds the listener for the editing mode changes on this document info view.
Link copied to clipboard
open fun addOnDocumentInfoViewSaveListener(@NonNull listener: OnDocumentInfoViewSaveListener)
Adds the listener for saving the document info changes.
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
@NonNull
open fun getPSPDFViewType(): PSPDFKitViews.Type
Returns the current type of this view.
Link copied to clipboard
open fun hide()
Hides the outline view (scroll up animation).
Link copied to clipboard
open fun onTouchEvent(@NonNull event: MotionEvent): Boolean
Link copied to clipboard
open fun performClick(): Boolean
Link copied to clipboard
@UiThread
open fun refreshViewPager()
Refreshes the view pager adapter and binds it to the pager tabs.
Link copied to clipboard
open fun removeDrawableProvider(@NonNull drawableProvider: PdfDrawableProvider)
Removes a previously added PdfDrawableProvider.
open fun removeOnDocumentInfoViewModeChangeListener(@NonNull listener: OnDocumentInfoViewModeChangeListener)
Removes the listener for the editing mode changes on this document info view.
Link copied to clipboard
open fun removeOnDocumentInfoViewSaveListener(@NonNull listener: OnDocumentInfoViewSaveListener)
Removes the listener for saving the document info changes.
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 setAnnotationEditingEnabled(annotationEditingEnabled: Boolean)
Enables additional controls in the annotation outline view to delete annotations.
Link copied to clipboard
open fun setAnnotationListReorderingEnabled(enable: Boolean)
Sets whether reordering of annotations in the annotation list is enabled.
Link copied to clipboard
open fun setAnnotationListViewEnabled(annotationListViewEnabled: Boolean)
open fun setAnnotationListViewEnabled(annotationListViewEnabled: Boolean, refreshViewPager: Boolean)
Enables annotation list view.
Link copied to clipboard
open fun setBookmarkAdapter(@Nullable adapter: BookmarkViewAdapter)
Sets an adapter that handles actual bookmark data.
Link copied to clipboard
open fun setBookmarkEditingEnabled(bookmarkEditingEnabled: Boolean)
Allows bookmark view to edit annotations.
Link copied to clipboard
open fun setBookmarkRenamingEnabled(bookmarkRenamingEnabled: Boolean)
Allows bookmark view to rename annotations.
Link copied to clipboard
open fun setBookmarkViewEnabled(bookmarkViewEnabled: Boolean)
open fun setBookmarkViewEnabled(bookmarkViewEnabled: Boolean, refreshViewPager: Boolean)
Enables bookmark view.
Link copied to clipboard
open fun setDisplayEmbeddedFilesViewEnabled(displayEmbeddedFilesView: Boolean)
Enables the embedded files view.
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 setDocumentInfoViewEnabled(documentInfoViewEnabled: Boolean)
open fun setDocumentInfoViewEnabled(documentInfoViewEnabled: Boolean, refreshViewPager: Boolean)
Enables document info view.
Link copied to clipboard
@UiThread
open fun setDocumentOutlineProvider(@Nullable outlineProvider: PdfOutlineView.DocumentOutlineProvider)
Sets DocumentOutlineProvider that should be used as a source of outline elements in the outline list instead of document outline.
Link copied to clipboard
open fun setListedAnnotationTypes(@NonNull listedAnnotationTypes: EnumSet<AnnotationType>)
Sets annotation types to be listed (if the annotation list is enabled).
Link copied to clipboard
open fun setOnAnnotationTapListener(@Nullable onAnnotationTapListener: PdfOutlineView.OnAnnotationTapListener)
Sets a listener to be notified of annotation tap events.
Link copied to clipboard
open fun setOnEmbeddedFileTapListener(@Nullable onEmbeddedFileTapListener: PdfOutlineView.OnEmbeddedFileTapListener)
Sets a listener to be notified of embedded files tap events.
Link copied to clipboard
open fun setOnOutlineElementTapListener(@Nullable onOutlineElementTapListener: PdfOutlineView.OnOutlineElementTapListener)
Sets a listener to be notified of outline tap events.
Link copied to clipboard
open fun setOutlineViewEnabled(outlineViewEnabled: Boolean)
open fun setOutlineViewEnabled(outlineViewEnabled: Boolean, refreshViewPager: Boolean)
Enables outline view.
Link copied to clipboard
open fun setRedactionAnnotationPreviewEnabled(redactionAnnotationPreviewEnabled: Boolean)
Link copied to clipboard
open fun setShowPageLabels(showPageLabels: Boolean)
Provide API for controlling content of the PdfOutlineView.
Link copied to clipboard
open fun setUndoManager(@NonNull undoManager: UndoManager)
Sets the UndoManager used for tracking annotations removed from the annotation list.
Link copied to clipboard
open fun setVisibility(visibility: Int)
Link copied to clipboard
open fun show()
Shows the outline view (scroll down animation).