MapLibre Native Android/org.maplibre.android.maps/MapFragment

MapFragment

class MapFragment : Fragment, OnMapReadyCallback

Fragment wrapper around a map view.

A Map component in an app. This fragment is the simplest way to place a map in an application. It's a wrapper around a view of a map to automatically handle the necessary life cycle needs. Being a fragment, this component can be added to an activity's layout or can dynamically be added using a FragmentManager.

To get a reference to the MapView, use getMapAsync}

Constructors

MapFragment

constructor()

Types

OnMapViewReadyCallback

interface OnMapViewReadyCallback

Callback to be invoked when the map fragment has inflated its MapView.

Properties

mPreviousWho

open var mPreviousWho: String

Functions

dump

open fun dump(prefix: String, fd: FileDescriptor, writer: PrintWriter, args: Array<String>)

equals

fun equals(o: Any): Boolean

getActivity

fun getActivity(): FragmentActivity

getAllowEnterTransitionOverlap

open fun getAllowEnterTransitionOverlap(): Boolean

getAllowReturnTransitionOverlap

open fun getAllowReturnTransitionOverlap(): Boolean

getArguments

fun getArguments(): Bundle

getChildFragmentManager

fun getChildFragmentManager(): FragmentManager

getContext

open fun getContext(): Context

getDefaultViewModelCreationExtras

open fun getDefaultViewModelCreationExtras(): CreationExtras

getDefaultViewModelProviderFactory

open fun getDefaultViewModelProviderFactory(): ViewModelProvider.Factory

getEnterTransition

open fun getEnterTransition(): Any

getExitTransition

open fun getExitTransition(): Any

getFragmentManager

fun getFragmentManager(): FragmentManager

getHost

fun getHost(): Any

getId

fun getId(): Int

getLayoutInflater

fun getLayoutInflater(): LayoutInflater

getLifecycle

open fun getLifecycle(): Lifecycle

getLoaderManager

open fun getLoaderManager(): LoaderManager

getMapAsync

open fun getMapAsync(@NonNull onMapReadyCallback: OnMapReadyCallback)

Sets a callback object which will be triggered when the MapLibreMap instance is ready to be used.

getParentFragment

fun getParentFragment(): Fragment

getParentFragmentManager

fun getParentFragmentManager(): FragmentManager

getReenterTransition

open fun getReenterTransition(): Any

getResources

fun getResources(): Resources

getRetainInstance

fun getRetainInstance(): Boolean

getReturnTransition

open fun getReturnTransition(): Any

getSavedStateRegistry

fun getSavedStateRegistry(): SavedStateRegistry

getSharedElementEnterTransition

open fun getSharedElementEnterTransition(): Any

getSharedElementReturnTransition

open fun getSharedElementReturnTransition(): Any

getString

fun getString(resId: Int): String

getTag

fun getTag(): String

getTargetFragment

fun getTargetFragment(): Fragment

getTargetRequestCode

fun getTargetRequestCode(): Int

getText

fun getText(resId: Int): CharSequence

getUserVisibleHint

open fun getUserVisibleHint(): Boolean

getView

open fun getView(): View

getViewLifecycleOwner

open fun getViewLifecycleOwner(): LifecycleOwner

getViewLifecycleOwnerLiveData

open fun getViewLifecycleOwnerLiveData(): LiveData<LifecycleOwner>

getViewModelStore

open fun getViewModelStore(): ViewModelStore

hashCode

fun hashCode(): Int

hasOptionsMenu

fun hasOptionsMenu(): Boolean

instantiate

open fun instantiate(context: Context, fname: String): Fragment

isAdded

fun isAdded(): Boolean

isDetached

fun isDetached(): Boolean

isHidden

fun isHidden(): Boolean

isInLayout

fun isInLayout(): Boolean

isMenuVisible

fun isMenuVisible(): Boolean

isRemoving

fun isRemoving(): Boolean

isResumed

fun isResumed(): Boolean

isStateSaved

fun isStateSaved(): Boolean

isVisible

fun isVisible(): Boolean

newInstance

open fun newInstance(): MapFragment

Creates a default MapFragment instance

@NonNull

open fun newInstance(@Nullable maplibreMapOptions: MapLibreMapOptions): MapFragment

Creates a MapFragment instance

onActivityCreated

open fun onActivityCreated(savedInstanceState: Bundle)

onActivityResult

open fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent)

onAttach

open fun onAttach(context: Context)

Called when the context attaches to this fragment.

onAttachFragment

open fun onAttachFragment(childFragment: Fragment)

onConfigurationChanged

open fun onConfigurationChanged(newConfig: Configuration)

onContextItemSelected

open fun onContextItemSelected(item: MenuItem): Boolean

onCreate

open fun onCreate(savedInstanceState: Bundle)

onCreateAnimation

open fun onCreateAnimation(transit: Int, enter: Boolean, nextAnim: Int): Animation

onCreateAnimator

open fun onCreateAnimator(transit: Int, enter: Boolean, nextAnim: Int): Animator

onCreateContextMenu

open fun onCreateContextMenu(menu: ContextMenu, v: View, menuInfo: ContextMenu.ContextMenuInfo)

onCreateOptionsMenu

open fun onCreateOptionsMenu(menu: Menu, inflater: MenuInflater)

onCreateView

