Summary: Ctors | Methods | Inherited Methods

RoutePreviewNavigationTemplate.Builder

Kotlin |Java

public static final class RoutePreviewNavigationTemplate.Builder
extends Object

java.lang.Object
↳	androidx.car.app.navigation.model.RoutePreviewNavigationTemplate.Builder

A builder of RoutePreviewNavigationTemplate.

Summary

Public constructors
`Builder()` Constructs an empty `RoutePreviewNavigationTemplate.Builder` instance.

Public methods
`RoutePreviewNavigationTemplate`	`build()` Constructs the template defined by this builder.
`RoutePreviewNavigationTemplate.Builder`	`setActionStrip(ActionStrip actionStrip)` Sets the `ActionStrip` for this template, or `null` to not display an `ActionStrip`.
`RoutePreviewNavigationTemplate.Builder`	`setHeaderAction(Action headerAction)` Sets the `Action` that will be displayed in the header of the template, or `null` to not display an action.
`RoutePreviewNavigationTemplate.Builder`	`setItemList(ItemList itemList)` Sets an `ItemList` to show route options in a list view along with the map.
`RoutePreviewNavigationTemplate.Builder`	`setLoading(boolean isLoading)` Sets whether the template is in a loading state.
`RoutePreviewNavigationTemplate.Builder`	`setNavigateAction(Action navigateAction)` Sets the `Action` to allow users to request navigation using the currently selected route.
`RoutePreviewNavigationTemplate.Builder`	`setTitle(CharSequence title)` Sets the title of the template.
`RoutePreviewNavigationTemplate.Builder`	`setTitle(CarText title)` Sets the title of the template, with support for multiple length variants.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()`
`boolean`	`equals(Object arg0)`
`void`	`finalize()`
`final Class<?>`	`getClass()`
`int`	`hashCode()`
`final void`	`notify()`
`final void`	`notifyAll()`
`String`	`toString()`
`final void`	`wait(long arg0, int arg1)`
`final void`	`wait(long arg0)`
`final void`	`wait()`

Public constructors

Builder

public Builder ()

Constructs an empty RoutePreviewNavigationTemplate.Builder instance.

Public methods

build

public RoutePreviewNavigationTemplate build ()

Constructs the template defined by this builder.

Requirements

Either a header Action or title must be set on the template.

Returns
`RoutePreviewNavigationTemplate`

Throws
`IllegalStateException`	if the template is in a loading state but the list is set or vice versa, if the template is not loading and the navigation action is not set, or if the template does not have either a title or header `Action` set

setActionStrip

public RoutePreviewNavigationTemplate.Builder setActionStrip (ActionStrip actionStrip)

Sets the ActionStrip for this template, or null to not display an ActionStrip.

Unless set with this method, the template will not have an action strip.

Requirements

This template allows up to 2 Actions in its ActionStrip. Of the 2 allowed Actions, one of them can contain a title as set via Action.Builder.setTitle(CarText). Otherwise, only Actions with icons are allowed.

Parameters
`actionStrip`	`ActionStrip`

Returns
`RoutePreviewNavigationTemplate.Builder`

Throws
`IllegalArgumentException`	if `actionStrip` does not meet the requirements
`NullPointerException`	if `actionStrip` is `null`

setHeaderAction

public RoutePreviewNavigationTemplate.Builder setHeaderAction (Action headerAction)

Sets the Action that will be displayed in the header of the template, or null to not display an action.

Unless set with this method, the template will not have a header action.

Requirements

This template only supports either one of Action.APP_ICON and Action.BACK as a header Action.

Parameters
`headerAction`	`Action`

Returns
`RoutePreviewNavigationTemplate.Builder`

Throws
`IllegalArgumentException`	if `headerAction` does not meet the template's requirements
`NullPointerException`	if `headerAction` is `null`

setItemList

public RoutePreviewNavigationTemplate.Builder setItemList (ItemList itemList)

Sets an ItemList to show route options in a list view along with the map.

Requirements

The number of items in the ItemList should be smaller or equal than the limit provided by ConstraintManager.CONTENT_LIMIT_TYPE_ROUTE_LIST. The host will ignore any items over that limit. The list must have an OnClickListener set. Each Row can add up to 2 lines of texts via Row.Builder.addText(CarText) and cannot contain a Toggle.

Images of type