Package com.here.sdk.mapview

Interface MapViewLifecycleListener

public interface MapViewLifecycleListener

Provides a mechanism for observing a lifecycle of a map view and/or implementing components whose lifecycle needs to be linked with that of a map view.

A configuration change that results in Activity being recreated does not trigger an onDestroy() call. The listener will be preserved throughout the destruction and recreation of the MapView. It is safe to hold and use the MapViewBase object passed in onAttach(com.here.sdk.mapview.MapViewBase) until onDetach() or onDestroy() gets called. However, it is important that the listener does not hold a strong reference to an Activity, directly or indirectly (for example by holding a reference to a MapView. A component implementing this interface should interact with the map view only through the MapViewBase object passed in onAttach(com.here.sdk.mapview.MapViewBase).

A MapView is using a SurfaceView

to render its content.

  • Method Details

    • onAttach

      void onAttach(@NonNull MapViewBase mapView)

      Called when adding MapViewLifecycleListener to the map view. If the map view does not have render target attached at the time of adding the listener, then this method will be called later, after render target is attached. This means that the map view it receives is always fully initialized.

      Can be used to implement the logic to create and add visual components to the map view.

      Parameters:
      mapView -

      The map view to attach to.

    • onDetach

      void onDetach(@NonNull MapViewBase mapView)

      Called when removing MapViewLifecycleListener from the map view. Can be used to implement the logic to remove visual components from the map view and release resources if necessary.

      Parameters:
      mapView -

      The map view to detach from.

    • onPause

      void onPause()

      Called when the map view to which this MapViewLifecycleListener is attached to gets paused (usually when the app goes into background). This should be used by components that perform continuous updates to pause those updates until onResume() is called.

    • onResume

      void onResume()

      Called when the map view to which this MapViewLifecycleListener is attached to gets resumed (usually when the app goes into foreground). This should be used by components that perform continuous updates to resume those updates after a previous call to onPause().

    • onDestroy

      void onDestroy()

      Called when the map view to which this is attached to is destroyed. After this is called, no other MapViewLifecycleListener method will be invoked. This should be used to make sure all resources are freed.