com.tomtom.pnd.maplib

Class MapControllerImp

java.lang.Object

com.tomtom.pnd.maplib.MapControllerImp

All Implemented Interfaces:

MapController

public class MapControllerImp
extends java.lang.Object
implements MapController

This is the default MapController implementation. It provides third party developers a means to control their MapView instance.

Nested Class Summary

Nested classes/interfaces inherited from interface com.tomtom.pnd.maplib.MapController

MapController.OnAutoCenterChangedListener, MapController.OnPanEnabledChangedListener, MapController.OnZoomEnabledChangedListener, MapController.UnknownLocationException

Constructor Summary

Constructors

Constructor and Description
MapControllerImp(android.content.Context context, int reflectionPort)

Method Summary

Methods

Modifier and Type	Method and Description
void	addOnAutoCenterChangedListener(MapController.OnAutoCenterChangedListener onAutoCenterChangedListener) Adds an auto-center listener to the list.
void	addOnPanEnabledChangedListener(MapController.OnPanEnabledChangedListener onPanEnabledChangedListener) Adds a user panning listener to the list.
void	addOnZoomEnabledChangedListener(MapController.OnZoomEnabledChangedListener onZoomEnabledChangedListener) Adds a user zooming listener to the list.
MarkerLayer	createLayer() Creates a new MarkerLayer for the map.
Marker	createMarkerAt(double latitude, double longitude) Deprecated.
Marker	createMarkerFrom(android.os.Parcel in) Deprecated.
java.util.List<MarkerLayer>	getLayers() Returns the list of all MarkerLayer's that the map currently contains.
MarkerLayer	getLayerWithId(long id) Returns the MarkerLayer with the given ID.
LocationConverter	getLocationConverter()
android.location.Location	getMapCenter() Returns the current location as shown at the center of the map.
java.util.List<Marker>	getMarkers() Deprecated.
Marker	getMarkerWithId(long id) Returns the Marker with the given ID.
int	getMaxZoomLevel()
int	getMinZoomLevel()
int	getZoomLevel() Returns the current zoom level.
boolean	isAutoCenterEnabled()
boolean	isLayerVisible(MarkerLayer layer) Determine if a MarkerLayer is currently shown or not.
boolean	isMapReady() Check if the map is ready to receive commands.
boolean	isPanEnabled() Note that setting this to false will not prevent panning when the panning functions are called.
boolean	isSensorLocationEnabled() Check if map matched location enabled.
boolean	isUserPanDisablesAutoCenterEnabled()
boolean	isZoomEnabled()
void	notifyMapIsConnected()
void	notifyMapIsDisconnected()
void	onPause() Called when activity goes to non-active state.
void	onResume() Called when activity goes to active state.
void	registerMapEventCallbacks(MapEventCallbacks eventCallback) Register callbacks to be invoked on map events.
void	removeLayer(MarkerLayer layer) Removes the given MarkerLayer from the map.
void	removeMarker(Marker marker) Deprecated.
void	removeMarkers(long[] markerIds) Removes the given default Markers.
void	removeMarkers(long layerId, long[] markerIds) Removes the given Markers from given layer with current ids.
void	setAutoCenterEnabled(boolean enable) Keeps the map centered at the current location of the device.
void	setLayerVisibility(long layerId, boolean show) Show or hide a specific layer, including StockLayers.
void	setLayerVisibility(MarkerLayer layer, boolean show) Show or hide a specific layer.
void	setMapCenter(double latitude, double longitude) Centers the map on the given location.
void	setMapCenter(android.location.Location location) Centers the map on the given location.
void	setMapCenterToCurrentLocation() Centers the map on the current location of the device.
void	setPanEnabled(boolean enable) Control whether or not the user is allowed to pan the map using touch gestures.
void	setSensorLocationEnabled(boolean enabled) Enable/disable sensor location.
void	setSensorLocationEnabled(boolean enabled, android.graphics.drawable.Drawable icon) Enable/disable sensor location.
void	setUserPanDisablesAutoCenterEnabled(boolean enable) Disables the auto-center mode once the user pans.
void	setZoomEnabled(boolean enable) Control whether or not the user is allowed to zoom the map using touch gestures.
void	setZoomLevel(int level) Zoom the map to the given level.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MapControllerImp

