AppBarConfiguration.Builder

Artifact: androidx.navigation:navigation-ui

Added in 1.0.0

Kotlin |Java

public final class AppBarConfiguration.Builder

The Builder class for constructing new AppBarConfiguration instances.

Summary

Public constructors
`Builder(@NonNull NavGraph navGraph)` Create a new Builder whose only top level destination is the start destination of the given `NavGraph`.
`Builder(int topLevelDestinationIds)` Create a new Builder with a specific set of top level destinations.
`Builder(@NonNull Set<@NonNull Integer> topLevelDestinationIds)` Create a new Builder with a specific set of top level destinations.
`Builder(@NonNull Menu topLevelMenu)` Create a new Builder using a `Menu` containing all top level destinations.

Public methods
`final @NonNull AppBarConfiguration`	`build()` Construct the `AppBarConfiguration` instance.
`final @NonNull AppBarConfiguration.Builder`	`setDrawerLayout(DrawerLayout drawerLayout)` This method is deprecated. Use {@link #setOpenableLayout(Openable)}.
`final @NonNull AppBarConfiguration.Builder`	`setFallbackOnNavigateUpListener( AppBarConfiguration.OnNavigateUpListener fallbackOnNavigateUpListener )` Adds a `OnNavigateUpListener` that will be called as a fallback if the default behavior of `androidx.navigation.NavController.navigateUp` returns `false`.
`final @NonNull AppBarConfiguration.Builder`	`setOpenableLayout(Openable openableLayout)` Display the Navigation button as a drawer symbol when it is not being shown as an Up button.

Public constructors

Added in 1.0.0

public Builder(@NonNull 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
`@NonNull 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

Added in 1.0.0

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
`int topLevelDestinationIds`	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

Added in 1.0.0

public Builder(@NonNull Set<@NonNull 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
`@NonNull Set<@NonNull Integer> topLevelDestinationIds`	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.

Added in 1.0.0

public Builder(@NonNull 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
`@NonNull Menu topLevelMenu`	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 methods

build

Added in 1.0.0

public final @NonNull AppBarConfiguration build()

Construct the AppBarConfiguration instance.

Returns
`@NonNull AppBarConfiguration`	a valid `AppBarConfiguration`

Added in 2.0.0

Deprecated in 2.3.0

public final @NonNull AppBarConfiguration.Builder setDrawerLayout(DrawerLayout drawerLayout)

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
`@NonNull AppBarConfiguration.Builder`	this `Builder`

Added in 1.0.0

public final @NonNull AppBarConfiguration.Builder setFallbackOnNavigateUpListener(
    AppBarConfiguration.OnNavigateUpListener fallbackOnNavigateUpListener
)

Adds a OnNavigateUpListener that will be called as a fallback if the default behavior of androidx.navigation.NavController.navigateUp returns false.

Parameters
`AppBarConfiguration.OnNavigateUpListener fallbackOnNavigateUpListener`	Listener that will be invoked if `androidx.navigation.NavController.navigateUp` returns `false`.

Returns
`@NonNull AppBarConfiguration.Builder`	this `Builder`

Added in 2.3.0

public final @NonNull AppBarConfiguration.Builder setOpenableLayout(Openable openableLayout)

Display the Navigation button as a drawer symbol when it is not being shown as an Up button.

Parameters
`Openable openableLayout`	The Openable layout that should be toggled from the Navigation button

Returns
`@NonNull AppBarConfiguration.Builder`	this `Builder`