Package org.vaadin.addons.componentfactory.leaflet.layer.ui

Class DivOverlay

java.lang.Object

org.vaadin.addons.componentfactory.leaflet.LeafletObject

org.vaadin.addons.componentfactory.leaflet.layer.Layer

org.vaadin.addons.componentfactory.leaflet.layer.ui.DivOverlay

All Implemented Interfaces:

Serializable, Evented, Identifiable, LayerPopupFunctions, LayerTooltipFunctions, ExecutableFunctions

Direct Known Subclasses:

Popup, Tooltip

public abstract class DivOverlay
extends Layer

Base model for L.Popup and L.Tooltip. Inherit from it for custom popup like plugins.

Since:

2020-10-01

Version:

1.0

Author:

Gabor Kokeny Email: kokeny19@gmail.com

See Also:

• Popup
• Tooltip
• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.vaadin.addons.componentfactory.leaflet.layer.Layer

Layer.LayerEventType

Field Summary

Fields inherited from class org.vaadin.addons.componentfactory.leaflet.layer.Layer

DEFAULT_PANE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DivOverlay(String content)	Creates a new overlay with the given HTML content.

Method Summary

Modifier and Type	Method	Description
String	getClassName()	A custom CSS class name to assign to the overlay.
String	getContent()	Returns the content of the overlay.
CompletableFuture<LatLng>	getLatLng()	Returns the geographical point of popup.
Point	getOffset()	The offset of the overlay position.
void	setClassName(String className)	Sets a custom CSS class name to assign to the overlay.
void	setContent(String content)	Sets the HTML content of the overlay.
void	setLatLng(LatLng latLng)	Sets the geographical point where the overlay will open.
void	setOffset(Point offset)	Sets the offset of the overlay position.

Methods inherited from class org.vaadin.addons.componentfactory.leaflet.layer.Layer

addEventListener, addTo, addTo, bindPopup, bindPopup, bindTooltip, bindTooltip, clearAllEventListeners, fireEvent, getAttribution, getEvents, getPane, getPopup, getTooltip, hasEventListeners, onAdd, onPopupClose, onPopupOpen, onRemove, onTooltipClose, onTooltipOpen, remove, removeEventListener, set, setAttribution, setPane, unbindPopup, unbindTooltip

Methods inherited from class org.vaadin.addons.componentfactory.leaflet.LeafletObject

call, configureObjectMapper, executeJs, getConstructorArgumentNames, getJson, getLeafletType, getParent, getUuid, setParent

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.vaadin.addons.componentfactory.leaflet.layer.events.Evented

listens, off, off, on

Methods inherited from interface org.vaadin.addons.componentfactory.leaflet.layer.map.functions.ExecutableFunctions

call, call, executeJs, executeJs

Methods inherited from interface org.vaadin.addons.componentfactory.leaflet.layer.Identifiable

getUuid

Methods inherited from interface org.vaadin.addons.componentfactory.leaflet.layer.LayerPopupFunctions

closePopup, isPopupOpen, openPopup, openPopup, setPopupContent, setPopupContent, togglePopup

Methods inherited from interface org.vaadin.addons.componentfactory.leaflet.layer.LayerTooltipFunctions

closeTooltip, isTooltipOpen, openTooltip, openTooltip, setTooltipContent, setTooltipContent, toggleTooltip

Constructor Details

DivOverlay

protected DivOverlay(String content)

Creates a new overlay with the given HTML content.

Parameters:

content - the HTML content of the overlay

Method Details

getClassName

public String getClassName()

A custom CSS class name to assign to the overlay.

Returns:

the CSS class name to assign to the overlay.

setClassName

public void setClassName(String className)

Sets a custom CSS class name to assign to the overlay.

Parameters:

className - the CSS class name to assign to the overlay

getOffset

public Point getOffset()

The offset of the overlay position. Useful to control the anchor of the overlay when opening it on some overlays.

Returns:

the offset of the overlay position

setOffset

public void setOffset(Point offset)

Sets the offset of the overlay position. Useful to control the anchor of the overlay when opening it.

Parameters:

offset - the offset of the overlay position

getLatLng

public CompletableFuture<LatLng> getLatLng()

Returns the geographical point of popup.

Returns:

the geographical point of popup.

setLatLng

public void setLatLng(LatLng latLng)

Sets the geographical point where the overlay will open.

Parameters:

latLng - the geographical point where the overlay will open

getContent

public String getContent()

Returns the content of the overlay.

Returns:

the content of the overlay.

setContent

public void setContent(String content)

Sets the HTML content of the overlay. If a function is passed the source layer will be passed to the function.

Parameters:

content - the content of the overlay