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

Class InteractiveLayer

java.lang.Object

org.vaadin.addons.componentfactory.leaflet.LeafletObject

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

org.vaadin.addons.componentfactory.leaflet.layer.InteractiveLayer

All Implemented Interfaces:

Serializable, Evented, SupportsMouseEvents, Identifiable, LayerPopupFunctions, LayerTooltipFunctions, ExecutableFunctions

Direct Known Subclasses:

ImageOverlay, Marker, Path

public abstract class InteractiveLayer
extends Layer
implements SupportsMouseEvents

Some Layers can be made interactive - when the user interacts with such a layer, mouse events like click and mouseover can be handled. Use the event handling methods to handle these events.

Since:

2020-02-06

Version:

1.0

Author:

Gabor Kokeny Email: kokeny19@gmail.com

See Also:

• 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	InteractiveLayer()	Creates a new interactive layer that is interactive and bubbles mouse events by default.

Method Summary

Modifier and Type	Method	Description
boolean	isBubblingMouseEvents()	Returns whether mouse events on this layer bubble up to its parents.
boolean	isInteractive()	Returns whether this layer emits mouse events and reacts to user interaction.
void	setBubblingMouseEvents(boolean bubblingMouseEvents)	Sets whether mouse events on this layer bubble up to its parents.
void	setInteractive(boolean interactive)	Sets whether this layer emits mouse events and reacts to user interaction.

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

addEventListener, clearAllEventListeners, hasEventListeners, listens, off, off, on, removeEventListener

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

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

onClick, onContextMenuOpened, onDoubleClick, onMouseDown, onMouseMove, onMouseOut, onMouseOver, onMouseUp

Constructor Details

InteractiveLayer

protected InteractiveLayer()

Creates a new interactive layer that is interactive and bubbles mouse events by default.

Method Details

isInteractive

public boolean isInteractive()

Returns whether this layer emits mouse events and reacts to user interaction.

Returns:

true if the layer is interactive

setInteractive

public void setInteractive(boolean interactive)

Sets whether this layer emits mouse events and reacts to user interaction.

Parameters:

interactive - true to make the layer interactive

isBubblingMouseEvents

public boolean isBubblingMouseEvents()

Returns whether mouse events on this layer bubble up to its parents.

Returns:

true if mouse events bubble up

setBubblingMouseEvents

public void setBubblingMouseEvents(boolean bubblingMouseEvents)

Sets whether mouse events on this layer bubble up to its parents.

Parameters:

bubblingMouseEvents - true to let mouse events bubble up