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

NavigationFragment

open class NavigationFragment : Fragment, UiComponentsController
Content copied to clipboard

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

com.tomtom.sdk.navigation.ui.attrs.NavigationFragmentResources

Constructors

Link copied to clipboard
fun NavigationFragment()
Content copied to clipboard

Types

Link copied to clipboard
object Companion
Content copied to clipboard
Link copied to clipboard
interface NavigationListener
Content copied to clipboard

Listens for navigation events.

Functions

Link copied to clipboard
fun addNavigationListener(listener: NavigationFragment.NavigationListener)
Content copied to clipboard

Adds the instance of NavigationListener.

Link copied to clipboard
fun changeAudioLanguage(language: Locale)
Content copied to clipboard

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

Link copied to clipboard
fun changeTextToSpeechEngine(ttsEngine: TextToSpeechEngine)
Content copied to clipboard

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

Link copied to clipboard
open fun dump(    @NonNull p0: String,     @Nullable p1: FileDescriptor?,     @NonNull p2: PrintWriter,     @Nullable p3: Array<String>?)
Content copied to clipboard
Link copied to clipboard
operator override fun equals(@Nullable other: Any?): Boolean
Content copied to clipboard
Link copied to clipboard
@Nullable
fun getActivity(): FragmentActivity?
Content copied to clipboard
Link copied to clipboard
open fun getAllowEnterTransitionOverlap(): Boolean
Content copied to clipboard
Link copied to clipboard
open fun getAllowReturnTransitionOverlap(): Boolean
Content copied to clipboard
Link copied to clipboard
@Nullable
fun getArguments(): Bundle?
Content copied to clipboard
Link copied to clipboard
@NonNull
fun getChildFragmentManager(): FragmentManager
Content copied to clipboard
Link copied to clipboard
@Nullable
open fun getContext(): Context?
Content copied to clipboard
Link copied to clipboard
@NonNull
open override fun getDefaultViewModelProviderFactory(): ViewModelProvider.Factory
Content copied to clipboard
Link copied to clipboard
@Nullable
open fun getEnterTransition(): Any?
Content copied to clipboard
Link copied to clipboard
@Nullable
open fun getExitTransition(): Any?
Content copied to clipboard
Link copied to clipboard
@Nullable
fun getHost(): Any?
Content copied to clipboard
Link copied to clipboard
fun getId(): Int
Content copied to clipboard
Link copied to clipboard
@NonNull
fun getLayoutInflater(): LayoutInflater
Content copied to clipboard
Link copied to clipboard
@NonNull
open override fun getLifecycle(): Lifecycle
Content copied to clipboard
Link copied to clipboard
@Nullable
fun getParentFragment(): Fragment?
Content copied to clipboard
Link copied to clipboard
@NonNull
fun getParentFragmentManager(): FragmentManager
Content copied to clipboard
Link copied to clipboard
@Nullable
open fun getReenterTransition(): Any?
Content copied to clipboard
Link copied to clipboard
@NonNull
fun getResources(): Resources
Content copied to clipboard
Link copied to clipboard
@Nullable
open fun getReturnTransition(): Any?
Content copied to clipboard
Link copied to clipboard
@NonNull
override fun getSavedStateRegistry(): SavedStateRegistry
Content copied to clipboard
Link copied to clipboard
@Nullable
open fun getSharedElementEnterTransition(): Any?
Content copied to clipboard
Link copied to clipboard
@Nullable
open fun getSharedElementReturnTransition(): Any?
Content copied to clipboard
Link copied to clipboard
@NonNull
fun getString(@StringRes p0: Int): String
Content copied to clipboard
@NonNull
fun getString(@StringRes p0: Int, @Nullable vararg p1: Any): String
Content copied to clipboard
Link copied to clipboard
@Nullable
fun getTag(): String?
Content copied to clipboard
Link copied to clipboard
@NonNull
fun getText(@StringRes p0: Int): CharSequence
Content copied to clipboard
Link copied to clipboard
@Nullable
open fun getView(): View?
Content copied to clipboard
Link copied to clipboard
@MainThread
@NonNull
open fun getViewLifecycleOwner(): LifecycleOwner
Content copied to clipboard
Link copied to clipboard
@NonNull
open fun getViewLifecycleOwnerLiveData(): LiveData<LifecycleOwner>
Content copied to clipboard
Link copied to clipboard
@NonNull
open override fun getViewModelStore(): ViewModelStore
Content copied to clipboard
Link copied to clipboard
override fun hashCode(): Int
Content copied to clipboard
Link copied to clipboard
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])
fun hasOptionsMenu(): Boolean
Content copied to clipboard
Link copied to clipboard
fun isAdded(): Boolean
Content copied to clipboard
Link copied to clipboard
fun isDetached(): Boolean
Content copied to clipboard
Link copied to clipboard
fun isHidden(): Boolean
Content copied to clipboard
Link copied to clipboard
fun isInLayout(): Boolean
Content copied to clipboard
Link copied to clipboard
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])
fun isMenuVisible(): Boolean
Content copied to clipboard
Link copied to clipboard
fun isRemoving(): Boolean
Content copied to clipboard
Link copied to clipboard
fun isResumed(): Boolean
Content copied to clipboard
Link copied to clipboard
fun isStateSaved(): Boolean
Content copied to clipboard
Link copied to clipboard
fun isVisible(): Boolean
Content copied to clipboard
Link copied to clipboard
@MainThread
@CallSuper
open fun onAttach(@NonNull p0: Context)
Content copied to clipboard
Link copied to clipboard
@CallSuper
open override fun onConfigurationChanged(@NonNull p0: Configuration)
Content copied to clipboard
Link copied to clipboard
@MainThread
open fun onContextItemSelected(@NonNull p0: MenuItem): Boolean
Content copied to clipboard
Link copied to clipboard
open override fun onCreate(savedInstanceState: Bundle?)
Content copied to clipboard
Link copied to clipboard
@MainThread
@Nullable
open fun onCreateAnimation(    p0: Int,     p1: Boolean,     p2: Int): Animation?
Content copied to clipboard
Link copied to clipboard
@MainThread
@Nullable
open fun onCreateAnimator(    p0: Int,     p1: Boolean,     p2: Int): Animator?
Content copied to clipboard
Link copied to clipboard
@MainThread
open override fun onCreateContextMenu(    @NonNull p0: ContextMenu,     @NonNull p1: View,     @Nullable p2: ContextMenu.ContextMenuInfo?)
Content copied to clipboard
Link copied to clipboard
@MainThread
open fun onCreateOptionsMenu(@NonNull p0: Menu, @NonNull p1: MenuInflater)
Content copied to clipboard
Link copied to clipboard
open override fun onCreateView(    inflater: LayoutInflater,     container: ViewGroup?,     state: Bundle?): View
Content copied to clipboard
Link copied to clipboard
open override fun onDestroy()
Content copied to clipboard
Link copied to clipboard
@MainThread
open fun onDestroyOptionsMenu()
Content copied to clipboard
Link copied to clipboard
open override fun onDestroyView()
Content copied to clipboard
Link copied to clipboard
@MainThread
@CallSuper
open fun onDetach()
Content copied to clipboard
Link copied to clipboard
@NonNull
open fun onGetLayoutInflater(@Nullable p0: Bundle?): LayoutInflater
Content copied to clipboard
Link copied to clipboard
@MainThread
open fun onHiddenChanged(p0: Boolean)
Content copied to clipboard
Link copied to clipboard
open override fun onInflate(    context: Context,     attrs: AttributeSet,     savedInstanceState: Bundle?)
Content copied to clipboard
Link copied to clipboard
@MainThread
@CallSuper
open override fun onLowMemory()
Content copied to clipboard
Link copied to clipboard
open fun onMultiWindowModeChanged(p0: Boolean)
Content copied to clipboard
Link copied to clipboard
@MainThread
open fun onOptionsItemSelected(@NonNull p0: MenuItem): Boolean
Content copied to clipboard
Link copied to clipboard
@MainThread
open fun onOptionsMenuClosed(@NonNull p0: Menu)
Content copied to clipboard
Link copied to clipboard
@MainThread
@CallSuper
open fun onPause()
Content copied to clipboard
Link copied to clipboard
open fun onPictureInPictureModeChanged(p0: Boolean)
Content copied to clipboard
Link copied to clipboard
@MainThread
open fun onPrepareOptionsMenu(@NonNull p0: Menu)
Content copied to clipboard
Link copied to clipboard
@MainThread
open fun onPrimaryNavigationFragmentChanged(p0: Boolean)
Content copied to clipboard
Link copied to clipboard
@MainThread
@CallSuper
open fun onResume()
Content copied to clipboard
Link copied to clipboard
@MainThread
open fun onSaveInstanceState(@NonNull p0: Bundle)
Content copied to clipboard
Link copied to clipboard
@MainThread
@CallSuper
open fun onStart()
Content copied to clipboard
Link copied to clipboard
@MainThread
@CallSuper
open fun onStop()
Content copied to clipboard
Link copied to clipboard
open override fun onViewCreated(view: View, savedInstanceState: Bundle?)
Content copied to clipboard
Link copied to clipboard
@MainThread
@CallSuper
open fun onViewStateRestored(@Nullable p0: Bundle?)
Content copied to clipboard
Link copied to clipboard
open fun postponeEnterTransition()
Content copied to clipboard
fun postponeEnterTransition(p0: Long, @NonNull p1: TimeUnit)
Content copied to clipboard
Link copied to clipboard
Link copied to clipboard
open fun registerForContextMenu(@NonNull p0: View)
Content copied to clipboard
Link copied to clipboard
fun removeNavigationListener(listener: NavigationFragment.NavigationListener)
Content copied to clipboard

