com.tomtom.pnd.maplib

Class MarkerLayer

java.lang.Object

com.tomtom.pnd.maplib.MarkerLayer

public final class MarkerLayer
extends java.lang.Object

A set of Marker's.

Method Summary

Methods

Modifier and Type	Method and Description
void	addMarker(Marker marker) Adds the given Marker to this layer and the map.
Marker	createMarkerAt(double latitude, double longitude) Creates a new Marker at the given coordinates.
Marker	createMarkerFrom(android.os.Parcel in) Creates a new Marker using the given Parcel.
java.lang.String	getIconPath()
long	getId()
java.util.List<Marker>	getMarkers() Returns a list of all Marker's in this layer.
boolean	isVisible()
void	removeMarker(long markerId)
void	removeMarker(Marker marker) Removes the given Marker from this layer and the map.
void	removeMarkers(long[] markerIds)
void	setIcon(android.content.Context context, android.graphics.drawable.Drawable drawable) Assigns a Drawable as an icon to this MarkerLayer.
void	setIconPath(java.lang.String iconPath) Assigns an icon to this MarkerLayer.
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

Method Detail

getId

public long getId()

Returns:

The ID of this layer.

getIconPath

public java.lang.String getIconPath()

Returns:

The absolute path to this layers icon image.

setIconPath

public void setIconPath(java.lang.String iconPath)
                 throws java.io.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:

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

setIcon

public void setIcon(android.content.Context context,
           android.graphics.drawable.Drawable drawable)
             throws java.io.FileNotFoundException,
                    MarkerOperationException

Assigns a Drawable as an icon to this MarkerLayer.

Parameters:

context - The Context for this Drawable.

drawable - The Drawable to use.

Throws:

java.io.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 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(android.os.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 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 void removeMarkers(long[] markerIds)

getMarkers

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

Returns a list of all Marker's in this layer.

Returns:

The list of Marker's.