uk.co.ordnancesurvey.android.maps

Class SupportMapFragment

java.lang.Object

android.support.v4.app.Fragment

uk.co.ordnancesurvey.android.maps.SupportMapFragment

All Implemented Interfaces:

android.content.ComponentCallbacks, android.view.View.OnCreateContextMenuListener

public class SupportMapFragment
extends android.support.v4.app.Fragment

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 file simply with the XML below. <fragment class="uk.co.ordnancesurvey.android.maps.SupportMapFragment" android:layout_width="match_parent" android:layout_height="match_parent"/>

An OSMap can only be acquired using getMap() when the underlying maps system is loaded and the underlying view in the fragment exists. This class automatically initializes the maps system and the view. If an OSMap is not available, getMap() will return null.

A view can be removed when the SupportMapFragment's onDestroyView() method is called. When this happens the MapFragment is no longer valid until the view is recreated again later when MapFragment's onCreateView(LayoutInflater, ViewGroup, Bundle) method is called.

Any objects obtained from the OSMap are associated with the view. It's important to not hold on to objects (e.g. Marker) beyond the view's life. Otherwise it will cause a memory leak as the view cannot be released.

To use this class, you must include the Android support library in your build path.

Nested Class Summary

Nested classes/interfaces inherited from class android.support.v4.app.Fragment

android.support.v4.app.Fragment.InstantiationException, android.support.v4.app.Fragment.SavedState

Field Summary

Fields

Modifier and Type	Field and Description
OSMapOptions	mOptions

Constructor Summary

Constructors

Constructor and Description
SupportMapFragment()
SupportMapFragment(OSMapOptions options)

Method Summary

Methods

Modifier and Type	Method and Description
OSMap	getMap() Gets the underlying OSMap that is tied to the view wrapped by this fragment.
static SupportMapFragment	newInstance() Creates a map fragment, using default options.
static SupportMapFragment	newInstance(OSMapOptions options) Creates a map fragment with the given options
android.view.View	onCreateView(android.view.LayoutInflater inflater, android.view.ViewGroup container, android.os.Bundle savedInstanceState)
void	onDestroyView()
void	onPause()
void	onResume()

Methods inherited from class android.support.v4.app.Fragment

dump, equals, getActivity, getArguments, getChildFragmentManager, getFragmentManager, getId, getLayoutInflater, getLoaderManager, getParentFragment, getResources, getRetainInstance, getString, getString, getTag, getTargetFragment, getTargetRequestCode, getText, getUserVisibleHint, getView, hashCode, hasOptionsMenu, instantiate, instantiate, isAdded, isDetached, isHidden, isInLayout, isMenuVisible, isRemoving, isResumed, isVisible, onActivityCreated, onActivityResult, onAttach, onConfigurationChanged, onContextItemSelected, onCreate, onCreateAnimation, onCreateContextMenu, onCreateOptionsMenu, onDestroy, onDestroyOptionsMenu, onDetach, onHiddenChanged, onInflate, onLowMemory, onOptionsItemSelected, onOptionsMenuClosed, onPrepareOptionsMenu, onSaveInstanceState, onStart, onStop, onViewCreated, onViewStateRestored, registerForContextMenu, setArguments, setHasOptionsMenu, setInitialSavedState, setMenuVisibility, setRetainInstance, setTargetFragment, setUserVisibleHint, startActivity, startActivityForResult, toString, unregisterForContextMenu

Methods inherited from class java.lang.Object

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

Field Detail

mOptions

public final OSMapOptions mOptions

Constructor Detail

SupportMapFragment

public SupportMapFragment()

SupportMapFragment

public SupportMapFragment(OSMapOptions options)

Method Detail

onCreateView

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

Overrides:

onCreateView in class android.support.v4.app.Fragment

getMap

public OSMap getMap()

Gets the underlying OSMap that is tied to the view wrapped by this fragment.

Returns:

Returns the OSMap. Null if the view of the fragment is not yet ready. This can happen if the fragment lifecyle have not gone through onCreateView(LayoutInflater, ViewGroup, Bundle) yet.

onResume

public void onResume()

Overrides:

onResume in class android.support.v4.app.Fragment

onPause

public void onPause()

Overrides:

onPause in class android.support.v4.app.Fragment

onDestroyView

public void onDestroyView()

Overrides:

onDestroyView in class android.support.v4.app.Fragment

newInstance

public static SupportMapFragment newInstance()

Creates a map fragment, using default options.

newInstance

public static SupportMapFragment newInstance(OSMapOptions options)

Creates a map fragment with the given options