Removes previously added NavigationListener.

Link copied to clipboard
@NonNull
fun requireActivity(): FragmentActivity
Content copied to clipboard
Link copied to clipboard
@NonNull
fun requireArguments(): Bundle
Content copied to clipboard
Link copied to clipboard
@NonNull
fun requireContext(): Context
Content copied to clipboard
Link copied to clipboard
@NonNull
fun requireHost(): Any
Content copied to clipboard
Link copied to clipboard
@NonNull
fun requireParentFragment(): Fragment
Content copied to clipboard
Link copied to clipboard
@NonNull
fun requireView(): View
Content copied to clipboard
Link copied to clipboard
open fun setAllowEnterTransitionOverlap(p0: Boolean)
Content copied to clipboard
Link copied to clipboard
open fun setAllowReturnTransitionOverlap(p0: Boolean)
Content copied to clipboard
Link copied to clipboard
open fun setArguments(@Nullable p0: Bundle?)
Content copied to clipboard
Link copied to clipboard
open fun setEnterSharedElementCallback(@Nullable p0: SharedElementCallback?)
Content copied to clipboard
Link copied to clipboard
open fun setEnterTransition(@Nullable p0: Any?)
Content copied to clipboard
Link copied to clipboard
open fun setExitSharedElementCallback(@Nullable p0: SharedElementCallback?)
Content copied to clipboard
Link copied to clipboard
open fun setExitTransition(@Nullable p0: Any?)
Content copied to clipboard
Link copied to clipboard
open fun setHasOptionsMenu(p0: Boolean)
Content copied to clipboard
Link copied to clipboard
open fun setInitialSavedState(@Nullable p0: Fragment.SavedState?)
Content copied to clipboard
Link copied to clipboard
open fun setMenuVisibility(p0: Boolean)
Content copied to clipboard
Link copied to clipboard
open fun setReenterTransition(@Nullable p0: Any?)
Content copied to clipboard
Link copied to clipboard
open fun setReturnTransition(@Nullable p0: Any?)
Content copied to clipboard
Link copied to clipboard
open fun setSharedElementEnterTransition(@Nullable p0: Any?)
Content copied to clipboard
Link copied to clipboard
open fun setSharedElementReturnTransition(@Nullable p0: Any?)
Content copied to clipboard
Link copied to clipboard
fun setTomTomNavigation(tomTomNavigation: TomTomNavigation)
Content copied to clipboard

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().