public MapControllerImp(android.content.Context context,
                int reflectionPort)

Method Detail

setZoomEnabled

public void setZoomEnabled(boolean enable)

Description copied from interface: MapController

Control whether or not the user is allowed to zoom the map using touch gestures. Zooming programatically is always possible and does not require setting this value to true.

Specified by:

setZoomEnabled in interface MapController

Parameters:

enable - When true, the user is allowed to zoom the map.

isZoomEnabled

public boolean isZoomEnabled()

Specified by:

isZoomEnabled in interface MapController

Returns:

Returns true when the user is allowed to zoom using touch; false otherwise.

getMinZoomLevel

public int getMinZoomLevel()

Specified by:

getMinZoomLevel in interface MapController

Returns:

The minimum supported zoom level for the current map.

getMaxZoomLevel

public int getMaxZoomLevel()

Specified by:

getMaxZoomLevel in interface MapController

Returns:

The maximum supported zoom level for the current map.

getZoomLevel

public int getZoomLevel()

Description copied from interface: MapController

Returns the current zoom level.

Specified by:

getZoomLevel in interface MapController

Returns:

The current zoom level, ranging from 0 (the world) to 20 (finest detail).

setZoomLevel

public void setZoomLevel(int level)

Description copied from interface: MapController

Zoom the map to the given level. The map will be scaled ranging from 0 (the world) to 20 (finest detail).

Specified by:

setZoomLevel in interface MapController

Parameters:

level - The zoom level.

getMapCenter

public android.location.Location getMapCenter()

Description copied from interface: MapController

Returns the current location as shown at the center of the map. Note that this is not the current GPS location but the location as shown in the view.

Specified by:

getMapCenter in interface MapController

Returns:

The center location of the map.

setMapCenterToCurrentLocation

public void setMapCenterToCurrentLocation()

Description copied from interface: MapController

Centers the map on the current location of the device. If the new location is too far from the current one, MapController will go to the given location instantaneously; otherwise it will pan to it.

Specified by:

setMapCenterToCurrentLocation in interface MapController

setAutoCenterEnabled

public void setAutoCenterEnabled(boolean enable)

Description copied from interface: MapController

Keeps the map centered at the current location of the device.

Specified by:

setAutoCenterEnabled in interface MapController

Parameters:

enable - When true, the map will be kept centered at the current location.

isAutoCenterEnabled

public boolean isAutoCenterEnabled()

Specified by:

isAutoCenterEnabled in interface MapController

Returns:

Whether or not the map is in auto center mode.

setUserPanDisablesAutoCenterEnabled

public void setUserPanDisablesAutoCenterEnabled(boolean enable)

Description copied from interface: MapController

Disables the auto-center mode once the user pans.

Specified by:

setUserPanDisablesAutoCenterEnabled in interface MapController

Parameters:

enable - When true, the auto-center will be disabled once the user pans the map. When false, the auto-center will remain active.

isUserPanDisablesAutoCenterEnabled

public boolean isUserPanDisablesAutoCenterEnabled()

Specified by:

isUserPanDisablesAutoCenterEnabled in interface MapController

Returns:

Whether or not auto-center mode is disabled when the user pans.

setMapCenter

public void setMapCenter(android.location.Location location)

Description copied from interface: MapController

Centers the map on the given location. If the new location is too far from the current one, MapController will go to the given location instantaneously; otherwise it will pan to it.

Specified by:

setMapCenter in interface MapController

Parameters:

location - The location the map should show at the center of the MapView.

setMapCenter

public void setMapCenter(double latitude,
                double longitude)

Description copied from interface: MapController

Centers the map on the given location. If the new location is too far from the current one, MapController will go to the given location instantaneously; otherwise it will pan to it.

Specified by:

setMapCenter in interface MapController

Parameters:

