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

Interface LayerPopupFunctions

All Superinterfaces:
ExecutableFunctions, Identifiable
All Known Implementing Classes:
Circle, CircleMarker, DivOverlay, DynamicMapLayer, EsriLeafletLayer, FeatureGroup, GridLayer, HeatLayer, ImageOverlay, InteractiveLayer, KmzLayer, Layer, LayerGroup, Marker, MarkerClusterGroup, MultiPolygon, MultiPolyline, Path, Polygon, Polyline, Popup, Rectangle, TiledMapLayer, TileLayer, Tooltip, VectorBasemapLayer
public interface LayerPopupFunctions extends ExecutableFunctions
A set of popup methods
Since:
2020-03-23
Version:
1.0
Author:
Gabor Kokeny Email: kokeny19@gmail.com

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    bindPopup(String popupContent)
    Binds a popup to the layer with the passed content
    default void
    bindPopup(Popup popup)
    Binds a popup to the layer with the passed content
    default void
    closePopup()
    Closes the popup bound to this layer if it is open.
    Popup
    getPopup()
    Returns the popup bound to this layer.
    default CompletableFuture<Boolean>
    isPopupOpen()
    Returns true if the popup bound to this layer is currently open.
    default void
    openPopup()
    Opens the bound popup
    default void
    openPopup(LatLng latLng)
    Opens the bound popup at the specified latlng or at the default popup anchor if no latlng is passed.
    default void
    setPopupContent(String popupContent)
    Sets the content of the popup bound to this layer.
    default void
    setPopupContent(Popup popup)
    Sets the content of the popup bound to this layer.
    default void
    togglePopup()
    Opens or closes the popup bound to this layer depending on its current state.
    default void
    unbindPopup()
    Removes the popup previously bound with bindPopup.

    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

  • Method Details

    • bindPopup

      default void bindPopup(String popupContent)
      Binds a popup to the layer with the passed content
      Parameters:
      popupContent - the new popup content

    • bindPopup

      default void bindPopup(Popup popup)
      Binds a popup to the layer with the passed content
      Parameters:
      popup - the new popup content

    • unbindPopup

      default void unbindPopup()
      Removes the popup previously bound with bindPopup.

    • closePopup

      default void closePopup()
      Closes the popup bound to this layer if it is open.

    • openPopup

      default void openPopup()
      Opens the bound popup

    • openPopup

      default void openPopup(LatLng latLng)
      Opens the bound popup at the specified latlng or at the default popup anchor if no latlng is passed.
      Parameters:
      latLng - the popup location

    • togglePopup

      default void togglePopup()
      Opens or closes the popup bound to this layer depending on its current state.

    • setPopupContent

      default void setPopupContent(String popupContent)
      Sets the content of the popup bound to this layer.
      Parameters:
      popupContent - the new popup content

    • setPopupContent

      default void setPopupContent(Popup popup)
      Sets the content of the popup bound to this layer.
      Parameters:
      popup - the new popup content

    • isPopupOpen

      default CompletableFuture<Boolean> isPopupOpen()
      Returns true if the popup bound to this layer is currently open.
      Returns:
      returns true if the is currently open

    • getPopup

      Popup getPopup()
      Returns the popup bound to this layer.
      Returns:
      the popup bound to this layer.