PlaceListMapTemplate.Builder

public static final class PlaceListMapTemplate.Builder
extends Object

java.lang.Object
   ↳ androidx.car.app.model.PlaceListMapTemplate.Builder


A builder of PlaceListMapTemplate.

Summary

Public constructors

Builder()

Returns an empty PlaceListMapTemplate.Builder instance.

Public methods

PlaceListMapTemplate build()

Constructs the template defined by this builder.

PlaceListMapTemplate.Builder setActionStrip(ActionStrip actionStrip)

Sets the ActionStrip for this template.

PlaceListMapTemplate.Builder setAnchor(Place anchor)

Sets the anchor maker on the map.

PlaceListMapTemplate.Builder setCurrentLocationEnabled(boolean isEnabled)

Sets whether to show the current location in the map.

PlaceListMapTemplate.Builder setHeaderAction(Action headerAction)

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

PlaceListMapTemplate.Builder setItemList(ItemList itemList)

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

PlaceListMapTemplate.Builder setLoading(boolean isLoading)

Sets whether the template is in a loading state.

PlaceListMapTemplate.Builder setTitle(CharSequence title)

Sets the title of the template.

PlaceListMapTemplate.Builder setTitle(CarText title)

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

Inherited methods

Public constructors

Builder

public Builder ()

Returns an empty PlaceListMapTemplate.Builder instance.

Public methods

build

public PlaceListMapTemplate build ()

Constructs the template defined by this builder.

Requirements

Either a header Action or title must be set on the template.

Returns
PlaceListMapTemplate

Throws
IllegalArgumentException if the template is in a loading state but the list is set, or vice versa
IllegalStateException if the template does not have either a title or header Action set

setActionStrip

public PlaceListMapTemplate.Builder setActionStrip (ActionStrip actionStrip)

Sets the ActionStrip for this template.

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

Requirements

This template allows up to 2 Actions in its ActionStrip. Of the 2 allowed Actions, one of them can contain a title as set via Action.Builder.setTitle(CarText). Otherwise, only Actions with icons are allowed.

Parameters
actionStrip ActionStrip

Returns
PlaceListMapTemplate.Builder

Throws
IllegalArgumentException if actionStrip does not meet the requirements
NullPointerException if actionStrip is null

setAnchor

public PlaceListMapTemplate.Builder setAnchor (Place anchor)

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.

Parameters
anchor Place

Returns
PlaceListMapTemplate.Builder

Throws
NullPointerException if anchor is null

setCurrentLocationEnabled

public PlaceListMapTemplate.Builder setCurrentLocationEnabled (boolean isEnabled)

Sets whether to show the current location in the map.

The map template will show the user's current location on the map, which is normally indicated by a blue dot.

This functionality requires the app to have the ACCESS_FINE_LOCATION permission.

Parameters
isEnabled boolean

Returns
PlaceListMapTemplate.Builder

setHeaderAction

public PlaceListMapTemplate.Builder setHeaderAction (Action headerAction)

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.

Parameters
headerAction Action

Returns
PlaceListMapTemplate.Builder

Throws
IllegalArgumentException if headerAction does not meet the template's requirements
NullPointerException if headerAction is null

setItemList

public PlaceListMapTemplate.Builder setItemList (ItemList itemList)

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(CarText) 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).

Parameters
itemList ItemList

Returns
PlaceListMapTemplate.Builder

Throws
IllegalArgumentException if itemList does not meet the template's requirements
NullPointerException if itemList is null

setLoading

public PlaceListMapTemplate.Builder setLoading (boolean isLoading)

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 setItemList(ItemList).

Parameters
isLoading boolean

Returns
PlaceListMapTemplate.Builder

setTitle

public PlaceListMapTemplate.Builder setTitle (CharSequence title)

Sets the title of the template.

Spans are not supported in the input string and will be ignored.

Parameters
title CharSequence

Returns
PlaceListMapTemplate.Builder

Throws
NullPointerException if title is null

See also:

setTitle

public PlaceListMapTemplate.Builder setTitle (CarText title)

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

Spans are not supported in the input string and will be ignored.

Parameters
title CarText

Returns
PlaceListMapTemplate.Builder

Throws
NullPointerException if title is null

See also: