net.java.html.leaflet

Class Popup

java.lang.Object

net.java.html.leaflet.ILayer

net.java.html.leaflet.Popup

public final class Popup
extends ILayer

Used to open popups in certain places of the map. Use Map.openPopup to open popups while making sure that only one popup is open at one time (recommended for usability), or use Map.addLayer to open as many as you want.

Constructor Summary

Constructors

Constructor and Description
Popup() Instantiates a Popup object given an optional options object that describes its appearance and location and an optional source object that is used to tag the popup with a reference to the ILayer to which it refers.
Popup(ILayer source) Instantiates a Popup object given an source object that is used to tag the popup with a reference to the ILayer to which it refers.
Popup(PopupOptions options) Instantiates a Popup object given an options object that describes its appearance and location.
Popup(PopupOptions options, ILayer source) Instantiates a Popup object given an optional options object that describes its appearance and location and an optional source object that is used to tag the popup with a reference to the ILayer to which it refers.

Method Summary

Modifier and Type	Method and Description
Popup	addTo(Map map) Adds the popup to the map.
String	getContent() Returns the content of the popup.
LatLng	getLatLng() Returns the geographical point of popup.
Popup	openOn(Map map) Adds the popup to the map and closes the previous one.
Popup	setContent(String htmlContent) Sets the HTML content of the popup.
Popup	setLatLng(LatLng latLng) Sets the geographical point where the popup will open.
Popup	update() Updates the popup content, layout and position.

Methods inherited from class java.lang.Object

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

Constructor Detail

Popup

public Popup()

Instantiates a Popup object given an optional options object that describes its appearance and location and an optional source object that is used to tag the popup with a reference to the ILayer to which it refers.

Popup

public Popup(PopupOptions options)

Instantiates a Popup object given an options object that describes its appearance and location.

Parameters:

options - options object that describes popup's appearance and location

Popup

public Popup(PopupOptions options,
             ILayer source)

Instantiates a Popup object given an optional options object that describes its appearance and location and an optional source object that is used to tag the popup with a reference to the ILayer to which it refers.

Parameters:

options - options object that describes popup's appearance and location

source - Source object that is used to tag the popup with a reference to the ILayer to which it refers

Popup

public Popup(ILayer source)

Instantiates a Popup object given an source object that is used to tag the popup with a reference to the ILayer to which it refers.

Parameters:

source - Source object that is used to tag the popup with a reference to the ILayer to which it refers

Method Detail

addTo

public Popup addTo(Map map)

Adds the popup to the map.

Parameters:

map - The map

Returns:

this

openOn

public Popup openOn(Map map)

Adds the popup to the map and closes the previous one. The same as map.openPopup.

Parameters:

map - The map

Returns:

this

setLatLng

public Popup setLatLng(LatLng latLng)

Sets the geographical point where the popup will open.

Parameters:

latLng - The LatLng location

Returns:

this

getLatLng

public LatLng getLatLng()

Returns the geographical point of popup.

Returns:

The LatLng location where the popup will open

setContent

public Popup setContent(String htmlContent)

Sets the HTML content of the popup.

Parameters:

htmlContent - HTML content of the popup

Returns:

this

getContent

public String getContent()

Returns the content of the popup.

Returns:

Popup content as HTML string

update

public Popup update()

Updates the popup content, layout and position. Useful for updating the popup after something inside changed, e.g. image loaded.

Returns:

this