com.tomtom.sdk.maps:map-display-common-internal/com.tomtom.sdk.map.display.ui/MapFragment

MapFragment

class MapFragment : Fragment, UiComponents, MapProvider

An Android fragment wrapping the TomTom MapView. This fragment handles a complete lifecycle of the underlying MapView. It can be instantiated either programmatically via MapFragment.newInstance(mapOptions: MapOptions) or via the XML view inflation. See MapResources to check what attributes can be configured via XML.

Constructors

constructor()

Types

object Companion

Functions

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?

getEnterTransition

open fun getEnterTransition(): Any?

getExitTransition

open fun getExitTransition(): Any?

fun getHost(): Any?

fun getId(): Int

getLayoutInflater

fun getLayoutInflater(): LayoutInflater

open override fun getMapAsync(callback: MapReadyCallback): Cancellable

Sets a callback that will be triggered when the map instance is ready to use. The callback will be executed on the main thread. Note: You must call this method from the main thread. Otherwise an exception will be thrown.

getParentFragment

fun getParentFragment(): Fragment?

getParentFragmentManager

fun getParentFragmentManager(): FragmentManager

getReenterTransition

open fun getReenterTransition(): Any?

fun getResources(): Resources

getReturnTransition

open fun getReturnTransition(): Any?

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>

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?)

Handles the 'onCreate' lifecycle event. Initializes the MapView internals and UI components.

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

Called on the fragment to instantiate its MapView. If there were some calls for getMapAsync(callback: OnMapReadyCallback), then the subscribed callbacks will be executed as soon as the MapView is created and the underlying TomTomMap is available.

open override fun onDestroy()

This handles the 'onDestroy' lifecycle event. It is called when the parent component is being destroyed. This ensures the internal map view components are properly shut down and resources are freed.

onDestroyOptionsMenu

open fun onDestroyOptionsMenu()

open 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?)

This is called when the fragment's UI is created. This method parses the given attributes and sets the map options accordingly.

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 override fun onPause()

This handles the 'onPause' lifecycle event. It is called when the parent component is no longer resumed but still visible. This ensures the internal map view components pause their active processes to conserve resources.

onPictureInPictureModeChanged

open fun onPictureInPictureModeChanged(p0: Boolean)

onPrepareOptionsMenu

open fun onPrepareOptionsMenu(@NonNull p0: Menu)

onPrimaryNavigationFragmentChanged

open fun onPrimaryNavigationFragmentChanged(p0: Boolean)

open override fun onResume()

This handles the 'onResume' lifecycle event. It is called when the parent component is visible to the user and actively running. This ensures the internal map view components are active and updated.

onSaveInstanceState

open override fun onSaveInstanceState(outState: Bundle)

This handles the 'onSaveInstanceState' lifecycle event. It is called when the parent component saves its instance state. This stores the current state of the MapView component, ensuring that the state can be restored after a configuration change or other events that restart the component.

open override fun onStart()

This handles the 'onStart' lifecycle event. It is called when the parent component becomes visible to the user. This ensures the internal map view components are ready to display.

open override fun onStop()

This handles the 'onStop' lifecycle event. It is called when the parent component is no longer visible to the user. This ensures the internal map view components stop all active processes to conserve resources.

open fun onViewCreated(@NonNull p0: View, @Nullable p1: 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)

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?)

shouldShowRequestPermissionRationale

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

open fun startActivity(p0: Intent)

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

startPostponedEnterTransition

open fun startPostponedEnterTransition()

open override fun toString(): String

unregisterForContextMenu

open fun unregisterForContextMenu(@NonNull p0: View)

Properties

balloonsViewContainer

open override val balloonsViewContainer: ViewGroup

This represents the container view for any balloon markers on the map. When clicked, balloon markers typically show more information about a specific point on the map.

open override val compassButton: CompassButton

This represents the compass button on the map. This button provides a quick way for users to change the map to have a northern orientation.

currentLocationButton

open override val currentLocationButton: CurrentLocationButton

This represents the button that shows the user's current location on the map.

defaultViewModelCreationExtras

open val defaultViewModelCreationExtras: CreationExtras

defaultViewModelProviderFactory

open override val defaultViewModelProviderFactory: ViewModelProvider.Factory

open override val lifecycle: Lifecycle

open override val logoView: LogoView

This represents the logo of the map provider. This logo ensures the correct attribution is given to the map data source.

markerBalloonViewAdapter

open override var markerBalloonViewAdapter: BalloonViewAdapter

This represents the adapter for the balloon views. The adapter determines how the content inside each balloon marker is displayed.

savedStateRegistry

override val savedStateRegistry: SavedStateRegistry

open override val scaleView: ScaleView

This represents the scale view on the map. This shows the scale of the map in relation to the real world distances.

open override val viewModelStore: ViewModelStore

zoomControlsView

open override val zoomControlsView: ZoomControlsView

This represents the zoom controls on the map. These controls allow users to zoom in and out of the map view.