open fun onCreateView(@NonNull inflater: LayoutInflater, container: ViewGroup, savedInstanceState: Bundle): View

Creates the fragment view hierarchy.

onDestroy

open fun onDestroy()

Called when the fragment is destroyed.

onDestroyOptionsMenu

open fun onDestroyOptionsMenu()

onDestroyView

open fun onDestroyView()

Called when the fragment is view hiearchy is being destroyed.

onDetach

open fun onDetach()

onGetLayoutInflater

open fun onGetLayoutInflater(savedInstanceState: Bundle): LayoutInflater

onHiddenChanged

open fun onHiddenChanged(hidden: Boolean)

onInflate

open fun onInflate(@NonNull context: Context, attrs: AttributeSet, savedInstanceState: Bundle)

Called when this fragment is inflated, parses XML tag attributes.

onLowMemory

open fun onLowMemory()

Called when the fragment receives onLowMemory call from the hosting Activity.

onMapReady

open fun onMapReady(@NonNull maplibreMap: MapLibreMap)

Called when the style of the map has successfully loaded.

onMultiWindowModeChanged

open fun onMultiWindowModeChanged(isInMultiWindowMode: Boolean)

onOptionsItemSelected

open fun onOptionsItemSelected(item: MenuItem): Boolean

onOptionsMenuClosed

open fun onOptionsMenuClosed(menu: Menu)

onPause

open fun onPause()

Called when the fragment is pausing.

onPictureInPictureModeChanged

open fun onPictureInPictureModeChanged(isInPictureInPictureMode: Boolean)

onPrepareOptionsMenu

open fun onPrepareOptionsMenu(menu: Menu)

onPrimaryNavigationFragmentChanged

open fun onPrimaryNavigationFragmentChanged(isPrimaryNavigationFragment: Boolean)

onRequestPermissionsResult

open fun onRequestPermissionsResult(requestCode: Int, permissions: Array<String>, grantResults: Array<Int>)

onResume

open fun onResume()

Called when the fragment is ready to be interacted with.

onSaveInstanceState

open fun onSaveInstanceState(@NonNull outState: Bundle)

Called when the fragment state needs to be saved.

onStart

open fun onStart()

Called when the fragment is visible for the users.

onStop

open fun onStop()

Called when the fragment is no longer visible for the user.

onViewCreated

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

Called when the fragment view hierarchy is created.

onViewStateRestored

open fun onViewStateRestored(savedInstanceState: Bundle)

postponeEnterTransition

open fun postponeEnterTransition()

registerForActivityResult

fun <I, O> registerForActivityResult(contract: ActivityResultContract<I, O>, callback: ActivityResultCallback<O>): ActivityResultLauncher<I>

registerForContextMenu

open fun registerForContextMenu(view: View)

requestPermissions

fun requestPermissions(permissions: Array<String>, requestCode: Int)

requireActivity

fun requireActivity(): FragmentActivity

requireArguments

fun requireArguments(): Bundle

requireContext

fun requireContext(): Context

requireFragmentManager

fun requireFragmentManager(): FragmentManager

requireHost

fun requireHost(): Any

requireParentFragment

fun requireParentFragment(): Fragment

requireView

fun requireView(): View

setAllowEnterTransitionOverlap

open fun setAllowEnterTransitionOverlap(allow: Boolean)

setAllowReturnTransitionOverlap

open fun setAllowReturnTransitionOverlap(allow: Boolean)

setArguments

open fun setArguments(args: Bundle)

setEnterSharedElementCallback

open fun setEnterSharedElementCallback(callback: SharedElementCallback)

setEnterTransition

open fun setEnterTransition(transition: Any)

setExitSharedElementCallback

open fun setExitSharedElementCallback(callback: SharedElementCallback)

setExitTransition

open fun setExitTransition(transition: Any)

setHasOptionsMenu

open fun setHasOptionsMenu(hasMenu: Boolean)

setInitialSavedState

open fun setInitialSavedState(state: Fragment.SavedState)

setMenuVisibility

open fun setMenuVisibility(menuVisible: Boolean)

setReenterTransition

open fun setReenterTransition(transition: Any)

setRetainInstance

open fun setRetainInstance(retain: Boolean)

setReturnTransition

open fun setReturnTransition(transition: Any)

setSharedElementEnterTransition

open fun setSharedElementEnterTransition(transition: Any)

setSharedElementReturnTransition

open fun setSharedElementReturnTransition(transition: Any)

setTargetFragment

open fun setTargetFragment(fragment: Fragment, requestCode: Int)

setUserVisibleHint

open fun setUserVisibleHint(isVisibleToUser: Boolean)

shouldShowRequestPermissionRationale

open fun shouldShowRequestPermissionRationale(permission: String): Boolean

startActivity

open fun startActivity(intent: Intent)

startActivityForResult

open fun startActivityForResult(intent: Intent, requestCode: Int)

startIntentSenderForResult

open fun startIntentSenderForResult(intent: IntentSender, requestCode: Int, fillInIntent: Intent, flagsMask: Int, flagsValues: Int, extraFlags: Int, options: Bundle)

startPostponedEnterTransition

open fun startPostponedEnterTransition()

toString

open fun toString(): String

unregisterForContextMenu

open fun unregisterForContextMenu(view: View)

MapFragment

See also

Constructors

Types

Properties

Functions