nutrient/com.pspdfkit.ui.outline/DefaultBookmarkAdapter

DefaultBookmarkAdapter

open class DefaultBookmarkAdapter : BookmarkViewAdapter, InternalDocumentListener, BookmarkProvider.BookmarkListener, DefaultLifecycleObserver

Default implementation of BookmarkViewAdapter which handles bookmark behaviour for the default BookmarkListView.

Note: This adapter is bound to a single PdfFragment instance. If you are using this manually in your custom activity, replace the fragment (for example when reloading documents), create and set a new adapter for the new fragment.

Constructors

constructor(@NonNull fragment: PdfFragment)

Creates a new adapter bound to the passed fragment.

Functions

addBookmarkListener

open fun addBookmarkListener(@NonNull listener: BookmarkProvider.BookmarkListener)

Adds this view to bookmark change events via BookmarkListener interface.

getBookmarks

open fun getBookmarks(): List<Bookmark>

Called to retrieve the list of bookmarks to display.

isBookmarkAddButtonEnabled

open fun isBookmarkAddButtonEnabled(): Boolean

Called to determine bookmark add button enabled state.

onBookmarkAdd

open fun onBookmarkAdd()

Called when add button has been clicked in this view.

onBookmarkAdded

open fun onBookmarkAdded(@NonNull bookmark: Bookmark)

Called when a new bookmark was added.

onBookmarkClicked

open fun onBookmarkClicked(@NonNull bookmark: Bookmark)

Called when user taps on a bookmark outside editing mode.

onBookmarkNameSet

open fun onBookmarkNameSet(@NonNull bookmark: Bookmark, @Nullable name: String)

Called when bookmark should be renamed.

onBookmarkPositionSet

open fun onBookmarkPositionSet(@NonNull bookmark: Bookmark, position: Int)

Called when bookmark has been reordered in this view.

onBookmarkRemove

open fun onBookmarkRemove(@NonNull bookmark: Bookmark): Boolean

Called when user deleted the bookmark from list.

onBookmarksChanged

open fun onBookmarksChanged(@NonNull bookmarks: List<Bookmark>)

Called when bookmark list has been changed in some way.

onDestroy

open fun onDestroy(@NonNull owner: LifecycleOwner)

Called when the lifecycle owner (the fragment) is destroyed.

onDocumentLoaded

@UiThread

open fun onDocumentLoaded(@NonNull document: PdfDocument)

Called when document is successfully loaded and the document view has been laid out.

onStart

open fun onStart(@NonNull owner: LifecycleOwner)

Called when the lifecycle owner (the fragment) moves to the started state.

onStop

open fun onStop(@NonNull owner: LifecycleOwner)

Called when the lifecycle owner (the fragment) moves to the stopped state.

removeBookmarkListener

open fun removeBookmarkListener(@NonNull listener: BookmarkProvider.BookmarkListener)

Removes this view from bookmark change events via BookmarkListener interface.