MapFragment (Meridian API)

java.lang.Object
- androidx.fragment.app.Fragment
- - com.arubanetworks.meridian.maps.MapFragment

All Implemented Interfaces:

android.content.ComponentCallbacks, android.view.View.OnCreateContextMenuListener, androidx.lifecycle.LifecycleOwner, androidx.lifecycle.ViewModelStoreOwner, OrientationDetector.Listener, MapView.DirectionsEventListener, MapView.MapEventListener, MapView.MarkerEventListener
```
public class MapFragment
extends androidx.fragment.app.Fragment
implements MapView.MarkerEventListener, MapView.DirectionsEventListener, MapView.MapEventListener, OrientationDetector.Listener
```
A Fragment for providing an interactive Meridian map surface with map and directions controls.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MapFragment.Builder
- Nested classes/interfaces inherited from class androidx.fragment.app.Fragment
  androidx.fragment.app.Fragment.InstantiationException, androidx.fragment.app.Fragment.SavedState

Nested Classes
Modifier and Type	Class and Description
`static class`	`MapFragment.Builder`

Constructor Summary

Constructors
Constructor and Description

MapFragment()

Constructors
Constructor and Description
`MapFragment()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MapOptions`	`getMapOptions()` Gets a copy of the current `MapOptions`, defaulting to the `MapView` options if none are set on this fragment or the default ones if a `MapView` was not initialized yet.
`MapView`	`getMapView()` Gets our owned `MapView` if created, otherwise null.
`Marker`	`markerForPlacemark(Placemark placemark)` This method is an opportunity to supply your own `Marker` instance for a given Placemark.
`Marker`	`markerForSelectedMarker(Marker markerToSelect)` This method is an opportunity to supply your own selected `Marker` instance for a given `Marker`.
`void`	`onActivityResult(int requestCode, int resultCode, android.content.Intent data)`
`boolean`	`onCalloutClick(Marker marker)` Called when the callout is tapped.
`void`	`onCreate(android.os.Bundle savedInstanceState)`
`android.view.View`	`onCreateView(android.view.LayoutInflater inflater, android.view.ViewGroup container, android.os.Bundle savedInstanceState)`
`void`	`onDestroy()`
`boolean`	`onDirectionsClick(Marker marker)` Called when the directions action of the marker callout view is tapped.
`boolean`	`onDirectionsClosed()` Called when the user exits directions
`boolean`	`onDirectionsError(java.lang.Throwable tr)` Called when there has been an error getting directions
`void`	`onDirectionsReroute()` Called when our directions need to reroute
`boolean`	`onDirectionsStart()` Called when the directions are calculated
`boolean`	`onLocationButtonClick()` Called when the user taps the location button.
`void`	`onLocationUpdated(MeridianLocation location)` Called when the Location has updated for this map.
`void`	`onMapLoadFail(java.lang.Throwable tr)` Called when there has been an error retrieving the map from the internet or parsing the map that was retrieved.
`void`	`onMapLoadFinish()` Called after loading of the map image is complete.
`void`	`onMapLoadStart()` Called when initial loading of a map starts, this is called before any web request or graphics related loading happens.
`void`	`onMapRenderFinish()` Called after the map and placemarks have been loaded and rendered.
`void`	`onMapTransformChange(android.graphics.Matrix transform)` Called when screen to map transform for this map changes.
`boolean`	`onMarkerDeselect(Marker marker)` Called when a user taps somewhere on the map deselecting a marker.
`boolean`	`onMarkerSelect(Marker marker)` Called when a user taps a Marker on the map.
`void`	`onOrientationRight()`
`void`	`onOrientationUpdated(MeridianOrientation orientation)` Called when orientation of the device has been updated.
`void`	`onOrientationWrong()`
`void`	`onPause()`
`void`	`onPlacemarksLoadFinish()` Called after loading Placemarks, this is a good place to add your own markers and edit data in the loaded placemarks before they are rendered to the screen.
`void`	`onResume()`
`boolean`	`onRouteStepIndexChange(int index)` Called when the route step has been updated
`void`	`onSaveInstanceState(android.os.Bundle outState)`
`protected void`	`onSourceResult(DirectionsDestination destination, DirectionsSource source)` This event takes place right before directions are retrieved from the server and provide an opportunity to change the source and destination, or just be notified of the event.
`void`	`onStop()`
`void`	`onUseAccessiblePathsChange()` Called when the accessibility option has been toggled by the user.
`void`	`setDirectionsEventListener(MapView.DirectionsEventListener listener)` Set the DirectionsEventListener for this MapFragment.
`void`	`setMapEventListener(MapView.MapEventListener listener)` Set the MapEventListener for this MapFragment.
`void`	`setMapOptions(MapOptions options)` Set current map options.
`void`	`setMarkerEventListener(MapView.MarkerEventListener listener)` Set the MarkerEventListener for this MapFragment.
`void`	`startDirections(DirectionsDestination destination)` Start directions to the given placemark.

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, onActivityCreated, onAttach, onAttach, onAttachFragment, onConfigurationChanged, onContextItemSelected, onCreateAnimation, onCreateAnimator, onCreateContextMenu, onCreateOptionsMenu, onDestroyOptionsMenu, onDestroyView, onDetach, onGetLayoutInflater, onHiddenChanged, onInflate, onInflate, onLowMemory, onMultiWindowModeChanged, onOptionsItemSelected, onOptionsMenuClosed, onPictureInPictureModeChanged, onPrepareOptionsMenu, onRequestPermissionsResult, onStart, 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

