org.osmdroid.views.overlay

Class OverlayWithIW

java.lang.Object

org.osmdroid.views.overlay.Overlay

org.osmdroid.views.overlay.OverlayWithIW

All Implemented Interfaces:

OverlayConstants

Direct Known Subclasses:

Marker, PolyOverlayWithIW

public abstract class OverlayWithIW
extends Overlay

The OverlayWithIW is an Overlay that contain data title , a snippet or description, and optionally a "sub-description" and that can be shown in a popup-InfoWindow (a bubble). Handling tap event and showing the InfoWindow at a relevant position is let to sub-classes.

See Also:

BasicInfoWindow

Nested Class Summary

Nested classes/interfaces inherited from class org.osmdroid.views.overlay.Overlay

Overlay.Snappable

Field Summary

Fields

Modifier and Type	Field and Description
protected String	mId
protected InfoWindow	mInfoWindow
protected Object	mRelatedObject
protected String	mSnippet
protected String	mSubDescription
protected String	mTitle

Fields inherited from class org.osmdroid.views.overlay.Overlay

mBounds, SHADOW_X_SKEW, SHADOW_Y_SCALE

Fields inherited from interface org.osmdroid.views.util.constants.OverlayConstants

DEFAULT_ZOOMLEVEL_MINIMAP_DIFFERENCE, NOT_SET

Constructor Summary

Constructors

Constructor and Description
OverlayWithIW()
OverlayWithIW(Context ctx) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	closeInfoWindow()
String	getId()
InfoWindow	getInfoWindow()
Object	getRelatedObject()
String	getSnippet()
String	getSubDescription()
String	getTitle()
boolean	isInfoWindowOpen()
void	onDestroy()
void	setId(String id) Allows to set a user-defined id.
void	setInfoWindow(InfoWindow infoWindow) By default, OverlayWithIW has no InfoWindow.
void	setRelatedObject(Object relatedObject) Allows to link an Object (any Object) to this marker.
void	setSnippet(String snippet)
void	setSubDescription(String subDescription) set the "sub-description", an optional text to be shown in the InfoWindow, below the snippet, in a smaller text size
void	setTitle(String title)

Methods inherited from class org.osmdroid.views.overlay.Overlay

draw, draw, drawAt, getBounds, getSafeMenuId, getSafeMenuIdSequence, isEnabled, onDetach, onDoubleTap, onDoubleTapEvent, onDown, onFling, onKeyDown, onKeyUp, onLongPress, onPause, onResume, onScroll, onShowPress, onSingleTapConfirmed, onSingleTapUp, onTouchEvent, onTrackballEvent, setEnabled

Methods inherited from class java.lang.Object

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

Field Detail

mTitle

protected String mTitle

mSnippet

protected String mSnippet

mSubDescription

protected String mSubDescription

mInfoWindow

protected InfoWindow mInfoWindow

mRelatedObject

protected Object mRelatedObject

mId

protected String mId

Constructor Detail

OverlayWithIW

@Deprecated
public OverlayWithIW(Context ctx)

Deprecated.

Use OverlayWithIW() instead

OverlayWithIW

public OverlayWithIW()

Method Detail

setTitle

public void setTitle(String title)

getTitle

public String getTitle()

setSnippet

public void setSnippet(String snippet)

getSnippet

public String getSnippet()

setSubDescription

public void setSubDescription(String subDescription)

set the "sub-description", an optional text to be shown in the InfoWindow, below the snippet, in a smaller text size

getSubDescription

public String getSubDescription()

setRelatedObject

public void setRelatedObject(Object relatedObject)

Allows to link an Object (any Object) to this marker. This is particularly useful to handle custom InfoWindow.

getRelatedObject

public Object getRelatedObject()

Returns:

the related object.

setId

public void setId(String id)

Allows to set a user-defined id. Example: when drawing KML objects, can be the KML id.

Parameters:

id - the user-defined id, as a String. Can be null.

getId

public String getId()

Returns:

the user-defined id.

setInfoWindow

public void setInfoWindow(InfoWindow infoWindow)

By default, OverlayWithIW has no InfoWindow. Usage: setInfoWindow(new BasicInfoWindow(layoutResId, mapView));

Parameters:

infoWindow - the InfoWindow to be opened when tapping the overlay. This InfoWindow MUST be able to handle an OverlayWithIW (as BasicInfoWindow does). Set it to null to remove an existing InfoWindow.

getInfoWindow

public InfoWindow getInfoWindow()

closeInfoWindow

public void closeInfoWindow()

onDestroy

public void onDestroy()

isInfoWindowOpen

public boolean isInfoWindowOpen()