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

Interface ExecutableFunctions

All Superinterfaces:
Identifiable
All Known Subinterfaces:
FeatureGroupFunctions, GeolocationFunctions, LayerGroupFunctions, LayerPopupFunctions, LayerTooltipFunctions, MapConversionFunctions, MapGetStateFunctions, MapModifyStateFunctions, MarkerFunctions, PathFunctions
All Known Implementing Classes:
AttributionControl, Circle, CircleMarker, DivOverlay, DynamicMapLayer, EsriLeafletLayer, FeatureGroup, FullScreenControl, GridLayer, HeatLayer, ImageOverlay, InteractiveLayer, KmzLayer, Layer, LayerGroup, LayersControl, LeafletControl, LeafletMap, LeafletObject, Marker, MarkerClusterGroup, MultiPolygon, MultiPolyline, Path, Polygon, Polyline, Popup, Rectangle, ScaleControl, TiledMapLayer, TileLayer, Tooltip, VectorBasemapLayer, ZoomControl
public interface ExecutableFunctions extends Identifiable
Defines the operations for invoking Leaflet JavaScript functions on the client side, either as fire-and-forget calls or as calls that return a result.

  • Method Summary

    Modifier and Type
    Method
    Description
    default <T extends Serializable>
    CompletableFuture<T>
    call(String functionName, Class<T> resultType, Serializable... arguments)
    Calls the given client-side JavaScript function on this object and returns its result asynchronously.
    <T extends Serializable>
    CompletableFuture<T>
    call(Identifiable target, String functionName, Class<T> resultType, Serializable... arguments)
    Calls the given client-side JavaScript function on the given target and returns its result asynchronously.
    default void
    executeJs(String functionName, Serializable... arguments)
    Executes the given client-side JavaScript function on this object without expecting a return value.
    void
    executeJs(Identifiable target, String functionName, Serializable... arguments)
    Executes the given client-side JavaScript function on the given target without expecting a return value.

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

    getUuid

  • Method Details

    • executeJs

      default void executeJs(String functionName, Serializable... arguments)
      Executes the given client-side JavaScript function on this object without expecting a return value.
      Parameters:
      functionName - the name of the client-side function to execute
      arguments - the arguments passed to the function

    • executeJs

      void executeJs(Identifiable target, String functionName, Serializable... arguments)
      Executes the given client-side JavaScript function on the given target without expecting a return value.
      Parameters:
      target - the object the function is executed on
      functionName - the name of the client-side function to execute
      arguments - the arguments passed to the function

    • call

      default <T extends Serializable> CompletableFuture<T> call(String functionName, Class<T> resultType, Serializable... arguments)
      Calls the given client-side JavaScript function on this object and returns its result asynchronously.
      Type Parameters:
      T - the type of the returned result
      Parameters:
      functionName - the name of the client-side function to call
      resultType - the type the result is converted to
      arguments - the arguments passed to the function
      Returns:
      a future that completes with the result of the client-side call

    • call

      <T extends Serializable> CompletableFuture<T> call(Identifiable target, String functionName, Class<T> resultType, Serializable... arguments)
      Calls the given client-side JavaScript function on the given target and returns its result asynchronously.
      Type Parameters:
      T - the type of the returned result
      Parameters:
      target - the object the function is called on
      functionName - the name of the client-side function to call
      resultType - the type the result is converted to
      arguments - the arguments passed to the function
      Returns:
      a future that completes with the result of the client-side call