RoutePreviewNavigationTemplate
@CarProtocol
public final class RoutePreviewNavigationTemplate implements Template
A template that supports showing a list of routes alongside a custom drawn map.
The list must have its ItemList.OnSelectedListener set, and the template must have its navigate action set (see setNavigateAction). These are used in conjunction to inform the app that:
- A route has been selected. The app should also highlight the route on the map surface.
- A navigate action has been triggered. The app should begin navigation using the selected route.
The template itself does not expose a drawing surface. In order to draw on the canvas, use setSurfaceCallback.
onGetTemplate, this template is considered a refresh of a previous one if:
- The previous template is in a loading state (see
setLoading, or - The template title has not changed, and the number of rows and the title (not counting spans) of each row between the previous and new
ItemLists have not changed.
Note that specifically, this means the app should not use this template to continuously refresh the routes as the car moves.
In order to use this template your car app MUST declare that it uses the
androidx.car.app.NAVIGATION_TEMPLATES permission in the manifest.
RoutePreviewNavigationTemplate, if the template was:
RoutePreviewNavigationTemplate template = new RoutePreviewNavigationTemplate
.Builder()
.setItemList(new ItemList.Builder()
.addItem(new Row.Builder()
.setTitle(title))
.build())
.build())
.setHeader(header)
.setNavigateAction(new Action.Builder()
.setTitle("drive")
.setOnClickListener(() -> {})
.build())
.setActionStrip(actionStrip)
.setMapActionStrip(mapActionStrip)
.build();MapWithContentTemplate, the template would be:
MapWithContentTemplate template = new MapWithContentTemplate.Builder()
.setContentTemplate(new ListTemplate.Builder()
.setSingleList(new ItemList.Builder()
.addItem(new Row.Builder()
.setTitle(title))
.addAction(new Action.Builder()
.setTitle("drive")
.setOnClickListener(() -> {})
.build())
.build())
.build()))
.setHeader(header)
.build())
.setActionStrip(actionStrip)
.setMapController(new MapController.Builder()
.setMapActionStrip(mapActionStrip)
.build())
.build();MapWithContentTemplate API instead.
Summary
Nested types |
|---|
public final class RoutePreviewNavigationTemplate.BuilderA builder of |
Public methods |
|
|---|---|
boolean |
|
@Nullable ActionStrip |
Returns the |
@Nullable Header |
@RequiresCarApi(value = 5)Returns the |
@Nullable Action |
This method is deprecated. use |
@Nullable ItemList |
Returns the |
@Nullable ActionStrip |
@RequiresCarApi(value = 4)Returns the map |
@Nullable Action |
Returns the |
@Nullable PanModeDelegate |
@RequiresCarApi(value = 4)Returns the |
@Nullable CarText |
This method is deprecated. use |
int |
hashCode() |
boolean |
Returns whether the template is loading. |
@NonNull String |
toString() |
Public methods
getActionStrip
public @Nullable ActionStrip getActionStrip()
Returns the ActionStrip for this template or null if not set.
| See also | |
|---|---|
setActionStrip |
getHeader
@RequiresCarApi(value = 5)
public @Nullable Header getHeader()
Returns the Header to display in this template.
| See also | |
|---|---|
setHeader |
public @Nullable ActiongetHeaderAction()
Returns the Action that is set to be displayed in the header of the template or null if not set.
| See also | |
|---|---|
setHeaderAction |
getItemList
public @Nullable ItemList getItemList()
Returns the ItemList to show route options in a list view along with the map or null if not set.
| See also | |
|---|---|
setItemList |
getMapActionStrip
@RequiresCarApi(value = 4)
public @Nullable ActionStrip getMapActionStrip()
Returns the map ActionStrip for this template or null if not set.
| See also | |
|---|---|
setMapActionStrip |
getNavigateAction
public @Nullable Action getNavigateAction()
Returns the Action to allow users to request navigation using the currently selected route or null if not set.
| See also | |
|---|---|
setNavigateAction |
getPanModeDelegate
@RequiresCarApi(value = 4)
public @Nullable PanModeDelegate getPanModeDelegate()
Returns the PanModeDelegate that should be called when the user interacts with pan mode on this template, or null if a PanModeListener was not set.
public @Nullable CarTextgetTitle()
Returns the title of the template or null if not set.
| See also | |
|---|---|
setTitle |
isLoading
public boolean isLoading()
Returns whether the template is loading.
| See also | |
|---|---|
setLoading |