- Constructor Detail
  - MapFragment
```
public MapFragment()
```
- Method Detail
  - getMapOptions
```
public MapOptions getMapOptions()
```
    Gets a copy of the current MapOptions, defaulting to the MapView options if none are set on this fragment or the default ones if a MapView was not initialized yet. Changing the properties of the returned MapOptions will have no effect. To change the MapOptions for this MapFragment, call setMapOptions.
  - setMapOptions
```
public void setMapOptions(MapOptions options)
```
    Set current map options. These will be applied to our owned MapView instance either immediately if it exists, or automatically when created.
  - getMapView
```
public MapView getMapView()
```
    Gets our owned MapView if created, otherwise null. You may call methods and set properties on the returned view.
  - setMarkerEventListener
```
public void setMarkerEventListener(MapView.MarkerEventListener listener)
```
    Set the MarkerEventListener for this MapFragment.
  - setDirectionsEventListener
```
public void setDirectionsEventListener(MapView.DirectionsEventListener listener)
```
    Set the DirectionsEventListener for this MapFragment.
  - setMapEventListener
```
public void setMapEventListener(MapView.MapEventListener listener)
```
    Set the MapEventListener for this MapFragment.
  - onCreate
```
public void onCreate(android.os.Bundle savedInstanceState)
```
    Overrides:
    
    onCreate in class androidx.fragment.app.Fragment
  - onSaveInstanceState
```
public void onSaveInstanceState(@NonNull
                                android.os.Bundle outState)
```
    Overrides:
    
    onSaveInstanceState in class androidx.fragment.app.Fragment
  - onCreateView
```
public android.view.View onCreateView(@NonNull
                                      android.view.LayoutInflater inflater,
                                      @Nullable
                                      android.view.ViewGroup container,
                                      @Nullable
                                      android.os.Bundle savedInstanceState)
```
    Overrides:
    
    onCreateView 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
  - startDirections
```
public void startDirections(DirectionsDestination destination)
```
    Start directions to the given placemark.
  - onActivityResult
```
public void onActivityResult(int requestCode,
                             int resultCode,
                             android.content.Intent data)
```
    Overrides:
    
    onActivityResult in class androidx.fragment.app.Fragment
  - onSourceResult
```
protected void onSourceResult(DirectionsDestination destination,
                              DirectionsSource source)
```
    This event takes place right before directions are retrieved from the server and provide an opportunity to change the source and destination, or just be notified of the event. Make sure to call super or the directions request will be canceled.
  - onMarkerSelect
```
public boolean onMarkerSelect(Marker marker)
```
    Description copied from interface: MapView.MarkerEventListener
    
    Called when a user taps a Marker on the map. `
    
    Specified by:
    
    onMarkerSelect in interface MapView.MarkerEventListener
    
    Parameters:
    
    marker - An instance of the marker that was tapped.
    
    Returns:
    
    true to indicate that the event has been handled, false to allow the default action to take place.
  - onMarkerDeselect
```
public boolean onMarkerDeselect(Marker marker)
```
    Description copied from interface: MapView.MarkerEventListener
    
    Called when a user taps somewhere on the map deselecting a marker. `
    
    Specified by:
    
    onMarkerDeselect in interface MapView.MarkerEventListener
    
    Parameters:
    
    marker - An instance of the marker that was previously selected.
    
    Returns:
    
    true to indicate that the event has been handled, false to allow the default action to take place.
  - markerForPlacemark
