NavigationTemplate

@CarProtocol
class NavigationTemplate : Template

A template for showing navigation information.

This template has two independent sections which can be updated:

• Navigation information such as routing instructions or navigation-related messages.
• Travel estimates to the destination.

To update the template as the user navigates, call invalidate to provide the host with a new template with the updated information.

The template itself does not expose a drawing surface. In order to draw on the canvas, use setSurfaceCallback.

See androidx.car.app.notification.CarAppExtender for how to show alerts with notifications. Frequent alert notifications distract the driver and are discouraged.

• onScroll
• onFling
• onScale

...
Action panAction = new Action.Builder(Action.PAN).setIcon(myPanIcon).build();
ActionStrip mapActionStrip = new ActionStrip.Builder().addAction(panAction).build();
NavigationTemplate.Builder builder = new NavigationTemplate.Builder();
builder.setMapActionStrip(mapActionStrip);
...

If the app does not include this 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.

The host may hide the pan button in some head units in which the user does not need it. Also, the host may hide other UI components in the template while the user is in the pan mode.

Note that not all head units support touch gestures, and not all touch screens support multi-touch gestures. Therefore, some SurfaceCallback methods may not be called in some cars. In order to support different head units, use the buttons in the map action strip to provide necessary functionality, such as the zoom-in and zoom-out buttons.

Further, this template is considered a view that the user will stay and consume contents from, and the host will reset the template quota once an app reaches this template.

In order to use this template your car app MUST declare that it uses the androidx.car.app.NAVIGATION_TEMPLATES permission in the manifest.

Summary

fun equals(other: Any?): Boolean

fun getActionStrip(): ActionStrip?

fun getBackgroundColor(): CarColor?

fun getDestinationTravelEstimate(): TravelEstimate?

@RequiresCarApi(value = 2)
fun getMapActionStrip(): ActionStrip?

fun getNavigationInfo(): NavigationTemplate.NavigationInfo?

@RequiresCarApi(value = 2)
fun getPanModeDelegate(): PanModeDelegate?

@RequiresCarApi(value = 2)
fun getPanModeToggle(): Toggle?

fun hashCode(): Int

fun toString(): String