latitude - The latitude degrees of the location the map should show at the center of the MapView.

longitude - The longitude degrees of the location the map should show at the center of the MapView.

setPanEnabled

public void setPanEnabled(boolean enable)

Description copied from interface: MapController

Control whether or not the user is allowed to pan the map using touch gestures. Panning programatically is always possible and does not require setting this value to true.

Specified by:

setPanEnabled in interface MapController

Parameters:

enable - When true, the user is allowed to pan the map.

isPanEnabled

public boolean isPanEnabled()

Description copied from interface: MapController

Note that setting this to false will not prevent panning when the panning functions are called. False will only prevent the user from moving the map.

Specified by:

isPanEnabled in interface MapController

Returns:

Returns true when the user is allowed to pan using touch; false otherwise.

createMarkerAt

@Deprecated
public Marker createMarkerAt(double latitude,
                               double longitude)
                      throws MarkerOperationException

Deprecated.

Description copied from interface: MapController

Factory function that creates a new Marker at the given location.

Specified by:

createMarkerAt in interface MapController

Parameters:

latitude - The latitude degrees of the location of the marker.

longitude - The longitude degrees of the locaiton of the marker.

Returns:

The created Marker.

Throws:

MarkerOperationException - When the Marker could not be created.

createMarkerFrom

@Deprecated
public Marker createMarkerFrom(android.os.Parcel in)

Deprecated.

Description copied from interface: MapController

This function creates a valid Marker from the given Parcel.

Specified by:

createMarkerFrom in interface MapController

Parameters:

in - The Parcel to create the Marker from.

Returns:

A valid Marker.

removeMarker

@Deprecated
public void removeMarker(Marker marker)

Deprecated.

Description copied from interface: MapController

Removes the given Marker from the map.

Specified by:

removeMarker in interface MapController

Parameters:

marker - The Marker to remove.

removeMarkers

public void removeMarkers(long[] markerIds)

Description copied from interface: MapController

Removes the given default Markers.

Specified by:

removeMarkers in interface MapController

Parameters:

markerIds - array of marker's ids that will be deleted.

removeMarkers

public void removeMarkers(long layerId,
                 long[] markerIds)

Description copied from interface: MapController

Removes the given Markers from given layer with current ids.

Specified by:

removeMarkers in interface MapController

Parameters:

layerId - layer's id from which markers will be deleted.

markerIds - array of marker's ids that will be deleted.

getMarkers

@Deprecated
public java.util.List<Marker> getMarkers()

Deprecated.

Description copied from interface: MapController

Returns the list of all Marker's that the map currently contains.

Specified by:

getMarkers in interface MapController

Returns:

The list of all Marker's.

getMarkerWithId

public Marker getMarkerWithId(long id)

Description copied from interface: MapController

Returns the Marker with the given ID. Will search through all layers to find it.

Specified by:

getMarkerWithId in interface MapController

Parameters:

id - The ID of the Marker.

Returns:

The Marker with the given ID, or null if it does not exist.

createLayer

public MarkerLayer createLayer()

Description copied from interface: MapController

Creates a new MarkerLayer for the map.

Specified by:

createLayer in interface MapController

Returns:

A valid MarkerLayer.

removeLayer

public void removeLayer(MarkerLayer layer)

Description copied from interface: MapController

Removes the given MarkerLayer from the map.

Specified by:

removeLayer in interface MapController

getLayers

public java.util.List<MarkerLayer> getLayers()

Description copied from interface: MapController

Returns the list of all MarkerLayer's that the map currently contains.

Specified by:

getLayers in interface MapController

Returns:

The list of all MarkerLayer's.

getLayerWithId

public MarkerLayer getLayerWithId(long id)

Description copied from interface: MapController

Returns the MarkerLayer with the given ID.

Specified by:

getLayerWithId in interface MapController

Parameters:

id - The ID of the MarkerLayer.

Returns:

The MarkerLayer with the given ID, or null if it does not exist.

setLayerVisibility

public void setLayerVisibility(MarkerLayer layer,
                      boolean show)

Description copied from interface: MapController

