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

Interface LayerTooltipFunctions

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 LayerTooltipFunctions extends ExecutableFunctions
A set of tooltip methods available on each layer
Since:
2020-03-23
Version:
1.0
Author:
Gabor Kokeny Email: kokeny19@gmail.com

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    bindTooltip(String tooltipContent)
    Binds a tooltip to the layer with the passed content
    default void
    bindTooltip(Tooltip tooltip)
    Binds a tooltip to the layer with the passed content
    default void
    closeTooltip()
    Closes the tooltip bound to this layer if it is open.
    Tooltip
    getTooltip()
    Returns the tooltip bound to this layer.
    default CompletableFuture<Boolean>
    isTooltipOpen()
    Returns true if the tooltip bound to this layer is currently open.
    default void
    openTooltip()
    Opens the bound tooltip
    default void
    openTooltip(LatLng latLng)
    Opens the bound tooltip at the specified latlng or at the default tooltip anchor if no latlng is passed.
    default void
    setTooltipContent(String tooltipContent)
    Sets the content of the tooltip bound to this layer.
    default void
    setTooltipContent(Tooltip tooltip)
    Sets the content of the tooltip bound to this layer.
    default void
    toggleTooltip()
    Opens or closes the tooltip bound to this layer depending on its current state.
    default void
    unbindTooltip()
    Removes the tooltip previously bound with bindTooltip.

    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

    • bindTooltip

      default void bindTooltip(String tooltipContent)
      Binds a tooltip to the layer with the passed content
      Parameters:
      tooltipContent - the new tooltip content

    • bindTooltip

      default void bindTooltip(Tooltip tooltip)
      Binds a tooltip to the layer with the passed content
      Parameters:
      tooltip - the new tooltip content

    • unbindTooltip

      default void unbindTooltip()
      Removes the tooltip previously bound with bindTooltip.

    • closeTooltip

      default void closeTooltip()
      Closes the tooltip bound to this layer if it is open.

    • openTooltip

      default void openTooltip()
      Opens the bound tooltip

    • openTooltip

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

    • toggleTooltip

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

    • setTooltipContent

      default void setTooltipContent(String tooltipContent)
      Sets the content of the tooltip bound to this layer.
      Parameters:
      tooltipContent - the new tooltip content

    • setTooltipContent

      default void setTooltipContent(Tooltip tooltip)
      Sets the content of the tooltip bound to this layer.
      Parameters:
      tooltip - the new tooltip content

    • isTooltipOpen

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

    • getTooltip

      Tooltip getTooltip()
      Returns the tooltip bound to this layer.
      Returns:
      the tooltip bound to this layer.