added image overlay and add function

Signed-off-by: makbn <mehdi74akbarian@gmail.com>

Author: makbn

jlmap-api/src/main/java/io/github/makbn/jlmap/layer/leaflet/LeafletUILayerInt.java

@@ -1,9 +1,6 @@
 package io.github.makbn.jlmap.layer.leaflet;
 
-import io.github.makbn.jlmap.model.JLLatLng;
-import io.github.makbn.jlmap.model.JLMarker;
-import io.github.makbn.jlmap.model.JLOptions;
-import io.github.makbn.jlmap.model.JLPopup;
+import io.github.makbn.jlmap.model.*;
 
 /**
  * The {@code LeafletUILayerInt} interface defines methods for adding and
@@ -71,5 +68,16 @@ public interface LeafletUILayerInt extends LeafletLayer {
      * was not found.
      */
     boolean removePopup(String id);
+
+    /**
+     * Instantiates an image overlay object given the URL of the image and the geographical bounds it is tied to.
+     * Read more about it on <a href="https://leafletjs.com/reference.html#videooverlay">Leaflet ImageOverlay</a>
+     *
+     * @param bounds   the geographical bounds the image is tied to.
+     * @param imageUrl URL of the image to be used as an overlay. (can be local or remote URL)
+     * @param options  theming options for JLImageOverlay. all options are not available!
+     * @return The {@link JLImageOverlay} representing the added image overlay on the map.
+     */
+    JLImageOverlay addImage(JLBounds bounds, String imageUrl, JLOptions options);
 }
 

jlmap-api/src/main/java/io/github/makbn/jlmap/model/JLImageOverlay.java

@@ -0,0 +1,52 @@
+package io.github.makbn.jlmap.model;
+
+import io.github.makbn.jlmap.engine.JLTransporter;
+import lombok.AccessLevel;
+import lombok.Builder;
+import lombok.Getter;
+import lombok.ToString;
+import lombok.experimental.FieldDefaults;
+
+/**
+ * An image overlay object given the URL of the image and the geographical bounds it is tied to.
+ * * @author Matt Akbarian  (@makbn)`
+ */
+@Getter
+@ToString
+@FieldDefaults(level = AccessLevel.PRIVATE, makeFinal = true)
+public final class JLImageOverlay extends JLObject<JLImageOverlay> {
+
+    /**
+     * id of object! this is an internal id for JLMap Application and not
+     * related to Leaflet!
+     */
+    String id;
+
+    /**
+     * URL of the image to be used as an overlay. (can be local or remote URL)
+     */
+    String imageUrl;
+    /**
+     * Coordinates of the JLMarker on the map
+     */
+    JLBounds bounds;
+    /**
+     * theming options for JLImageOverlay. all options are not available!
+     */
+    JLOptions options;
+
+    @Builder(toBuilder = true)
+    private JLImageOverlay(String id, String imageUrl, JLBounds bounds, JLOptions options, JLTransporter<?> transport) {
+        super(transport);
+        this.id = id;
+        this.imageUrl = imageUrl;
+        this.bounds = bounds;
+        this.options = options;
+    }
+
+
+    @Override
+    public JLImageOverlay self() {
+        return this;
+    }
+}