PlaceListNavigationTemplate.Builder
public final class PlaceListNavigationTemplate.Builder
A builder of PlaceListNavigationTemplate.
Summary
Public constructors
Builder
public Builder()
Constructs an empty Builder instance.
Public methods
build
public @NonNull PlaceListNavigationTemplate build()
Constructs the template defined by this builder.
RequirementsIf neither header Action nor title have been set on the template, the header is hidden.
| Throws | |
|---|---|
java.lang.IllegalArgumentException |
if the template is in a loading state but the list is set, or vice versa |
setActionStrip
public @NonNull PlaceListNavigationTemplate.Builder setActionStrip(@NonNull ActionStrip actionStrip)
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.
Actions in its ActionStrip. Of the 4 allowed Actions, it can either be a title Action as set via setTitle, or a icon Action as set via setIcon.
| Throws | |
|---|---|
java.lang.IllegalArgumentException |
if |
java.lang.NullPointerException |
if |
setHeader
@RequiresCarApi(value = 5)
public @NonNull PlaceListNavigationTemplate.Builder setHeader(@NonNull Header header)
Sets the Header for this template.
| Throws | |
|---|---|
java.lang.NullPointerException |
if |
public @NonNull PlaceListNavigationTemplate.BuildersetHeaderAction(@NonNull 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 ofAPP_ICON and BACK as a header Action.
| Throws | |
|---|---|
java.lang.IllegalArgumentException |
if |
java.lang.NullPointerException |
if |
setItemList
public @NonNull PlaceListNavigationTemplate.Builder setItemList(@NonNull ItemList itemList)
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.
ItemList should be smaller or equal than the limit provided by CONTENT_LIMIT_TYPE_PLACE_LIST. The host will ignore any items over that limit. The list itself cannot be selectable as set via setOnSelectedListener. Each Row can add up to 2 lines of texts via addText and cannot contain a Toggle.
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.
| Throws | |
|---|---|
java.lang.IllegalArgumentException |
if |
java.lang.NullPointerException |
if |
| See also | |
|---|---|
getContentLimit |
setLoading
public @NonNull PlaceListNavigationTemplate.Builder setLoading(boolean isLoading)
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.
setMapActionStrip
@RequiresCarApi(value = 4)
public @NonNull PlaceListNavigationTemplate.Builder setMapActionStrip(@NonNull ActionStrip actionStrip)
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.
Actions in its map ActionStrip. Only Actions with icons set via setIcon are allowed.
| Throws | |
|---|---|
java.lang.IllegalArgumentException |
if |
java.lang.NullPointerException |
if |
setOnContentRefreshListener
public @NonNull PlaceListNavigationTemplate.Builder setOnContentRefreshListener(
@NonNull OnContentRefreshListener onContentRefreshListener
)
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.
| Throws | |
|---|---|
java.lang.NullPointerException |
if |
setPanModeListener
@RequiresCarApi(value = 4)
public @NonNull PlaceListNavigationTemplate.Builder setPanModeListener(@NonNull PanModeListener panModeListener)
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.
| Throws | |
|---|---|
java.lang.NullPointerException |
if |
public @NonNull PlaceListNavigationTemplate.BuildersetTitle(@NonNull CarText title)
Sets the title of the template, with support for multiple length variants.
Only DistanceSpans and DurationSpans are supported in the input string.
| Throws | |
|---|---|
java.lang.NullPointerException |
if |
java.lang.IllegalArgumentException |
if |
| See also | |
|---|---|
CarText |
public @NonNull PlaceListNavigationTemplate.BuildersetTitle(@NonNull CharSequence title)
Sets the title of the template.
Only DistanceSpans and DurationSpans are supported in the input string.
| Throws | |
|---|---|
java.lang.NullPointerException |
if |
java.lang.IllegalArgumentException |
if |
| See also | |
|---|---|
CarText |