PlaceListNavigationTemplate
@CarProtocol
public final class PlaceListNavigationTemplate implements Template
A template that supports showing a list of places alongside a custom drawn map.
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. - The template is sent in response to a user-initiated content refresh request. (see
setOnContentRefreshListener.
In order to use this template your car app MUST declare that it uses the
androidx.car.app.NAVIGATION_TEMPLATES permission in the manifest.
PlaceListNavigationTemplate, if the template was:
PlaceListNavigationTemplate template = new PlaceListNavigationTemplate.Builder()
.setItemList(itemListBuilder.build())
.setHeader(header)
.setActionStrip(actionStrip)
.setMapActionStrip(mapActionStrip)
.build();MapWithContentTemplate, the template would be:
MapWithContentTemplate template = new MapWithContentTemplate.Builder()
.setContentTemplate(new ListTemplate.Builder()
.setSingleList(itemListBuilder.build())
.setHeader(header)
.build())
.setActionStrip(actionStrip)
.setMapController(new MapController.Builder()
.setMapActionStrip(mapActionStrip)
.build())
.build();Summary
Nested types |
|---|
public final class PlaceListNavigationTemplate.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 list of items to display alongside the map or |
@Nullable ActionStrip |
@RequiresCarApi(value = 4)Returns the map |
@Nullable OnContentRefreshDelegate |
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 list of items to display alongside the map or null if the list is 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 |
getOnContentRefreshDelegate
public @Nullable OnContentRefreshDelegate getOnContentRefreshDelegate()
Returns the OnContentRefreshDelegate to be called when the user requests for content refresh for this template.
| See also | |
|---|---|
setOnContentRefreshListener |
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 |