pspdfkit/com.pspdfkit.ui.navigation/PageNavigator

PageNavigator

interface PageNavigator

Class responsible for managing current page and page navigation history in the .

Inheritors

Functions

Link copied to clipboard
@UiThread
abstract fun beginNavigation()
Notifies the navigation manager that calls to setPageIndex should be added to the navigation history until endNavigation is called.
Link copied to clipboard
@UiThread
abstract fun endNavigation()
Commits the page changes to the navigation history dropping everything but the very last one.
Link copied to clipboard
@NonNull
abstract fun getNavigationHistory(): NavigationBackStack<NavigationBackStack.NavigationItem<Integer>>
Returns the navigation history owned by this manager.
Link copied to clipboard
@IntRange(from = "-1")
abstract fun getPageCount(): Int
Gets number of pages in the document.
Link copied to clipboard
@IntRange(from = "-1")
abstract fun getPageIndex(): Int
Gets currently displayed document page.
Link copied to clipboard
@UiThread
abstract fun setPageIndex(@IntRange(from = 0) pageIndex: Int)
Sets the pageIndex to be displayed (0 is the first one), using our default decision on animating, which is to animate the transition if the page is next/before the current page, and not animate if further away.
@UiThread
abstract fun setPageIndex(@IntRange(from = 0) pageIndex: Int, animated: Boolean)
Sets the pageIndex to be displayed (0 is the first one).