com.tomtom.online.sdk.map

Interface OverlaySettings

All Superinterfaces:

com.tomtom.core.maps.OnMapTapListener

public interface OverlaySettings
extends com.tomtom.core.maps.OnMapTapListener

Settings for overlays manipulation. To obtain this interface, call TomtomMap.getOverlaySettings().

Method Summary

Modifier and Type	Method and Description
void	addOnCircleClickListener(TomtomMapCallback.OnCircleClickListener listener) Called to add a listener for circle clicks.
void	addOnPolygonClickListener(TomtomMapCallback.OnPolygonClickListener listener) Called to add a listener for polygon clicks.
void	addOnPolylineClickListener(TomtomMapCallback.OnPolylineClickListener listener) Called to add a listener for polygon clicks.
Overlay	addOverlay(Overlay overlay) Add new overlay to the map providing overlay options (e.g.
boolean	areOverlaysActive() True if any overlay are added to the map, false otherwise.
java.util.List<Overlay>	getOverlays() List of all overlays
void	onViewStateRestored(com.tomtom.online.sdk.map.MapState savedState) Called to restore overlays when screen rotates.
void	removeOnCircleClickListener(TomtomMapCallback.OnCircleClickListener listener) Called to remove a listener for circle clicks.
void	removeOnCircleClickListeners() Remove all registered circle click listeners.
void	removeOnPolygonClickListener(TomtomMapCallback.OnPolygonClickListener listener) Called to remove a listener for polygon clicks.
void	removeOnPolygonClickListeners() Remove all registered polygon click listeners.
void	removeOnPolylineClickListener(TomtomMapCallback.OnPolylineClickListener listener) Called to remove a listener for polyline clicks.
void	removeOnPolylineClickListeners() Remove all registered polyline click listeners.
void	removeOverlay(Overlay overlay) Remove specified overlay from the map.
void	removeOverlayByTag(java.lang.String name) Find the overlay using its name and then remove it.
void	removeOverlays() Remove all overlays from the map.

Methods inherited from interface com.tomtom.core.maps.OnMapTapListener

onMapLongTap, onMapTap

Method Detail

addOverlay

Overlay addOverlay(Overlay overlay)

Add new overlay to the map providing overlay options (e.g. type of the overlay and its tyle).

removeOverlays

void removeOverlays()

Remove all overlays from the map.

removeOverlay

void removeOverlay(Overlay overlay)

Remove specified overlay from the map. If the overlay is not found, no action happens.

removeOverlayByTag

void removeOverlayByTag(java.lang.String name)

Find the overlay using its name and then remove it.

getOverlays

java.util.List<Overlay> getOverlays()

List of all overlays

Returns:

areOverlaysActive

boolean areOverlaysActive()

True if any overlay are added to the map, false otherwise.

onViewStateRestored

void onViewStateRestored(com.tomtom.online.sdk.map.MapState savedState)

Called to restore overlays when screen rotates.

addOnCircleClickListener

void addOnCircleClickListener(TomtomMapCallback.OnCircleClickListener listener)

Called to add a listener for circle clicks.

Parameters:

listener - Listener to be added for circle clicks.

removeOnCircleClickListener

void removeOnCircleClickListener(TomtomMapCallback.OnCircleClickListener listener)

Called to remove a listener for circle clicks.

Parameters:

listener - Listener to be removed for circle clicks.

removeOnCircleClickListeners

void removeOnCircleClickListeners()

Remove all registered circle click listeners.

addOnPolygonClickListener

void addOnPolygonClickListener(TomtomMapCallback.OnPolygonClickListener listener)

Called to add a listener for polygon clicks.

Parameters:

listener - Listener to be added for polygon clicks.

removeOnPolygonClickListener

void removeOnPolygonClickListener(TomtomMapCallback.OnPolygonClickListener listener)

Called to remove a listener for polygon clicks.

Parameters:

listener - Listener to be removed for polygon clicks.

removeOnPolygonClickListeners

void removeOnPolygonClickListeners()

Remove all registered polygon click listeners.

addOnPolylineClickListener

void addOnPolylineClickListener(TomtomMapCallback.OnPolylineClickListener listener)

Called to add a listener for polygon clicks.

Parameters:

listener - Listener to be added for polygon clicks.

removeOnPolylineClickListener

void removeOnPolylineClickListener(TomtomMapCallback.OnPolylineClickListener listener)

Called to remove a listener for polyline clicks.

Parameters:

listener - Listener to be removed for polyline clicks.

removeOnPolylineClickListeners

void removeOnPolylineClickListeners()

Remove all registered polyline click listeners.