RoutePreviewNavigationTemplate.java
/*
* Copyright 2020 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package androidx.car.app.navigation.model;
import static androidx.car.app.model.constraints.ActionsConstraints.ACTIONS_CONSTRAINTS_HEADER;
import static androidx.car.app.model.constraints.ActionsConstraints.ACTIONS_CONSTRAINTS_SIMPLE;
import static androidx.car.app.model.constraints.RowListConstraints.ROW_LIST_CONSTRAINTS_ROUTE_PREVIEW;
import static java.util.Objects.requireNonNull;
import androidx.annotation.Keep;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.car.app.Screen;
import androidx.car.app.SurfaceCallback;
import androidx.car.app.model.Action;
import androidx.car.app.model.ActionStrip;
import androidx.car.app.model.CarText;
import androidx.car.app.model.ItemList;
import androidx.car.app.model.ModelUtils;
import androidx.car.app.model.OnClickListener;
import androidx.car.app.model.Row;
import androidx.car.app.model.Template;
import androidx.car.app.model.Toggle;
import java.util.Collections;
import java.util.Objects;
/**
* A template that supports showing a list of routes alongside a custom drawn map.
*
* <p>The list must have its {@link
* ItemList.OnSelectedListener} set, and the template
* must have its navigate action set (see {@link Builder#setNavigateAction}). These are used in
* conjunction to inform the app that:
*
* <ol>
* <li>A route has been selected. The app should also highlight the route on the map surface.
* <li>A navigate action has been triggered. The app should begin navigation using the selected
* route.
* </ol>
*
* <p>The template itself does not expose a drawing surface. In order to draw on the canvas, use
* {@link androidx.car.app.AppManager#setSurfaceCallback(SurfaceCallback)}.
*
* <h4>Template Restrictions</h4>
*
* In regards to template refreshes, as described in {@link Screen#onGetTemplate()}, this template
* is considered a refresh of a previous one if:
*
* <ul>
* <li>The template title has not changed, and
* <li>The previous template is in a loading state (see {@link Builder#setLoading}, or the
* number of rows and the string contents (title, texts, not counting spans) of each row
* between the previous and new {@link ItemList}s have not changed.
* </ul>
*
* <p>Note that specifically, this means the app can't use this template to continuously refresh
* the routes as the car moves without hitting the template limit.
*
* <p>In order to use this template your car app <b>MUST</b> declare that it uses the {@code
* androidx.car.app.NAVIGATION_TEMPLATES} permission in the manifest.
*/
public final class RoutePreviewNavigationTemplate implements Template {
@Keep
private final boolean mIsLoading;
@Keep
@Nullable
private final CarText mTitle;
@Keep
@Nullable
private final Action mNavigateAction;
@Keep
@Nullable
private final ItemList mItemList;
@Keep
@Nullable
private final Action mHeaderAction;
@Keep
@Nullable
private final ActionStrip mActionStrip;
/**
* Returns the title of the template or {@code null} if not set.
*
* @see Builder#setTitle(CharSequence)
*/
@Nullable
public CarText getTitle() {
return mTitle;
}
/**
* Returns the {@link Action} that is set to be displayed in the header of the template or
* {@code null} if not set.
*
* @see Builder#setHeaderAction(Action)
*/
@Nullable
public Action getHeaderAction() {
return mHeaderAction;
}
/**
* Returns the {@link ActionStrip} for this template or {@code null} if not set.
*
* @see Builder#setActionStrip(ActionStrip)
*/
@Nullable
public ActionStrip getActionStrip() {
return mActionStrip;
}
/**
* Returns whether the template is loading.
*
* @see Builder#setLoading(boolean)
*/
public boolean isLoading() {
return mIsLoading;
}
/**
* Returns the {@link Action} to allow users to request navigation using the currently selected
* route or {@code null} if not set.
*
* @see Builder#setNavigateAction(Action)
*/
@Nullable
public Action getNavigateAction() {
return mNavigateAction;
}
/**
* Returns the {@link ItemList} to show route options in a list view along with the map or
* {@code null} if not set.
*
* @see Builder#setItemList(ItemList)
*/
@Nullable
public ItemList getItemList() {
return mItemList;
}
@NonNull
@Override
public String toString() {
return "RoutePreviewNavigationTemplate";
}
@Override
public int hashCode() {
return Objects.hash(mTitle, mIsLoading, mNavigateAction, mItemList, mHeaderAction,
mActionStrip);
}
@Override
public boolean equals(@Nullable Object other) {
if (this == other) {
return true;
}
if (!(other instanceof RoutePreviewNavigationTemplate)) {
return false;
}
RoutePreviewNavigationTemplate otherTemplate = (RoutePreviewNavigationTemplate) other;
return mIsLoading == otherTemplate.mIsLoading
&& Objects.equals(mTitle, otherTemplate.mTitle)
&& Objects.equals(mNavigateAction, otherTemplate.mNavigateAction)
&& Objects.equals(mItemList, otherTemplate.mItemList)
&& Objects.equals(mHeaderAction, otherTemplate.mHeaderAction)
&& Objects.equals(mActionStrip, otherTemplate.mActionStrip);
}
RoutePreviewNavigationTemplate(Builder builder) {
mTitle = builder.mTitle;
mIsLoading = builder.mIsLoading;
mNavigateAction = builder.mNavigateAction;
mItemList = builder.mItemList;
mHeaderAction = builder.mHeaderAction;
mActionStrip = builder.mActionStrip;
}
/** Constructs an empty instance, used by serialization code. */
private RoutePreviewNavigationTemplate() {
mTitle = null;
mIsLoading = false;
mNavigateAction = null;
mItemList = null;
mHeaderAction = null;
mActionStrip = null;
}
/** A builder of {@link RoutePreviewNavigationTemplate}. */
public static final class Builder {
@Nullable
CarText mTitle;
boolean mIsLoading;
@Nullable
Action mNavigateAction;
@Nullable
ItemList mItemList;
@Nullable
Action mHeaderAction;
@Nullable
ActionStrip mActionStrip;
/**
* Sets the title of the template.
*
* <p>Unless set with this method, the template will not have a title.
*
* <p>Spans are not supported in the input string.
*
* @throws NullPointerException if {@code title} is null
* @see CarText
*/
@NonNull
public Builder setTitle(@NonNull CharSequence title) {
mTitle = CarText.create(requireNonNull(title));
return this;
}
/**
* Sets whether the template is in a loading state.
*
* <p>If set to {@code true}, the UI will show a loading indicator where the list content
* would be otherwise. The caller is expected to call
* {@link androidx.car.app.Screen#invalidate()} and send the new template content to the
* host once the data is ready.
*/
@NonNull
public Builder setLoading(boolean isLoading) {
mIsLoading = isLoading;
return this;
}
/**
* Sets the {@link Action} that will be displayed in the header of the template, or
* {@code null} to not display an action.
*
* <p>Unless set with this method, the template will not have a header action.
*
* <h4>Requirements</h4>
*
* This template only supports either one of {@link Action#APP_ICON} and
* {@link Action#BACK} as a header {@link Action}.
*
* @throws IllegalArgumentException if {@code headerAction} does not meet the template's
* requirements
* @throws NullPointerException if {@code headerAction} is {@code null}
*/
@NonNull
public Builder setHeaderAction(@NonNull Action headerAction) {
ACTIONS_CONSTRAINTS_HEADER.validateOrThrow(
Collections.singletonList(requireNonNull(headerAction)));
mHeaderAction = headerAction;
return this;
}
/**
* Sets the {@link Action} to allow users to request navigation using the currently selected
* route.
*
* <p>This should not be {@code null} if the template is not in a loading state (see
* #setIsLoading}), and the {@link Action}'s title must be set.
*
* @throws NullPointerException if {@code navigateAction} is {@code null}
* @throws IllegalArgumentException if {@code navigateAction}'s title is {@code null} or
* empty
*/
@NonNull
public Builder setNavigateAction(@NonNull Action navigateAction) {
if (CarText.isNullOrEmpty(requireNonNull(navigateAction).getTitle())) {
throw new IllegalArgumentException("The Action's title cannot be null or empty");
}
mNavigateAction = requireNonNull(navigateAction);
return this;
}
/**
* Sets an {@link ItemList} to show route options in a list view along with the map.
*
* <h4>Requirements</h4>
*
* This template allows up to 3 {@link Row}s in the {@link ItemList}. The host will
* ignore any items over that limit. The list must have an {@link OnClickListener} set. Each
* {@link Row} can add up to 2 lines of texts via {@link Row.Builder#addText} and cannot
* contain a {@link Toggle}.
*
* <p>Images of type {@link Row#IMAGE_TYPE_LARGE} are not allowed in this template.
*
* <p>All rows must have either a {@link androidx.car.app.model.DistanceSpan} or a {@link
* androidx.car.app.model.DurationSpan} 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 IllegalArgumentException if {@code itemList} does not meet the template's
* requirements
* @throws NullPointerException if {@code itemList} is {@code null}
*/
@NonNull
public Builder setItemList(@NonNull ItemList itemList) {
ROW_LIST_CONSTRAINTS_ROUTE_PREVIEW.validateOrThrow(requireNonNull(itemList));
ModelUtils.validateAllRowsHaveDistanceOrDuration(itemList.getItems());
ModelUtils.validateAllRowsHaveOnlySmallImages(itemList.getItems());
if (!itemList.getItems().isEmpty() && itemList.getOnSelectedDelegate() == null) {
throw new IllegalArgumentException(
"The OnSelectedListener must be set for the route list");
}
mItemList = itemList;
return this;
}
/**
* Sets the {@link ActionStrip} for this template, or {@code null} to not display an {@link
* ActionStrip}.
*
* <p>Unless set with this method, the template will not have an action strip.
*
* <h4>Requirements</h4>
*
* This template allows up to 2 {@link Action}s in its {@link ActionStrip}. Of the 2 allowed
* {@link Action}s, one of them can contain a title as set via
* {@link Action.Builder#setTitle}. Otherwise, only {@link Action}s with icons are allowed.
*
* @throws IllegalArgumentException if {@code actionStrip} does not meet the requirements
* @throws NullPointerException if {@code actionStrip} is {@code null}
*/
@NonNull
public Builder setActionStrip(@NonNull ActionStrip actionStrip) {
ACTIONS_CONSTRAINTS_SIMPLE.validateOrThrow(requireNonNull(actionStrip).getActions());
mActionStrip = actionStrip;
return this;
}
/**
* Constructs the template defined by this builder.
*
* <h4>Requirements</h4>
*
* Either a header {@link Action} or title must be set on the template.
*
* @throws IllegalStateException if the template is in a loading state but the list is
* set or vice versa, if the template is not loading and
* the navigation action is not set, or if the template
* does not have either a title or header {@link Action} set
*/
@NonNull
public RoutePreviewNavigationTemplate build() {
boolean hasList = mItemList != null;
if (mIsLoading == hasList) {
throw new IllegalStateException(
"Template is in a loading state but a list is set, or vice versa");
}
if (!mIsLoading) {
if (mNavigateAction == null) {
throw new IllegalStateException(
"The navigation action cannot be null when the list is not in a "
+ "loading state");
}
}
if (CarText.isNullOrEmpty(mTitle) && mHeaderAction == null) {
throw new IllegalStateException("Either the title or header action must be set");
}
return new RoutePreviewNavigationTemplate(this);
}
/** Constructs an empty {@link Builder} instance. */
public Builder() {
}
}
}