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

Nested Classes

Modifier and Type	Class and Description
static class	OverlayItem.HotspotPlace Indicates a hotspot for an area.

Field Summary

Fields

Modifier and Type	Field and Description
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
protected IGeoPoint	mGeoPoint
protected OverlayItem.HotspotPlace	mHotspotPlace
protected android.graphics.drawable.Drawable	mMarker
protected String	mSnippet
protected String	mTitle
protected String	mUid

Constructor Summary

Constructors

Constructor and Description
OverlayItem(String aTitle, String aSnippet, IGeoPoint aGeoPoint)
OverlayItem(String aUid, String aTitle, String aDescription, IGeoPoint aGeoPoint)

Method Summary

Methods

Modifier and Type	Method and Description
android.graphics.drawable.Drawable	getDrawable()
int	getHeight()
android.graphics.drawable.Drawable	getMarker(int stateBitset)
OverlayItem.HotspotPlace	getMarkerHotspot()
IGeoPoint	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

protected final String mUid

mTitle

protected final String mTitle

mSnippet

protected final String mSnippet

mGeoPoint

protected final IGeoPoint mGeoPoint

mMarker

protected android.graphics.drawable.Drawable mMarker

mHotspotPlace

protected OverlayItem.HotspotPlace mHotspotPlace

Constructor Detail

OverlayItem

public OverlayItem(String aTitle,
           String aSnippet,
           IGeoPoint aGeoPoint)

Parameters:

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

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

aGeoPoint -

OverlayItem

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

Method Detail

getUid

public String getUid()

getTitle

public String getTitle()

getSnippet

public String getSnippet()

getPoint

public IGeoPoint 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()