BackNavigationBehavior
A class to control how back navigation should behave in a ThreePaneScaffoldNavigator.
Summary
Enum Values |
|
|---|---|
PopLatest |
Pop the latest destination from the backstack. |
PopUntilContentChange |
Pop destinations from the backstack until there is a content change. |
PopUntilCurrentDestinationChange |
Pop destinations from the backstack until there is a change in the current destination pane. |
PopUntilScaffoldValueChange |
Pop destinations from the backstack until there is a change in the scaffold value. |
Public functions |
||
|---|---|---|
BackNavigationBehavior |
Returns the enum constant of this type with the specified name. |
Cmn
|
Array<BackNavigationBehavior> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Cmn
|
Public properties |
||
|---|---|---|
EnumEntries<BackNavigationBehavior> |
Returns a representation of an immutable list of all enum entries, in the order they're declared. |
Cmn
|
Enum Values
PopLatest
@ExperimentalMaterial3AdaptiveApi
val BackNavigationBehavior.PopLatest: BackNavigationBehavior
Pop the latest destination from the backstack.
PopUntilContentChange
@ExperimentalMaterial3AdaptiveApi
val BackNavigationBehavior.PopUntilContentChange: BackNavigationBehavior
Pop destinations from the backstack until there is a content change.
A "content change" is defined as either a change in the content of the current ThreePaneScaffoldDestinationItem, or a change in the scaffold value (similar to PopUntilScaffoldValueChange).
PopUntilCurrentDestinationChange
@ExperimentalMaterial3AdaptiveApi
val BackNavigationBehavior.PopUntilCurrentDestinationChange: BackNavigationBehavior
Pop destinations from the backstack until there is a change in the current destination pane.
In a single-pane layout, this should behave similarly to PopUntilScaffoldValueChange. In a multi-pane layout, it is possible for both the current destination and previous destination to be showing at the same time, so this may not result in a visual change in the scaffold.
PopUntilScaffoldValueChange
@ExperimentalMaterial3AdaptiveApi
val BackNavigationBehavior.PopUntilScaffoldValueChange: BackNavigationBehavior
Pop destinations from the backstack until there is a change in the scaffold value.
For example, in a single-pane layout, this will skip entries until the current destination is a different ThreePaneScaffoldRole. In a multi-pane layout, this will skip entries until the PaneAdaptedValue of any pane changes.
Public functions
valueOf
fun valueOf(value: String): BackNavigationBehavior
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
| Throws | |
|---|---|
kotlin.IllegalArgumentException |
if this enum type has no constant with the specified name |
values
fun values(): Array<BackNavigationBehavior>
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
Public properties
entries
val entries: EnumEntries<BackNavigationBehavior>
Returns a representation of an immutable list of all enum entries, in the order they're declared.
This method may be used to iterate over the enum entries.