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.

See also

NavigationFragmentResources

Constructors

NavigationFragment

fun NavigationFragment()

Types

object Companion

NavigationListener

interface NavigationListener

Listens for navigation events.

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.dispose is called on TextToSpeechEngine which is being replaced.

open fun dump(@NonNull p0: String, @Nullable p1: FileDescriptor?, @NonNull p2: PrintWriter, @Nullable p3: Array<String>?)

operator override fun equals(@Nullable other: Any?): Boolean

fun getActivity(): FragmentActivity?

getAllowEnterTransitionOverlap

open fun getAllowEnterTransitionOverlap(): Boolean

getAllowReturnTransitionOverlap

open fun getAllowReturnTransitionOverlap(): Boolean

fun getArguments(): Bundle?

getChildFragmentManager

fun getChildFragmentManager(): FragmentManager

open fun getContext(): Context?

getDefaultViewModelProviderFactory

open override fun getDefaultViewModelProviderFactory(): ViewModelProvider.Factory

getEnterTransition

open fun getEnterTransition(): Any?

getExitTransition

open fun getExitTransition(): Any?

fun getHost(): Any?

fun getId(): Int

getLayoutInflater

fun getLayoutInflater(): LayoutInflater

open override fun getLifecycle(): Lifecycle

getParentFragment

fun getParentFragment(): Fragment?

getParentFragmentManager

fun getParentFragmentManager(): FragmentManager

getReenterTransition

open fun getReenterTransition(): Any?

fun getResources(): Resources

getReturnTransition

open fun getReturnTransition(): Any?

getSavedStateRegistry

override fun getSavedStateRegistry(): SavedStateRegistry

getSharedElementEnterTransition

open fun getSharedElementEnterTransition(): Any?

getSharedElementReturnTransition

open fun getSharedElementReturnTransition(): Any?

fun getString(@StringRes p0: Int): String

fun getString(@StringRes p0: Int, @Nullable vararg p1: Any): String

fun getTag(): String?

fun getText(@StringRes p0: Int): CharSequence

open fun getView(): View?

getViewLifecycleOwner

open fun getViewLifecycleOwner(): LifecycleOwner

getViewLifecycleOwnerLiveData

open fun getViewLifecycleOwnerLiveData(): LiveData<LifecycleOwner>

getViewModelStore

open override fun getViewModelStore(): ViewModelStore

override fun hashCode(): Int

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

fun hasOptionsMenu(): Boolean

fun isAdded(): Boolean

fun isDetached(): Boolean

fun isHidden(): Boolean

fun isInLayout(): Boolean

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

fun isMenuVisible(): Boolean

fun isRemoving(): Boolean

fun isResumed(): Boolean

fun isStateSaved(): Boolean

fun isVisible(): Boolean

open fun onAttach(@NonNull p0: Context)

onConfigurationChanged

open override fun onConfigurationChanged(@NonNull p0: Configuration)

onContextItemSelected

open fun onContextItemSelected(@NonNull p0: MenuItem): Boolean

open override fun onCreate(savedInstanceState: Bundle?)

onCreateAnimation

open fun onCreateAnimation(p0: Int, p1: Boolean, p2: Int): Animation?

onCreateAnimator

open fun onCreateAnimator(p0: Int, p1: Boolean, p2: Int): Animator?

onCreateContextMenu

open override fun onCreateContextMenu(@NonNull p0: ContextMenu, @NonNull p1: View, @Nullable p2: ContextMenu.ContextMenuInfo?)

onCreateOptionsMenu

open fun onCreateOptionsMenu(@NonNull p0: Menu, @NonNull p1: MenuInflater)

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

open override fun onDestroy()

onDestroyOptionsMenu

open fun onDestroyOptionsMenu()

open override fun onDestroyView()

open fun onDetach()

onGetLayoutInflater

open fun onGetLayoutInflater(@Nullable p0: Bundle?): LayoutInflater

onHiddenChanged

open fun onHiddenChanged(p0: Boolean)

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

open override fun onLowMemory()

onMultiWindowModeChanged

open fun onMultiWindowModeChanged(p0: Boolean)

