AppBarConfiguration.Builder
class AppBarConfiguration.Builder
The Builder class for constructing new AppBarConfiguration instances.
Summary
Public constructors |
|---|
|
Create a new Builder whose only top level destination is the start destination of the given |
|
Create a new Builder with a specific set of top level destinations. |
|
Create a new Builder with a specific set of top level destinations. |
|
Create a new Builder using a |
Public functions |
|
|---|---|
AppBarConfiguration |
build()Construct the |
AppBarConfiguration.Builder |
This function is deprecated. Use {@link #setOpenableLayout(Openable)}. |
AppBarConfiguration.Builder |
setFallbackOnNavigateUpListener(Adds a |
AppBarConfiguration.Builder |
setOpenableLayout(openableLayout: Openable?)Display the Navigation button as a drawer symbol when it is not being shown as an Up button. |
Public constructors
Builder
Builder(navGraph: NavGraph)
Create a new Builder whose only top level destination is the start destination of the given NavGraph. The Up button will not be displayed when on the start destination of the graph.
| Parameters | |
|---|---|
navGraph: NavGraph |
The NavGraph whose start destination should be considered the only top level destination. The Up button will not be displayed when on the start destination of the graph. |
Builder
Builder(vararg topLevelDestinationIds: Int)
Create a new Builder with a specific set of top level destinations. The Up button will not be displayed when on these destinations.
| Parameters | |
|---|---|
vararg topLevelDestinationIds: Int |
The set of destinations by id considered at the top level of your information hierarchy. The Up button will not be displayed when on these destinations. |
Builder
Builder(topLevelDestinationIds: Set<Int>)
Create a new Builder with a specific set of top level destinations. The Up button will not be displayed when on these destinations.
Builder
Builder(topLevelMenu: Menu)
Create a new Builder using a Menu containing all top level destinations. It is expected that the menu item id of each item corresponds with a destination in your navigation graph. The Up button will not be displayed when on these destinations.
| Parameters | |
|---|---|
topLevelMenu: Menu |
A Menu containing MenuItems corresponding with the destinations considered at the top level of your information hierarchy. The Up button will not be displayed when on these destinations. |
Public functions
build
fun build(): AppBarConfiguration
Construct the AppBarConfiguration instance.
| Returns | |
|---|---|
AppBarConfiguration |
a valid |
funsetDrawerLayout(drawerLayout: DrawerLayout?): AppBarConfiguration.Builder
Display the Navigation button as a drawer symbol when it is not being shown as an Up button.
| Parameters | |
|---|---|
drawerLayout: DrawerLayout? |
The DrawerLayout that should be toggled from the Navigation button |
| Returns | |
|---|---|
AppBarConfiguration.Builder |
this |
setFallbackOnNavigateUpListener
fun setFallbackOnNavigateUpListener(
fallbackOnNavigateUpListener: AppBarConfiguration.OnNavigateUpListener?
): AppBarConfiguration.Builder
Adds a OnNavigateUpListener that will be called as a fallback if the default behavior of androidx.navigation.NavController.navigateUp returns false.
| Parameters | |
|---|---|
fallbackOnNavigateUpListener: AppBarConfiguration.OnNavigateUpListener? |
Listener that will be invoked if |
| Returns | |
|---|---|
AppBarConfiguration.Builder |
this |
setOpenableLayout
fun setOpenableLayout(openableLayout: Openable?): AppBarConfiguration.Builder
Display the Navigation button as a drawer symbol when it is not being shown as an Up button.
| Parameters | |
|---|---|
openableLayout: Openable? |
The Openable layout that should be toggled from the Navigation button |
| Returns | |
|---|---|
AppBarConfiguration.Builder |
this |