NavOptions
class NavOptions
NavOptions stores special options for navigate actions
Summary
Nested types |
|---|
class NavOptions.BuilderBuilder for constructing new instances of NavOptions. |
Public functions |
|
|---|---|
open operator Boolean |
|
@IdRes Int |
This function is deprecated. Use popUpToId instead. |
open Int |
hashCode() |
Boolean |
Whether the destination set in |
Boolean |
Whether this navigation action should launch as single-top (i.e., there will be at most one copy of a given destination on the top of the back stack). |
Boolean |
Whether the back stack and the state of all destinations between the current destination and |
Boolean |
Whether this navigation action should restore any state previously saved by |
open String |
toString() |
Public properties |
|
|---|---|
Int |
The custom enter Animation/Animator that should be run. |
Int |
The custom exit Animation/Animator that should be run. |
Int |
The custom enter Animation/Animator that should be run when this destination is popped from the back stack. |
Int |
The custom exit Animation/Animator that should be run when this destination is popped from the back stack. |
@IdRes Int |
The destination to pop up to before navigating. |
String? |
Route for the destination to pop up to before navigating. |
KClass<*>? |
Route from a |
Any? |
Route from an Object for the destination to pop up to before navigating. |
Public functions
fungetPopUpTo(): @IdRes Int
The destination to pop up to before navigating. When set, all non-matching destinations should be popped from the back stack.
isPopUpToInclusive
fun isPopUpToInclusive(): Boolean
Whether the destination set in getPopUpTo should be popped from the back stack.
| See also | |
|---|---|
setPopUpTo |
|
getPopUpTo |
shouldLaunchSingleTop
fun shouldLaunchSingleTop(): Boolean
Whether this navigation action should launch as single-top (i.e., there will be at most one copy of a given destination on the top of the back stack).
This functions similarly to how android.content.Intent.FLAG_ACTIVITY_SINGLE_TOP works with activities.
shouldPopUpToSaveState
fun shouldPopUpToSaveState(): Boolean
Whether the back stack and the state of all destinations between the current destination and popUpToId should be saved for later restoration via Builder.setRestoreState or the restoreState attribute using the same ID as popUpToId (note: this matching ID is true whether isPopUpToInclusive is true or false).
shouldRestoreState
fun shouldRestoreState(): Boolean
Whether this navigation action should restore any state previously saved by Builder.setPopUpTo or the popUpToSaveState attribute.
Public properties
enterAnim
val enterAnim: Int
The custom enter Animation/Animator that should be run.
| Returns | |
|---|---|
Int |
the resource id of a Animation or Animator or -1 if none. |
exitAnim
val exitAnim: Int
The custom exit Animation/Animator that should be run.
| Returns | |
|---|---|
Int |
the resource id of a Animation or Animator or -1 if none. |
popEnterAnim
val popEnterAnim: Int
The custom enter Animation/Animator that should be run when this destination is popped from the back stack.
| Returns | |
|---|---|
Int |
the resource id of a Animation or Animator or -1 if none. |
popExitAnim
val popExitAnim: Int
The custom exit Animation/Animator that should be run when this destination is popped from the back stack.
| Returns | |
|---|---|
Int |
the resource id of a Animation or Animator or -1 if none. |
popUpToId
val popUpToId: @IdRes Int
The destination to pop up to before navigating. When set, all non-matching destinations should be popped from the back stack.
popUpToRoute
val popUpToRoute: String?
Route for the destination to pop up to before navigating. When set, all non-matching destinations should be popped from the back stack.
| Returns | |
|---|---|
String? |
the destination route to pop up to, clearing all intervening destinations |
popUpToRouteClass
val popUpToRouteClass: KClass<*>?
Route from a KClass for the destination to pop up to before navigating. When set, all non-matching destinations should be popped from the back stack.
| Returns | |
|---|---|
KClass<*>? |
the destination route to pop up to, clearing all intervening destinations |
popUpToRouteObject
val popUpToRouteObject: Any?
Route from an Object for the destination to pop up to before navigating. When set, all non-matching destinations should be popped from the back stack.
| Returns | |
|---|---|
Any? |
the destination route to pop up to, clearing all intervening destinations |