onOptionsItemSelected

open fun onOptionsItemSelected(@NonNull p0: MenuItem): Boolean

onOptionsMenuClosed

open fun onOptionsMenuClosed(@NonNull p0: Menu)

open fun onPause()

onPictureInPictureModeChanged

open fun onPictureInPictureModeChanged(p0: Boolean)

onPrepareOptionsMenu

open fun onPrepareOptionsMenu(@NonNull p0: Menu)

onPrimaryNavigationFragmentChanged

open fun onPrimaryNavigationFragmentChanged(p0: Boolean)

open fun onResume()

onSaveInstanceState

open fun onSaveInstanceState(@NonNull p0: Bundle)

open fun onStart()

open fun onStop()

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

onViewStateRestored

open fun onViewStateRestored(@Nullable p0: Bundle?)

postponeEnterTransition

open fun postponeEnterTransition()

fun postponeEnterTransition(p0: Long, @NonNull p1: TimeUnit)

registerForActivityResult

override fun <I : Any, O : Any> registerForActivityResult(@NonNull p0: ActivityResultContract<I, O>, @NonNull p1: ActivityResultCallback<O>): ActivityResultLauncher<I>

override fun <I : Any, O : Any> registerForActivityResult(@NonNull p0: ActivityResultContract<I, O>, @NonNull p1: ActivityResultRegistry, @NonNull p2: ActivityResultCallback<O>): ActivityResultLauncher<I>

registerForContextMenu

open fun registerForContextMenu(@NonNull p0: View)

removeNavigationListener

fun removeNavigationListener(listener: NavigationFragment.NavigationListener)

Removes previously added NavigationListener.

requireActivity

fun requireActivity(): FragmentActivity

requireArguments

fun requireArguments(): Bundle

fun requireContext(): Context

fun requireHost(): Any

requireParentFragment

fun requireParentFragment(): Fragment

fun requireView(): View

setAllowEnterTransitionOverlap

open fun setAllowEnterTransitionOverlap(p0: Boolean)

setAllowReturnTransitionOverlap

open fun setAllowReturnTransitionOverlap(p0: Boolean)

open fun setArguments(@Nullable p0: Bundle?)

setEnterSharedElementCallback

open fun setEnterSharedElementCallback(@Nullable p0: SharedElementCallback?)

setEnterTransition

open fun setEnterTransition(@Nullable p0: Any?)

setExitSharedElementCallback

open fun setExitSharedElementCallback(@Nullable p0: SharedElementCallback?)

setExitTransition

open fun setExitTransition(@Nullable p0: Any?)

setHasOptionsMenu

open fun setHasOptionsMenu(p0: Boolean)

setInitialSavedState

open fun setInitialSavedState(@Nullable p0: Fragment.SavedState?)

setMenuVisibility

open fun setMenuVisibility(p0: Boolean)

setReenterTransition

open fun setReenterTransition(@Nullable p0: Any?)

setReturnTransition

open fun setReturnTransition(@Nullable p0: Any?)

setSharedElementEnterTransition

open fun setSharedElementEnterTransition(@Nullable p0: Any?)

setSharedElementReturnTransition

open fun setSharedElementReturnTransition(@Nullable p0: Any?)

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), updateRoute(route: Route) or stopNavigation().

fun setUnits(units: UnitSystemType)

Sets the units for distance and speed.

shouldShowRequestPermissionRationale

open fun shouldShowRequestPermissionRationale(@NonNull p0: String): Boolean

open fun startActivity(p0: Intent)

open fun startActivity(p0: Intent, @Nullable p1: Bundle?)

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.

startPostponedEnterTransition

open fun startPostponedEnterTransition()

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.

open override fun toString(): String

unregisterForContextMenu

open fun unregisterForContextMenu(@NonNull p0: View)

fun update(routePlan: RoutePlan)

Updates navigation session with a provided RoutePlan. This method wraps the call to TomTomNavigation.update. If startNavigation(navigationOptions: NavigationOptions) has been called already, the UI will change accordingly.

Properties

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

var mPreviousWho: String?

open override val navigationView: NavigationView

Returns the configurable navigation view.