Link copied to clipboard
fun setUnits(units: Units)
Content copied to clipboard

Sets the units for distance and speed.

Link copied to clipboard
open fun shouldShowRequestPermissionRationale(@NonNull p0: String): Boolean
Content copied to clipboard
Link copied to clipboard
open fun startActivity(p0: Intent)
Content copied to clipboard
open fun startActivity(p0: Intent, @Nullable p1: Bundle?)
Content copied to clipboard
Link copied to clipboard
fun startNavigation()
Content copied to clipboard

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

fun startNavigation(routePlan: RoutePlan)
Content copied to clipboard

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.

Link copied to clipboard
open fun startPostponedEnterTransition()
Content copied to clipboard
Link copied to clipboard
fun stopNavigation()
Content copied to clipboard

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.

Link copied to clipboard
@NonNull
open override fun toString(): String
Content copied to clipboard
Link copied to clipboard
open fun unregisterForContextMenu(@NonNull p0: View)
Content copied to clipboard
Link copied to clipboard
fun update(routePlan: RoutePlan)
Content copied to clipboard

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

Link copied to clipboard
@RestrictTo(value = [RestrictTo.Scope.LIBRARY])
@Nullable
var mPreviousWho: String?
Content copied to clipboard
Link copied to clipboard
open override val navigationView: NavigationView
Content copied to clipboard

Returns the configurable navigation view.