From 69adaa7b31078cb30043b073dada14dee1a9e75d Mon Sep 17 00:00:00 2001 From: Mathieu Baudier Date: Fri, 1 Sep 2023 11:14:25 +0200 Subject: [PATCH] Improve callback support --- .../org.argeo.app.geo.js/OpenLayersMapPart.js | 33 +++++++ .../src/org/argeo/app/geo/ux/MapPart.java | 8 ++ .../org/argeo/app/geo/swt/MapUiProvider.java | 2 +- ...vaScriptMapPart.java => SwtJSMapPart.java} | 87 +++++++++++-------- 4 files changed, 91 insertions(+), 39 deletions(-) rename swt/org.argeo.app.geo.swt/src/org/argeo/app/geo/swt/{SwtJavaScriptMapPart.java => SwtJSMapPart.java} (60%) diff --git a/org.argeo.app.geo.js/src/org.argeo.app.geo.js/OpenLayersMapPart.js b/org.argeo.app.geo.js/src/org.argeo.app.geo.js/OpenLayersMapPart.js index 7c157eb..6eff99f 100644 --- a/org.argeo.app.geo.js/src/org.argeo.app.geo.js/OpenLayersMapPart.js +++ b/org.argeo.app.geo.js/src/org.argeo.app.geo.js/OpenLayersMapPart.js @@ -12,6 +12,7 @@ import { Point } from 'ol/geom.js'; import VectorLayer from 'ol/layer/Vector.js'; import GeoJSON from 'ol/format/GeoJSON.js'; import GPX from 'ol/format/GPX.js'; +import Select from 'ol/interaction/Select.js'; import MapPart from './MapPart.js'; import { SentinelCloudless } from './OpenLayerTileSources.js'; @@ -20,6 +21,8 @@ import { SentinelCloudless } from './OpenLayerTileSources.js'; export default class OpenLayersMapPart extends MapPart { /** The OpenLayers Map. */ #map; + callbacks = {}; + // Constructor constructor() { super(); @@ -38,6 +41,8 @@ export default class OpenLayersMapPart extends MapPart { }); } + /* GEOGRAPHICAL METHODS */ + setZoom(zoom) { this.#map.getView().setZoom(zoom); } @@ -67,4 +72,32 @@ export default class OpenLayersMapPart extends MapPart { source: vectorSource, })); } + + /* CALLBACKS */ + enableFeatureSingleClick() { + // we cannot use 'this' in the function provided to OpenLayers + let mapPart = this; + this.#map.on('singleclick', function(e) { + let feature = null; + // we chose only one + e.map.forEachFeatureAtPixel(e.pixel, function(f) { + feature = f; + }); + if (feature !== null) + mapPart.callbacks['onFeatureSingleClick'](feature.get('path')); + }); + } + + enableFeatureSelected() { + // we cannot use 'this' in the function provided to OpenLayers + let mapPart = this; + var select = new Select(); + this.#map.addInteraction(select); + select.on('select', function(e) { + if (e.selected.length > 0) { + let feature = e.selected[0]; + mapPart.callbacks['onFeatureSelected'](feature.get('path')); + } + }); + } } diff --git a/org.argeo.app.geo/src/org/argeo/app/geo/ux/MapPart.java b/org.argeo.app.geo/src/org/argeo/app/geo/ux/MapPart.java index 9e61531..13190c9 100644 --- a/org.argeo.app.geo/src/org/argeo/app/geo/ux/MapPart.java +++ b/org.argeo.app.geo/src/org/argeo/app/geo/ux/MapPart.java @@ -14,4 +14,12 @@ public interface MapPart { void setZoom(int zoom); void setCenter(double lng, double lat); + + /** Event when a feature has been single-clicked. */ + record FeatureSingleClickEvent(String path) { + }; + + /** Event when a feature has been selected. */ + record FeatureSelectedEvent(String path) { + }; } diff --git a/swt/org.argeo.app.geo.swt/src/org/argeo/app/geo/swt/MapUiProvider.java b/swt/org.argeo.app.geo.swt/src/org/argeo/app/geo/swt/MapUiProvider.java index 517a2dc..d32ea45 100644 --- a/swt/org.argeo.app.geo.swt/src/org/argeo/app/geo/swt/MapUiProvider.java +++ b/swt/org.argeo.app.geo.swt/src/org/argeo/app/geo/swt/MapUiProvider.java @@ -10,7 +10,7 @@ public class MapUiProvider implements SwtUiProvider { @Override public Control createUiPart(Composite parent, Content context) { - SwtJavaScriptMapPart map = new SwtJavaScriptMapPart(parent, 0); + SwtJSMapPart map = new SwtJSMapPart(parent, 0); map.setCenter(13.404954, 52.520008); // Berlin // map.setCenter(-74.00597, 40.71427); // NYC // map.addPoint(-74.00597, 40.71427, null); diff --git a/swt/org.argeo.app.geo.swt/src/org/argeo/app/geo/swt/SwtJavaScriptMapPart.java b/swt/org.argeo.app.geo.swt/src/org/argeo/app/geo/swt/SwtJSMapPart.java similarity index 60% rename from swt/org.argeo.app.geo.swt/src/org/argeo/app/geo/swt/SwtJavaScriptMapPart.java rename to swt/org.argeo.app.geo.swt/src/org/argeo/app/geo/swt/SwtJSMapPart.java index 7d5d71d..09848f9 100644 --- a/swt/org.argeo.app.geo.swt/src/org/argeo/app/geo/swt/SwtJavaScriptMapPart.java +++ b/swt/org.argeo.app.geo.swt/src/org/argeo/app/geo/swt/SwtJSMapPart.java @@ -1,17 +1,13 @@ package org.argeo.app.geo.swt; -import java.util.HashMap; import java.util.Locale; -import java.util.Map; import java.util.concurrent.CompletableFuture; import java.util.concurrent.CompletionStage; +import java.util.function.Consumer; -import org.argeo.api.cms.CmsConstants; import org.argeo.api.cms.CmsLog; -import org.argeo.api.cms.ux.CmsView; import org.argeo.app.geo.ux.JsImplementation; import org.argeo.app.geo.ux.MapPart; -import org.argeo.app.ux.SuiteUxEvent; import org.argeo.cms.swt.CmsSwtUtils; import org.eclipse.swt.SWT; import org.eclipse.swt.browser.Browser; @@ -25,34 +21,29 @@ import org.eclipse.swt.widgets.Composite; * An SWT implementation of {@link MapPart} based on JavaScript execute in a * {@link Browser} control. */ -public class SwtJavaScriptMapPart extends Composite implements MapPart { +public class SwtJSMapPart extends Composite implements MapPart { static final long serialVersionUID = 2713128477504858552L; - private final static CmsLog log = CmsLog.getLog(SwtJavaScriptMapPart.class); + private final static CmsLog log = CmsLog.getLog(SwtJSMapPart.class); - private Browser browser; + private final static String GLOBAL_THIS_ = "globalThis."; - private CompletableFuture pageLoaded = new CompletableFuture<>(); + private final Browser browser; - private String jsImplementation = JsImplementation.OPENLAYERS_MAP_PART.getJsClass(); - private String mapVar = "globalThis.argeoMap"; + private final CompletableFuture pageLoaded = new CompletableFuture<>(); - private final CmsView cmsView; + private String jsImplementation = JsImplementation.OPENLAYERS_MAP_PART.getJsClass(); + private String mapVar = "argeoMap"; - public SwtJavaScriptMapPart(Composite parent, int style) { + public SwtJSMapPart(Composite parent, int style) { super(parent, style); parent.setLayout(CmsSwtUtils.noSpaceGridLayout()); setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true)); setLayout(CmsSwtUtils.noSpaceGridLayout()); - cmsView = CmsSwtUtils.getCmsView(parent); - browser = new Browser(this, SWT.BORDER); browser.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true)); - // functions exposed to JavaScript - new onFeatureSelect(); - browser.setUrl("/pkg/org.argeo.app.geo.js/index.html"); browser.addProgressListener(new ProgressListener() { static final long serialVersionUID = 1L; @@ -61,7 +52,7 @@ public class SwtJavaScriptMapPart extends Composite implements MapPart { public void completed(ProgressEvent event) { try { // create map - browser.execute(mapVar + " = new " + jsImplementation + "();"); + browser.execute(getJsMapVar() + " = new " + jsImplementation + "();"); pageLoaded.complete(true); } catch (Exception e) { log.error("Cannot create map in browser", e); @@ -75,30 +66,42 @@ public class SwtJavaScriptMapPart extends Composite implements MapPart { }); } + /* + * MapPart.js METHODS + */ + @Override public void addPoint(double lng, double lat, String style) { - callMethod(mapVar, "addPoint(%f, %f, %s)", lng, lat, style == null ? "'default'" : style); + callMapMethod("addPoint(%f, %f, %s)", lng, lat, style == null ? "'default'" : style); } @Override public void addUrlLayer(String url, GeoFormat format) { - callMethod(mapVar, "addUrlLayer('%s', '%s')", url, format.name()); + callMapMethod("addUrlLayer('%s', '%s')", url, format.name()); } @Override public void setZoom(int zoom) { - callMethod(mapVar, "setZoom(%d)", zoom); + callMapMethod("setZoom(%d)", zoom); } @Override public void setCenter(double lng, double lat) { - callMethod(mapVar, "setCenter(%f, %f)", lng, lat); + callMapMethod("setCenter(%f, %f)", lng, lat); + } + + protected CompletionStage callMapMethod(String methodCall, Object... args) { + return callMethod(getJsMapVar(), methodCall, args); } protected CompletionStage callMethod(String jsObject, String methodCall, Object... args) { return evaluate(jsObject + '.' + methodCall, args); } + private String getJsMapVar() { + return GLOBAL_THIS_ + mapVar; + } + /** * Execute this JavaScript on the client side after making sure that the page * has been loaded and the map object has been created. @@ -119,23 +122,31 @@ public class SwtJavaScriptMapPart extends Composite implements MapPart { return res.minimalCompletionStage(); } - /** JavaScript function called when a feature is selected on the map. */ - private class onFeatureSelect extends BrowserFunction { + /* + * CALLBACKS + */ + public void onFeatureSelected(Consumer toDo) { + addCallback("FeatureSelected", (arr) -> toDo.accept(new FeatureSelectedEvent((String) arr[0]))); + } + + public void onFeatureSingleClick(Consumer toDo) { + addCallback("FeatureSingleClick", (arr) -> toDo.accept(new FeatureSingleClickEvent((String) arr[0]))); + } - onFeatureSelect() { - super(browser, onFeatureSelect.class.getSimpleName()); - } + protected void addCallback(String suffix, Consumer toDo) { + pageLoaded.thenAccept((ready) -> { + // browser functions must be directly on window (RAP specific) + new BrowserFunction(browser, mapVar + "__on" + suffix) { - @Override - public Object function(Object[] arguments) { - if (arguments.length == 0) - return null; - String path = arguments[0].toString(); - Map properties = new HashMap<>(); - properties.put(SuiteUxEvent.CONTENT_PATH, '/' + CmsConstants.SYS_WORKSPACE + path); - cmsView.sendEvent(SuiteUxEvent.refreshPart.topic(), properties); - return null; - } + @Override + public Object function(Object[] arguments) { + toDo.accept(arguments); + return null; + } + }; + browser.execute(getJsMapVar() + ".callbacks['on" + suffix + "']=window." + mapVar + "__on" + suffix + ";"); + callMethod(mapVar, "enable" + suffix + "()"); + }); } } -- 2.30.2