com.tomtom.online.sdk.map

Class MapFragment

java.lang.Object

androidx.fragment.app.Fragment

com.tomtom.online.sdk.map.MapFragment

All Implemented Interfaces:

android.content.ComponentCallbacks, android.view.View.OnCreateContextMenuListener, androidx.lifecycle.LifecycleOwner, androidx.lifecycle.ViewModelStoreOwner

public class MapFragment
extends androidx.fragment.app.Fragment

Fragment is the simplest way to place a map in an application. It is a wrapper around a map view that handles map lifecycle.

Nested Class Summary

Nested classes/interfaces inherited from class androidx.fragment.app.Fragment

androidx.fragment.app.Fragment.InstantiationException, androidx.fragment.app.Fragment.SavedState

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MAP_DYNAMIC_KEY Key used to store dynamic keys set in Bundle when creating fragment.
static java.lang.String	STYLE_URL_KEY Key used to store style URL in Bundle when creating fragment.

Constructor Summary

Constructors

Constructor and Description
MapFragment()

Method Summary

Modifier and Type	Method and Description
void	getAsyncMap(OnMapReadyCallback callback) Sets a callback which will be triggered when the map instance is ready to use.
static MapFragment	newInstance() Create new instance of MapFragment.
static MapFragment	newInstance(java.util.HashMap<java.lang.String,java.lang.String> keys) Deprecated.
static MapFragment	newInstance(java.util.HashMap<java.lang.String,java.lang.String> keys, java.lang.String styleUrl) Deprecated.
static MapFragment	newInstance(MapProperties mapProperties) Create new instance of MapFragment with desired initial properties.
static MapFragment	newInstance(java.lang.String styleUrl) Deprecated.
void	onActivityCreated(android.os.Bundle savedInstanceState)
void	onCreate(android.os.Bundle savedInstanceState)
android.view.View	onCreateView(android.view.LayoutInflater inflater, android.view.ViewGroup container, android.os.Bundle savedInstanceState)
void	onDestroy()
void	onInflate(android.content.Context context, android.util.AttributeSet attrs, android.os.Bundle savedInstanceState)
void	onPause()
void	onResume()
void	onSaveInstanceState(@NotNull android.os.Bundle outState)
void	onStart()
void	onStop()
protected void	parseAttrs(android.content.Context context, android.util.AttributeSet attrs)
void	setMapBackgroundColor(int mapBackgroundColor) Set map background color
void	setZOrderMediaOverlay(boolean zOrderOnTop) Control whether the map surface view's surface is placed on top of another regular surface view in the window (but still behind the window itself).

Methods inherited from class androidx.fragment.app.Fragment

dump, equals, getActivity, getAllowEnterTransitionOverlap, getAllowReturnTransitionOverlap, getArguments, getChildFragmentManager, getContext, getEnterTransition, getExitTransition, getFragmentManager, getHost, getId, getLayoutInflater, getLayoutInflater, getLifecycle, getLoaderManager, getParentFragment, getReenterTransition, getResources, getRetainInstance, getReturnTransition, getSharedElementEnterTransition, getSharedElementReturnTransition, getString, getString, getTag, getTargetFragment, getTargetRequestCode, getText, getUserVisibleHint, getView, getViewLifecycleOwner, getViewLifecycleOwnerLiveData, getViewModelStore, hashCode, hasOptionsMenu, instantiate, instantiate, isAdded, isDetached, isHidden, isInLayout, isMenuVisible, isRemoving, isResumed, isStateSaved, isVisible, onActivityResult, onAttach, onAttach, onAttachFragment, onConfigurationChanged, onContextItemSelected, onCreateAnimation, onCreateAnimator, onCreateContextMenu, onCreateOptionsMenu, onDestroyOptionsMenu, onDestroyView, onDetach, onGetLayoutInflater, onHiddenChanged, onInflate, onLowMemory, onMultiWindowModeChanged, onOptionsItemSelected, onOptionsMenuClosed, onPictureInPictureModeChanged, onPrepareOptionsMenu, onRequestPermissionsResult, onViewCreated, onViewStateRestored, postponeEnterTransition, registerForContextMenu, requestPermissions, requireActivity, requireContext, requireFragmentManager, requireHost, setAllowEnterTransitionOverlap, setAllowReturnTransitionOverlap, setArguments, setEnterSharedElementCallback, setEnterTransition, setExitSharedElementCallback, setExitTransition, setHasOptionsMenu, setInitialSavedState, setMenuVisibility, setReenterTransition, setRetainInstance, setReturnTransition, setSharedElementEnterTransition, setSharedElementReturnTransition, setTargetFragment, setUserVisibleHint, shouldShowRequestPermissionRationale, startActivity, startActivity, startActivityForResult, startActivityForResult, startIntentSenderForResult, startPostponedEnterTransition, toString, unregisterForContextMenu

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

