com.tomtom.pnd.maplib

Class MarkerLayer

java.lang.Object

com.tomtom.pnd.maplib.MarkerLayer

public abstract class MarkerLayer
extends Object

A set of Marker's.

Since:

2 (15.2 Fisichella)

Constructor Summary

Constructors

Constructor and Description
MarkerLayer()

Method Summary

Modifier and Type	Method and Description
void	addMarker(Marker marker) Adds the given Marker to this layer and the map.
abstract Marker	createMarkerAt(double latitude, double longitude) Creates a new Marker at the given coordinates.
Marker	createMarkerFrom(Parcel in) Creates a new Marker using the given Parcel.
String	getIconPath()
abstract long	getId()
List<Marker>	getMarkers() Returns a list of all Marker's in this layer.
protected abstract boolean	isValid()
boolean	isVisible()
void	removeMarker(long markerId)
void	removeMarker(Marker marker) Removes the given Marker from this layer and the map.
abstract void	removeMarkers(long[] markerIds)
void	setIcon(Context context, Drawable drawable) Assigns a Drawable as an icon to this MarkerLayer.
void	setIconPath(String iconPath) Assigns an icon to this MarkerLayer.
abstract void	updateMarker(Marker marker) Updates the given Marker with the currently contained information.

Methods inherited from class java.lang.Object

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

Constructor Detail

MarkerLayer

public MarkerLayer()

Method Detail

getId

public abstract long getId()

Returns:

The ID of this layer.

getIconPath

public String getIconPath()

Returns:

The absolute path to this layers icon image, or an empty string if it is not set.

setIconPath

public void setIconPath(String iconPath)
                 throws FileNotFoundException

Assigns an icon to this MarkerLayer. It will be used for all Marker's created after this call.

Parameters:

iconPath - The full path to the icon image file on the device. May not be null.

Throws:

FileNotFoundException - Thrown when the given image file cannot be found or read.

setIcon

public void setIcon(Context context,
                    Drawable drawable)
             throws FileNotFoundException,
                    MarkerOperationException

Assigns a Drawable as an icon to this MarkerLayer.

Parameters:

context - The Context for this Drawable.

drawable - The Drawable to use.

Throws:

FileNotFoundException - When the given image file cannot be found or read.

MarkerOperationException - When the image file could not be cached.

isVisible

public boolean isVisible()

Returns:

True, when this layer is visible; false otherwise.

createMarkerAt

public abstract Marker createMarkerAt(double latitude,
                                      double longitude)
                               throws MarkerOperationException

Creates a new Marker at the given coordinates. It will be added to this layer and to the map this layer belongs to.

Parameters:

latitude - The latitude degrees of the Marker's position.

longitude - The longitude degrees of the Marker's position.

Returns:

The newly created Marker, or null when creation failed.

Throws:

MarkerOperationException - When the Marker's anchor point could not be set.

createMarkerFrom

public Marker createMarkerFrom(Parcel in)
                        throws MarkerOperationException

Creates a new Marker using the given Parcel. It will be added to this layer and to the map this layer belongs to.

Parameters:

in - The Parcel containing the instance state information.

Returns:

The newly created Marker, or null when creation failed.

Throws:

MarkerOperationException - When the new Marker could not be added to this MarkerLayer.

updateMarker

public abstract void updateMarker(Marker marker)
                           throws MarkerOperationException

Updates the given Marker with the currently contained information.

Parameters:

marker - The Marker to update.

Throws:

MarkerOperationException - When the marker was not successfully updated.

addMarker

public void addMarker(Marker marker)
               throws MarkerOperationException

Adds the given Marker to this layer and the map. This marker will have a valid ID after this call.

Parameters:

marker - The Marker to add.

Throws:

MarkerOperationException - When the marker was not successfully added.

removeMarker

public void removeMarker(Marker marker)

Removes the given Marker from this layer and the map. This marker will become invalid and may no longer be used!

Parameters:

marker - The Marker to remove.

removeMarker

public void removeMarker(long markerId)

removeMarkers

public abstract void removeMarkers(long[] markerIds)

getMarkers

public List<Marker> getMarkers()

Returns a list of all Marker's in this layer. If the layer is invalid, an empty list is returned.

Returns:

The list of Marker's.

isValid

protected abstract boolean isValid()

Returns:

True when this layer is valid and active; false otherwise.