Show or hide a specific layer.

Specified by:

setLayerVisibility in interface MapController

Parameters:

layer - The MarkerLayer to change the visibility of.

show - When true, the layer will be visible; when false the layer will be hidden.

setLayerVisibility

public void setLayerVisibility(long layerId,
                      boolean show)

Description copied from interface: MapController

Show or hide a specific layer, including StockLayers.

Specified by:

setLayerVisibility in interface MapController

Parameters:

layerId - The id of the layer to change the visibility of. Can be one of the StockLayers values.

show - When true, the layer will be visible; when false the layer will be hidden.

isLayerVisible

public boolean isLayerVisible(MarkerLayer layer)

Description copied from interface: MapController

Determine if a MarkerLayer is currently shown or not.

Specified by:

isLayerVisible in interface MapController

Parameters:

layer - The MarkerLayer to determine the visibility of.

Returns:

True if the layer is visible; false otherwise.

addOnAutoCenterChangedListener

public void addOnAutoCenterChangedListener(MapController.OnAutoCenterChangedListener onAutoCenterChangedListener)

Description copied from interface: MapController

Adds an auto-center listener to the list.

Specified by:

addOnAutoCenterChangedListener in interface MapController

Parameters:

onAutoCenterChangedListener - Listener that will be notified of auto-center state changes.

addOnPanEnabledChangedListener

public void addOnPanEnabledChangedListener(MapController.OnPanEnabledChangedListener onPanEnabledChangedListener)

Description copied from interface: MapController

Adds a user panning listener to the list.

Specified by:

addOnPanEnabledChangedListener in interface MapController

Parameters:

onPanEnabledChangedListener - Listener that will be notified of user panning state changes.

addOnZoomEnabledChangedListener

public void addOnZoomEnabledChangedListener(MapController.OnZoomEnabledChangedListener onZoomEnabledChangedListener)

Description copied from interface: MapController

Adds a user zooming listener to the list.

Specified by:

addOnZoomEnabledChangedListener in interface MapController

Parameters:

onZoomEnabledChangedListener - Listener that will be notified of user zooming state changes.

getLocationConverter

public LocationConverter getLocationConverter()

Specified by:

getLocationConverter in interface MapController

Returns:

The LocationConverter that can be used with this MapController instance.

setSensorLocationEnabled

public void setSensorLocationEnabled(boolean enabled)

Description copied from interface: MapController

Enable/disable sensor location.

Specified by:

setSensorLocationEnabled in interface MapController

Parameters:

enabled - When true then map matched location enabled, when false - sensor location.

setSensorLocationEnabled

public void setSensorLocationEnabled(boolean enabled,
                            android.graphics.drawable.Drawable icon)

Description copied from interface: MapController

Enable/disable sensor location.

Specified by:

setSensorLocationEnabled in interface MapController

Parameters:

enabled - When true then map matched location enabled, when false - sensor location.

icon - custom icon to show sensor match

isSensorLocationEnabled

public boolean isSensorLocationEnabled()

Description copied from interface: MapController

Check if map matched location enabled.

Specified by:

isSensorLocationEnabled in interface MapController

Returns:

True if the map matched location is enabled; false otherwise.

registerMapEventCallbacks

public void registerMapEventCallbacks(MapEventCallbacks eventCallback)

Description copied from interface: MapController

Register callbacks to be invoked on map events.

Specified by:

registerMapEventCallbacks in interface MapController

Parameters:

eventCallback - map callbacks

notifyMapIsConnected

public void notifyMapIsConnected()

notifyMapIsDisconnected

public void notifyMapIsDisconnected()

onResume

public void onResume()

Description copied from interface: MapController

Called when activity goes to active state.

Specified by:

onResume in interface MapController

onPause

public void onPause()

Description copied from interface: MapController

Called when activity goes to non-active state.

Specified by:

onPause in interface MapController

isMapReady

public boolean isMapReady()

Description copied from interface: MapController

Check if the map is ready to receive commands.

Specified by:

isMapReady in interface MapController

Returns:

true if map is ready.