Overview

A builder of PlaceListMapTemplate.

Summary

Constructors
public	Builder() Returns an empty PlaceListMapTemplate.Builder instance.

Methods
public PlaceListMapTemplate	build() Constructs the template defined by this builder.
public PlaceListMapTemplate.Builder	setActionStrip(ActionStrip actionStrip) Sets the ActionStrip for this template.
public PlaceListMapTemplate.Builder	setAnchor(Place anchor) Sets the anchor maker on the map.
public PlaceListMapTemplate.Builder	setCurrentLocationEnabled(boolean isEnabled) Sets whether to show the current location in the map.
public PlaceListMapTemplate.Builder	setHeaderAction(Action headerAction) Sets the Action that will be displayed in the header of the template.
public PlaceListMapTemplate.Builder	setItemList(ItemList itemList) Sets an ItemList to show in a list view along with the map.
public PlaceListMapTemplate.Builder	setLoading(boolean isLoading) Sets whether the template is in a loading state.
public PlaceListMapTemplate.Builder	setOnContentRefreshListener(OnContentRefreshListener onContentRefreshListener) Sets the OnContentRefreshListener to call when the user requests for the list contents to be refreshed in this template.
public PlaceListMapTemplate.Builder	setTitle(CarText title) Sets the title of the template, with support for multiple length variants.
public PlaceListMapTemplate.Builder	setTitle(java.lang.CharSequence title) Sets the title of the template.
from java.lang.Object	clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructors

Returns an empty PlaceListMapTemplate.Builder instance.

Methods

Sets whether to show the current location in the map.

The map template will show the user's current location on the map.

This functionality requires the app to have either the ACCESS_FINE_LOCATION or ACCESS_COARSE_LOCATION permission. When isEnabled is true, the host may receive location updates from the app in order to show the user's current location.

Sets whether the template is in a loading state.

If set to true, the UI will display a loading indicator where the list content would be otherwise. The caller is expected to call Screen.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 PlaceListMapTemplate.Builder.setItemList(ItemList).

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.

Requirements

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

Sets the title of the template.

Only DistanceSpans and DurationSpans are supported in the input string.

See also: CarText

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

Only DistanceSpans and DurationSpans are supported in the input string.

See also: CarText

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

Unless set with this method, the template will not show an item list.

To show a marker corresponding to a point of interest represented by a row, set the Place instance via Row.Builder.setMetadata(Metadata). The host will display the PlaceMarker in both the map and the list view as the row becomes visible.

Requirements

The number of items in the ItemList should be smaller or equal than the limit provided by ConstraintManager.CONTENT_LIMIT_TYPE_PLACE_LIST. The host will ignore any items over that limit. The list itself cannot be selectable as set via ItemList.Builder.setOnSelectedListener(ItemList.OnSelectedListener). Each Row can add up to 2 lines of texts via Row.Builder.addText(CharSequence) and cannot contain a Toggle.

Images of type Row.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. A row is browsable when it's configured like so with Row.Builder.setBrowsable(boolean).

See also: ConstraintManager.getContentLimit(int)

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.

Requirements

This template allows up to 4 Actions in its ActionStrip. Of the 4 allowed Actions, it can either be a title Action as set via Action.Builder.setTitle(CharSequence), or a icon Action as set via Action.Builder.setIcon(CarIcon).

Sets the anchor maker on the map.

An anchor marker will not be displayed unless set with this method.

The anchor marker is displayed differently from other markers by the host.

If not null, an anchor marker will be shown at the specified CarLocation on the map. The camera will adapt to always have the anchor marker visible within its viewport, along with other places' markers from Row that are currently visible in the Pane. This can be used to provide a reference point on the map (e.g. the center of a search region) as the user pages through the Pane's markers, for example.

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 Screen.onGetTemplate().

Constructs the template defined by this builder.

Requirements

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