PlaceListNavigationTemplate
@CarProtocol
class PlaceListNavigationTemplate : 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 |
|---|
|
A builder of |
Public functions |
|
|---|---|
Boolean |
|
ActionStrip? |
Returns the |
Header? |
@RequiresCarApi(value = 5)Returns the |
Action? |
This function is deprecated. use |
ItemList? |
Returns the list of items to display alongside the map or |
ActionStrip? |
@RequiresCarApi(value = 4)Returns the map |
OnContentRefreshDelegate? |
Returns the |
PanModeDelegate? |
@RequiresCarApi(value = 4)Returns the |
CarText? |
This function is deprecated. use |
Int |
hashCode() |
Boolean |
Returns whether the template is loading. |
String |
toString() |
Public functions
getActionStrip
fun getActionStrip(): ActionStrip?
Returns the ActionStrip for this template or null if not set.
| See also | |
|---|---|
setActionStrip |
getHeader
@RequiresCarApi(value = 5)
fun getHeader(): Header?
Returns the Header to display in this template.
| See also | |
|---|---|
setHeader |
fungetHeaderAction(): Action?
Returns the Action that is set to be displayed in the header of the template or null if not set.
| See also | |
|---|---|
setHeaderAction |
getItemList
fun getItemList(): ItemList?
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)
fun getMapActionStrip(): ActionStrip?
Returns the map ActionStrip for this template or null if not set.
| See also | |
|---|---|
setMapActionStrip |
getOnContentRefreshDelegate
fun getOnContentRefreshDelegate(): OnContentRefreshDelegate?
Returns the OnContentRefreshDelegate to be called when the user requests for content refresh for this template.
| See also | |
|---|---|
setOnContentRefreshListener |
getPanModeDelegate
@RequiresCarApi(value = 4)
fun getPanModeDelegate(): PanModeDelegate?
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.
isLoading
fun isLoading(): Boolean
Returns whether the template is loading.
| See also | |
|---|---|
setLoading |