PlaceListNavigationTemplate.Builder

Builder()

Constructs an empty Builder instance.

fun build(): PlaceListNavigationTemplate

Constructs the template defined by this builder.

If neither header Action nor title have been set on the template, the header is hidden.

fun setActionStrip(actionStrip: ActionStrip): PlaceListNavigationTemplate.Builder

Sets the ActionStrip for this template.

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

The Action buttons in Map Based Template are automatically adjusted based on the screen size. On narrow width screen, icon Actions show by default. If no icon specify, showing title Actions instead. On wider width screen, title Actions show by default. If no title specify, showing icon Actions instead.

@RequiresCarApi(value = 5)
fun setHeader(header: Header): PlaceListNavigationTemplate.Builder

Sets the Header for this template.

fun setHeaderAction(headerAction: Action): PlaceListNavigationTemplate.Builder

Sets the Action that will be displayed in the header of the template.

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

fun setItemList(itemList: ItemList): PlaceListNavigationTemplate.Builder

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

To show a marker corresponding to a point of interest represented by a row, set the Place instance via setMetadata. The host will render the PlaceMarker in the list view as the row become visible. The app should synchronize with the list's behavior by rendering the same marker on the map surface.

Images of type IMAGE_TYPE_LARGE are not allowed in this template.

Rows are not allowed to have both and an image and a place marker.

All non-browsable rows must have a DistanceSpan attached to either its title or texts, to indicate the distance of the point of interest from the current location. Where in the title or text the span is attached to is up to the app.

fun setLoading(isLoading: Boolean): PlaceListNavigationTemplate.Builder

Sets whether the template is in a loading state.

If set to true, the UI will show a loading indicator where the list content would be otherwise. The caller is expected to call invalidate and send the new template content to the host once the data is ready. If set to false, the UI shows the ItemList contents added via setItemList.

@RequiresCarApi(value = 4)
fun setMapActionStrip(actionStrip: ActionStrip): PlaceListNavigationTemplate.Builder

Sets an ActionStrip with a list of map-control related actions for this template, such as pan or zoom.

The host will draw the buttons in an area that is associated with map controls.

If the app does not include the PAN button in this ActionStrip, the app will not receive the user input for panning gestures from SurfaceCallback methods, and the host will exit any previously activated pan mode.

fun setOnContentRefreshListener(
    onContentRefreshListener: OnContentRefreshListener
): PlaceListNavigationTemplate.Builder

Sets the OnContentRefreshListener to call when the user requests for the list contents to be refreshed in this template.

When the listener is triggered, an app can send a new PlaceListMapTemplate, for example, to show a new set of point-of-interests based on the current user location, without the car host counting it against the template quota described in onGetTemplate.

@RequiresCarApi(value = 4)
fun setPanModeListener(panModeListener: PanModeListener): PlaceListNavigationTemplate.Builder

Sets a PanModeListener that notifies when the user enters and exits the pan mode.

If the app does not include the PAN button in the map ActionStrip, the app will not receive the user input for panning gestures from SurfaceCallback methods, and the host will exit any previously activated pan mode.

fun setTitle(title: CarText): PlaceListNavigationTemplate.Builder

Sets the title of the template, with support for multiple length variants.

Only DistanceSpans and DurationSpans are supported in the input string.

fun setTitle(title: CharSequence): PlaceListNavigationTemplate.Builder

Sets the title of the template.

Only DistanceSpans and DurationSpans are supported in the input string.