RouteSettings (Android Maps SDK

All Superinterfaces:

com.tomtom.core.maps.OnMapTapListener
```
public interface RouteSettings
extends com.tomtom.core.maps.OnMapTapListener
```
Advanced settings for routes manipulation. To obtain this interface, call TomtomMap.getRouteSettings()

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addOnRouteClickListener(TomtomMapCallback.OnRouteClickListener listener)` Called to add a listener for route clicks.
`Route`	`addRoute(RouteBuilder routeBuilder)` Display route and prepare map to navigate on that route.
`void`	`clearRoute()` Erase route from map.
`void`	`displayRouteOverview(long id)` Display route overview using its id.
`void`	`displayRoutesOverview()` Display route overview.
`Optional<Route>`	`findRouteByID(long id)` Find route using its id.
`java.util.List<Route>`	`getRoutes()` Get list of all routs added to the map.
`void`	`onViewStateRestored(com.tomtom.online.sdk.map.MapState savedState)` Called internally to restore state, e.g.
`void`	`removeOnRouteClickListener(TomtomMapCallback.OnRouteClickListener listener)` Called to remove a listener for route clicks.
`void`	`removeOnRouteClickListeners()` Remove all registered route click listeners.
`void`	`setRouteActive(long routeId)` Mark route with a given id as active.
`void`	`setRouteInactive(long routeId)` Mark route with a given id as inactive.
`void`	`setRoutesActive()` Mark all added routes as active.
`void`	`setRoutesInactive()` Mark all added routes as inactive.

Methods inherited from interface com.tomtom.core.maps.OnMapTapListener
onMapLongTap, onMapTap

- Method Detail
  - onViewStateRestored
```
void onViewStateRestored(com.tomtom.online.sdk.map.MapState savedState)
```
    Called internally to restore state, e.g. when app is resumed from the background.
  - addRoute
```
Route addRoute(RouteBuilder routeBuilder)
```
    Display route and prepare map to navigate on that route.
  - getRoutes
```
java.util.List<Route> getRoutes()
```
    Get list of all routs added to the map.
  - clearRoute
```
void clearRoute()
```
    Erase route from map.
  - displayRoutesOverview
```
void displayRoutesOverview()
```
    Display route overview. All added routes will be visible.
  - displayRouteOverview
```
void displayRouteOverview(long id)
```
    Display route overview using its id. No action when route not found.
  - findRouteByID
```
Optional<Route> findRouteByID(long id)
```
    Find route using its id.
  - setRoutesInactive
```
void setRoutesInactive()
```
    Mark all added routes as inactive.
  - setRoutesActive
```
void setRoutesActive()
```
    Mark all added routes as active.
  - setRouteActive
```
void setRouteActive(long routeId)
```
    Mark route with a given id as active. No action if route does not exist.
  - setRouteInactive
```
void setRouteInactive(long routeId)
```
    Mark route with a given id as inactive. No action if route does not exist.
  - addOnRouteClickListener
```
void addOnRouteClickListener(TomtomMapCallback.OnRouteClickListener listener)
```
    Called to add a listener for route clicks.
    
    Parameters:
    
    listener - Listener to be added for route clicks.
  - removeOnRouteClickListener
```
void removeOnRouteClickListener(TomtomMapCallback.OnRouteClickListener listener)
```
    Called to remove a listener for route clicks.
    
    Parameters:
    
    listener - Listener to be removed for route clicks.
  - removeOnRouteClickListeners
```
void removeOnRouteClickListeners()
```
    Remove all registered route click listeners.

Interface RouteSettings

Method Summary

Methods inherited from interface com.tomtom.core.maps.OnMapTapListener

Method Detail

onViewStateRestored

addRoute

getRoutes

clearRoute

displayRoutesOverview

displayRouteOverview

findRouteByID

setRoutesInactive

setRoutesActive

setRouteActive

setRouteInactive

addOnRouteClickListener

removeOnRouteClickListener

removeOnRouteClickListeners