nutrient/com.pspdfkit.ui.navigation/NavigationBackStack

NavigationBackStack

open class NavigationBackStack<T> : Parcelable

Manages a browser like backstack of items.

Constructors

NavigationBackStack

constructor()

Types

BackStackListener

interface BackStackListener<T>

Listener for changes to the navigation back stack.

NavigationItem

open class NavigationItem<T> : Parcelable

A single item on the navigation backstack.

Properties

CREATOR

val CREATOR: Parcelable.Creator<NavigationBackStack>

Parcelable creator for restoring NavigationBackStack from a Parcel.

Functions

addBackStackListener

open fun addBackStackListener(@NonNull backStackListener: NavigationBackStack.BackStackListener<T>)

Adds a back stack listener to be notified of changes.

addItem

open fun addItem(@NonNull item: T)

Adds a new item depending on if we are currently going back or forward.

clearBackStackListeners

open fun clearBackStackListeners()

Removes all previously added back stack listeners.

describeContents

open fun describeContents(): Int

Describes the kinds of special objects contained in this Parcelable instance's marshaled representation.

getBackItem

@Nullable

open fun getBackItem(): T

Returns the current top back item, or null.

getForwardItem

@Nullable

open fun getForwardItem(): T

Returns the current top forward item, or null.

goBack

open fun goBack()

Goes back one step, or does nothing if the stack is already empty.

goForward

open fun goForward()

Goes forward one step, or does nothing if the stack is already empty.

removeBackStackListener

open fun removeBackStackListener(@NonNull backStackListener: NavigationBackStack.BackStackListener<T>)

Removes the back stack listener.

replaceWith

open fun replaceWith(@NonNull navigationHistory: NavigationBackStack<T>)

Replaces navigation back stack with another instance.

resetForwardList

open fun resetForwardList()

Removes all forward navigation items.

writeToParcel

open fun writeToParcel(dest: Parcel, flags: Int)

Flattens this object into a Parcel.