Added basic support for CRS + a demo

Author: AB-xdev

CHANGELOG.md

@@ -1,5 +1,6 @@
 ## 4.2.0
 * Fixed some invalid built JavaScript commands #330
+* Add basic support for CRS #333
 
 ## 4.1.1
 * ⚠️ GroupId changed from ``com.xdev-software`` to ``software.xdev``

vaadin-maps-leaflet-flow-demo/src/main/java/software/xdev/vaadin/maps/leaflet/flow/DemoView.java

@@ -17,6 +17,7 @@
 import software.xdev.vaadin.maps.leaflet.flow.demo.FreeingUpResourceBenchmarkDemo;
 import software.xdev.vaadin.maps.leaflet.flow.demo.InitialResizeDemo;
 import software.xdev.vaadin.maps.leaflet.flow.demo.MinimalisticDemo;
+import software.xdev.vaadin.maps.leaflet.flow.demo.NotOfThisEarthDemo;
 
 
 @PageTitle("Leaflet + Vaadin demos")
@@ -67,6 +68,11 @@ protected void onAttach(final AttachEvent attachEvent)
 				"Complex",
 				"A complex example with various leaflet components and methods"
 			),
+			new Example(
+				NotOfThisEarthDemo.NAV,
+				"Not of this earth",
+				"Displays a map that is not from this earth"
+			),
 			new Example(
 				FreeingUpResourceBenchmarkDemo.NAV,
 				"Freeing up resources Benchmark",

vaadin-maps-leaflet-flow-demo/src/main/java/software/xdev/vaadin/maps/leaflet/flow/demo/NotOfThisEarthDemo.java

@@ -0,0 +1,86 @@
+package software.xdev.vaadin.maps.leaflet.flow.demo;
+
+import java.util.Map;
+
+import com.vaadin.flow.component.html.Anchor;
+import com.vaadin.flow.router.Route;
+
+import software.xdev.vaadin.maps.leaflet.MapContainer;
+import software.xdev.vaadin.maps.leaflet.basictypes.LLatLng;
+import software.xdev.vaadin.maps.leaflet.basictypes.LLatLngBounds;
+import software.xdev.vaadin.maps.leaflet.crs.LCRS;
+import software.xdev.vaadin.maps.leaflet.layer.raster.LImageOverlay;
+import software.xdev.vaadin.maps.leaflet.layer.ui.LMarker;
+import software.xdev.vaadin.maps.leaflet.layer.vector.LPolyline;
+import software.xdev.vaadin.maps.leaflet.map.LMap;
+import software.xdev.vaadin.maps.leaflet.map.LMapOptions;
+import software.xdev.vaadin.maps.leaflet.registry.LComponentManagementRegistry;
+import software.xdev.vaadin.maps.leaflet.registry.LDefaultComponentManagementRegistry;
+
+
+@Route(NotOfThisEarthDemo.NAV)
+@SuppressWarnings("checkstyle:MagicNumber")
+public class NotOfThisEarthDemo extends AbstractDemo
+{
+	public static final String NAV = "not-of-this-earth";
+	
+	private final LComponentManagementRegistry reg;
+	
+	public NotOfThisEarthDemo()
+	{
+		// Let the view use 100% of the site
+		this.setSizeFull();
+		
+		this.add(new Anchor("https://leafletjs.com/examples/crs-simple/crs-simple.html", "Based on this example"));
+		
+		// Create the registry which is needed so that components can be reused and their methods invoked
+		// Note: You normally don't need to invoke any methods of the registry and just hand it over to the components
+		this.reg = new LDefaultComponentManagementRegistry(this);
+		
+		this.buildMap();
+	}
+	
+	private void buildMap()
+	{
+		// Create and add the MapContainer (which contains the map) to the UI
+		final MapContainer mapContainer = new MapContainer(
+			this.reg,
+			new LMapOptions()
+				.withCrs(LCRS.Defined.SIMPLE)
+				.withMinZoom(-3));
+		mapContainer.setSizeFull();
+		this.add(mapContainer);
+		
+		final LMap map = mapContainer.getlMap();
+		
+		new LImageOverlay(
+			this.reg,
+			"uqm_map_full.png",
+			new LLatLngBounds(
+				this.reg,
+				this.xy(-25, -26.5),
+				this.xy(1023, 1021.5))
+		).addTo(map);
+		
+		final LLatLng cordSol = this.xy(175.2, 145);
+		final LLatLng cordDeneb = this.xy(218.7, 8.3);
+		Map.ofEntries(
+			Map.entry(cordSol, "Sol"),
+			Map.entry(this.xy(41.6, 130.1), "Mizar"),
+			Map.entry(this.xy(13.4, 56.5), "Krueger-Z"),
+			Map.entry(cordDeneb, "Deneb")
+		).forEach((cords, text) -> new LMarker(this.reg, cords)
+			.bindPopup(text)
+			.addTo(map));
+		
+		new LPolyline(this.reg, cordSol, cordDeneb)
+			.addTo(map);
+		
+		map.setView(this.xy(300, 140), 1);
+	}
+	
+	private LLatLng xy(final double x, final double y)
+	{
+		return new LLatLng(this.reg, y, x);
+	}
+}

vaadin-maps-leaflet-flow-demo/src/main/resources/META-INF/resources/uqm_map_full.png

@@ -31,6 +31,7 @@
 
 import software.xdev.vaadin.maps.leaflet.basictypes.LLatLngBounds;
 import software.xdev.vaadin.maps.leaflet.map.LMap;
+import software.xdev.vaadin.maps.leaflet.map.LMapOptions;
 import software.xdev.vaadin.maps.leaflet.registry.LComponentManagementRegistry;
 
 
@@ -49,7 +50,29 @@ public class MapContainer extends Composite<Div> implements HasSize, HasStyle, H
 
 	public MapContainer(final LComponentManagementRegistry reg)
 	{
-		this(reg, null);
+		this(reg, (LMapOptions)null);
+	}
+	
+	public MapContainer(
+		final LComponentManagementRegistry reg,
+		final LMapOptions options)
+	{
+		this(reg, options, null);
+	}
+	
+	/**
+	 * @param afterInitialResize This is called after the map was initially resized/is ready.
+	 *                           <p/>
+	 *                           This is ONLY required when calling certain methods like e.g.
+	 *                           {@link LMap#fitBounds(LLatLngBounds)} instantly after the map is created.
+	 *                           <p/>
+	 *                           For performance reasons it's highly recommended to only use this when required.
+	 */
+	public MapContainer(
+		final LComponentManagementRegistry reg,
+		final Consumer<LMap> afterInitialResize)
+	{
+		this(reg, null, afterInitialResize);
 	}
 
 	/**
@@ -62,13 +85,14 @@ public MapContainer(final LComponentManagementRegistry reg)
 	 */
 	public MapContainer(
 		final LComponentManagementRegistry reg,
+		final LMapOptions options,
 		final Consumer<LMap> afterInitialResize)
 	{
 		this.afterInitialResize = afterInitialResize;
 		this.getContent().setSizeFull();
 		this.fixZIndex();
 
-		this.lMap = new LMap(reg, this.getContent());
+		this.lMap = new LMap(reg, this.getContent(), options);
 		this.fixInitialSizeAfterCreation();
 	}
 

vaadin-maps-leaflet-flow/src/main/java/software/xdev/vaadin/maps/leaflet/MapContainer.java

@@ -0,0 +1,30 @@
+package software.xdev.vaadin.maps.leaflet.crs;
+
+import software.xdev.vaadin.maps.leaflet.base.RawString;
+
+
+/**
+ * @apiNote CRS can't be constructed
+ * @see <a href="https://leafletjs.com/reference.html#crs">Leaflet docs</a>
+ */
+public final class LCRS
+{
+	public static final class Defined
+	{
+		public static final RawString EARTH = new RawString("L.CRS.Earth");
+		
+		public static final RawString EPSG3395 = new RawString("L.CRS.EPSG3395");
+		public static final RawString EPSG3857 = new RawString("L.CRS.EPSG3857");
+		public static final RawString EPSG4326 = new RawString("L.CRS.EPSG4326");
+		public static final RawString BASE = new RawString("L.CRS.Base");
+		public static final RawString SIMPLE = new RawString("L.CRS.Simple");
+		
+		private Defined()
+		{
+		}
+	}
+	
+	private LCRS()
+	{
+	}
+}

vaadin-maps-leaflet-flow/src/main/java/software/xdev/vaadin/maps/leaflet/crs/LCRS.java

@@ -59,7 +59,8 @@ public class LMapOptions implements LComponentOptions<LMapOptions>
 	// Boolean|String
 	private Object touchZoom;
 	private Boolean bounceAtZoomLimits;
-	// CRS is currently not implemented - the default used one should be sufficient
+	
+	private Object crs;
 	private LLatLng center;
 	private Integer zoom;
 	private Integer minZoom;
@@ -473,6 +474,22 @@ public LMapOptions withBounceAtZoomLimits(final Boolean bounceAtZoomLimits)
 		return this.self();
 	}
 
+	public Object getCrs()
+	{
+		return this.crs;
+	}
+	
+	public void setCrs(final Object crs)
+	{
+		this.crs = crs;
+	}
+	
+	public LMapOptions withCrs(final Object crs)
+	{
+		this.setCrs(crs);
+		return this.self();
+	}
+	
 	public LLatLng getCenter()
 	{
 		return this.center;