RoutePreviewNavigationTemplate.Builder
public final class RoutePreviewNavigationTemplate.Builder
A builder of RoutePreviewNavigationTemplate.
Summary
Public constructors
Builder
public Builder()
Constructs an empty Builder instance.
Public methods
build
public @NonNull RoutePreviewNavigationTemplate 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.IllegalStateException |
if the template is in a loading state but the list is set or vice versa, or if the template is not loading and the navigation action is not set. |
setActionStrip
public @NonNull RoutePreviewNavigationTemplate.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 RoutePreviewNavigationTemplate.Builder setHeader(@NonNull Header header)
Sets the Header for this template.
| Throws | |
|---|---|
java.lang.NullPointerException |
if |
public @NonNull RoutePreviewNavigationTemplate.BuildersetHeaderAction(@NonNull Action headerAction)
Sets the Action that will be displayed in the header of the template, or null to not display an action.
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 RoutePreviewNavigationTemplate.Builder setItemList(@NonNull ItemList itemList)
Sets an ItemList to show route options in a list view along with the map.
ItemList should be smaller or equal than the limit provided by CONTENT_LIMIT_TYPE_ROUTE_LIST. The host will ignore any items over that limit. The list must have an OnClickListener set. 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.
All rows must have either a androidx.car.app.model.DistanceSpan or a attached to either its title or texts, to indicate an estimate trip distance or duration for the route it represents. Where in the title or text these spans are attached to is up to the app.
| Throws | |
|---|---|
java.lang.IllegalArgumentException |
if |
java.lang.NullPointerException |
if |
| See also | |
|---|---|
getContentLimit |
setLoading
public @NonNull RoutePreviewNavigationTemplate.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.
setMapActionStrip
@RequiresCarApi(value = 4)
public @NonNull RoutePreviewNavigationTemplate.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 |
setNavigateAction
public @NonNull RoutePreviewNavigationTemplate.Builder setNavigateAction(@NonNull Action navigateAction)
Sets the Action to allow users to request navigation using the currently selected route.
This should not be null if the template is not in a loading state (see #setIsLoading}), and the Action's title must be set.
Spans are not supported in the navigate action and will be ignored.
| Throws | |
|---|---|
java.lang.NullPointerException |
if |
java.lang.IllegalArgumentException |
if |
setPanModeListener
@RequiresCarApi(value = 4)
public @NonNull RoutePreviewNavigationTemplate.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 RoutePreviewNavigationTemplate.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 RoutePreviewNavigationTemplate.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 |