STYLE_URL_KEY

public static final java.lang.String STYLE_URL_KEY

Key used to store style URL in Bundle when creating fragment.

See Also:

Constant Field Values

MAP_DYNAMIC_KEY

public static final java.lang.String MAP_DYNAMIC_KEY

Key used to store dynamic keys set in Bundle when creating fragment.

See Also:

Constant Field Values

Constructor Detail

MapFragment

public MapFragment()

Method Detail

setMapBackgroundColor

public void setMapBackgroundColor(int mapBackgroundColor)

Set map background color

newInstance

@NonNull
public static MapFragment newInstance()

Create new instance of MapFragment.

newInstance

@NonNull
 @Deprecated
 @DeprecatedSince(year=2020,
                 month=2)
public static MapFragment newInstance(java.util.HashMap<java.lang.String,java.lang.String> keys)

Deprecated.

Create new instance of MapFragment with dynamic API Keys

Parameters:

keys - map containing api key values for "OnlineMaps.Key" & "OnlineTraffic.Key"

Returns:

mapFragment

newInstance

@NonNull
 @Deprecated
 @DeprecatedSince(year=2020,
                 month=2)
public static MapFragment newInstance(java.lang.String styleUrl)

Deprecated.

Create new instance of MapFragment with custom style.

newInstance

@NonNull
 @Deprecated
 @DeprecatedSince(year=2020,
                 month=2)
public static MapFragment newInstance(java.util.HashMap<java.lang.String,java.lang.String> keys,
                                                                                                                   java.lang.String styleUrl)

Deprecated.

Create new instance of MapFragment with dynamic API Keys and custom style.

Parameters:

keys - map containing api key values for "OnlineMaps.Key" & "OnlineTraffic.Key"

styleUrl -

Returns:

mapFragment

newInstance

@NonNull
public static MapFragment newInstance(MapProperties mapProperties)

Create new instance of MapFragment with desired initial properties.

Parameters:

mapProperties - initial map properties

Returns:

mapFragment

onCreate

public void onCreate(@Nullable
                     android.os.Bundle savedInstanceState)

Overrides:

onCreate in class androidx.fragment.app.Fragment

onInflate

public void onInflate(android.content.Context context,
                      android.util.AttributeSet attrs,
                      android.os.Bundle savedInstanceState)

Overrides:

onInflate in class androidx.fragment.app.Fragment

onCreateView

public android.view.View onCreateView(android.view.LayoutInflater inflater,
                                      android.view.ViewGroup container,
                                      android.os.Bundle savedInstanceState)

Overrides:

onCreateView in class androidx.fragment.app.Fragment

onStart

public void onStart()

Overrides:

onStart in class androidx.fragment.app.Fragment

onResume

public void onResume()

Overrides:

onResume in class androidx.fragment.app.Fragment

onPause

public void onPause()

Overrides:

onPause in class androidx.fragment.app.Fragment

onStop

public void onStop()

Overrides:

onStop in class androidx.fragment.app.Fragment

onDestroy

public void onDestroy()

Overrides:

onDestroy in class androidx.fragment.app.Fragment

onSaveInstanceState

public void onSaveInstanceState(@NotNull
                                @NotNull android.os.Bundle outState)

Overrides:

onSaveInstanceState in class androidx.fragment.app.Fragment

onActivityCreated

public void onActivityCreated(@Nullable
                              android.os.Bundle savedInstanceState)

Overrides:

onActivityCreated in class androidx.fragment.app.Fragment

getAsyncMap

public void getAsyncMap(@NonNull
                        OnMapReadyCallback callback)

Sets a callback which will be triggered when the map instance is ready to use. The callback will be executed in the main thread.

Parameters:

callback - The callback to handle the result.

setZOrderMediaOverlay

public void setZOrderMediaOverlay(boolean zOrderOnTop)

Control whether the map surface view's surface is placed on top of another regular surface view in the window (but still behind the window itself). This is typically used to place mini map on top of an underlying map surface view.

parseAttrs

protected void parseAttrs(android.content.Context context,
                          android.util.AttributeSet attrs)