org.osmdroid.views.overlay
Class OverlayItem

java.lang.Object
  org.osmdroid.views.overlay.OverlayItem

public class OverlayItem
extends Object

Immutable class describing a GeoPoint with a Title and a Description.

Author:

Nicolas Gramlich, Theodore Hong, Fred Eisele

Nested Class Summary

static class

OverlayItem.HotspotPlace Indicates a hotspot for an area.

Field Summary

protected static android.graphics.Point	DEFAULT_MARKER_SIZE
static int	ITEM_STATE_FOCUSED_MASK
static int	ITEM_STATE_PRESSED_MASK
static int	ITEM_STATE_SELECTED_MASK
String	mDescription
GeoPoint	mGeoPoint
protected OverlayItem.HotspotPlace	mHotspotPlace
protected android.graphics.drawable.Drawable	mMarker
String	mTitle
String	mUid

Constructor Summary

OverlayItem(String aTitle, String aDescription, GeoPoint aGeoPoint)

OverlayItem(String aUid, String aTitle, String aDescription, GeoPoint aGeoPoint)

Method Summary

android.graphics.drawable.Drawable	getDrawable()
int	getHeight()
android.graphics.drawable.Drawable	getMarker(int stateBitset)
OverlayItem.HotspotPlace	getMarkerHotspot()
GeoPoint	getPoint()
String	getSnippet()
String	getTitle()
String	getUid()
int	getWidth()
void	setMarker(android.graphics.drawable.Drawable marker)
void	setMarkerHotspot(OverlayItem.HotspotPlace place)
static void	setState(android.graphics.drawable.Drawable drawable, int stateBitset)

Methods inherited from class java.lang.Object

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

Field Detail

ITEM_STATE_FOCUSED_MASK

public static final int ITEM_STATE_FOCUSED_MASK

See Also:

Constant Field Values

ITEM_STATE_PRESSED_MASK

public static final int ITEM_STATE_PRESSED_MASK

See Also:

Constant Field Values

ITEM_STATE_SELECTED_MASK

public static final int ITEM_STATE_SELECTED_MASK

See Also:

Constant Field Values

DEFAULT_MARKER_SIZE

protected static final android.graphics.Point DEFAULT_MARKER_SIZE

mUid

public final String mUid

mTitle

public final String mTitle

mDescription

public final String mDescription

mGeoPoint

public final GeoPoint mGeoPoint

mMarker

protected android.graphics.drawable.Drawable mMarker

mHotspotPlace

protected OverlayItem.HotspotPlace mHotspotPlace

Constructor Detail

OverlayItem

public OverlayItem(String aTitle,
                   String aDescription,
                   GeoPoint aGeoPoint)

Parameters:

aTitle - this should be singleLine (no '\n' )

aDescription - a multiLine description ( '\n' possible)

aGeoPoint -

OverlayItem

public OverlayItem(String aUid,
                   String aTitle,
                   String aDescription,
                   GeoPoint aGeoPoint)

Method Detail

getUid

public String getUid()

getTitle

public String getTitle()

getSnippet

public String getSnippet()

getPoint

public GeoPoint getPoint()

getMarker

public android.graphics.drawable.Drawable getMarker(int stateBitset)

setMarker

public void setMarker(android.graphics.drawable.Drawable marker)

setMarkerHotspot

public void setMarkerHotspot(OverlayItem.HotspotPlace place)

getMarkerHotspot

public OverlayItem.HotspotPlace getMarkerHotspot()

setState

public static void setState(android.graphics.drawable.Drawable drawable,
                            int stateBitset)

getDrawable

public android.graphics.drawable.Drawable getDrawable()

getWidth

public int getWidth()

getHeight

public int getHeight()