NavigationTemplate.Builder

Builder()

Constructs an empty Builder instance.

fun build(): NavigationTemplate

Constructs the NavigationTemplate defined by this builder.

fun setActionStrip(actionStrip: ActionStrip): NavigationTemplate.Builder

Sets an ActionStrip with a list of template-scoped actions for this template.

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.

fun setBackgroundColor(backgroundColor: CarColor): NavigationTemplate.Builder

Sets the background color to use for the navigation information.

Depending on contrast requirements, capabilities of the vehicle screens, or other factors, the color may be ignored by the host or overridden by the vehicle system.

fun setDestinationTravelEstimate(destinationTravelEstimate: TravelEstimate): NavigationTemplate.Builder

Sets the TravelEstimate to the final destination.

@RequiresCarApi(value = 2)
fun setMapActionStrip(actionStrip: ActionStrip): NavigationTemplate.Builder

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.

fun setNavigationInfo(navigationInfo: NavigationTemplate.NavigationInfo): NavigationTemplate.Builder

Sets the navigation information to display on the template.

Unless set with this method, navigation info won't be displayed on the template.

@RequiresCarApi(value = 2)
fun setPanModeListener(panModeListener: PanModeListener): NavigationTemplate.Builder

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.