AppBarConfiguration.Builder
public
static
final
class
AppBarConfiguration.Builder
extends Object
java.lang.Object | |
↳ | androidx.navigation.ui.AppBarConfiguration.Builder |
The Builder class for constructing new AppBarConfiguration
instances.
Summary
Public constructors | |
---|---|
Builder(NavGraph navGraph)
Create a new Builder whose only top level destination is the start destination
of the given |
|
Builder(Menu topLevelMenu)
Create a new Builder using a |
|
Builder(int... topLevelDestinationIds)
Create a new Builder with a specific set of top level destinations. |
|
Builder(Set<Integer> topLevelDestinationIds)
Create a new Builder with a specific set of top level destinations. |
Public methods | |
---|---|
AppBarConfiguration
|
build()
Construct the |
AppBarConfiguration.Builder
|
setDrawerLayout(DrawerLayout drawerLayout)
This method is deprecated.
Use |
AppBarConfiguration.Builder
|
setFallbackOnNavigateUpListener(AppBarConfiguration.OnNavigateUpListener fallbackOnNavigateUpListener)
Adds a |
AppBarConfiguration.Builder
|
setOpenableLayout(Openable openableLayout)
Display the Navigation button as a drawer symbol when it is not being shown as an Up button. |
Inherited methods | |
---|---|
Public constructors
Builder
public 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
public Builder (Menu topLevelMenu)
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.
|
Builder
public Builder (int... topLevelDestinationIds)
Create a new Builder with a specific set of top level destinations. The Up button will not be displayed when on these destinations.
Parameters | |
---|---|
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
public Builder (Set<Integer> topLevelDestinationIds)
Create a new Builder with a specific set of top level destinations. The Up button will not be displayed when on these destinations.
Parameters | |
---|---|
topLevelDestinationIds |
Set : 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.
|
Public methods
build
public AppBarConfiguration build ()
Construct the AppBarConfiguration
instance.
Returns | |
---|---|
AppBarConfiguration |
a valid AppBarConfiguration
|
setDrawerLayout
public AppBarConfiguration.Builder setDrawerLayout (DrawerLayout drawerLayout)
This method is deprecated.
Use setOpenableLayout(Openable)
.
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 AppBarConfiguration.Builder |
setFallbackOnNavigateUpListener
public AppBarConfiguration.Builder setFallbackOnNavigateUpListener (AppBarConfiguration.OnNavigateUpListener fallbackOnNavigateUpListener)
Adds a AppBarConfiguration.OnNavigateUpListener
that will be called as a fallback if the default
behavior of NavController.navigateUp()
returns false
.
Parameters | |
---|---|
fallbackOnNavigateUpListener |
AppBarConfiguration.OnNavigateUpListener : Listener that will be invoked if
NavController.navigateUp()
returns false . |
Returns | |
---|---|
AppBarConfiguration.Builder |
this AppBarConfiguration.Builder
|
setOpenableLayout
public AppBarConfiguration.Builder setOpenableLayout (Openable openableLayout)
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 AppBarConfiguration.Builder
|