com.tomtom.pnd.maplib

Class Marker

java.lang.Object

com.tomtom.pnd.maplib.Marker

All Implemented Interfaces:

Parcelable

public class Marker
extends Object
implements Parcelable

A point on the map, marked by an icon, that the user can select.

Since:

2 (15.2 Fisichella)

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static Parcelable.Creator<Marker>	CREATOR Creates a new Marker from the given Parcel.

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Methods

Modifier and Type	Method and Description
int	describeContents()
long	getId()
Location	getLocation()
Object	getTag()
void	setAnchorPoint(int x, int y) The anchor point defines which point of the icon is used as the reference for associating the icon to the map coordinates.
void	setIcon(Context context, Drawable drawable) Replaces the icon of this Marker by the given Drawable.
void	setIcon(String iconPath) Sets the icon for this Marker.
void	setLocation(Location location) Set location for the marker.
void	setTag(Object tag) Sets the given Object as a tag to this Marker.
String	toString() This class converted to a JSON string.
void	writeToParcel(Parcel dest, int flags)

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static final Parcelable.Creator<Marker> CREATOR

Creates a new Marker from the given Parcel.

Method Detail

writeToParcel

public void writeToParcel(Parcel dest,
                 int flags)

Specified by:

writeToParcel in interface Parcelable

describeContents

public int describeContents()

Specified by:

describeContents in interface Parcelable

setIcon

public void setIcon(String iconPath)
             throws FileNotFoundException,
                    MarkerOperationException

Sets the icon for this Marker. The file should be present on the device and accessible.

Parameters:

iconPath - The path to the icon file.

Throws:

FileNotFoundException - When the file does not exist or cannot be read.

MarkerOperationException - When the Marker could not be updated with the new icon.

setIcon

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

Replaces the icon of this Marker by the given Drawable.

Parameters:

context - This Context is used to determine the cache directory.

drawable - The Drawable to use as an icon. May not be null.

Throws:

FileNotFoundException - When the icon cannot be found or is null.

MarkerOperationException - When the Marker could not be updated with the new icon.

setAnchorPoint

public void setAnchorPoint(int x,
                  int y)
                    throws MarkerOperationException

The anchor point defines which point of the icon is used as the reference for associating the icon to the map coordinates. Both attributes have default value 0, which corresponds to the center of the icon. A value of 1 corresponds to half a length of either width or height; e.g. an anchor set at (-1, -1) corresponds to the bottom left corner, while one at (1, 1) corresponds to the top right corner.

Parameters:

x - The horizontal position.

y - The vertical position.

Throws:

MarkerOperationException - When the anchor point could not be successfully set.

getLocation

public Location getLocation()

Returns:

The Location of this Marker.

setLocation

public void setLocation(Location location)
                 throws MarkerOperationException

Set location for the marker.

Parameters:

location - new location.

Throws:

MarkerOperationException - When the location could not be successfully set.

getTag

public Object getTag()

Returns:

The tag associated with this Marker.

setTag

public void setTag(Object tag)

Sets the given Object as a tag to this Marker.

Parameters:

tag - The object to use as a tag.

getId

public long getId()

Returns:

The ID of this Marker as used by the map.

toString

public String toString()

This class converted to a JSON string.

Overrides:

toString in class Object