org.osmdroid.views.overlay.infowindow

Class InfoWindow

java.lang.Object

org.osmdroid.views.overlay.infowindow.InfoWindow

Direct Known Subclasses:

BasicInfoWindow

public abstract class InfoWindow
extends Object

InfoWindow is a (pop-up-) View that can be displayed on an MapView, associated to a IGeoPoint.

Typical usage: cartoon-like bubbles displayed when clicking an overlay item (i.e. a Marker). It mimics the InfoWindow class of Google Maps JavaScript API V3. Main differences are:

• Structure and content of the view is let to the responsibility of the caller.
• The same InfoWindow can be associated to many items.

This is an abstract class.

See Also:

MarkerInfoWindow

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	mIsVisible
protected MapView	mMapView
protected Object	mRelatedObject
protected View	mView

Constructor Summary

Constructors

Constructor and Description
InfoWindow(int layoutResId, MapView mapView)
InfoWindow(View v, MapView mapView)

Method Summary

Modifier and Type	Method and Description
void	close() hides the info window, which triggers another render of the map
static void	closeAllInfoWindowsOn(MapView mapView) close all InfoWindows currently opened on this MapView
void	draw() refresh the infowindow drawing.
MapView	getMapView() may return null if the info window hasn't been attached yet
static ArrayList<InfoWindow>	getOpenedInfoWindowsOn(MapView mapView) return all InfoWindows currently opened on this MapView
Object	getRelatedObject()
View	getView() Returns the Android view.
boolean	isOpen()
abstract void	onClose()
void	onDetach() this destroys the window and all references to views
abstract void	onOpen(Object item)
void	open(Object object, GeoPoint position, int offsetX, int offsetY) open the InfoWindow at the specified GeoPosition + offset.
void	setRelatedObject(Object relatedObject) Allows to link an Object (any Object) to this marker.

Methods inherited from class java.lang.Object

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

Field Detail

mView

protected View mView

mIsVisible

protected boolean mIsVisible

mMapView

protected MapView mMapView

mRelatedObject

protected Object mRelatedObject

Constructor Detail

InfoWindow

public InfoWindow(int layoutResId,
                  MapView mapView)

Parameters:

layoutResId - the id of the view resource.

mapView - the mapview on which is hooked the view

InfoWindow

public InfoWindow(View v,
                  MapView mapView)

Method Detail

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.

getMapView

public MapView getMapView()

may return null if the info window hasn't been attached yet

Returns:

getView

public View getView()

Returns the Android view. This allows to set its content.

Returns:

the Android view

open

public void open(Object object,
                 GeoPoint position,
                 int offsetX,
                 int offsetY)

open the InfoWindow at the specified GeoPosition + offset. If it was already opened, close it before reopening.

Parameters:

object - the graphical object on which is hooked the view

position - to place the window on the map

offsetX - (&offsetY) the offset of the view to the position, in pixels. This allows to offset the view from the object position.

draw

public void draw()

refresh the infowindow drawing. Must be called every time the view changes (drag, zoom,...). Best practice is to call this method in the draw method of its overlay.

close

public void close()

hides the info window, which triggers another render of the map

onDetach

public void onDetach()

this destroys the window and all references to views

isOpen

public boolean isOpen()

closeAllInfoWindowsOn

public static void closeAllInfoWindowsOn(MapView mapView)

close all InfoWindows currently opened on this MapView

Parameters:

mapView -

getOpenedInfoWindowsOn

public static ArrayList<InfoWindow> getOpenedInfoWindowsOn(MapView mapView)

return all InfoWindows currently opened on this MapView

Parameters:

mapView -

Returns:

onOpen

public abstract void onOpen(Object item)

onClose

public abstract void onClose()