com.tomtom.sdk.navigation:ui/com.tomtom.sdk.navigation.ui/NavigationFragment

NavigationFragment

open class NavigationFragment : Fragment, UiComponentsController

An Android fragment wrapping TomTomNavigation. It provides the UI that shows information about the oncoming manoeuvres, route parameters (like ETA and remaining distance), current speed and the speed limit.

It can be instantiated either programmatically via NavigationFragment.newInstance(navigationUiOptions: NavigationUiOptions) or via the XML view inflation.

Important: This is a Public Preview API. It may be changed or removed at any time.

Constructors

NavigationFragment

constructor()

Types

Companion

object Companion

NavigationListener

interface NavigationListener

Listens for navigation events.

Properties

navigationView

open override val navigationView: NavigationView

Returns the configurable navigation view.

Inherited properties

defaultViewModelCreationExtras

@get:NonNull

@get:CallSuper

open override val defaultViewModelCreationExtras: CreationExtras

defaultViewModelProviderFactory

@get:NonNull

open override val defaultViewModelProviderFactory: ViewModelProvider.Factory

lifecycle

@get:NonNull

open override val lifecycle: Lifecycle

mPreviousWho

@RestrictTo(value = [RestrictTo.Scope.LIBRARY])

@Nullable

var mPreviousWho: String?

savedStateRegistry

@get:NonNull

override val savedStateRegistry: SavedStateRegistry

viewModelStore

@get:NonNull

open override val viewModelStore: ViewModelStore

Functions

addNavigationListener

fun addNavigationListener(listener: NavigationFragment.NavigationListener)

Adds the instance of NavigationListener.

changeAudioLanguage

fun changeAudioLanguage(language: Locale)

Changes the language which will be used to synthesize audio messages.

changeTextToSpeechEngine

fun changeTextToSpeechEngine(ttsEngine: TextToSpeechEngine)

Changes which TextToSpeechEngine will be used to synthesize audio instructions. TextToSpeechEngine.close is called on TextToSpeechEngine which is being replaced.

onCreate

open override fun onCreate(savedInstanceState: Bundle?)

onCreateView

open override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, state: Bundle?): View

onDestroy

open override fun onDestroy()

onDestroyView

open override fun onDestroyView()

onInflate

open override fun onInflate(context: Context, attrs: AttributeSet, savedInstanceState: Bundle?)

onViewCreated

open override fun onViewCreated(view: View, savedInstanceState: Bundle?)

removeNavigationListener

fun removeNavigationListener(listener: NavigationFragment.NavigationListener)

Removes previously added NavigationListener.

setActiveRoutePlan

fun setActiveRoutePlan(routePlan: RoutePlan)

Sets a provided routePlan as active. This method wraps the call to TomTomNavigation.setActiveRoutePlan.

setTomTomNavigation

fun setTomTomNavigation(tomTomNavigation: TomTomNavigation)

Sets an instance of TomTomNavigation. It has to be called before calling any other navigation method, such as: startNavigation(routes: List), setActiveRoutePlan or stopNavigation().

setUnits

fun setUnits(units: UnitSystemType)

Sets the units for distance and speed.

startNavigation

fun startNavigation()

Starts navigation without a Route. This method wraps the call to TomTomNavigation.start. Navigation will proceed with following steps:

fun startNavigation(routePlan: RoutePlan)

Starts navigation with provided RoutePlan. This method wraps the call to TomTomNavigation.start. When called, the UI starts showing Route's guidance, current speed and speed limit. NavigationListener.onStarted is called when navigation has been started.

stopNavigation

fun stopNavigation()

Stops the navigation. This method wraps the call to TomTomNavigation.stop. When called, the UI stops showing Route's guidance, current speed and speed limit.