```
public Marker markerForPlacemark(Placemark placemark)
```
    Description copied from interface: MapView.MarkerEventListener
    
    This method is an opportunity to supply your own Marker instance for a given Placemark. You can use this to completely customize the look of placemarks on the map. The default implementation returns null.
    
    Specified by:
    
    markerForPlacemark in interface MapView.MarkerEventListener
    
    Parameters:
    
    placemark - The placemark that is requesting a Marker for displaying on the map
    
    Returns:
    
    A new instance of a Marker subclass, or null to request that MapView create a default Marker.
  - markerForSelectedMarker
```
public Marker markerForSelectedMarker(Marker markerToSelect)
```
    Description copied from interface: MapView.MarkerEventListener
    
    This method is an opportunity to supply your own selected Marker instance for a given Marker. You can use this to completely customize the look of selected placemarks on the map. The default implementation returns null.
    
    Specified by:
    
    markerForSelectedMarker in interface MapView.MarkerEventListener
    
    Parameters:
    
    markerToSelect - The Marker that is being selected.
    
    Returns:
    
    A new instance of a Marker subclass, or null to request that MapView create a default Marker.
  - onCalloutClick
```
public boolean onCalloutClick(Marker marker)
```
    Description copied from interface: MapView.MarkerEventListener
    
    Called when the callout is tapped.
    
    Specified by:
    
    onCalloutClick in interface MapView.MarkerEventListener
    
    Parameters:
    
    marker - An instance of the marker that was active when the callout was tapped.
    
    Returns:
    
    true to indicate that the event has been handled, false to allow the default action to take place.
  - onMapLoadStart
```
public void onMapLoadStart()
```
    Description copied from interface: MapView.MapEventListener
    
    Called when initial loading of a map starts, this is called before any web request or graphics related loading happens.
    
    Specified by:
    
    onMapLoadStart in interface MapView.MapEventListener
  - onMapLoadFinish
```
public void onMapLoadFinish()
```
    Description copied from interface: MapView.MapEventListener
    
    Called after loading of the map image is complete. It has not been rendered at this point.
    
    Specified by:
    
    onMapLoadFinish in interface MapView.MapEventListener
  - onPlacemarksLoadFinish
```
public void onPlacemarksLoadFinish()
```
    Description copied from interface: MapView.MapEventListener
    
    Called after loading Placemarks, this is a good place to add your own markers and edit data in the loaded placemarks before they are rendered to the screen.
    
    Specified by:
    
    onPlacemarksLoadFinish in interface MapView.MapEventListener
  - onMapRenderFinish
```
public void onMapRenderFinish()
```
    Description copied from interface: MapView.MapEventListener
    
    Called after the map and placemarks have been loaded and rendered. Changing any markers should be avoided.
    
    Specified by:
    
    onMapRenderFinish in interface MapView.MapEventListener
  - onMapLoadFail
```
public void onMapLoadFail(java.lang.Throwable tr)
```
    Description copied from interface: MapView.MapEventListener
    
    Called when there has been an error retrieving the map from the internet or parsing the map that was retrieved.
    
    Specified by:
    
    onMapLoadFail in interface MapView.MapEventListener
  - onMapTransformChange
```
public void onMapTransformChange(android.graphics.Matrix transform)
```
    Description copied from interface: MapView.MapEventListener
    
    Called when screen to map transform for this map changes.
    
    Specified by:
    
    onMapTransformChange in interface MapView.MapEventListener
  - onLocationUpdated
```
public void onLocationUpdated(MeridianLocation location)
```
    Description copied from interface: MapView.MapEventListener
    
    Called when the Location has updated for this map.
    
    Specified by:
    
    onLocationUpdated in interface MapView.MapEventListener
  - onOrientationUpdated
```
public void onOrientationUpdated(MeridianOrientation orientation)
```
    Description copied from interface: MapView.MapEventListener
    
    Called when orientation of the device has been updated.
    
    Specified by:
    
    onOrientationUpdated in interface MapView.MapEventListener
  - onLocationButtonClick
```
public boolean onLocationButtonClick()
```
    Description copied from interface: MapView.MapEventListener
    
    Called when the user taps the location button.
    
    Specified by:
    
    onLocationButtonClick in interface MapView.MapEventListener
    
    Returns:
    
    true if the event has been handled, false if we still want the default behavior to occur.
  - onDirectionsReroute
```
public void onDirectionsReroute()
```
    Description copied from interface: MapView.DirectionsEventListener
    
    Called when our directions need to reroute
    
    Specified by:
    
    onDirectionsReroute in interface MapView.DirectionsEventListener
  - onDirectionsClick
```
public boolean onDirectionsClick(Marker marker)
```
    Description copied from interface: MapView.DirectionsEventListener
    
    Called when the directions action of the marker callout view is tapped.
    
    Specified by:
    
    onDirectionsClick in interface MapView.DirectionsEventListener
    
    Parameters:
    
    marker - An instance of the marker that was active when the callout was tapped.
    
    Returns:
    
    true to indicate that the event has been handled, false to allow the default action to take place.
  - onDirectionsStart
```
public boolean onDirectionsStart()
```
    Description copied from interface: MapView.DirectionsEventListener
    
    Called when the directions are calculated
    
    Specified by:
    
    onDirectionsStart in interface MapView.DirectionsEventListener
    
    Returns:
    
    true to indicate that the event has been handled, false to allow the default action to take place.
  - onRouteStepIndexChange
```
public boolean onRouteStepIndexChange(int index)
```
    Description copied from interface: MapView.DirectionsEventListener
    
    Called when the route step has been updated
    
    Specified by:
    
    onRouteStepIndexChange in interface MapView.DirectionsEventListener
    
    Parameters:
    
    index - The index of the updated step.
    
    Returns:
    
    true to indicate that the event has been handled, false to allow the default action to take place.
  - onDirectionsClosed
```
public boolean onDirectionsClosed()
```
    Description copied from interface: MapView.DirectionsEventListener
    
    Called when the user exits directions
    
    Specified by:
    
    onDirectionsClosed in interface MapView.DirectionsEventListener
    
    Returns:
    
    true to indicate that the event has been handled, false to allow the default action to take place.
  - onDirectionsError
```
public boolean onDirectionsError(java.lang.Throwable tr)
```
    Description copied from interface: MapView.DirectionsEventListener
    
    Called when there has been an error getting directions
    
    Specified by:
    
    onDirectionsError in interface MapView.DirectionsEventListener
    
    Returns:
    
    true to indicate that the event has been handled, false to allow the default action to take place.
  - onUseAccessiblePathsChange
```
public void onUseAccessiblePathsChange()
```
    Description copied from interface: MapView.DirectionsEventListener
    
    Called when the accessibility option has been toggled by the user.
    
    Specified by:
    
    onUseAccessiblePathsChange in interface MapView.DirectionsEventListener
  - onOrientationRight
```
public void onOrientationRight()
```
    Specified by:
    
    onOrientationRight in interface OrientationDetector.Listener
  - onOrientationWrong
```
public void onOrientationWrong()
```
    Specified by:
    
    onOrientationWrong in interface OrientationDetector.Listener

Class MapFragment

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class androidx.fragment.app.Fragment

Methods inherited from class java.lang.Object

Constructor Detail

MapFragment

Method Detail

getMapOptions

setMapOptions

getMapView

setMarkerEventListener

setDirectionsEventListener

setMapEventListener

onCreate

onSaveInstanceState

onCreateView

onResume

onPause

onStop

onDestroy

startDirections

onActivityResult

onSourceResult

onMarkerSelect

onMarkerDeselect

markerForPlacemark

markerForSelectedMarker

onCalloutClick

onMapLoadStart

onMapLoadFinish

onPlacemarksLoadFinish

onMapRenderFinish

onMapLoadFail

onMapTransformChange

onLocationUpdated

onOrientationUpdated

onLocationButtonClick

onDirectionsReroute

onDirectionsClick

onDirectionsStart

onRouteStepIndexChange

onDirectionsClosed

onDirectionsError

onUseAccessiblePathsChange

onOrientationRight

onOrientationWrong