diff --git a/src/main/java/com/gwidgets/api/leaflet/Attribution.java b/src/main/java/com/gwidgets/api/leaflet/Attribution.java index e85bdc8..b94dd11 100644 --- a/src/main/java/com/gwidgets/api/leaflet/Attribution.java +++ b/src/main/java/com/gwidgets/api/leaflet/Attribution.java @@ -20,8 +20,9 @@ /** * The attribution control allows you to display attribution data in a small text box on a map. It is put on the map by default unless you set its attributionControl option to false, and it fetches attribution texts from layers with getAttribution method automatically. - * + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative = true) public class Attribution extends Control{ @@ -60,4 +61,4 @@ private Attribution() { @JsMethod public native L removeAttribution(String text); -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/Bounds.java b/src/main/java/com/gwidgets/api/leaflet/Bounds.java index c282fdb..41fc648 100644 --- a/src/main/java/com/gwidgets/api/leaflet/Bounds.java +++ b/src/main/java/com/gwidgets/api/leaflet/Bounds.java @@ -20,8 +20,9 @@ /** * Represents a rectangular area in pixel coordinates. - * + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative = true) public class Bounds { @@ -60,8 +61,8 @@ private Bounds() { /** * Returns true if the rectangle contains the given point. * - * @param the point * @return true/false + * @param point a {@link com.gwidgets.api.leaflet.Point} object */ @JsMethod public native Boolean contains(Point point); @@ -91,4 +92,4 @@ private Bounds() { @JsMethod public native Point getSize(); -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/CRS.java b/src/main/java/com/gwidgets/api/leaflet/CRS.java index 7ab240a..9923cce 100644 --- a/src/main/java/com/gwidgets/api/leaflet/CRS.java +++ b/src/main/java/com/gwidgets/api/leaflet/CRS.java @@ -19,7 +19,9 @@ /** * Defines coordinate reference systems for projecting geographical points into pixel (screen) coordinates and back (and to coordinates in other units for WMS services). + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative = true) public abstract class CRS { @@ -111,8 +113,8 @@ public abstract class CRS { /** * Returns the distance between two geographical coordinates. * - * @param latlng1 - * @param latlng2 + * @param latlng1 a {@link com.gwidgets.api.leaflet.LatLng} object + * @param latlng2 a {@link com.gwidgets.api.leaflet.LatLng} object * @return the distance */ @JsMethod @@ -121,10 +123,10 @@ public abstract class CRS { /** * Returns a LatLng where lat and lng has been wrapped according to the CRS's wrapLat and wrapLng properties, if they are outside the CRS's bounds. * - * @param latlng + * @param latlng a {@link com.gwidgets.api.leaflet.LatLng} object * @return the LatLng */ @JsMethod public native double wrapLatLng(LatLng latlng); -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/Canvas.java b/src/main/java/com/gwidgets/api/leaflet/Canvas.java index 79a257a..39d361d 100644 --- a/src/main/java/com/gwidgets/api/leaflet/Canvas.java +++ b/src/main/java/com/gwidgets/api/leaflet/Canvas.java @@ -6,8 +6,8 @@ /** * Used to create Canvas-based tile layers where tiles get drawn on the browser side. - * - * @author Zakaria Amine + * + * @version $Id: $Id */ @JsType(isNative = true) public class Canvas extends Renderer { @@ -17,4 +17,4 @@ private Canvas() { } -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/Circle.java b/src/main/java/com/gwidgets/api/leaflet/Circle.java index d72ea21..f883238 100644 --- a/src/main/java/com/gwidgets/api/leaflet/Circle.java +++ b/src/main/java/com/gwidgets/api/leaflet/Circle.java @@ -4,6 +4,9 @@ /** * A class for drawing circle overlays on a map. Extends Path. Use addLayer method of the Map class to add it to the map. + * + * @author zakaria + * @version $Id: $Id */ @JsType(isNative = true) public class Circle extends CircleMarker { @@ -11,6 +14,9 @@ public class Circle extends CircleMarker { + /** + *

Constructor for Circle.

+ */ protected Circle() { super(); @@ -20,4 +26,4 @@ protected Circle() { -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/CircleMarker.java b/src/main/java/com/gwidgets/api/leaflet/CircleMarker.java index c6701ad..a56388b 100644 --- a/src/main/java/com/gwidgets/api/leaflet/CircleMarker.java +++ b/src/main/java/com/gwidgets/api/leaflet/CircleMarker.java @@ -27,7 +27,9 @@ /** * A circle of a fixed size with radius specified in pixels. Extends Circle. Use Map#addLayer to add it to the map. + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative = true) public class CircleMarker extends Path implements Layer, Evented{ @@ -35,6 +37,9 @@ public class CircleMarker extends Path implements Layer, Evented{ + /** + *

Constructor for CircleMarker.

+ */ protected CircleMarker() { } @@ -52,7 +57,7 @@ protected CircleMarker() { /** * Returns the current geographical position of the circle. * - * @return the lat lng + * @return the lat lng */ @JsMethod public native LatLng getLatLng(); @@ -88,6 +93,7 @@ protected CircleMarker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindPopup(com.gwidgets.api.leaflet.elemental.HTMLElement, com.gwidgets.api.leaflet.options.PopupOptions) */ + /** {@inheritDoc} */ @JsMethod public native L bindPopup(HTMLElement content, PopupOptions options); @@ -95,6 +101,7 @@ protected CircleMarker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindPopup(java.lang.String, com.gwidgets.api.leaflet.options.PopupOptions) */ + /** {@inheritDoc} */ @JsMethod public native L bindPopup(String id, PopupOptions options); @@ -102,6 +109,11 @@ protected CircleMarker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#unbindPopup() */ + /** + *

unbindPopup.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L unbindPopup(); @@ -110,6 +122,7 @@ protected CircleMarker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#openPopup(com.gwidgets.api.leaflet.LatLng) */ + /** {@inheritDoc} */ @JsMethod public native L openPopup(LatLng latlng); @@ -117,6 +130,11 @@ protected CircleMarker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#closePopup() */ + /** + *

closePopup.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L closePopup(); @@ -124,6 +142,11 @@ protected CircleMarker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#togglePopup() */ + /** + *

togglePopup.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L togglePopup(); @@ -131,6 +154,11 @@ protected CircleMarker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#isPopupOpen() */ + /** + *

isPopupOpen.

+ * + * @return a boolean + */ @JsMethod public native boolean isPopupOpen(); @@ -138,6 +166,7 @@ protected CircleMarker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setPopupContent(java.lang.String) */ + /** {@inheritDoc} */ @JsMethod public native L setPopupContent(String content); @@ -145,6 +174,12 @@ protected CircleMarker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setPopupContent(com.gwidgets.api.leaflet.elemental.HTMLElement) */ + /** + *

setPopupContent.

+ * + * @param content a {@link elemental2.dom.HTMLElement} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L setPopupContent(HTMLElement content); @@ -152,6 +187,12 @@ protected CircleMarker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setPopupContent(com.gwidgets.api.leaflet.Popup) */ + /** + *

setPopupContent.

+ * + * @param content a {@link com.gwidgets.api.leaflet.Popup} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L setPopupContent(Popup content); @@ -159,6 +200,11 @@ protected CircleMarker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#getPopup() */ + /** + *

getPopup.

+ * + * @return a {@link com.gwidgets.api.leaflet.Popup} object + */ @JsMethod public native Popup getPopup(); @@ -166,6 +212,7 @@ protected CircleMarker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindTooltip(java.lang.String, com.gwidgets.api.leaflet.options.TooltipOptions) */ + /** {@inheritDoc} */ @JsMethod public native L bindTooltip(String content, TooltipOptions options); @@ -173,6 +220,7 @@ protected CircleMarker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindTooltip(com.gwidgets.api.leaflet.elemental.HTMLElement, com.gwidgets.api.leaflet.options.TooltipOptions) */ + /** {@inheritDoc} */ @JsMethod public native L bindTooltip(HTMLElement content, TooltipOptions options); @@ -180,6 +228,7 @@ protected CircleMarker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindTooltip(com.gwidgets.api.leaflet.Tooltip, com.gwidgets.api.leaflet.options.TooltipOptions) */ + /** {@inheritDoc} */ @JsMethod public native L bindTooltip(Tooltip content, TooltipOptions options); @@ -187,6 +236,11 @@ protected CircleMarker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#unbindTooltip() */ + /** + *

unbindTooltip.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L unbindTooltip(); @@ -194,6 +248,7 @@ protected CircleMarker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#openTooltip(com.gwidgets.api.leaflet.LatLng) */ + /** {@inheritDoc} */ @JsMethod public native L openTooltip(LatLng latlng); @@ -201,30 +256,52 @@ protected CircleMarker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#closeTooltip() */ + /** + *

closeTooltip.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L closeTooltip(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#toggleTooltip() */ + /** + *

toggleTooltip.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L toggleTooltip(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#isTooltipOpen() */ + /** + *

isTooltipOpen.

+ * + * @return a boolean + */ @JsMethod public native boolean isTooltipOpen(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setTooltipContent(java.lang.String) */ + /** + *

setTooltipContent.

+ * + * @param content a {@link java.lang.String} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L setTooltipContent(String content); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setTooltipContent(com.gwidgets.api.leaflet.elemental.HTMLElement) */ + /** {@inheritDoc} */ @JsMethod public native L setTooltipContent(HTMLElement content); @@ -232,6 +309,12 @@ protected CircleMarker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setTooltipContent(com.gwidgets.api.leaflet.Tooltip) */ + /** + *

setTooltipContent.

+ * + * @param content a {@link com.gwidgets.api.leaflet.Tooltip} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L setTooltipContent(Tooltip content); @@ -239,12 +322,18 @@ protected CircleMarker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#getTooltip() */ + /** + *

getTooltip.

+ * + * @return a {@link com.gwidgets.api.leaflet.Tooltip} object + */ @JsMethod public native Tooltip getTooltip(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#addTo(com.gwidgets.api.leaflet.Map) */ + /** {@inheritDoc} */ @JsMethod public native L addTo(Map map); @@ -252,12 +341,18 @@ protected CircleMarker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#remove() */ + /** + *

remove.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L remove(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#removeFrom(com.gwidgets.api.leaflet.Map) */ + /** {@inheritDoc} */ @JsMethod public native L removeFrom(Map map); @@ -265,6 +360,7 @@ protected CircleMarker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#getPane(java.lang.String) */ + /** {@inheritDoc} */ @JsMethod public native HTMLElement getPane(String name); @@ -272,6 +368,11 @@ protected CircleMarker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#clearAllEventListeners() */ + /** + *

clearAllEventListeners.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L clearAllEventListeners(); @@ -279,6 +380,7 @@ protected CircleMarker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#on(java.lang.String, com.gwidgets.api.leaflet.elemental.Function) */ + /** {@inheritDoc} */ @JsMethod public native L on(String type, EventCallback fn); @@ -286,6 +388,7 @@ protected CircleMarker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#once(java.lang.String, com.gwidgets.api.leaflet.elemental.Function) */ + /** {@inheritDoc} */ @JsMethod public native L once(String type, EventCallback fn); @@ -293,6 +396,12 @@ protected CircleMarker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#off(java.lang.String) */ + /** + *

off.

+ * + * @param type a {@link java.lang.String} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L off(String type); @@ -300,6 +409,12 @@ protected CircleMarker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#off(java.lang.String[]) */ + /** + *

off.

+ * + * @param type an array of {@link java.lang.String} objects + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L off(String[] type); @@ -307,6 +422,11 @@ protected CircleMarker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#off() */ + /** + *

off.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L off(); @@ -314,6 +434,7 @@ protected CircleMarker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#fire(java.lang.String) */ + /** {@inheritDoc} */ @JsMethod public native L fire(String type); @@ -321,6 +442,7 @@ protected CircleMarker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#listens(java.lang.String) */ + /** {@inheritDoc} */ @JsMethod public native Boolean listens(String type); @@ -328,6 +450,7 @@ protected CircleMarker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#addEventParent(com.gwidgets.api.leaflet.Evented) */ + /** {@inheritDoc} */ @JsMethod public native L addEventParent(Evented obj); @@ -335,7 +458,8 @@ protected CircleMarker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#removeEventParent(com.gwidgets.api.leaflet.Evented) */ + /** {@inheritDoc} */ @JsMethod public native L removeEventParent(Evented obj); -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/Control.java b/src/main/java/com/gwidgets/api/leaflet/Control.java index f452fac..de19b7c 100644 --- a/src/main/java/com/gwidgets/api/leaflet/Control.java +++ b/src/main/java/com/gwidgets/api/leaflet/Control.java @@ -26,7 +26,9 @@ * // or * map.addControl(control);} * + * *@author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative = true) public class Control { @@ -34,12 +36,15 @@ public class Control { + /** + *

Constructor for Control.

+ */ protected Control() { } /** - * Sets the position of the control. + * Sets the position of the control. * * @param position the position * @return the L class @@ -68,6 +73,7 @@ protected Control() { * Removes the control from the map. * * @return the L class + * @param map a {@link com.gwidgets.api.leaflet.Map} object */ @JsMethod public native L remove(Map map); diff --git a/src/main/java/com/gwidgets/api/leaflet/DivIcon.java b/src/main/java/com/gwidgets/api/leaflet/DivIcon.java index 30d75ff..5b3d53f 100644 --- a/src/main/java/com/gwidgets/api/leaflet/DivIcon.java +++ b/src/main/java/com/gwidgets/api/leaflet/DivIcon.java @@ -18,11 +18,16 @@ /** * Represents a lightweight icon for markers that uses a simple div element instead of an image. + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative = true) public class DivIcon extends Icon{ + /** + *

Constructor for DivIcon.

+ */ protected DivIcon() { super(); @@ -32,4 +37,4 @@ protected DivIcon() { -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/DivOverlay.java b/src/main/java/com/gwidgets/api/leaflet/DivOverlay.java index 58e346d..e34593a 100644 --- a/src/main/java/com/gwidgets/api/leaflet/DivOverlay.java +++ b/src/main/java/com/gwidgets/api/leaflet/DivOverlay.java @@ -2,9 +2,18 @@ import jsinterop.annotations.JsType; +/** + *

DivOverlay class.

+ * + * @author zakaria + * @version $Id: $Id + */ @JsType(isNative = true) public class DivOverlay { + /** + *

Constructor for DivOverlay.

+ */ protected DivOverlay() { } diff --git a/src/main/java/com/gwidgets/api/leaflet/Evented.java b/src/main/java/com/gwidgets/api/leaflet/Evented.java index 384d9c3..504fdf2 100644 --- a/src/main/java/com/gwidgets/api/leaflet/Evented.java +++ b/src/main/java/com/gwidgets/api/leaflet/Evented.java @@ -4,6 +4,12 @@ import jsinterop.annotations.JsType; +/** + *

Evented interface.

+ * + * @author zakaria + * @version $Id: $Id + */ @JsType(isNative = true) public interface Evented { @@ -51,7 +57,6 @@ public interface Evented { /** * Removes all listener * - * @param type the type * @return the L class */ public L off(); @@ -65,23 +70,30 @@ public interface Evented { public L fire(String type); - /** Returns true if a particular event type has any listeners attached to it. - * @return true if there is listener, false otherwise - */ + /** + * Returns true if a particular event type has any listeners attached to it. + * + * @return true if there is listener, false otherwise + * @param type a {@link java.lang.String} object + */ public Boolean listens(String type); - /** Adds an event parent - an Evented that will receive propagated events - * @param the parent object that will receive the propagated events - * @return the L class - */ + /** + * Adds an event parent - an Evented that will receive propagated events + * + * @return the L class + * @param obj a {@link com.gwidgets.api.leaflet.Evented} object + */ public L addEventParent(Evented obj); - /** Removes an event parent, so it will stop receiving propagated events - * @param the parent object that be removed - * @return the L class - */ + /** + * Removes an event parent, so it will stop receiving propagated events + * + * @return the L class + * @param obj a {@link com.gwidgets.api.leaflet.Evented} object + */ public L removeEventParent(Evented obj); diff --git a/src/main/java/com/gwidgets/api/leaflet/FeatureGroup.java b/src/main/java/com/gwidgets/api/leaflet/FeatureGroup.java index cdbe8e9..ecf55ae 100644 --- a/src/main/java/com/gwidgets/api/leaflet/FeatureGroup.java +++ b/src/main/java/com/gwidgets/api/leaflet/FeatureGroup.java @@ -22,7 +22,9 @@ /** * Extended layerGroup that also has mouse events (propagated from members of the group) and a shared bindPopup method. + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative = true) public class FeatureGroup extends LayerGroup { @@ -30,6 +32,9 @@ public class FeatureGroup extends LayerGroup { + /** + *

Constructor for FeatureGroup.

+ */ protected FeatureGroup() { } @@ -72,4 +77,4 @@ protected FeatureGroup() { -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/GeoJSON.java b/src/main/java/com/gwidgets/api/leaflet/GeoJSON.java index 3353c13..301c7aa 100644 --- a/src/main/java/com/gwidgets/api/leaflet/GeoJSON.java +++ b/src/main/java/com/gwidgets/api/leaflet/GeoJSON.java @@ -23,7 +23,9 @@ /** *Represents a GeoJSON object or an array of GeoJSON objects. Allows you to parse GeoJSON data and display it on the map. + * *@author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative = true) public class GeoJSON extends FeatureGroup { @@ -64,7 +66,7 @@ private GeoJSON() { * Creates a layer from a given GeoJSON feature. * * @param featureData the feature data - * @param pointToLayer the point to layer + * @param pointToLayer the point to layer * @return the layer */ @JsMethod @@ -73,6 +75,7 @@ public native static Layer geometryToLayer(JsObject featureData, /** * Creates a LatLng object from an array of 2 numbers (latitude, longitude) used in GeoJSON for points. If reverse is set to true, the numbers will be interpreted as (longitude, latitude). + * * @param coords the coordinates * @return the lat lng */ @@ -84,47 +87,47 @@ public native static Layer geometryToLayer(JsObject featureData, * Creates a multidimensional array of LatLngs from a GeoJSON coordinates array. levelsDeep specifies the nesting level (0 is for an array of points, 1 for an array of arrays of points, etc., 0 by default). Can use a custom coordsToLatLng function. * * @param coords the coordinates - * @param levelsDeep specifies the nesting level - * @param Function coordsToLatLngs + * @param levelsDeep specifies the nesting level * @return js array of coordinates + * @param coordsToLatlngs a {@link com.gwidgets.api.leaflet.options.GeoJSONOptions.CoordsToLatLngFunction} object */ @JsMethod public native static JsObject[] coordsToLatlngs(JsObject[] coords, double levelsDeep, GeoJSONOptions.CoordsToLatLngFunction coordsToLatlngs); - /** - * Reverse of coordsToLatLng. - * - * @param latlng the latlng - * @return the js array - */ + /** + * Reverse of coordsToLatLng. + * + * @param latlng the latlng + * @return the js array + */ @JsMethod public native JsObject[] latLngToCoords(LatLng latlng); -/** - * Reverse of coordsToLatLngs closed determines whether the first point should be appended to the end of the array to close the feature, only used when levelsDeep is 0. False by default. - * - * @param latlngs the latlngs - * @param levelsDeep the levels deep - * @param closed closed - * @return the js array - */ + /** + * Reverse of coordsToLatLngs closed determines whether the first point should be appended to the end of the array to close the feature, only used when levelsDeep is 0. False by default. + * + * @param latlngs the latlngs + * @param levelsDeep the levels deep + * @param closed closed + * @return the js array + */ @JsMethod public native JsObject[] latLngsToCoords(JsObject[] latlngs, double levelsDeep, Boolean closed); - /** - * Normalize GeoJSON geometries/features into GeoJSON features. - * - * @param geojson the geojson - * @return the java script object - */ + /** + * Normalize GeoJSON geometries/features into GeoJSON features. + * + * @param geojson the geojson + * @return the java script object + */ @JsMethod public native JsObject asFeature(JsObject geojson); -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/GridLayer.java b/src/main/java/com/gwidgets/api/leaflet/GridLayer.java index de2bafe..7176860 100644 --- a/src/main/java/com/gwidgets/api/leaflet/GridLayer.java +++ b/src/main/java/com/gwidgets/api/leaflet/GridLayer.java @@ -11,86 +11,121 @@ import jsinterop.annotations.JsType; import jsinterop.base.JsForEachCallbackFn; +/** + *

GridLayer class.

+ * + * @author zakaria + * @version $Id: $Id + */ @JsType(isNative=true) public class GridLayer implements Layer, Evented{ + /** + *

Constructor for GridLayer.

+ */ protected GridLayer() { } - /** Brings the tile layer to the top of all tile layers. - * @return the L class - */ + /** + * Brings the tile layer to the top of all tile layers. + * + * @return the L class + */ @JsMethod public native L bringToFront(); - /** Brings the tile layer to the bottom of all tile layers. - * @return the L cass - */ + /** + * Brings the tile layer to the bottom of all tile layers. + * + * @return the L cass + */ @JsMethod public native L bringToBack(); - /** Used by the attribution control, returns the attribution option. - * @return String the attribution option value - */ + /** + * Used by the attribution control, returns the attribution option. + * + * @return String the attribution option value + */ @JsMethod public native String getAttribution(); - /** Returns the HTML element that contains the tiles for this layer. - * @return HTMLElement - */ + /** + * Returns the HTML element that contains the tiles for this layer. + * + * @return HTMLElement + */ @JsMethod public native HTMLElement getContainer(); - /** Changes the opacity of the grid layer. - * @return the L class - */ + /** + * Changes the opacity of the grid layer. + * + * @return the L class + * @param opacity a double + */ @JsMethod public native L setOpacity(double opacity); - /** Changes the zIndex of the grid layer. - * @return the L class - */ + /** + * Changes the zIndex of the grid layer. + * + * @return the L class + * @param zIndex a double + */ @JsMethod public native L setZIndex(double zIndex); - /** Returns true if any tile in the grid layer has not finished loading. - * @return true if not finished loading, false otherwise - */ + /** + * Returns true if any tile in the grid layer has not finished loading. + * + * @return true if not finished loading, false otherwise + */ @JsMethod public native Boolean isLoading(); - /** Causes the layer to clear all the tiles and request them again. - * @return the L class - */ + /** + * Causes the layer to clear all the tiles and request them again. + * + * @return the L class + */ @JsMethod public native L redraw(); - /** Normalizes the tileSize option into a point. Used by the createTile() method. - * @return point - */ + /** + * Normalizes the tileSize option into a point. Used by the createTile() method. + * + * @return point + */ @JsMethod public native Point getTileSize(); + /** + *

createTile.

+ * + * @param coords a {@link elemental2.core.JsObject} object + * @param doneCallback a {@link com.gwidgets.api.leaflet.utils.JsFn} object + * @return a {@link elemental2.dom.HTMLElement} object + */ @JsMethod public native HTMLElement createTile(JsObject coords, JsFn doneCallback); /** - * Adds the layer to the map. + * {@inheritDoc} * - * @param map the map - * @return the L class + * Adds the layer to the map. */ @JsMethod public native L addTo(Map map); @@ -102,66 +137,95 @@ protected GridLayer() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#clearAllEventListeners() */ + /** + *

clearAllEventListeners.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L clearAllEventListeners(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#on(java.lang.String, com.gwidgets.api.leaflet.elemental.Function) */ + /** {@inheritDoc} */ public native L on(String type, EventCallback fn); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#once(java.lang.String, com.gwidgets.api.leaflet.elemental.Function) */ + /** {@inheritDoc} */ public native L once(String type, EventCallback fn); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#off(java.lang.String) */ + /** + *

off.

+ * + * @param type a {@link java.lang.String} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L off(String type); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#off(java.lang.String[]) */ + /** + *

off.

+ * + * @param type an array of {@link java.lang.String} objects + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L off(String[] type); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#off() */ + /** + *

off.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L off(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#fire(java.lang.String) */ + /** {@inheritDoc} */ public native L fire(String type); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#listens(java.lang.String) */ + /** {@inheritDoc} */ public native Boolean listens(String type); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#addEventParent(com.gwidgets.api.leaflet.Evented) */ + /** {@inheritDoc} */ public native L addEventParent(Evented obj); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#removeEventParent(com.gwidgets.api.leaflet.Evented) */ + /** {@inheritDoc} */ public native L removeEventParent(Evented obj); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindPopup(com.gwidgets.api.leaflet.elemental.HTMLElement, com.gwidgets.api.leaflet.options.PopupOptions) */ +/** {@inheritDoc} */ @JsMethod public native L bindPopup(HTMLElement content, PopupOptions options); @@ -169,6 +233,7 @@ protected GridLayer() { * @see com.gwidgets.api.leaflet.Layer#bindPopup(java.lang.String, com.gwidgets.api.leaflet.options.PopupOptions) */ +/** {@inheritDoc} */ @JsMethod public native L bindPopup(String id, PopupOptions options); @@ -176,6 +241,11 @@ protected GridLayer() { * @see com.gwidgets.api.leaflet.Layer#unbindPopup() */ +/** + *

unbindPopup.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L unbindPopup(); @@ -183,6 +253,7 @@ protected GridLayer() { * @see com.gwidgets.api.leaflet.Layer#openPopup(com.gwidgets.api.leaflet.LatLng) */ +/** {@inheritDoc} */ @JsMethod public native L openPopup(LatLng latlng); @@ -190,6 +261,11 @@ protected GridLayer() { * @see com.gwidgets.api.leaflet.Layer#closePopup() */ +/** + *

closePopup.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L closePopup(); @@ -197,6 +273,11 @@ protected GridLayer() { * @see com.gwidgets.api.leaflet.Layer#togglePopup() */ +/** + *

togglePopup.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L togglePopup(); @@ -204,6 +285,11 @@ protected GridLayer() { * @see com.gwidgets.api.leaflet.Layer#isPopupOpen() */ +/** + *

isPopupOpen.

+ * + * @return a boolean + */ @JsMethod public native boolean isPopupOpen(); @@ -211,6 +297,7 @@ protected GridLayer() { * @see com.gwidgets.api.leaflet.Layer#setPopupContent(java.lang.String) */ +/** {@inheritDoc} */ @JsMethod public native L setPopupContent(String content); @@ -218,6 +305,12 @@ protected GridLayer() { * @see com.gwidgets.api.leaflet.Layer#setPopupContent(com.gwidgets.api.leaflet.elemental.HTMLElement) */ +/** + *

setPopupContent.

+ * + * @param content a {@link elemental2.dom.HTMLElement} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L setPopupContent(HTMLElement content); @@ -225,6 +318,12 @@ protected GridLayer() { * @see com.gwidgets.api.leaflet.Layer#setPopupContent(com.gwidgets.api.leaflet.Popup) */ +/** + *

setPopupContent.

+ * + * @param content a {@link com.gwidgets.api.leaflet.Popup} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L setPopupContent(Popup content); @@ -233,6 +332,11 @@ protected GridLayer() { * @see com.gwidgets.api.leaflet.Layer#getPopup() */ +/** + *

getPopup.

+ * + * @return a {@link com.gwidgets.api.leaflet.Popup} object + */ @JsMethod public native Popup getPopup(); @@ -241,6 +345,7 @@ protected GridLayer() { * @see com.gwidgets.api.leaflet.Layer#bindTooltip(java.lang.String, com.gwidgets.api.leaflet.options.TooltipOptions) */ +/** {@inheritDoc} */ @JsMethod public native L bindTooltip(String content, TooltipOptions options); @@ -249,6 +354,7 @@ protected GridLayer() { * @see com.gwidgets.api.leaflet.Layer#bindTooltip(com.gwidgets.api.leaflet.elemental.HTMLElement, com.gwidgets.api.leaflet.options.TooltipOptions) */ +/** {@inheritDoc} */ @JsMethod public native L bindTooltip(HTMLElement content, TooltipOptions options); @@ -256,6 +362,7 @@ protected GridLayer() { * @see com.gwidgets.api.leaflet.Layer#bindTooltip(com.gwidgets.api.leaflet.Tooltip, com.gwidgets.api.leaflet.options.TooltipOptions) */ +/** {@inheritDoc} */ @JsMethod public native L bindTooltip(Tooltip content, TooltipOptions options); @@ -263,6 +370,11 @@ protected GridLayer() { * @see com.gwidgets.api.leaflet.Layer#unbindTooltip() */ +/** + *

unbindTooltip.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L unbindTooltip(); @@ -270,6 +382,7 @@ protected GridLayer() { * @see com.gwidgets.api.leaflet.Layer#openTooltip(com.gwidgets.api.leaflet.LatLng) */ +/** {@inheritDoc} */ @JsMethod public native L openTooltip(LatLng latlng); @@ -277,6 +390,11 @@ protected GridLayer() { * @see com.gwidgets.api.leaflet.Layer#closeTooltip() */ +/** + *

closeTooltip.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L closeTooltip(); @@ -284,6 +402,11 @@ protected GridLayer() { * @see com.gwidgets.api.leaflet.Layer#toggleTooltip() */ +/** + *

toggleTooltip.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L toggleTooltip(); @@ -291,6 +414,11 @@ protected GridLayer() { * @see com.gwidgets.api.leaflet.Layer#isTooltipOpen() */ +/** + *

isTooltipOpen.

+ * + * @return a boolean + */ @JsMethod public native boolean isTooltipOpen(); @@ -298,6 +426,12 @@ protected GridLayer() { * @see com.gwidgets.api.leaflet.Layer#setTooltipContent(java.lang.String) */ +/** + *

setTooltipContent.

+ * + * @param content a {@link java.lang.String} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L setTooltipContent(String content); @@ -305,36 +439,55 @@ protected GridLayer() { * @see com.gwidgets.api.leaflet.Layer#setTooltipContent(com.gwidgets.api.leaflet.elemental.HTMLElement) */ +/** {@inheritDoc} */ @JsMethod public native L setTooltipContent(HTMLElement content); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setTooltipContent(com.gwidgets.api.leaflet.Tooltip) */ +/** + *

setTooltipContent.

+ * + * @param content a {@link com.gwidgets.api.leaflet.Tooltip} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L setTooltipContent(Tooltip content); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#getTooltip() */ +/** + *

getTooltip.

+ * + * @return a {@link com.gwidgets.api.leaflet.Tooltip} object + */ @JsMethod public native Tooltip getTooltip(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#remove() */ +/** + *

remove.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L remove(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#removeFrom(com.gwidgets.api.leaflet.Map) */ +/** {@inheritDoc} */ @JsMethod public native L removeFrom(Map map); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#getPane(java.lang.String) */ +/** {@inheritDoc} */ @JsMethod public native HTMLElement getPane(String name); diff --git a/src/main/java/com/gwidgets/api/leaflet/Handler.java b/src/main/java/com/gwidgets/api/leaflet/Handler.java index d37ca4c..34c56b0 100644 --- a/src/main/java/com/gwidgets/api/leaflet/Handler.java +++ b/src/main/java/com/gwidgets/api/leaflet/Handler.java @@ -19,7 +19,9 @@ /** * An interface implemented by interaction handlers. + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative = true) public interface Handler { @@ -47,4 +49,4 @@ public interface Handler { -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/Icon.java b/src/main/java/com/gwidgets/api/leaflet/Icon.java index 0220711..2b590f3 100644 --- a/src/main/java/com/gwidgets/api/leaflet/Icon.java +++ b/src/main/java/com/gwidgets/api/leaflet/Icon.java @@ -24,11 +24,16 @@ /** * Represents an icon to provide when creating a marker. + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative = true) public class Icon implements Layer, Evented{ + /** + *

Constructor for Icon.

+ */ protected Icon() { } @@ -36,6 +41,7 @@ protected Icon() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindPopup(com.gwidgets.api.leaflet.elemental.HTMLElement, com.gwidgets.api.leaflet.options.PopupOptions) */ + /** {@inheritDoc} */ @JsMethod public native L bindPopup(HTMLElement content, PopupOptions options); @@ -43,6 +49,7 @@ protected Icon() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindPopup(java.lang.String, com.gwidgets.api.leaflet.options.PopupOptions) */ + /** {@inheritDoc} */ @JsMethod public native L bindPopup(String id, PopupOptions options); @@ -50,6 +57,11 @@ protected Icon() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#unbindPopup() */ + /** + *

unbindPopup.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L unbindPopup(); @@ -58,6 +70,7 @@ protected Icon() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#openPopup(com.gwidgets.api.leaflet.LatLng) */ + /** {@inheritDoc} */ @JsMethod public native L openPopup(LatLng latlng); @@ -65,6 +78,11 @@ protected Icon() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#closePopup() */ + /** + *

closePopup.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L closePopup(); @@ -72,6 +90,11 @@ protected Icon() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#togglePopup() */ + /** + *

togglePopup.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L togglePopup(); @@ -79,6 +102,11 @@ protected Icon() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#isPopupOpen() */ + /** + *

isPopupOpen.

+ * + * @return a boolean + */ @JsMethod public native boolean isPopupOpen(); @@ -86,6 +114,7 @@ protected Icon() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setPopupContent(java.lang.String) */ + /** {@inheritDoc} */ @JsMethod public native L setPopupContent(String content); @@ -93,6 +122,12 @@ protected Icon() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setPopupContent(com.gwidgets.api.leaflet.elemental.HTMLElement) */ + /** + *

setPopupContent.

+ * + * @param content a {@link elemental2.dom.HTMLElement} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L setPopupContent(HTMLElement content); @@ -100,6 +135,12 @@ protected Icon() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setPopupContent(com.gwidgets.api.leaflet.Popup) */ + /** + *

setPopupContent.

+ * + * @param content a {@link com.gwidgets.api.leaflet.Popup} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L setPopupContent(Popup content); @@ -107,6 +148,11 @@ protected Icon() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#getPopup() */ + /** + *

getPopup.

+ * + * @return a {@link com.gwidgets.api.leaflet.Popup} object + */ @JsMethod public native Popup getPopup(); @@ -114,6 +160,7 @@ protected Icon() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindTooltip(java.lang.String, com.gwidgets.api.leaflet.options.TooltipOptions) */ + /** {@inheritDoc} */ @JsMethod public native L bindTooltip(String content, TooltipOptions options); @@ -121,6 +168,7 @@ protected Icon() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindTooltip(com.gwidgets.api.leaflet.elemental.HTMLElement, com.gwidgets.api.leaflet.options.TooltipOptions) */ + /** {@inheritDoc} */ @JsMethod public native L bindTooltip(HTMLElement content, TooltipOptions options); @@ -128,6 +176,7 @@ protected Icon() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindTooltip(com.gwidgets.api.leaflet.Tooltip, com.gwidgets.api.leaflet.options.TooltipOptions) */ + /** {@inheritDoc} */ @JsMethod public native L bindTooltip(Tooltip content, TooltipOptions options); @@ -135,6 +184,11 @@ protected Icon() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#unbindTooltip() */ + /** + *

unbindTooltip.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L unbindTooltip(); @@ -142,6 +196,7 @@ protected Icon() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#openTooltip(com.gwidgets.api.leaflet.LatLng) */ + /** {@inheritDoc} */ @JsMethod public native L openTooltip(LatLng latlng); @@ -149,30 +204,52 @@ protected Icon() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#closeTooltip() */ + /** + *

closeTooltip.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L closeTooltip(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#toggleTooltip() */ + /** + *

toggleTooltip.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L toggleTooltip(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#isTooltipOpen() */ + /** + *

isTooltipOpen.

+ * + * @return a boolean + */ @JsMethod public native boolean isTooltipOpen(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setTooltipContent(java.lang.String) */ + /** + *

setTooltipContent.

+ * + * @param content a {@link java.lang.String} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L setTooltipContent(String content); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setTooltipContent(com.gwidgets.api.leaflet.elemental.HTMLElement) */ + /** {@inheritDoc} */ @JsMethod public native L setTooltipContent(HTMLElement content); @@ -180,6 +257,12 @@ protected Icon() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setTooltipContent(com.gwidgets.api.leaflet.Tooltip) */ + /** + *

setTooltipContent.

+ * + * @param content a {@link com.gwidgets.api.leaflet.Tooltip} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L setTooltipContent(Tooltip content); @@ -187,12 +270,18 @@ protected Icon() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#getTooltip() */ + /** + *

getTooltip.

+ * + * @return a {@link com.gwidgets.api.leaflet.Tooltip} object + */ @JsMethod public native Tooltip getTooltip(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#addTo(com.gwidgets.api.leaflet.Map) */ + /** {@inheritDoc} */ @JsMethod public native L addTo(Map map); @@ -200,12 +289,18 @@ protected Icon() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#remove() */ + /** + *

remove.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L remove(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#removeFrom(com.gwidgets.api.leaflet.Map) */ + /** {@inheritDoc} */ @JsMethod public native L removeFrom(Map map); @@ -213,6 +308,7 @@ protected Icon() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#getPane(java.lang.String) */ + /** {@inheritDoc} */ @JsMethod public native HTMLElement getPane(String name); @@ -220,6 +316,11 @@ protected Icon() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#clearAllEventListeners() */ + /** + *

clearAllEventListeners.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L clearAllEventListeners(); @@ -227,6 +328,7 @@ protected Icon() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#on(java.lang.String, com.gwidgets.api.leaflet.elemental.Function) */ + /** {@inheritDoc} */ @JsMethod public native L on(String type, EventCallback fn); @@ -234,6 +336,7 @@ protected Icon() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#once(java.lang.String, com.gwidgets.api.leaflet.elemental.Function) */ + /** {@inheritDoc} */ @JsMethod public native L once(String type, EventCallback fn); @@ -241,6 +344,12 @@ protected Icon() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#off(java.lang.String) */ + /** + *

off.

+ * + * @param type a {@link java.lang.String} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L off(String type); @@ -248,6 +357,12 @@ protected Icon() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#off(java.lang.String[]) */ + /** + *

off.

+ * + * @param type an array of {@link java.lang.String} objects + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L off(String[] type); @@ -255,6 +370,11 @@ protected Icon() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#off() */ + /** + *

off.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L off(); @@ -262,6 +382,7 @@ protected Icon() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#fire(java.lang.String) */ + /** {@inheritDoc} */ @JsMethod public native L fire(String type); @@ -269,6 +390,7 @@ protected Icon() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#listens(java.lang.String) */ + /** {@inheritDoc} */ @JsMethod public native Boolean listens(String type); @@ -276,6 +398,7 @@ protected Icon() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#addEventParent(com.gwidgets.api.leaflet.Evented) */ + /** {@inheritDoc} */ @JsMethod public native L addEventParent(Evented obj); @@ -283,9 +406,10 @@ protected Icon() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#removeEventParent(com.gwidgets.api.leaflet.Evented) */ + /** {@inheritDoc} */ @JsMethod public native L removeEventParent(Evented obj); -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/ImageOverlay.java b/src/main/java/com/gwidgets/api/leaflet/ImageOverlay.java index 833dc93..f95c537 100644 --- a/src/main/java/com/gwidgets/api/leaflet/ImageOverlay.java +++ b/src/main/java/com/gwidgets/api/leaflet/ImageOverlay.java @@ -24,7 +24,9 @@ /** *Used to load and display a single image over specific bounds of the map, implements ILayer interface. + * *@author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative = true) public class ImageOverlay implements Layer, Evented{ @@ -62,6 +64,7 @@ private ImageOverlay() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindPopup(com.gwidgets.api.leaflet.elemental.HTMLElement, com.gwidgets.api.leaflet.options.PopupOptions) */ + /** {@inheritDoc} */ @JsMethod public native L bindPopup(HTMLElement content, PopupOptions options); @@ -69,6 +72,7 @@ private ImageOverlay() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindPopup(java.lang.String, com.gwidgets.api.leaflet.options.PopupOptions) */ + /** {@inheritDoc} */ @JsMethod public native L bindPopup(String id, PopupOptions options); @@ -76,6 +80,11 @@ private ImageOverlay() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#unbindPopup() */ + /** + *

unbindPopup.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L unbindPopup(); @@ -84,6 +93,7 @@ private ImageOverlay() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#openPopup(com.gwidgets.api.leaflet.LatLng) */ + /** {@inheritDoc} */ @JsMethod public native L openPopup(LatLng latlng); @@ -91,6 +101,11 @@ private ImageOverlay() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#closePopup() */ + /** + *

closePopup.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L closePopup(); @@ -98,6 +113,11 @@ private ImageOverlay() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#togglePopup() */ + /** + *

togglePopup.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L togglePopup(); @@ -105,6 +125,11 @@ private ImageOverlay() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#isPopupOpen() */ + /** + *

isPopupOpen.

+ * + * @return a boolean + */ @JsMethod public native boolean isPopupOpen(); @@ -112,6 +137,7 @@ private ImageOverlay() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setPopupContent(java.lang.String) */ + /** {@inheritDoc} */ @JsMethod public native L setPopupContent(String content); @@ -119,6 +145,12 @@ private ImageOverlay() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setPopupContent(com.gwidgets.api.leaflet.elemental.HTMLElement) */ + /** + *

setPopupContent.

+ * + * @param content a {@link elemental2.dom.HTMLElement} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L setPopupContent(HTMLElement content); @@ -126,6 +158,12 @@ private ImageOverlay() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setPopupContent(com.gwidgets.api.leaflet.Popup) */ + /** + *

setPopupContent.

+ * + * @param content a {@link com.gwidgets.api.leaflet.Popup} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L setPopupContent(Popup content); @@ -133,6 +171,11 @@ private ImageOverlay() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#getPopup() */ + /** + *

getPopup.

+ * + * @return a {@link com.gwidgets.api.leaflet.Popup} object + */ @JsMethod public native Popup getPopup(); @@ -140,152 +183,230 @@ private ImageOverlay() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindTooltip(java.lang.String, com.gwidgets.api.leaflet.options.TooltipOptions) */ + /** {@inheritDoc} */ public native L bindTooltip(String content, TooltipOptions options); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindTooltip(com.gwidgets.api.leaflet.elemental.HTMLElement, com.gwidgets.api.leaflet.options.TooltipOptions) */ + /** {@inheritDoc} */ public native L bindTooltip(HTMLElement content, TooltipOptions options); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindTooltip(com.gwidgets.api.leaflet.Tooltip, com.gwidgets.api.leaflet.options.TooltipOptions) */ + /** {@inheritDoc} */ public native L bindTooltip(Tooltip content, TooltipOptions options); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#unbindTooltip() */ + /** + *

unbindTooltip.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L unbindTooltip(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#openTooltip(com.gwidgets.api.leaflet.LatLng) */ + /** {@inheritDoc} */ public native L openTooltip(LatLng latlng); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#closeTooltip() */ + /** + *

closeTooltip.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L closeTooltip(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#toggleTooltip() */ + /** + *

toggleTooltip.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L toggleTooltip(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#isTooltipOpen() */ + /** + *

isTooltipOpen.

+ * + * @return a boolean + */ public native boolean isTooltipOpen(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setTooltipContent(java.lang.String) */ + /** + *

setTooltipContent.

+ * + * @param content a {@link java.lang.String} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L setTooltipContent(String content); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setTooltipContent(com.gwidgets.api.leaflet.elemental.HTMLElement) */ + /** {@inheritDoc} */ public native L setTooltipContent(HTMLElement content); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setTooltipContent(com.gwidgets.api.leaflet.Tooltip) */ + /** + *

setTooltipContent.

+ * + * @param content a {@link com.gwidgets.api.leaflet.Tooltip} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L setTooltipContent(Tooltip content); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#getTooltip() */ + /** + *

getTooltip.

+ * + * @return a {@link com.gwidgets.api.leaflet.Tooltip} object + */ public native Tooltip getTooltip(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#addTo(com.gwidgets.api.leaflet.Map) */ + /** {@inheritDoc} */ public native L addTo(Map map); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#remove() */ + /** + *

remove.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L remove(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#removeFrom(com.gwidgets.api.leaflet.Map) */ + /** {@inheritDoc} */ public native L removeFrom(Map map); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#getPane(java.lang.String) */ + /** {@inheritDoc} */ public native HTMLElement getPane(String name); // Events /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#clearAllEventListeners() */ + /** + *

clearAllEventListeners.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L clearAllEventListeners(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#on(java.lang.String, com.gwidgets.api.leaflet.elemental.Function) */ + /** {@inheritDoc} */ public native L on(String type, EventCallback fn); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#once(java.lang.String, com.gwidgets.api.leaflet.elemental.Function) */ + /** {@inheritDoc} */ public native L once(String type, EventCallback fn); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#off(java.lang.String) */ + /** + *

off.

+ * + * @param type a {@link java.lang.String} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L off(String type); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#off(java.lang.String[]) */ + /** + *

off.

+ * + * @param type an array of {@link java.lang.String} objects + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L off(String[] type); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#off() */ + /** + *

off.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L off(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#fire(java.lang.String) */ + /** {@inheritDoc} */ public native L fire(String type); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#listens(java.lang.String) */ + /** {@inheritDoc} */ public native Boolean listens(String type); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#addEventParent(com.gwidgets.api.leaflet.Evented) */ + /** {@inheritDoc} */ public native L addEventParent(Evented obj); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#removeEventParent(com.gwidgets.api.leaflet.Evented) */ + /** {@inheritDoc} */ public native L removeEventParent(Evented obj); -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/L.java b/src/main/java/com/gwidgets/api/leaflet/L.java index 416347a..383173e 100644 --- a/src/main/java/com/gwidgets/api/leaflet/L.java +++ b/src/main/java/com/gwidgets/api/leaflet/L.java @@ -50,10 +50,11 @@ // TODO: Auto-generated Javadoc /** * The Master class of leaflet. All leaflet classes should be created through this class. - * This class transcribes factory methods from the Javascript version. + * This class transcribes factory methods from the Javascript version. * It powers the OOP facilities of Leaflet. - * + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative = true, namespace = JsPackage.GLOBAL) public class L { @@ -69,7 +70,7 @@ private L() { /** * The central class of the API — it is used to create a map on a page and manipulate it. * - * @param id the id of the element + * @param id the id of the element * @param options map options * @return a new Map object */ @@ -136,8 +137,8 @@ public static native Polyline polyline(LatLng[][] latlngs, /** * A class for drawing polygon overlays on a map. Extends Polyline. Use Map.addLayer() to add it to the map. - -Note that points you pass when creating a polygon shouldn't have an additional last point equal to the first one — it's better to filter out such points. + * + *Note that points you pass when creating a polygon shouldn't have an additional last point equal to the first one — it's better to filter out such points. * * @param latlngs the latlngs array * @param options the Polygon options @@ -163,7 +164,7 @@ public static native Rectangle rectangle(LatLngBounds bounds, * @param latlng the latlng of the circle on the map * @param options the Circle options * @return a new Circle object - */ + */ public static native Circle circle(LatLng latlng, CircleOptions options); @@ -215,7 +216,7 @@ public static native CircleMarker circleMarker(LatLng latlng, * Represents a rectangular geographical area on a map. * * @param southWest the south west point - * @param northEast the north east point + * @param northEast the north east point * @return a new LatLngBounds object */ public static native LatLngBounds latLngBounds(LatLng southWest, @@ -260,8 +261,8 @@ public static native LatLngBounds latLngBounds(LatLng southWest, * The base class for all Leaflet controls. Implements IControl interface. You can add controls to the map like this: *
 	 *{@code control.addTo(map);
-     *       // or
-     *  map.addControl(control);}
+	 *       // or
+	 *  map.addControl(control);}
 	 *
* * @param options the Control options @@ -286,7 +287,6 @@ public static native Transformation transformation(double a, double b, /** * A constant that represents the Leaflet version in use. * - * @return the version */ @JsProperty public static String version; @@ -509,4 +509,4 @@ public Transformation(double a, double b, } -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/LatLng.java b/src/main/java/com/gwidgets/api/leaflet/LatLng.java index 01debb6..8e7f210 100644 --- a/src/main/java/com/gwidgets/api/leaflet/LatLng.java +++ b/src/main/java/com/gwidgets/api/leaflet/LatLng.java @@ -21,7 +21,9 @@ /** * Represents a geographical point with a certain latitude and longitude. + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative = true) public class LatLng { @@ -44,19 +46,19 @@ private LatLng() { - /** - * Instantiates a new lat lng. - * - * @param lat the lat - * @param lng the lng - */ + /** + * Instantiates a new lat lng. + * + * @param lat the lat + * @param lng the lng + */ @JsConstructor public LatLng(double lat, double lng) { } /** - * Returns the distance (in meters) to the given LatLng calculated using the Haversine formula. + * Returns the distance (in meters) to the given LatLng calculated using the Haversine formula. * * @param otherLatlng the other latlng * @return the distance (in meters) @@ -76,6 +78,11 @@ public LatLng(double lat, double lng) { /* (non-Javadoc) * @see java.lang.Object#toString() */ + /** + *

toString.

+ * + * @return a {@link java.lang.String} object + */ @JsMethod public native String toString(); @@ -89,4 +96,4 @@ public LatLng(double lat, double lng) { @JsMethod public native LatLng wrap(double left, double right); -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/LatLngBounds.java b/src/main/java/com/gwidgets/api/leaflet/LatLngBounds.java index 6728ddb..51cd27e 100644 --- a/src/main/java/com/gwidgets/api/leaflet/LatLngBounds.java +++ b/src/main/java/com/gwidgets/api/leaflet/LatLngBounds.java @@ -20,7 +20,9 @@ /** * Represents a rectangular geographical area on a map. + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative = true) public class LatLngBounds { @@ -182,4 +184,4 @@ private LatLngBounds() { @JsMethod public native Boolean isValid(); -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/Layer.java b/src/main/java/com/gwidgets/api/leaflet/Layer.java index 0cc1b4d..936bb39 100644 --- a/src/main/java/com/gwidgets/api/leaflet/Layer.java +++ b/src/main/java/com/gwidgets/api/leaflet/Layer.java @@ -33,8 +33,8 @@ public interface Layer { /** * Binds a popup to the layer with the passed content and sets up the neccessary event listeners. * - * @param HTMLElement the element on which to binds the pop up - * @param PopupOptions the popup options + * @param content the element on which to binds the pop up + * @param options the popup options * @return the L class */ @@ -42,8 +42,8 @@ public interface Layer { /*** Binds a popup to the layer with the passed content and sets up the neccessary event listeners. * - * @param String the id of the element - * @param PopupOptions the popup options + * @param id the id of the element + * @param options the popup options * @return the L class */ @@ -60,7 +60,7 @@ public interface Layer { /*** Opens the bound popup at the specificed latlng or at the default popup anchor if no latlng is passed. * - * @param LatLng the latlng where to open the pop up + * @param latlng the latlng where to open the pop up * @return the L class */ @@ -90,14 +90,14 @@ public interface Layer { public boolean isPopupOpen(); /*** Sets the content of the popup bound to this layer. -** @param String content of the popup as a String +** @param content content of the popup as a String * @return the L class */ public L setPopupContent(String content); /*** Sets the content of the popup bound to this layer. -** @param HTMLElement content of the popup as a HTMLElement +** @param content content of the popup as a HTMLElement * @return the L class */ @@ -105,7 +105,7 @@ public interface Layer { /*** Sets the content of the popup bound to this layer. -** @param HTMLElement content of the popup as a Popup Object +** @param content content of the popup as a Popup Object * @return the L class */ @@ -121,8 +121,8 @@ public interface Layer { /** * Binds a tooltip to the layer with the passed *content and sets up the neccessary event listeners. If a Function is passed it will receive the layer as the first argument and should return a String or HTMLElement. * - * @param String the tooltip content as a string - * @param TooltipOptions the options object of this tooltip + * @param content the tooltip content as a string + * @param options the options object of this tooltip * @return the L class */ @@ -131,8 +131,8 @@ public interface Layer { /** * Binds a tooltip to the layer with the passed *content and sets up the neccessary event listeners. If a Function is passed it will receive the layer as the first argument and should return a String or HTMLElement. * - * @param HTMLElement the tooltip content as a HTMLElement object - * @param TooltipOptions the options object of this tooltip + * @param content the tooltip content as a HTMLElement object + * @param options the options object of this tooltip * @return the L class */ @@ -141,8 +141,8 @@ public interface Layer { /** * Binds a tooltip to the layer with the passed content and sets up the neccessary event listeners. If a Function is passed it will receive the layer as the first argument and should return a String or HTMLElement. * - * @param HTMLElement the tooltip content as a ToolTip object - * @param TooltipOptions the options object of this tooltip + * @param content the tooltip content as a ToolTip object + * @param options the options object of this tooltip * @return the L class */ @@ -161,7 +161,7 @@ public interface Layer { /** * Opens the bound tooltip at the specificed latlng or at the default tooltip anchor if no latlng is passed. * - * @param LatLng the latlng where the tooltip is opened + * @param latlng the latlng where the tooltip is opened * @return the L class */ @@ -195,7 +195,7 @@ public interface Layer { /** * Sets the content of the tooltip bound to this layer. * - * @param String the content of the tooltip as a string + * @param content the content of the tooltip as a string * @return the L class */ @@ -204,7 +204,7 @@ public interface Layer { /** * Sets the content of the tooltip bound to this layer. * - * @param HTMLElement the content of the tooltip as a HTMLELement object + * @param content the content of the tooltip as a HTMLELement object * @return the L class */ @@ -214,7 +214,7 @@ public interface Layer { /** * Sets the content of the tooltip bound to this layer. * - * @param Tooltip the content of the tooltip as a Tooltip object + * @param content the content of the tooltip as a Tooltip object * @return the L class */ @@ -230,7 +230,7 @@ public interface Layer { public Tooltip getTooltip(); /** Adds the tooltip to the given map -* @param Map the map object to which to add this toolltip +* @param map the map object to which to add this toolltip * @return the L class */ @@ -244,14 +244,14 @@ public interface Layer { /** Removes the tooltip from the given map -* @param Map the map object from which to remove this toolltip +* @param map the map object from which to remove this toolltip * @return the L class */ public L removeFrom(Map map); /** Returns the HTMLElement representing the named pane on the map. If name is omitted, returns the pane for this layer. -* @param Map the map object from which to remove this toolltip +* @param name the map object from which to remove this toolltip * @return HTMLElement the element */ public HTMLElement getPane(String name); diff --git a/src/main/java/com/gwidgets/api/leaflet/Layers.java b/src/main/java/com/gwidgets/api/leaflet/Layers.java index fc82387..0e96d4b 100644 --- a/src/main/java/com/gwidgets/api/leaflet/Layers.java +++ b/src/main/java/com/gwidgets/api/leaflet/Layers.java @@ -6,7 +6,9 @@ /** * The layers control gives users the ability to switch between different base layers and switch overlays on/off + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative = true) public class Layers extends Control{ @@ -53,7 +55,6 @@ public class Layers extends Control{ /** * Collapse the control container if expanded. * - * @param layer the layer * @return the l */ @JsMethod @@ -61,4 +62,4 @@ public class Layers extends Control{ -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/Map.java b/src/main/java/com/gwidgets/api/leaflet/Map.java index 67e9fa7..399a0f2 100644 --- a/src/main/java/com/gwidgets/api/leaflet/Map.java +++ b/src/main/java/com/gwidgets/api/leaflet/Map.java @@ -35,7 +35,9 @@ // TODO: Auto-generated Javadoc /** * The central class of the API. it is used to create a map on a page and manipulate it. + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative = true) public class Map implements Evented { @@ -92,7 +94,7 @@ private Map() { * @param options the map options * @return the L class */ - + @JsMethod public native L setView(LatLng center, double zoom, ZoomPanOptions options); @@ -217,7 +219,7 @@ public native L setZoomAround(LatLng latlng, double zoom, public native L setMaxBounds(LatLngBounds bounds, ZoomPanOptions options); /** - * Tries to locate the user using the Geolocation API, firing a locationfound event with location data on success or a locationerror event on failure, and optionally sets the map view to the user's location with respect to detection accuracy (or to the world view if geolocation failed). + * Tries to locate the user using the Geolocation API, firing a locationfound event with location data on success or a locationerror event on failure, and optionally sets the map view to the user's location with respect to detection accuracy (or to the world view if geolocation failed). * * @param options the locateOptions * @return the l @@ -248,7 +250,7 @@ public native L setZoomAround(LatLng latlng, double zoom, * * @return the center */ - + @JsMethod public native LatLng getCenter(); @@ -326,7 +328,7 @@ public native L setZoomAround(LatLng latlng, double zoom, * @param insertAtTheBottom the insert at the bottom flag * @return the L class */ - + @JsMethod public native L addLayer(Layer layer, Boolean insertAtTheBottom); @@ -393,7 +395,7 @@ public native L openPopup(HTMLElement el, LatLng latlng, PopupOptions options); /** - * Closes the popup previously opened with openPopup + * Closes the popup previously opened with openPopup * * @param popup the popup * @return the L class @@ -427,7 +429,7 @@ public native L openPopup(HTMLElement el, LatLng latlng, * @param latlng the latlng * @return the point */ - + @JsMethod public native Point latLngToLayerPoint(LatLng latlng); @@ -537,6 +539,7 @@ public native L openPopup(HTMLElement el, LatLng latlng, * Creates a new map pane with the given name if it doesn't exist already, then returns it. The pane is created as a children of container, or as a children of the main map pane if not set. * * @return the container + * @param name a {@link java.lang.String} object */ @JsMethod public native HTMLElement createPane(String name); @@ -545,6 +548,8 @@ public native L openPopup(HTMLElement el, LatLng latlng, * Creates a new map pane with the given name if it doesn't exist already, then returns it. The pane is created as a children of container, or as a children of the main map pane if not set. * * @return the container + * @param name a {@link java.lang.String} object + * @param container a {@link elemental2.dom.HTMLElement} object */ @JsMethod public native HTMLElement createPane(String name, HTMLElement container); @@ -571,60 +576,88 @@ public native L openPopup(HTMLElement el, LatLng latlng, /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#clearAllEventListeners() */ + /** + *

clearAllEventListeners.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L clearAllEventListeners(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#on(java.lang.String, com.gwidgets.api.leaflet.elemental.Function) */ + /** {@inheritDoc} */ public native L on(String type, EventCallback fn); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#once(java.lang.String, com.gwidgets.api.leaflet.elemental.Function) */ + /** {@inheritDoc} */ public native L once(String type, EventCallback fn); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#off(java.lang.String) */ + /** + *

off.

+ * + * @param type a {@link java.lang.String} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L off(String type); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#off(java.lang.String[]) */ + /** + *

off.

+ * + * @param type an array of {@link java.lang.String} objects + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L off(String[] type); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#off() */ + /** + *

off.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L off(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#fire(java.lang.String) */ + /** {@inheritDoc} */ public native L fire(String type); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#listens(java.lang.String) */ + /** {@inheritDoc} */ public native Boolean listens(String type); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#addEventParent(com.gwidgets.api.leaflet.Evented) */ + /** {@inheritDoc} */ public native L addEventParent(Evented obj); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#removeEventParent(com.gwidgets.api.leaflet.Evented) */ + /** {@inheritDoc} */ public native L removeEventParent(Evented obj); @JsFunction @@ -635,4 +668,4 @@ public interface EachLayerFunction { } -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/MapPanes.java b/src/main/java/com/gwidgets/api/leaflet/MapPanes.java index e8de209..13d475a 100644 --- a/src/main/java/com/gwidgets/api/leaflet/MapPanes.java +++ b/src/main/java/com/gwidgets/api/leaflet/MapPanes.java @@ -24,7 +24,9 @@ /** * An object literal (returned by map.getPanes) that contains different map panes that you can use to put your custom overlays in. The difference is mostly in zIndex order that such overlays get. + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType public class MapPanes { diff --git a/src/main/java/com/gwidgets/api/leaflet/Marker.java b/src/main/java/com/gwidgets/api/leaflet/Marker.java index a07615d..7bdd4c1 100644 --- a/src/main/java/com/gwidgets/api/leaflet/Marker.java +++ b/src/main/java/com/gwidgets/api/leaflet/Marker.java @@ -26,7 +26,9 @@ /** * Used to put markers on the map. + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative = true) public class Marker implements Layer, Evented { @@ -143,66 +145,95 @@ private Marker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#clearAllEventListeners() */ + /** + *

clearAllEventListeners.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L clearAllEventListeners(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#on(java.lang.String, com.gwidgets.api.leaflet.elemental.Function) */ + /** {@inheritDoc} */ public native L on(String type, EventCallback fn); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#once(java.lang.String, com.gwidgets.api.leaflet.elemental.Function) */ + /** {@inheritDoc} */ public native L once(String type, EventCallback fn); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#off(java.lang.String) */ + /** + *

off.

+ * + * @param type a {@link java.lang.String} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L off(String type); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#off(java.lang.String[]) */ + /** + *

off.

+ * + * @param type an array of {@link java.lang.String} objects + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L off(String[] type); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#off() */ + /** + *

off.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L off(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#fire(java.lang.String) */ + /** {@inheritDoc} */ public native L fire(String type); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#listens(java.lang.String) */ + /** {@inheritDoc} */ public native Boolean listens(String type); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#addEventParent(com.gwidgets.api.leaflet.Evented) */ + /** {@inheritDoc} */ public native L addEventParent(Evented obj); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#removeEventParent(com.gwidgets.api.leaflet.Evented) */ + /** {@inheritDoc} */ public native L removeEventParent(Evented obj); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindPopup(com.gwidgets.api.leaflet.elemental.HTMLElement, com.gwidgets.api.leaflet.options.PopupOptions) */ + /** {@inheritDoc} */ @JsMethod public native L bindPopup(HTMLElement content, PopupOptions options); @@ -210,6 +241,7 @@ private Marker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindPopup(java.lang.String, com.gwidgets.api.leaflet.options.PopupOptions) */ + /** {@inheritDoc} */ @JsMethod public native L bindPopup(String id, PopupOptions options); @@ -217,6 +249,11 @@ private Marker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#unbindPopup() */ + /** + *

unbindPopup.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L unbindPopup(); @@ -225,6 +262,7 @@ private Marker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#openPopup(com.gwidgets.api.leaflet.LatLng) */ + /** {@inheritDoc} */ @JsMethod public native L openPopup(LatLng latlng); @@ -232,6 +270,11 @@ private Marker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#closePopup() */ + /** + *

closePopup.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L closePopup(); @@ -239,6 +282,11 @@ private Marker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#togglePopup() */ + /** + *

togglePopup.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L togglePopup(); @@ -246,6 +294,11 @@ private Marker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#isPopupOpen() */ + /** + *

isPopupOpen.

+ * + * @return a boolean + */ @JsMethod public native boolean isPopupOpen(); @@ -253,6 +306,7 @@ private Marker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setPopupContent(java.lang.String) */ + /** {@inheritDoc} */ @JsMethod public native L setPopupContent(String content); @@ -260,6 +314,12 @@ private Marker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setPopupContent(com.gwidgets.api.leaflet.elemental.HTMLElement) */ + /** + *

setPopupContent.

+ * + * @param content a {@link elemental2.dom.HTMLElement} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L setPopupContent(HTMLElement content); @@ -267,6 +327,12 @@ private Marker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setPopupContent(com.gwidgets.api.leaflet.Popup) */ + /** + *

setPopupContent.

+ * + * @param content a {@link com.gwidgets.api.leaflet.Popup} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L setPopupContent(Popup content); @@ -274,6 +340,11 @@ private Marker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#getPopup() */ + /** + *

getPopup.

+ * + * @return a {@link com.gwidgets.api.leaflet.Popup} object + */ @JsMethod public native Popup getPopup(); @@ -281,89 +352,139 @@ private Marker() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindTooltip(java.lang.String, com.gwidgets.api.leaflet.options.TooltipOptions) */ + /** {@inheritDoc} */ public native L bindTooltip(String content, TooltipOptions options); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindTooltip(com.gwidgets.api.leaflet.elemental.HTMLElement, com.gwidgets.api.leaflet.options.TooltipOptions) */ + /** {@inheritDoc} */ public native L bindTooltip(HTMLElement content, TooltipOptions options); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindTooltip(com.gwidgets.api.leaflet.Tooltip, com.gwidgets.api.leaflet.options.TooltipOptions) */ + /** {@inheritDoc} */ public native L bindTooltip(Tooltip content, TooltipOptions options); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#unbindTooltip() */ + /** + *

unbindTooltip.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L unbindTooltip(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#openTooltip(com.gwidgets.api.leaflet.LatLng) */ + /** {@inheritDoc} */ public native L openTooltip(LatLng latlng); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#closeTooltip() */ + /** + *

closeTooltip.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L closeTooltip(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#toggleTooltip() */ + /** + *

toggleTooltip.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L toggleTooltip(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#isTooltipOpen() */ + /** + *

isTooltipOpen.

+ * + * @return a boolean + */ public native boolean isTooltipOpen(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setTooltipContent(java.lang.String) */ + /** + *

setTooltipContent.

+ * + * @param content a {@link java.lang.String} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L setTooltipContent(String content); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setTooltipContent(com.gwidgets.api.leaflet.elemental.HTMLElement) */ + /** {@inheritDoc} */ public native L setTooltipContent(HTMLElement content); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setTooltipContent(com.gwidgets.api.leaflet.Tooltip) */ + /** + *

setTooltipContent.

+ * + * @param content a {@link com.gwidgets.api.leaflet.Tooltip} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L setTooltipContent(Tooltip content); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#getTooltip() */ + /** + *

getTooltip.

+ * + * @return a {@link com.gwidgets.api.leaflet.Tooltip} object + */ public native Tooltip getTooltip(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#addTo(com.gwidgets.api.leaflet.Map) */ + /** {@inheritDoc} */ public native L addTo(Map map); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#remove() */ + /** + *

remove.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L remove(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#removeFrom(com.gwidgets.api.leaflet.Map) */ + /** {@inheritDoc} */ public native L removeFrom(Map map); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#getPane(java.lang.String) */ + /** {@inheritDoc} */ public native HTMLElement getPane(String name); -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/Path.java b/src/main/java/com/gwidgets/api/leaflet/Path.java index 5f16b5b..5b2a517 100644 --- a/src/main/java/com/gwidgets/api/leaflet/Path.java +++ b/src/main/java/com/gwidgets/api/leaflet/Path.java @@ -23,7 +23,9 @@ /** * An abstract class that contains options and constants shared between vector overlays (Polygon, Polyline, Circle). Do not use it directly. + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative = true) public abstract class Path { @@ -122,7 +124,7 @@ public abstract class Path { /** * Brings the layer to the bottom of all path layers. * - * @return the L class + * @return the L class */ @JsMethod public native L bringToBack(); @@ -136,4 +138,4 @@ public abstract class Path { public native L redraw(); -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/Point.java b/src/main/java/com/gwidgets/api/leaflet/Point.java index ee7404f..105b3f7 100644 --- a/src/main/java/com/gwidgets/api/leaflet/Point.java +++ b/src/main/java/com/gwidgets/api/leaflet/Point.java @@ -7,7 +7,9 @@ // TODO: Auto-generated Javadoc /** *Represents a point with x and y coordinates in pixels. + * *@author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative = true) public class Point { @@ -73,6 +75,11 @@ public class Point { /* (non-Javadoc) * @see java.lang.Object#clone() */ + /** + *

clone.

+ * + * @return a {@link com.gwidgets.api.leaflet.Point} object + */ @JsMethod public native Point clone(); @@ -87,6 +94,7 @@ public class Point { /** * Returns a copy of the current point with floored coordinates (rounded down). + * * @return the point */ @JsMethod @@ -115,7 +123,12 @@ public class Point { /* (non-Javadoc) * @see java.lang.Object#toString() */ + /** + *

toString.

+ * + * @return a {@link java.lang.String} object + */ @JsMethod public native String toString(); -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/Polygon.java b/src/main/java/com/gwidgets/api/leaflet/Polygon.java index 41d173e..cc79be0 100644 --- a/src/main/java/com/gwidgets/api/leaflet/Polygon.java +++ b/src/main/java/com/gwidgets/api/leaflet/Polygon.java @@ -22,13 +22,18 @@ /** * A class for drawing polygon overlays on a map. Extends Polyline. Use addLayer method of map to add it to the map. * Note that points you pass when creating a polygon shouldn't have an additional last point equal to the first one — it's better to filter out such points. + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative = true) public class Polygon extends Polyline { + /** + *

Constructor for Polygon.

+ */ protected Polygon() { super(); } @@ -36,7 +41,12 @@ protected Polygon() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Polyline#toGeoJSON() */ + /** + *

toGeoJSON.

+ * + * @return a {@link elemental2.core.JsObject} object + */ @JsMethod public native JsObject toGeoJSON(); -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/Polyline.java b/src/main/java/com/gwidgets/api/leaflet/Polyline.java index 44c75c9..45512a4 100644 --- a/src/main/java/com/gwidgets/api/leaflet/Polyline.java +++ b/src/main/java/com/gwidgets/api/leaflet/Polyline.java @@ -26,13 +26,18 @@ // TODO: Auto-generated Javadoc /** * A class for drawing polyline overlays on a map. Extends Path. Use addLayer of the class Map to add it to the map. + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative = true) public class Polyline extends Path implements Layer, Evented { + /** + *

Constructor for Polyline.

+ */ protected Polyline() { } @@ -78,6 +83,11 @@ public native LatLng[] spliceLatLngs(double index, double pointsToRemove, /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Path#getBounds() */ + /** + *

getBounds.

+ * + * @return a {@link com.gwidgets.api.leaflet.LatLngBounds} object + */ @JsMethod public native LatLngBounds getBounds(); @@ -92,6 +102,7 @@ public native LatLng[] spliceLatLngs(double index, double pointsToRemove, /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindPopup(com.gwidgets.api.leaflet.elemental.HTMLElement, com.gwidgets.api.leaflet.options.PopupOptions) */ + /** {@inheritDoc} */ @JsMethod public native L bindPopup(HTMLElement content, PopupOptions options); @@ -99,6 +110,7 @@ public native LatLng[] spliceLatLngs(double index, double pointsToRemove, /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindPopup(java.lang.String, com.gwidgets.api.leaflet.options.PopupOptions) */ + /** {@inheritDoc} */ @JsMethod public native L bindPopup(String id, PopupOptions options); @@ -106,6 +118,11 @@ public native LatLng[] spliceLatLngs(double index, double pointsToRemove, /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#unbindPopup() */ + /** + *

unbindPopup.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L unbindPopup(); @@ -114,6 +131,7 @@ public native LatLng[] spliceLatLngs(double index, double pointsToRemove, /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#openPopup(com.gwidgets.api.leaflet.LatLng) */ + /** {@inheritDoc} */ @JsMethod public native L openPopup(LatLng latlng); @@ -121,6 +139,11 @@ public native LatLng[] spliceLatLngs(double index, double pointsToRemove, /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#closePopup() */ + /** + *

closePopup.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L closePopup(); @@ -128,6 +151,11 @@ public native LatLng[] spliceLatLngs(double index, double pointsToRemove, /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#togglePopup() */ + /** + *

togglePopup.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L togglePopup(); @@ -135,6 +163,11 @@ public native LatLng[] spliceLatLngs(double index, double pointsToRemove, /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#isPopupOpen() */ + /** + *

isPopupOpen.

+ * + * @return a boolean + */ @JsMethod public native boolean isPopupOpen(); @@ -142,6 +175,7 @@ public native LatLng[] spliceLatLngs(double index, double pointsToRemove, /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setPopupContent(java.lang.String) */ + /** {@inheritDoc} */ @JsMethod public native L setPopupContent(String content); @@ -149,6 +183,12 @@ public native LatLng[] spliceLatLngs(double index, double pointsToRemove, /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setPopupContent(com.gwidgets.api.leaflet.elemental.HTMLElement) */ + /** + *

setPopupContent.

+ * + * @param content a {@link elemental2.dom.HTMLElement} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L setPopupContent(HTMLElement content); @@ -156,6 +196,12 @@ public native LatLng[] spliceLatLngs(double index, double pointsToRemove, /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setPopupContent(com.gwidgets.api.leaflet.Popup) */ + /** + *

setPopupContent.

+ * + * @param content a {@link com.gwidgets.api.leaflet.Popup} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L setPopupContent(Popup content); @@ -163,6 +209,11 @@ public native LatLng[] spliceLatLngs(double index, double pointsToRemove, /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#getPopup() */ + /** + *

getPopup.

+ * + * @return a {@link com.gwidgets.api.leaflet.Popup} object + */ @JsMethod public native Popup getPopup(); @@ -170,150 +221,228 @@ public native LatLng[] spliceLatLngs(double index, double pointsToRemove, /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindTooltip(java.lang.String, com.gwidgets.api.leaflet.options.TooltipOptions) */ + /** {@inheritDoc} */ public native L bindTooltip(String content, TooltipOptions options); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindTooltip(com.gwidgets.api.leaflet.elemental.HTMLElement, com.gwidgets.api.leaflet.options.TooltipOptions) */ + /** {@inheritDoc} */ public native L bindTooltip(HTMLElement content, TooltipOptions options); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindTooltip(com.gwidgets.api.leaflet.Tooltip, com.gwidgets.api.leaflet.options.TooltipOptions) */ + /** {@inheritDoc} */ public native L bindTooltip(Tooltip content, TooltipOptions options); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#unbindTooltip() */ + /** + *

unbindTooltip.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L unbindTooltip(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#openTooltip(com.gwidgets.api.leaflet.LatLng) */ + /** {@inheritDoc} */ public native L openTooltip(LatLng latlng); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#closeTooltip() */ + /** + *

closeTooltip.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L closeTooltip(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#toggleTooltip() */ + /** + *

toggleTooltip.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L toggleTooltip(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#isTooltipOpen() */ + /** + *

isTooltipOpen.

+ * + * @return a boolean + */ public native boolean isTooltipOpen(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setTooltipContent(java.lang.String) */ + /** + *

setTooltipContent.

+ * + * @param content a {@link java.lang.String} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L setTooltipContent(String content); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setTooltipContent(com.gwidgets.api.leaflet.elemental.HTMLElement) */ + /** {@inheritDoc} */ public native L setTooltipContent(HTMLElement content); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setTooltipContent(com.gwidgets.api.leaflet.Tooltip) */ + /** + *

setTooltipContent.

+ * + * @param content a {@link com.gwidgets.api.leaflet.Tooltip} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L setTooltipContent(Tooltip content); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#getTooltip() */ + /** + *

getTooltip.

+ * + * @return a {@link com.gwidgets.api.leaflet.Tooltip} object + */ public native Tooltip getTooltip(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#addTo(com.gwidgets.api.leaflet.Map) */ + /** {@inheritDoc} */ public native L addTo(Map map); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#remove() */ + /** + *

remove.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L remove(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#removeFrom(com.gwidgets.api.leaflet.Map) */ + /** {@inheritDoc} */ public native L removeFrom(Map map); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#getPane(java.lang.String) */ + /** {@inheritDoc} */ public native HTMLElement getPane(String name); // Events /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#clearAllEventListeners() */ + /** + *

clearAllEventListeners.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L clearAllEventListeners(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#on(java.lang.String, com.gwidgets.api.leaflet.elemental.Function) */ + /** {@inheritDoc} */ public native L on(String type, EventCallback fn); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#once(java.lang.String, com.gwidgets.api.leaflet.elemental.Function) */ + /** {@inheritDoc} */ public native L once(String type, EventCallback fn); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#off(java.lang.String) */ + /** + *

off.

+ * + * @param type a {@link java.lang.String} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L off(String type); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#off(java.lang.String[]) */ + /** + *

off.

+ * + * @param type an array of {@link java.lang.String} objects + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L off(String[] type); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#off() */ + /** + *

off.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L off(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#fire(java.lang.String) */ + /** {@inheritDoc} */ public native L fire(String type); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#listens(java.lang.String) */ + /** {@inheritDoc} */ public native Boolean listens(String type); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#addEventParent(com.gwidgets.api.leaflet.Evented) */ + /** {@inheritDoc} */ public native L addEventParent(Evented obj); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#removeEventParent(com.gwidgets.api.leaflet.Evented) */ + /** {@inheritDoc} */ public native L removeEventParent(Evented obj); -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/Popup.java b/src/main/java/com/gwidgets/api/leaflet/Popup.java index 669b40d..25cbf27 100644 --- a/src/main/java/com/gwidgets/api/leaflet/Popup.java +++ b/src/main/java/com/gwidgets/api/leaflet/Popup.java @@ -10,6 +10,9 @@ /** * Used to open popups in certain places of the map. Use openPopup of the Map class to open popups while making sure that only one popup is open at one time (recommended for usability), or use of addLayer method of the Map class to open as many as you want. + * + * @author zakaria + * @version $Id: $Id */ @JsType(isNative = true) public class Popup extends DivOverlay implements Layer, Evented{ @@ -17,6 +20,9 @@ public class Popup extends DivOverlay implements Layer, Evented{ + /** + *

Constructor for Popup.

+ */ protected Popup() { super(); } @@ -121,6 +127,7 @@ protected Popup() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindPopup(com.gwidgets.api.leaflet.elemental.HTMLElement, com.gwidgets.api.leaflet.options.PopupOptions) */ + /** {@inheritDoc} */ @JsMethod public native L bindPopup(HTMLElement content, PopupOptions options); @@ -128,6 +135,7 @@ protected Popup() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindPopup(java.lang.String, com.gwidgets.api.leaflet.options.PopupOptions) */ + /** {@inheritDoc} */ @JsMethod public native L bindPopup(String id, PopupOptions options); @@ -135,6 +143,11 @@ protected Popup() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#unbindPopup() */ + /** + *

unbindPopup.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L unbindPopup(); @@ -143,6 +156,7 @@ protected Popup() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#openPopup(com.gwidgets.api.leaflet.LatLng) */ + /** {@inheritDoc} */ @JsMethod public native L openPopup(LatLng latlng); @@ -150,6 +164,11 @@ protected Popup() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#closePopup() */ + /** + *

closePopup.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L closePopup(); @@ -157,6 +176,11 @@ protected Popup() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#togglePopup() */ + /** + *

togglePopup.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L togglePopup(); @@ -164,6 +188,11 @@ protected Popup() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#isPopupOpen() */ + /** + *

isPopupOpen.

+ * + * @return a boolean + */ @JsMethod public native boolean isPopupOpen(); @@ -171,6 +200,7 @@ protected Popup() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setPopupContent(java.lang.String) */ + /** {@inheritDoc} */ @JsMethod public native L setPopupContent(String content); @@ -178,6 +208,12 @@ protected Popup() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setPopupContent(com.gwidgets.api.leaflet.elemental.HTMLElement) */ + /** + *

setPopupContent.

+ * + * @param content a {@link elemental2.dom.HTMLElement} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L setPopupContent(HTMLElement content); @@ -185,6 +221,12 @@ protected Popup() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setPopupContent(com.gwidgets.api.leaflet.Popup) */ + /** + *

setPopupContent.

+ * + * @param content a {@link com.gwidgets.api.leaflet.Popup} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L setPopupContent(Popup content); @@ -192,6 +234,11 @@ protected Popup() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#getPopup() */ + /** + *

getPopup.

+ * + * @return a {@link com.gwidgets.api.leaflet.Popup} object + */ @JsMethod public native Popup getPopup(); @@ -199,90 +246,140 @@ protected Popup() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindTooltip(java.lang.String, com.gwidgets.api.leaflet.options.TooltipOptions) */ + /** {@inheritDoc} */ public native L bindTooltip(String content, TooltipOptions options); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindTooltip(com.gwidgets.api.leaflet.elemental.HTMLElement, com.gwidgets.api.leaflet.options.TooltipOptions) */ + /** {@inheritDoc} */ public native L bindTooltip(HTMLElement content, TooltipOptions options); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindTooltip(com.gwidgets.api.leaflet.Tooltip, com.gwidgets.api.leaflet.options.TooltipOptions) */ + /** {@inheritDoc} */ public native L bindTooltip(Tooltip content, TooltipOptions options); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#unbindTooltip() */ + /** + *

unbindTooltip.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L unbindTooltip(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#openTooltip(com.gwidgets.api.leaflet.LatLng) */ + /** {@inheritDoc} */ public native L openTooltip(LatLng latlng); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#closeTooltip() */ + /** + *

closeTooltip.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L closeTooltip(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#toggleTooltip() */ + /** + *

toggleTooltip.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L toggleTooltip(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#isTooltipOpen() */ + /** + *

isTooltipOpen.

+ * + * @return a boolean + */ public native boolean isTooltipOpen(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setTooltipContent(java.lang.String) */ + /** + *

setTooltipContent.

+ * + * @param content a {@link java.lang.String} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L setTooltipContent(String content); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setTooltipContent(com.gwidgets.api.leaflet.elemental.HTMLElement) */ + /** {@inheritDoc} */ public native L setTooltipContent(HTMLElement content); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setTooltipContent(com.gwidgets.api.leaflet.Tooltip) */ + /** + *

setTooltipContent.

+ * + * @param content a {@link com.gwidgets.api.leaflet.Tooltip} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L setTooltipContent(Tooltip content); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#getTooltip() */ + /** + *

getTooltip.

+ * + * @return a {@link com.gwidgets.api.leaflet.Tooltip} object + */ public native Tooltip getTooltip(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#addTo(com.gwidgets.api.leaflet.Map) */ + /** {@inheritDoc} */ public native L addTo(Map map); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#remove() */ + /** + *

remove.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L remove(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#removeFrom(com.gwidgets.api.leaflet.Map) */ + /** {@inheritDoc} */ public native L removeFrom(Map map); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#getPane(java.lang.String) */ + /** {@inheritDoc} */ public native HTMLElement getPane(String name); @@ -292,62 +389,90 @@ protected Popup() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#clearAllEventListeners() */ + /** + *

clearAllEventListeners.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L clearAllEventListeners(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#on(java.lang.String, com.gwidgets.api.leaflet.elemental.Function) */ + /** {@inheritDoc} */ public native L on(String type, EventCallback fn); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#once(java.lang.String, com.gwidgets.api.leaflet.elemental.Function) */ + /** {@inheritDoc} */ public native L once(String type, EventCallback fn); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#off(java.lang.String) */ + /** + *

off.

+ * + * @param type a {@link java.lang.String} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L off(String type); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#off(java.lang.String[]) */ + /** + *

off.

+ * + * @param type an array of {@link java.lang.String} objects + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L off(String[] type); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#off() */ + /** + *

off.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L off(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#fire(java.lang.String) */ + /** {@inheritDoc} */ public native L fire(String type); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#listens(java.lang.String) */ + /** {@inheritDoc} */ public native Boolean listens(String type); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#addEventParent(com.gwidgets.api.leaflet.Evented) */ + /** {@inheritDoc} */ public native L addEventParent(Evented obj); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#removeEventParent(com.gwidgets.api.leaflet.Evented) */ + /** {@inheritDoc} */ public native L removeEventParent(Evented obj); -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/Projection.java b/src/main/java/com/gwidgets/api/leaflet/Projection.java index eb7e285..a8ddca9 100644 --- a/src/main/java/com/gwidgets/api/leaflet/Projection.java +++ b/src/main/java/com/gwidgets/api/leaflet/Projection.java @@ -20,7 +20,9 @@ /** * An object with methods for projecting geographical coordinates of the world onto a flat surface (and back). + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative = true) public class Projection { @@ -51,4 +53,4 @@ private Projection() { @JsMethod public native LatLng unproject(Point point); -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/Rectangle.java b/src/main/java/com/gwidgets/api/leaflet/Rectangle.java index e3f521b..0aa9433 100644 --- a/src/main/java/com/gwidgets/api/leaflet/Rectangle.java +++ b/src/main/java/com/gwidgets/api/leaflet/Rectangle.java @@ -20,7 +20,9 @@ /** * A class for drawing rectangle overlays on a map. Extends Polygon. - * @author Zakaria Amine + * + * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative = true) public class Rectangle extends Polygon{ @@ -34,10 +36,10 @@ private Rectangle() { /** * Redraws the rectangle with the passed bounds. * - * @param bounds + * @param bounds a {@link com.gwidgets.api.leaflet.LatLngBounds} object * @return the L class */ @JsMethod public native L setBounds(LatLngBounds bounds); -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/Renderer.java b/src/main/java/com/gwidgets/api/leaflet/Renderer.java index 571c778..c5860c8 100644 --- a/src/main/java/com/gwidgets/api/leaflet/Renderer.java +++ b/src/main/java/com/gwidgets/api/leaflet/Renderer.java @@ -8,12 +8,21 @@ import jsinterop.annotations.JsMethod; import jsinterop.annotations.JsType; +/** + *

Renderer class.

+ * + * @author zakaria + * @version $Id: $Id + */ @JsType(isNative = true) public class Renderer implements Evented, Layer { + /** + *

Constructor for Renderer.

+ */ protected Renderer() { } @@ -23,65 +32,94 @@ protected Renderer() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#clearAllEventListeners() */ + /** + *

clearAllEventListeners.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L clearAllEventListeners(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#on(java.lang.String, com.gwidgets.api.leaflet.elemental.Function) */ + /** {@inheritDoc} */ public native L on(String type, EventCallback fn); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#once(java.lang.String, com.gwidgets.api.leaflet.elemental.Function) */ + /** {@inheritDoc} */ public native L once(String type, EventCallback fn); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#off(java.lang.String) */ + /** + *

off.

+ * + * @param type a {@link java.lang.String} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L off(String type); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#off(java.lang.String[]) */ + /** + *

off.

+ * + * @param type an array of {@link java.lang.String} objects + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L off(String[] type); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#off() */ + /** + *

off.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L off(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#fire(java.lang.String) */ + /** {@inheritDoc} */ public native L fire(String type); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#listens(java.lang.String) */ + /** {@inheritDoc} */ public native Boolean listens(String type); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#addEventParent(com.gwidgets.api.leaflet.Evented) */ + /** {@inheritDoc} */ public native L addEventParent(Evented obj); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#removeEventParent(com.gwidgets.api.leaflet.Evented) */ + /** {@inheritDoc} */ public native L removeEventParent(Evented obj); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindPopup(com.gwidgets.api.leaflet.elemental.HTMLElement, com.gwidgets.api.leaflet.options.PopupOptions) */ + /** {@inheritDoc} */ @JsMethod public native L bindPopup(HTMLElement content, PopupOptions options); @@ -89,6 +127,7 @@ protected Renderer() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindPopup(java.lang.String, com.gwidgets.api.leaflet.options.PopupOptions) */ + /** {@inheritDoc} */ @JsMethod public native L bindPopup(String id, PopupOptions options); @@ -96,6 +135,11 @@ protected Renderer() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#unbindPopup() */ + /** + *

unbindPopup.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L unbindPopup(); @@ -104,6 +148,7 @@ protected Renderer() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#openPopup(com.gwidgets.api.leaflet.LatLng) */ + /** {@inheritDoc} */ @JsMethod public native L openPopup(LatLng latlng); @@ -111,6 +156,11 @@ protected Renderer() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#closePopup() */ + /** + *

closePopup.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L closePopup(); @@ -118,6 +168,11 @@ protected Renderer() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#togglePopup() */ + /** + *

togglePopup.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L togglePopup(); @@ -125,6 +180,11 @@ protected Renderer() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#isPopupOpen() */ + /** + *

isPopupOpen.

+ * + * @return a boolean + */ @JsMethod public native boolean isPopupOpen(); @@ -132,6 +192,7 @@ protected Renderer() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setPopupContent(java.lang.String) */ + /** {@inheritDoc} */ @JsMethod public native L setPopupContent(String content); @@ -139,6 +200,12 @@ protected Renderer() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setPopupContent(com.gwidgets.api.leaflet.elemental.HTMLElement) */ + /** + *

setPopupContent.

+ * + * @param content a {@link elemental2.dom.HTMLElement} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L setPopupContent(HTMLElement content); @@ -146,6 +213,12 @@ protected Renderer() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setPopupContent(com.gwidgets.api.leaflet.Popup) */ + /** + *

setPopupContent.

+ * + * @param content a {@link com.gwidgets.api.leaflet.Popup} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L setPopupContent(Popup content); @@ -153,6 +226,11 @@ protected Renderer() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#getPopup() */ + /** + *

getPopup.

+ * + * @return a {@link com.gwidgets.api.leaflet.Popup} object + */ @JsMethod public native Popup getPopup(); @@ -160,90 +238,140 @@ protected Renderer() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindTooltip(java.lang.String, com.gwidgets.api.leaflet.options.TooltipOptions) */ + /** {@inheritDoc} */ public native L bindTooltip(String content, TooltipOptions options); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindTooltip(com.gwidgets.api.leaflet.elemental.HTMLElement, com.gwidgets.api.leaflet.options.TooltipOptions) */ + /** {@inheritDoc} */ public native L bindTooltip(HTMLElement content, TooltipOptions options); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindTooltip(com.gwidgets.api.leaflet.Tooltip, com.gwidgets.api.leaflet.options.TooltipOptions) */ + /** {@inheritDoc} */ public native L bindTooltip(Tooltip content, TooltipOptions options); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#unbindTooltip() */ + /** + *

unbindTooltip.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L unbindTooltip(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#openTooltip(com.gwidgets.api.leaflet.LatLng) */ + /** {@inheritDoc} */ public native L openTooltip(LatLng latlng); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#closeTooltip() */ + /** + *

closeTooltip.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L closeTooltip(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#toggleTooltip() */ + /** + *

toggleTooltip.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L toggleTooltip(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#isTooltipOpen() */ + /** + *

isTooltipOpen.

+ * + * @return a boolean + */ public native boolean isTooltipOpen(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setTooltipContent(java.lang.String) */ + /** + *

setTooltipContent.

+ * + * @param content a {@link java.lang.String} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L setTooltipContent(String content); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setTooltipContent(com.gwidgets.api.leaflet.elemental.HTMLElement) */ + /** {@inheritDoc} */ public native L setTooltipContent(HTMLElement content); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setTooltipContent(com.gwidgets.api.leaflet.Tooltip) */ + /** + *

setTooltipContent.

+ * + * @param content a {@link com.gwidgets.api.leaflet.Tooltip} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L setTooltipContent(Tooltip content); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#getTooltip() */ + /** + *

getTooltip.

+ * + * @return a {@link com.gwidgets.api.leaflet.Tooltip} object + */ public native Tooltip getTooltip(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#addTo(com.gwidgets.api.leaflet.Map) */ + /** {@inheritDoc} */ public native L addTo(Map map); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#remove() */ + /** + *

remove.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L remove(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#removeFrom(com.gwidgets.api.leaflet.Map) */ + /** {@inheritDoc} */ public native L removeFrom(Map map); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#getPane(java.lang.String) */ + /** {@inheritDoc} */ public native HTMLElement getPane(String name); } diff --git a/src/main/java/com/gwidgets/api/leaflet/SVG.java b/src/main/java/com/gwidgets/api/leaflet/SVG.java index 2d285e9..bcd0870 100644 --- a/src/main/java/com/gwidgets/api/leaflet/SVG.java +++ b/src/main/java/com/gwidgets/api/leaflet/SVG.java @@ -5,6 +5,12 @@ import elemental2.svg.SVGElement; import jsinterop.annotations.JsType; +/** + *

SVG class.

+ * + * @author zakaria + * @version $Id: $Id + */ @JsType(isNative = true) public class SVG extends Renderer{ @@ -17,15 +23,22 @@ private SVG() { } - /** Returns a instance of SVGElement, corresponding to the class name passed. For example, using 'line' will return an instance of SVGLineElement. - * @return SVGElement - */ + /** + * Returns a instance of SVGElement, corresponding to the class name passed. For example, using 'line' will return an instance of SVGLineElement. + * + * @return SVGElement + * @param name a {@link java.lang.String} object + */ public static native SVGElement create(String name); - /** Generates a SVG path string for multiple rings, with each ring turning into "M..L..L.." instructions - * @return String the path string - */ + /** + * Generates a SVG path string for multiple rings, with each ring turning into "M..L..L.." instructions + * + * @return String the path string + * @param rings an array of {@link com.gwidgets.api.leaflet.Point} objects + * @param closed a {@link java.lang.Boolean} object + */ public static native String pointsToPath(Point[] rings, Boolean closed); } diff --git a/src/main/java/com/gwidgets/api/leaflet/Scale.java b/src/main/java/com/gwidgets/api/leaflet/Scale.java index 0e96b3a..d4c0a55 100644 --- a/src/main/java/com/gwidgets/api/leaflet/Scale.java +++ b/src/main/java/com/gwidgets/api/leaflet/Scale.java @@ -18,11 +18,16 @@ /** * A simple scale control that shows the scale of the current center of screen in metric (m/km) and imperial (mi/ft) systems. Extends Control. + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative = true) public class Scale extends Control{ + /** + *

Constructor for Scale.

+ */ protected Scale() { super(); @@ -30,4 +35,4 @@ protected Scale() { -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/TileLayer.java b/src/main/java/com/gwidgets/api/leaflet/TileLayer.java index 101d6c4..55f4c73 100644 --- a/src/main/java/com/gwidgets/api/leaflet/TileLayer.java +++ b/src/main/java/com/gwidgets/api/leaflet/TileLayer.java @@ -23,6 +23,7 @@ * Used to load and display tile layers on the map,. * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative = true) public class TileLayer extends GridLayer{ @@ -31,6 +32,9 @@ public class TileLayer extends GridLayer{ + /** + *

Constructor for TileLayer.

+ */ protected TileLayer() { diff --git a/src/main/java/com/gwidgets/api/leaflet/Tooltip.java b/src/main/java/com/gwidgets/api/leaflet/Tooltip.java index 71ad094..da35b53 100644 --- a/src/main/java/com/gwidgets/api/leaflet/Tooltip.java +++ b/src/main/java/com/gwidgets/api/leaflet/Tooltip.java @@ -25,6 +25,9 @@ /** * The Class Tooltip. + * + * @author zakaria + * @version $Id: $Id */ @JsType(isNative = true) public class Tooltip extends DivOverlay implements Layer, Evented { @@ -40,6 +43,7 @@ private Tooltip() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindPopup(com.gwidgets.api.leaflet.elemental.HTMLElement, com.gwidgets.api.leaflet.options.PopupOptions) */ + /** {@inheritDoc} */ @JsMethod public native L bindPopup(HTMLElement content, PopupOptions options); @@ -47,6 +51,7 @@ private Tooltip() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindPopup(java.lang.String, com.gwidgets.api.leaflet.options.PopupOptions) */ + /** {@inheritDoc} */ @JsMethod public native L bindPopup(String id, PopupOptions options); @@ -54,6 +59,11 @@ private Tooltip() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#unbindPopup() */ + /** + *

unbindPopup.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L unbindPopup(); @@ -62,6 +72,7 @@ private Tooltip() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#openPopup(com.gwidgets.api.leaflet.LatLng) */ + /** {@inheritDoc} */ @JsMethod public native L openPopup(LatLng latlng); @@ -69,6 +80,11 @@ private Tooltip() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#closePopup() */ + /** + *

closePopup.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L closePopup(); @@ -76,6 +92,11 @@ private Tooltip() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#togglePopup() */ + /** + *

togglePopup.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L togglePopup(); @@ -83,6 +104,11 @@ private Tooltip() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#isPopupOpen() */ + /** + *

isPopupOpen.

+ * + * @return a boolean + */ @JsMethod public native boolean isPopupOpen(); @@ -90,6 +116,7 @@ private Tooltip() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setPopupContent(java.lang.String) */ + /** {@inheritDoc} */ @JsMethod public native L setPopupContent(String content); @@ -97,6 +124,12 @@ private Tooltip() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setPopupContent(com.gwidgets.api.leaflet.elemental.HTMLElement) */ + /** + *

setPopupContent.

+ * + * @param content a {@link elemental2.dom.HTMLElement} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L setPopupContent(HTMLElement content); @@ -104,6 +137,12 @@ private Tooltip() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setPopupContent(com.gwidgets.api.leaflet.Popup) */ + /** + *

setPopupContent.

+ * + * @param content a {@link com.gwidgets.api.leaflet.Popup} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ @JsMethod public native L setPopupContent(Popup content); @@ -111,6 +150,11 @@ private Tooltip() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#getPopup() */ + /** + *

getPopup.

+ * + * @return a {@link com.gwidgets.api.leaflet.Popup} object + */ @JsMethod public native Popup getPopup(); @@ -118,90 +162,140 @@ private Tooltip() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindTooltip(java.lang.String, com.gwidgets.api.leaflet.options.TooltipOptions) */ + /** {@inheritDoc} */ public native L bindTooltip(String content, TooltipOptions options); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindTooltip(com.gwidgets.api.leaflet.elemental.HTMLElement, com.gwidgets.api.leaflet.options.TooltipOptions) */ + /** {@inheritDoc} */ public native L bindTooltip(HTMLElement content, TooltipOptions options); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#bindTooltip(com.gwidgets.api.leaflet.Tooltip, com.gwidgets.api.leaflet.options.TooltipOptions) */ + /** {@inheritDoc} */ public native L bindTooltip(Tooltip content, TooltipOptions options); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#unbindTooltip() */ + /** + *

unbindTooltip.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L unbindTooltip(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#openTooltip(com.gwidgets.api.leaflet.LatLng) */ + /** {@inheritDoc} */ public native L openTooltip(LatLng latlng); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#closeTooltip() */ + /** + *

closeTooltip.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L closeTooltip(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#toggleTooltip() */ + /** + *

toggleTooltip.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L toggleTooltip(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#isTooltipOpen() */ + /** + *

isTooltipOpen.

+ * + * @return a boolean + */ public native boolean isTooltipOpen(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setTooltipContent(java.lang.String) */ + /** + *

setTooltipContent.

+ * + * @param content a {@link java.lang.String} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L setTooltipContent(String content); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setTooltipContent(com.gwidgets.api.leaflet.elemental.HTMLElement) */ + /** {@inheritDoc} */ public native L setTooltipContent(HTMLElement content); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#setTooltipContent(com.gwidgets.api.leaflet.Tooltip) */ + /** + *

setTooltipContent.

+ * + * @param content a {@link com.gwidgets.api.leaflet.Tooltip} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L setTooltipContent(Tooltip content); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#getTooltip() */ + /** + *

getTooltip.

+ * + * @return a {@link com.gwidgets.api.leaflet.Tooltip} object + */ public native Tooltip getTooltip(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#addTo(com.gwidgets.api.leaflet.Map) */ + /** {@inheritDoc} */ public native L addTo(Map map); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#remove() */ + /** + *

remove.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L remove(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#removeFrom(com.gwidgets.api.leaflet.Map) */ + /** {@inheritDoc} */ public native L removeFrom(Map map); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Layer#getPane(java.lang.String) */ + /** {@inheritDoc} */ public native HTMLElement getPane(String name); @@ -211,60 +305,88 @@ private Tooltip() { /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#clearAllEventListeners() */ + /** + *

clearAllEventListeners.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L clearAllEventListeners(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#on(java.lang.String, com.gwidgets.api.leaflet.elemental.Function) */ + /** {@inheritDoc} */ public native L on(String type, EventCallback fn); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#once(java.lang.String, com.gwidgets.api.leaflet.elemental.Function) */ + /** {@inheritDoc} */ public native L once(String type, EventCallback fn); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#off(java.lang.String) */ + /** + *

off.

+ * + * @param type a {@link java.lang.String} object + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L off(String type); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#off(java.lang.String[]) */ + /** + *

off.

+ * + * @param type an array of {@link java.lang.String} objects + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L off(String[] type); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#off() */ + /** + *

off.

+ * + * @return a {@link com.gwidgets.api.leaflet.L} object + */ public native L off(); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#fire(java.lang.String) */ + /** {@inheritDoc} */ public native L fire(String type); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#listens(java.lang.String) */ + /** {@inheritDoc} */ public native Boolean listens(String type); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#addEventParent(com.gwidgets.api.leaflet.Evented) */ + /** {@inheritDoc} */ public native L addEventParent(Evented obj); /* (non-Javadoc) * @see com.gwidgets.api.leaflet.Evented#removeEventParent(com.gwidgets.api.leaflet.Evented) */ + /** {@inheritDoc} */ public native L removeEventParent(Evented obj); diff --git a/src/main/java/com/gwidgets/api/leaflet/WMS.java b/src/main/java/com/gwidgets/api/leaflet/WMS.java index 3cbe7af..b77a1ea 100644 --- a/src/main/java/com/gwidgets/api/leaflet/WMS.java +++ b/src/main/java/com/gwidgets/api/leaflet/WMS.java @@ -20,8 +20,10 @@ import jsinterop.annotations.JsType; /** - * Used to display WMS services as tile layers on the map. + * Used to display WMS services as tile layers on the map. + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative = true) public class WMS extends TileLayer{ @@ -43,4 +45,4 @@ private WMS() { public static native L setParams(TileLayerWMSOptions params, Boolean noRedraw); -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/Zoom.java b/src/main/java/com/gwidgets/api/leaflet/Zoom.java index b8a8fa2..c536bb5 100644 --- a/src/main/java/com/gwidgets/api/leaflet/Zoom.java +++ b/src/main/java/com/gwidgets/api/leaflet/Zoom.java @@ -18,7 +18,9 @@ /** * A basic zoom control with two buttons (zoom in and zoom out). It is put on the map by default unless you set its zoomControl option to false. + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative = true) public class Zoom extends Control { @@ -29,4 +31,4 @@ private Zoom() { -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/events/DragEndEvent.java b/src/main/java/com/gwidgets/api/leaflet/events/DragEndEvent.java index 2457a32..64f483f 100644 --- a/src/main/java/com/gwidgets/api/leaflet/events/DragEndEvent.java +++ b/src/main/java/com/gwidgets/api/leaflet/events/DragEndEvent.java @@ -19,7 +19,9 @@ /** * The Class DragEndEvent. + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative=true, name="Object", namespace=jsinterop.annotations.JsPackage.GLOBAL) public class DragEndEvent extends Event { diff --git a/src/main/java/com/gwidgets/api/leaflet/events/ErrorEvent.java b/src/main/java/com/gwidgets/api/leaflet/events/ErrorEvent.java index c1b47ee..9afa3ad 100644 --- a/src/main/java/com/gwidgets/api/leaflet/events/ErrorEvent.java +++ b/src/main/java/com/gwidgets/api/leaflet/events/ErrorEvent.java @@ -19,7 +19,9 @@ /** * The Class ErrorEvent. + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative=true, name="Object", namespace=jsinterop.annotations.JsPackage.GLOBAL) public class ErrorEvent extends Event { @@ -46,4 +48,4 @@ private ErrorEvent(){ */ public final native double getCode(); -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/events/Event.java b/src/main/java/com/gwidgets/api/leaflet/events/Event.java index 025bbbb..23270b1 100644 --- a/src/main/java/com/gwidgets/api/leaflet/events/Event.java +++ b/src/main/java/com/gwidgets/api/leaflet/events/Event.java @@ -24,12 +24,17 @@ /** * The base event object. All other event objects contain these properties too. + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative=true, name="Object", namespace=jsinterop.annotations.JsPackage.GLOBAL) public class Event { + /** + *

Constructor for Event.

+ */ public Event(){ @@ -54,4 +59,4 @@ public Event(){ -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/events/EventCallback.java b/src/main/java/com/gwidgets/api/leaflet/events/EventCallback.java index 70c6577..49f0b71 100644 --- a/src/main/java/com/gwidgets/api/leaflet/events/EventCallback.java +++ b/src/main/java/com/gwidgets/api/leaflet/events/EventCallback.java @@ -4,9 +4,17 @@ /** * Created by zakaria on 7/2/2017. + * + * @author zakaria + * @version $Id: $Id */ @JsFunction public interface EventCallback { + /** + *

call.

+ * + * @param event a T object + */ void call(T event); } diff --git a/src/main/java/com/gwidgets/api/leaflet/events/EventTypes.java b/src/main/java/com/gwidgets/api/leaflet/events/EventTypes.java index 2ee39e7..42520c2 100644 --- a/src/main/java/com/gwidgets/api/leaflet/events/EventTypes.java +++ b/src/main/java/com/gwidgets/api/leaflet/events/EventTypes.java @@ -14,6 +14,12 @@ */ package com.gwidgets.api.leaflet.events; +/** + *

EventTypes class.

+ * + * @author zakaria + * @version $Id: $Id + */ public class EventTypes { private EventTypes() { diff --git a/src/main/java/com/gwidgets/api/leaflet/events/GeoJSONEvent.java b/src/main/java/com/gwidgets/api/leaflet/events/GeoJSONEvent.java index 56c9db1..5eb928b 100644 --- a/src/main/java/com/gwidgets/api/leaflet/events/GeoJSONEvent.java +++ b/src/main/java/com/gwidgets/api/leaflet/events/GeoJSONEvent.java @@ -21,7 +21,9 @@ /** * The Class GeoJSONEvent. + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative=true, name="Object", namespace=jsinterop.annotations.JsPackage.GLOBAL) public class GeoJSONEvent extends Event { @@ -64,4 +66,4 @@ private GeoJSONEvent() { @JsProperty public final native String getId(); -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/events/KeyboardEvent.java b/src/main/java/com/gwidgets/api/leaflet/events/KeyboardEvent.java index 424fda6..b3fb013 100644 --- a/src/main/java/com/gwidgets/api/leaflet/events/KeyboardEvent.java +++ b/src/main/java/com/gwidgets/api/leaflet/events/KeyboardEvent.java @@ -23,16 +23,21 @@ /** * The Class KeyboardEvent. + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative=true, name="Object", namespace=jsinterop.annotations.JsPackage.GLOBAL) public class KeyboardEvent extends Event { + /** + *

Constructor for KeyboardEvent.

+ */ protected KeyboardEvent() {} /** - * The original Dom KeyboardEvent that triggered this Leaflet event. + * The original Dom KeyboardEvent that triggered this Leaflet event. * * @return the popup */ diff --git a/src/main/java/com/gwidgets/api/leaflet/events/LayerEvent.java b/src/main/java/com/gwidgets/api/leaflet/events/LayerEvent.java index 49dbfba..31e8b51 100644 --- a/src/main/java/com/gwidgets/api/leaflet/events/LayerEvent.java +++ b/src/main/java/com/gwidgets/api/leaflet/events/LayerEvent.java @@ -22,7 +22,9 @@ /** * The Class LayerEvent. + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative=true, name="Object", namespace=jsinterop.annotations.JsPackage.GLOBAL) public class LayerEvent extends Event { @@ -41,4 +43,4 @@ private LayerEvent() { @JsProperty public final native Layer getLayer(); -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/events/LayersControlEvent.java b/src/main/java/com/gwidgets/api/leaflet/events/LayersControlEvent.java index b391294..66875ba 100644 --- a/src/main/java/com/gwidgets/api/leaflet/events/LayersControlEvent.java +++ b/src/main/java/com/gwidgets/api/leaflet/events/LayersControlEvent.java @@ -22,7 +22,9 @@ /** * The Class LayerControlEvent. + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative=true, name="Object", namespace=jsinterop.annotations.JsPackage.GLOBAL) public class LayersControlEvent extends Event { @@ -48,4 +50,4 @@ private LayersControlEvent() { @JsProperty public final native String getName(); -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/events/LocationEvent.java b/src/main/java/com/gwidgets/api/leaflet/events/LocationEvent.java index ffd6081..bdcf938 100644 --- a/src/main/java/com/gwidgets/api/leaflet/events/LocationEvent.java +++ b/src/main/java/com/gwidgets/api/leaflet/events/LocationEvent.java @@ -23,7 +23,9 @@ /** * The Class LocationEvent. + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative=true, name="Object", namespace=jsinterop.annotations.JsPackage.GLOBAL) public class LocationEvent extends Event { @@ -97,4 +99,4 @@ private LocationEvent(){} @JsProperty public final native double getTimestamp(); -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/events/MouseEvent.java b/src/main/java/com/gwidgets/api/leaflet/events/MouseEvent.java index 16b462d..4b3d598 100644 --- a/src/main/java/com/gwidgets/api/leaflet/events/MouseEvent.java +++ b/src/main/java/com/gwidgets/api/leaflet/events/MouseEvent.java @@ -23,7 +23,9 @@ /** * The Class MouseEvent. + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative=true, name="Object", namespace=jsinterop.annotations.JsPackage.GLOBAL) public class MouseEvent extends Event { @@ -64,4 +66,4 @@ private MouseEvent(){} public final native elemental2.dom.MouseEvent getOriginalEvent(); -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/events/PopupEvent.java b/src/main/java/com/gwidgets/api/leaflet/events/PopupEvent.java index c83e2b3..b1859de 100644 --- a/src/main/java/com/gwidgets/api/leaflet/events/PopupEvent.java +++ b/src/main/java/com/gwidgets/api/leaflet/events/PopupEvent.java @@ -22,7 +22,9 @@ /** * The Class PopupEvent. + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative=true, name="Object", namespace=jsinterop.annotations.JsPackage.GLOBAL) public class PopupEvent extends Event { @@ -38,4 +40,4 @@ private PopupEvent() {} @JsProperty public final native Popup getPopup(); -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/events/ResizeEvent.java b/src/main/java/com/gwidgets/api/leaflet/events/ResizeEvent.java index d59c8f4..9af87c4 100644 --- a/src/main/java/com/gwidgets/api/leaflet/events/ResizeEvent.java +++ b/src/main/java/com/gwidgets/api/leaflet/events/ResizeEvent.java @@ -22,7 +22,9 @@ /** * The Class ResizeEvent. + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative=true, name="Object", namespace=jsinterop.annotations.JsPackage.GLOBAL) public class ResizeEvent extends Event { @@ -48,4 +50,4 @@ private ResizeEvent(){} @JsProperty public final native Point getNewSize(); -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/events/TileErrorEvent.java b/src/main/java/com/gwidgets/api/leaflet/events/TileErrorEvent.java index 107d9ba..1622a03 100644 --- a/src/main/java/com/gwidgets/api/leaflet/events/TileErrorEvent.java +++ b/src/main/java/com/gwidgets/api/leaflet/events/TileErrorEvent.java @@ -23,7 +23,9 @@ /** * The Class TileErrorEvent. + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative=true, name="Object", namespace=jsinterop.annotations.JsPackage.GLOBAL) public class TileErrorEvent extends Event { @@ -43,7 +45,7 @@ private TileErrorEvent() { /** - * Point object with tile's x, y, and z (zoom level) coordinates. + * Point object with tile's x, y, and z (zoom level) coordinates. * * @return the coords */ diff --git a/src/main/java/com/gwidgets/api/leaflet/events/TileEvent.java b/src/main/java/com/gwidgets/api/leaflet/events/TileEvent.java index c8dc25f..1de1c3e 100644 --- a/src/main/java/com/gwidgets/api/leaflet/events/TileEvent.java +++ b/src/main/java/com/gwidgets/api/leaflet/events/TileEvent.java @@ -24,7 +24,9 @@ /** * The Class TileEvent. + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative=true, name="Object", namespace=jsinterop.annotations.JsPackage.GLOBAL) public class TileEvent extends Event { @@ -42,11 +44,11 @@ private TileEvent() {} public final native HTMLElement getTile(); /** - * Point object with tile's x, y, and z (zoom level) coordinates. + * Point object with tile's x, y, and z (zoom level) coordinates. * * @return the coords */ @JsProperty public final native Point getCoords(); -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/events/TooltipEvent.java b/src/main/java/com/gwidgets/api/leaflet/events/TooltipEvent.java index 2ed7973..95b06b1 100644 --- a/src/main/java/com/gwidgets/api/leaflet/events/TooltipEvent.java +++ b/src/main/java/com/gwidgets/api/leaflet/events/TooltipEvent.java @@ -24,7 +24,9 @@ // TODO: Auto-generated Javadoc /** * The Class TooltipEvent. + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative=true, name="Object", namespace=jsinterop.annotations.JsPackage.GLOBAL) public class TooltipEvent extends Event { diff --git a/src/main/java/com/gwidgets/api/leaflet/options/CircleOptions.java b/src/main/java/com/gwidgets/api/leaflet/options/CircleOptions.java index cdfa480..1f7eb7e 100644 --- a/src/main/java/com/gwidgets/api/leaflet/options/CircleOptions.java +++ b/src/main/java/com/gwidgets/api/leaflet/options/CircleOptions.java @@ -72,7 +72,7 @@ public Builder() { /** * Whether to draw stroke along the path. Set it to false to disable - * borders on polygons or circles.
+ * borders on polygons or circles. * default true * * @param stroke @@ -85,7 +85,7 @@ public Builder stroke(Boolean stroke) { } /** - * Stroke color.
+ * Stroke color. * default "#03f" * * @param color @@ -98,7 +98,7 @@ public Builder color(String color) { } /** - * Stroke width in pixels.
+ * Stroke width in pixels. * default 5 * * @param weight @@ -111,7 +111,7 @@ public Builder weight(Double weight) { } /** - * Stroke opacity.
+ * Stroke opacity. * default 0.5 * * @param opacity @@ -125,7 +125,7 @@ public Builder opacity(Double opacity) { /** * Whether to fill the path with color. Set it to false to disable - * filling on polygons or circles.
+ * filling on polygons or circles. * default true * * @param fill @@ -138,7 +138,7 @@ public Builder fill(Boolean fill) { } /** - * Fill color.
+ * Fill color. * default "#03f" * * @param fillColor @@ -151,7 +151,7 @@ public Builder fillColor(String fillColor) { } /** - * Fill opacity.
+ * Fill opacity. * default 0.2 * * @param fillOpacity @@ -167,7 +167,7 @@ public Builder fillOpacity(Double fillOpacity) { * A string that defines how the inside of a shape is determined. See * - * docs for more info
+ * docs for more info * * @param fillRule * the fill rule @@ -182,7 +182,7 @@ public Builder fillRule(String fillRule) { * A string that defines the stroke * dash pattern. Doesn't work on canvas-powered layers (e.g. Android - * 2).
+ * 2). * default "evenodd" * * @param dashArray @@ -197,7 +197,7 @@ public Builder dashArray(String dashArray) { /** * A string that defines - * shape to be used at the end of the stroke.
+ * shape to be used at the end of the stroke. * default null * * @param lineCap @@ -212,7 +212,7 @@ public Builder lineCap(String lineCap) { /** * A string that defines - * shape to be used at the corners of the stroke.
+ * shape to be used at the corners of the stroke. * default null * * @param lineJoin @@ -227,7 +227,7 @@ public Builder lineJoin(String lineJoin) { /** * Sets the pointer-events attribute on the path if SVG backend is used. - *
+ * * default null * * @param pointerEvents @@ -240,7 +240,7 @@ public Builder pointerEvents(String pointerEvents) { } /** - * Custom class name set on an element.
+ * Custom class name set on an element. * default empty string * * @param className diff --git a/src/main/java/com/gwidgets/api/leaflet/options/ControlAttributionOptions.java b/src/main/java/com/gwidgets/api/leaflet/options/ControlAttributionOptions.java index 2a06040..0a4d043 100644 --- a/src/main/java/com/gwidgets/api/leaflet/options/ControlAttributionOptions.java +++ b/src/main/java/com/gwidgets/api/leaflet/options/ControlAttributionOptions.java @@ -42,7 +42,7 @@ private ControlAttributionOptions(){ /** * Gets the position of the control (one of the map corners). See class constants for possible values - *
+ * *default "bottomright" * @return the position */ @@ -52,7 +52,7 @@ private ControlAttributionOptions(){ /** * Gets the prefix: The HTML text shown before the attributions. Pass false to disable. - *
+ * * default "lealflet" * @return the prefix */ @@ -81,9 +81,9 @@ public Builder(){ /** * The position of the control (one of the map corners). - *
+ * * default "bottomright" - *
+ * * possible values: "topleft", "topright", "bottomleft", "bottomright" * * @param position the position @@ -96,7 +96,7 @@ public Builder position(String position){ /** * The HTML text shown before the attributions. Pass false to disable. - *
+ * * default "Leaflet" * @param prefix the prefix * @return the builder diff --git a/src/main/java/com/gwidgets/api/leaflet/options/ControlLayersOptions.java b/src/main/java/com/gwidgets/api/leaflet/options/ControlLayersOptions.java index 64364df..25ebda5 100644 --- a/src/main/java/com/gwidgets/api/leaflet/options/ControlLayersOptions.java +++ b/src/main/java/com/gwidgets/api/leaflet/options/ControlLayersOptions.java @@ -45,7 +45,7 @@ private ControlLayersOptions(){ /** * Gets the position of the control (one of the map corners). - *
+ * * default "topright" * * @return the position @@ -57,7 +57,7 @@ private ControlLayersOptions(){ /** * Gets whether the control will be collapsed into an icon and expanded on mouse hover or touch. - *
+ * * default true * @return the collapsed */ @@ -68,7 +68,7 @@ private ControlLayersOptions(){ /** * Gets whether the control will assign zIndexes in increasing order to all of its layers so that the order is preserved when switching them on/off. - *
+ * * default true * @return the auto Z index */ @@ -97,9 +97,9 @@ public Builder(){ /** * The position of the control (one of the map corners). - *
+ * * default "topright" - *
+ * * possible values: "topleft", "topright", "bottomleft", "bottomright" * @param position the position * @return the builder @@ -108,7 +108,7 @@ public Builder(){ /** * If true, the control will be collapsed into an icon and expanded on mouse hover or touch. - *
+ * * default true * @param collapsed the collapsed * @return the builder @@ -117,7 +117,7 @@ public Builder(){ /** * If true, the control will assign zIndexes in increasing order to all of its layers so that the order is preserved when switching them on/off. - *
+ * * default true * @param autoZIndex the auto Z index * @return the builder diff --git a/src/main/java/com/gwidgets/api/leaflet/options/ControlOptions.java b/src/main/java/com/gwidgets/api/leaflet/options/ControlOptions.java index 38b3ab2..bd29ef6 100644 --- a/src/main/java/com/gwidgets/api/leaflet/options/ControlOptions.java +++ b/src/main/java/com/gwidgets/api/leaflet/options/ControlOptions.java @@ -40,7 +40,7 @@ private ControlOptions(){ /** * Gets The initial position of the control (one of the map corners). - *
+ * * default "topright" * @return the position */ @@ -64,9 +64,9 @@ public Builder() { /** * The initial position of the control (one of the map corners). - *
+ * * default "topright" - *
+ * * possible values: "topleft", "topright", "bottomleft", "bottomright" * @param position the position * @return the builder diff --git a/src/main/java/com/gwidgets/api/leaflet/options/ControlScaleOptions.java b/src/main/java/com/gwidgets/api/leaflet/options/ControlScaleOptions.java index 9eb0359..1ccefd3 100644 --- a/src/main/java/com/gwidgets/api/leaflet/options/ControlScaleOptions.java +++ b/src/main/java/com/gwidgets/api/leaflet/options/ControlScaleOptions.java @@ -49,7 +49,7 @@ private ControlScaleOptions() { /** * Gets the position of the control (one of the map corners) - *
+ * * default "bottomleft" * @return the position */ @@ -60,7 +60,7 @@ public final String getPosition() { /** * Gets Maximum width of the control in pixels. The width is set dynamically to show round values (e.g. 100, 200, 500). - *
+ * * default 100 * @return the max width */ @@ -71,7 +71,7 @@ public final double getMaxWidth() { /** * Gets Whether to show the metric scale line (m/km). - *
+ * * default true * @return the metric */ @@ -82,7 +82,7 @@ public final boolean getMetric() { /** * Gets Whether to show the imperial scale line (mi/ft). - *
+ * * default true * @return the imperial */ @@ -93,7 +93,7 @@ public final boolean getImperial() { /** * Gets whether the control is updated on moveend, otherwise it's always up-to-date (updated on move). - *
+ * * default false * @return the update when idle */ @@ -126,9 +126,9 @@ public Builder() { /** * The position of the control (one of the map corners - *
+ * * possible values: "topleft", "topright", "bottomleft", "bottomright" - *
+ * * @param position the position * @return the builder */ @@ -139,7 +139,7 @@ public Builder position(String position) { /** * Maximum width of the control in pixels. The width is set dynamically to show round values (e.g. 100, 200, 500). - *
+ * * default 100 * @param maxWidth the max width * @return the builder @@ -151,7 +151,7 @@ public Builder maxWidth(Double maxWidth) { /** * Whether to show the metric scale line (m/km). - *
+ * * default true * @param metric the metric * @return the builder @@ -163,7 +163,7 @@ public Builder metric(Boolean metric) { /** * Whether to show the imperial scale line (mi/ft). - *
+ * * default true * @param imperial the imperial * @return the builder @@ -175,7 +175,7 @@ public Builder imperial(Boolean imperial) { /** * If true, the control is updated on moveend, otherwise it's always up-to-date (updated on move). - *
+ * * default false * @param updateWhenIdle the update when idle * @return the builder diff --git a/src/main/java/com/gwidgets/api/leaflet/options/ControlZoomOptions.java b/src/main/java/com/gwidgets/api/leaflet/options/ControlZoomOptions.java index 7c603ea..dc14843 100644 --- a/src/main/java/com/gwidgets/api/leaflet/options/ControlZoomOptions.java +++ b/src/main/java/com/gwidgets/api/leaflet/options/ControlZoomOptions.java @@ -48,7 +48,7 @@ private ControlZoomOptions() { private String zoomOutTitle; /** - * Gets the position of the control (one of the map corners).
+ * Gets the position of the control (one of the map corners). * default "topleft" * * @return the position @@ -59,7 +59,7 @@ public final String getPosition() { } /** - * Gets The text set on the zoom in button.
+ * Gets The text set on the zoom in button. * default "+" * * @return the zoomInText @@ -70,7 +70,7 @@ public final String getZoomInText() { } /** - * Gets The text set on the zoom out button.
+ * Gets The text set on the zoom out button. * default "-" * * @return the zoomOutText @@ -81,7 +81,7 @@ public final String getZoomOutText() { } /** - * Gets The title set on the zoom in button.
+ * Gets The title set on the zoom in button. * default "Zoom in" * * @return the zoomInTitle @@ -92,7 +92,7 @@ public final String getzoomInTitle() { } /** - * Gets The title set on the zoom out button.
+ * Gets The title set on the zoom out button. * default "Zoom out" * * @return the zoomOutTitle @@ -119,8 +119,8 @@ public Builder() { } /** - * The position of the control (one of the map corners).
- * default "topleft"
+ * The position of the control (one of the map corners). + * default "topleft" * possible values: "topleft", "topright", "bottomleft", "bottomright" * * @param position @@ -134,7 +134,7 @@ public Builder position(String position) { } /** - * The text set on the zoom in button.
+ * The text set on the zoom in button. * default "+" * * @param zoomInText @@ -148,7 +148,7 @@ public Builder zoomInText(String zoomInText) { } /** - * The text set on the zoom out button.
+ * The text set on the zoom out button. * default "-" * * @param zoomOutText @@ -162,7 +162,7 @@ public Builder zoomOutText(String zoomOutText) { } /** - * The title set on the zoom in button.
+ * The title set on the zoom in button. * default "Zoom in" * * @param zoomInTitle @@ -176,7 +176,7 @@ public Builder zoomInTitle(String zoomInTitle) { } /** - * The title set on the zoom out button.
+ * The title set on the zoom out button. * default "Zoom out" * * @param zoomOutTitle diff --git a/src/main/java/com/gwidgets/api/leaflet/options/DivIconOptions.java b/src/main/java/com/gwidgets/api/leaflet/options/DivIconOptions.java index dc30522..f273e7a 100644 --- a/src/main/java/com/gwidgets/api/leaflet/options/DivIconOptions.java +++ b/src/main/java/com/gwidgets/api/leaflet/options/DivIconOptions.java @@ -25,8 +25,9 @@ /** * The Class DivIconOptions. - * + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative=true, namespace=GLOBAL, name="Object") public class DivIconOptions { @@ -149,46 +150,91 @@ private DivIconOptions() { } + /** + *

Getter for the field bgPos.

+ * + * @return a {@link com.gwidgets.api.leaflet.Point} object + */ @JsOverlay public final Point getBgPos() { return this.bgPos; } + /** + *

Getter for the field iconUrl.

+ * + * @return a {@link java.lang.String} object + */ @JsOverlay public final String getIconUrl() { return this.iconUrl; } + /** + *

Getter for the field iconRetinaUrl.

+ * + * @return a {@link java.lang.String} object + */ @JsOverlay public final String getIconRetinaUrl() { return this.iconRetinaUrl; } + /** + *

Getter for the field shadowUrl.

+ * + * @return a {@link java.lang.String} object + */ @JsOverlay public final String getShadowUrl() { return this.shadowUrl; } + /** + *

Getter for the field shadowRetinaUrl.

+ * + * @return a {@link java.lang.String} object + */ @JsOverlay public final String getShadowRetinaUrl() { return this.shadowRetinaUrl; } + /** + *

Getter for the field shadowSize.

+ * + * @return a {@link com.gwidgets.api.leaflet.Point} object + */ @JsOverlay public final Point getShadowSize() { return this.shadowSize; } + /** + *

Getter for the field shadowAnchor.

+ * + * @return a {@link com.gwidgets.api.leaflet.Point} object + */ @JsOverlay public final Point getShadowAnchor() { return this.shadowAnchor; } + /** + *

Getter for the field pane.

+ * + * @return a {@link java.lang.String} object + */ @JsOverlay public final String getPane() { return this.pane; } + /** + *

Getter for the field attribution.

+ * + * @return a {@link java.lang.String} object + */ @JsOverlay public final String getAttribution() { return this.attribution; } @@ -345,4 +391,4 @@ public DivIconOptions build(){ return options; } } -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/options/FitBoundsOptions.java b/src/main/java/com/gwidgets/api/leaflet/options/FitBoundsOptions.java index 2e9fb0b..b8f8d76 100644 --- a/src/main/java/com/gwidgets/api/leaflet/options/FitBoundsOptions.java +++ b/src/main/java/com/gwidgets/api/leaflet/options/FitBoundsOptions.java @@ -167,7 +167,7 @@ public Builder() { /** * Sets the amount of padding in the top left corner of a map container that shouldn't be accounted for when setting the view to fit bounds. Useful if you have some control overlays on the map like a sidebar and you don't want them to obscure objects you're zooming to. - *
+ * * default [0, 0] * * @param paddingTopLeft the padding top left @@ -180,7 +180,7 @@ public Builder paddingTopLeft(Point paddingTopLeft) { /** * The same for bottom right corner of the map. - *
+ * * default [0, 0] * * @param paddingBottomRight the padding bottom right @@ -193,7 +193,7 @@ public Builder paddingBottomRight(Point paddingBottomRight) { /** * Equivalent of setting both top left and bottom right padding to the same value. - *
+ * * default [0, 0] * * @param padding the padding @@ -206,7 +206,7 @@ public Builder padding(Point padding) { /** * The maximum possible zoom to use. - *
+ * * default null * * @param maxZoom the max zoom diff --git a/src/main/java/com/gwidgets/api/leaflet/options/GeoJSONOptions.java b/src/main/java/com/gwidgets/api/leaflet/options/GeoJSONOptions.java index f455194..f3d804e 100644 --- a/src/main/java/com/gwidgets/api/leaflet/options/GeoJSONOptions.java +++ b/src/main/java/com/gwidgets/api/leaflet/options/GeoJSONOptions.java @@ -3,7 +3,6 @@ import com.gwidgets.api.leaflet.LatLng; import com.gwidgets.api.leaflet.Layer; import com.gwidgets.api.leaflet.Marker; -import com.gwidgets.api.leaflet.utils.JsFn; import elemental2.core.JsObject; import jsinterop.annotations.JsFunction; @@ -49,10 +48,6 @@ public final String getAttribution() { /** * Function that will be used for creating layers for GeoJSON points (if not specified, simple markers will be created). - * - * @param featureData the feature data - * @param latlng the latlng - * @return the function */ @JsProperty public PointToLayerFunction pointToLayer; @@ -60,8 +55,6 @@ public final String getAttribution() { /** * Function that will be used to get style options for vector layers created for GeoJSON features. * - * @param featureData the feature data - * @return the function */ @JsProperty public StyleFunction style; @@ -69,28 +62,18 @@ public final String getAttribution() { /** * Function that will be called on each created feature layer. Useful for attaching events and popups to features. * - * @param featureData the feature data - * @param layer the layer - * @return the function */ @JsProperty public OnEachFeatureFunction onEachFeature; /** * Function that will be used to decide whether to show a feature or not. - * - * @param featureData the feature data - * @param layer the layer - * @return the function */ @JsProperty public FilterFunction filter; /** * Function that will be used for converting GeoJSON coordinates to LatLng points (if not specified, coords will be assumed to be WGS84 standard [longitude, latitude] values in degrees). - * - * @param coords the coords - * @return the function */ @JsProperty public CoordsToLatLngFunction coordsToLatLng; @@ -98,6 +81,12 @@ public final String getAttribution() { @JsFunction public interface PointToLayerFunction { + /** + * Function that will be used for creating layers for GeoJSON points (if not specified, simple markers will be created). + * + * @param feature data + * @param latLng the latlng + */ Marker apply(JsObject feature, LatLng latLng); } @@ -105,27 +94,51 @@ public interface PointToLayerFunction { @JsFunction public interface StyleFunction { - JsObject apply(JsObject feature); + /** + * Function that will be used to get style options for vector layers created for GeoJSON features. + * + * @param featureData the feature data + * @return the function + */ + JsObject apply(JsObject featureData); } @JsFunction public interface OnEachFeatureFunction { - JsObject apply(JsObject feature, Layer layer); + /** + * Function that will be called on each created feature layer. Useful for attaching events and popups to features. + * + * @param featureData the feature data + * @param layer the layer + */ + JsObject apply(JsObject featureData, Layer layer); } @JsFunction public interface FilterFunction { - + /** + * Function that will be used to decide whether to show a feature or not. + * + * @param feature the feature data + * @param layer the layer + */ JsObject apply(JsObject feature, Layer layer); } @JsFunction public interface CoordsToLatLngFunction { - LatLng apply(JsObject feature, Layer layer); + + /** + * Function that will be used for converting GeoJSON coordinates to LatLng points (if not specified, coords will be assumed to be WGS84 standard [longitude, latitude] values in degrees). + * + * @param coords the coords + * @param layer layer + */ + LatLng apply(JsObject coords, Layer layer); } } diff --git a/src/main/java/com/gwidgets/api/leaflet/options/GridLayerOptions.java b/src/main/java/com/gwidgets/api/leaflet/options/GridLayerOptions.java index ed24f3f..8b605c7 100644 --- a/src/main/java/com/gwidgets/api/leaflet/options/GridLayerOptions.java +++ b/src/main/java/com/gwidgets/api/leaflet/options/GridLayerOptions.java @@ -7,6 +7,12 @@ import jsinterop.annotations.JsOverlay; import jsinterop.annotations.JsType; +/** + *

GridLayerOptions class.

+ * + * @author zakaria + * @version $Id: $Id + */ @JsType(isNative=true, namespace=GLOBAL, name="Object") public class GridLayerOptions { @@ -43,73 +49,143 @@ private GridLayerOptions(){ } + /** + *

Getter for the field tileSize.

+ * + * @return a double + */ @JsOverlay public final double getTileSize() { return this.tileSize; } + /** + *

Getter for the field opacity.

+ * + * @return a double + */ @JsOverlay public final double getOpacity() { return this.opacity; } + /** + *

Getter for the field updateWhenIdle.

+ * + * @return a boolean + */ @JsOverlay public final boolean getUpdateWhenIdle() { return this.updateWhenIdle; } + /** + *

Getter for the field updateWhenZooming.

+ * + * @return a boolean + */ @JsOverlay public final boolean getUpdateWhenZooming() { return this.updateWhenZooming; } + /** + *

Getter for the field updateInterval.

+ * + * @return a double + */ @JsOverlay public final double getUpdateInterval() { return this.updateInterval; } + /** + *

Getter for the field attribution.

+ * + * @return a {@link java.lang.String} object + */ @JsOverlay public final String getAttribution() { return this.attribution; } + /** + *

Getter for the field zIndex.

+ * + * @return a double + */ @JsOverlay public final double getzIndex() { return this.zIndex; } + /** + *

Getter for the field bounds.

+ * + * @return a {@link com.gwidgets.api.leaflet.LatLngBounds} object + */ @JsOverlay public final LatLngBounds getBounds() { return this.bounds; } + /** + *

Getter for the field minZoom.

+ * + * @return a double + */ @JsOverlay public final double getMinZoom() { return this.minZoom; } + /** + *

Getter for the field maxZoom.

+ * + * @return a double + */ @JsOverlay public final double getMaxZoom() { return this.maxZoom; } + /** + *

Getter for the field noWrap.

+ * + * @return a boolean + */ @JsOverlay public final boolean getNoWrap() { return this.noWrap; } + /** + *

Getter for the field pane.

+ * + * @return a {@link java.lang.String} object + */ @JsOverlay public final String getPane() { return this.pane; } + /** + *

Getter for the field className.

+ * + * @return a {@link java.lang.String} object + */ @JsOverlay public final String getClassName() { return this.className; } + /** + *

Getter for the field keepBuffer.

+ * + * @return a double + */ @JsOverlay public final double getKeepBuffer() { return this.keepBuffer; @@ -212,4 +288,4 @@ public GridLayerOptions build(){ return options; } } -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/options/IconOptions.java b/src/main/java/com/gwidgets/api/leaflet/options/IconOptions.java index eaea2b2..647f542 100644 --- a/src/main/java/com/gwidgets/api/leaflet/options/IconOptions.java +++ b/src/main/java/com/gwidgets/api/leaflet/options/IconOptions.java @@ -25,8 +25,9 @@ /** * The Class IconOptions. - * + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative=true, namespace=GLOBAL, name="Object") public class IconOptions { @@ -77,7 +78,7 @@ private IconOptions(){ /** - * Gets the URL to the icon image + * Gets the URL to the icon image * * @return the icon url */ @@ -175,11 +176,21 @@ private IconOptions(){ return this.className; } + /** + *

Getter for the field pane.

+ * + * @return a {@link java.lang.String} object + */ @JsOverlay public final String getPane() { return this.pane; } + /** + *

Getter for the field attribution.

+ * + * @return a {@link java.lang.String} object + */ @JsOverlay public final String getAttribution() { return this.attribution; } @@ -351,4 +362,4 @@ public IconOptions build(){ return options; } } -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/options/ImageOverlayOptions.java b/src/main/java/com/gwidgets/api/leaflet/options/ImageOverlayOptions.java index cf490b1..6012fd5 100644 --- a/src/main/java/com/gwidgets/api/leaflet/options/ImageOverlayOptions.java +++ b/src/main/java/com/gwidgets/api/leaflet/options/ImageOverlayOptions.java @@ -112,7 +112,7 @@ public Builder() { /** * The opacity of the image overlay. - *
+ * * default 1.0 * @param opacity the opacity * @return the builder @@ -124,7 +124,7 @@ public Builder opacity(Double opacity){ /** * The attribution text of the image overlay. - *
+ * * default empty * @param attribution the attribution * @return the builder diff --git a/src/main/java/com/gwidgets/api/leaflet/options/LocateOptions.java b/src/main/java/com/gwidgets/api/leaflet/options/LocateOptions.java index 780252a..bec41ae 100644 --- a/src/main/java/com/gwidgets/api/leaflet/options/LocateOptions.java +++ b/src/main/java/com/gwidgets/api/leaflet/options/LocateOptions.java @@ -52,7 +52,7 @@ private LocateOptions() { /** * Gets whether continuous watching of location changes (instead of - * detecting it once) using W3C watchPosition method is set.
+ * detecting it once) using W3C watchPosition method is set. * default false * * @return the watch @@ -65,7 +65,7 @@ public final boolean getWatch() { /** * Gets whether If true, automatically sets the map view to the user * location with respect to detection accuracy, or to world view if - * geolocation failed.
+ * geolocation failed. * default false * * @return the sets the view @@ -77,7 +77,7 @@ public final boolean getSetView() { /** * Gets the maximum zoom for automatic view setting when using `setView` - * option.
+ * option. * default infinity * * @return the max zoom locate @@ -89,7 +89,7 @@ public final double getMaxZoom() { /** * Gets the number of milliseconds to wait for a response from geolocation - * before firing a locationerror event.
+ * before firing a locationerror event. * default 10000 * * @return the timeout @@ -102,7 +102,7 @@ public final double getTimeout() { /** * Gets the maximum age of detected location. If less than this amount of * milliseconds passed since last geolocation response, locate will return a - * cached location.
+ * cached location. * default 0 * * @return the maximum age @@ -115,7 +115,7 @@ public final double getMaximumAge() { /** * Gets whether high accuracy is enabled, see description in * the - * W3C spec .
+ * W3C spec . * default false * * @return the enable high accuracy @@ -152,7 +152,7 @@ public Builder() { /** * If true, starts continuous watching of location changes (instead of * detecting it once) using W3C watchPosition method. You can later stop - * watching using map.stopLocate() method.
+ * watching using map.stopLocate() method. * default false * * @param watch @@ -167,7 +167,7 @@ public Builder watch(Boolean watch) { /** * If true, automatically sets the map view to the user location with * respect to detection accuracy, or to world view if geolocation - * failed.
+ * failed. * default false * * @param setView @@ -181,10 +181,10 @@ public Builder setView(Boolean setView) { /** * The maximum zoom for automatic view setting when using `setView` - * option.
+ * option. * default infinity * - * @param maxZoomLocate + * @param maxZoom * the max zoom locate * @return the builder */ @@ -195,7 +195,7 @@ public Builder maxZoom(double maxZoom) { /** * Number of milliseconds to wait for a response from geolocation before - * firing a locationerror event.Timeout.
+ * firing a locationerror event.Timeout. * default 10000 * * @param timeout @@ -210,7 +210,7 @@ public Builder timeout(double timeout) { /** * Maximum age of detected location. If less than this amount of * milliseconds passed since last geolocation response, locate will - * return a cached location.
+ * return a cached location. * default 0 * * @param maximumAge @@ -225,7 +225,7 @@ public Builder maximumAge(double maximumAge) { /** * Gets whether high accuracy is enabled, see description in the W3C - * spec .
+ * spec . * default false * * @param enableHighAccuracy @@ -238,7 +238,7 @@ public Builder enableHighAccuracy(Boolean enableHighAccuracy) { } /** - * Builds the LocateOptions new instance
+ * Builds the LocateOptions new instance * * @return the locate options */ diff --git a/src/main/java/com/gwidgets/api/leaflet/options/MapOptions.java b/src/main/java/com/gwidgets/api/leaflet/options/MapOptions.java index d9f3c56..95dc7e0 100644 --- a/src/main/java/com/gwidgets/api/leaflet/options/MapOptions.java +++ b/src/main/java/com/gwidgets/api/leaflet/options/MapOptions.java @@ -196,7 +196,7 @@ private MapOptions() { /** * Gets the Initial geographical center of the map. - *
+ * * default null * @return the center */ @@ -207,7 +207,7 @@ public final LatLng getCenter() { /** * Gets Initial map zoom. - *
+ * * default 0 * @return the zoom */ @@ -219,7 +219,7 @@ public final double getZoom() { /** * Gets the Layers that will be added to the map initially. - *
+ * * default null * @return the layers */ @@ -229,7 +229,7 @@ public final double getZoom() { /** * Gets Minimum zoom level of the map. Overrides any minZoom set on map layers. - *
+ * * default 0 * @return the min zoom */ @@ -239,7 +239,7 @@ public final double getZoom() { /** * Gets Maximum zoom level of the map. This overrides any maxZoom set on map layers. - *
+ * * default 0 * @return the max zoom */ @@ -249,7 +249,7 @@ public final double getZoom() { /** * Gets the bounds that restricts the view if the option is set - *
+ * * * default null * @return the max bounds @@ -260,7 +260,7 @@ public final double getZoom() { /** * Gets Whether the map be draggable with mouse/touch or not. - *
+ * * * default true * @return the dragging @@ -271,7 +271,7 @@ public final double getZoom() { /** * Gets Whether the map can be zoomed by touch-dragging with two fingers. - *
+ * * * default true * @@ -283,7 +283,7 @@ public final double getZoom() { /** * Gets Whether the map can be zoomed by using the mouse wheel. If passed 'center', it will zoom to the center of the view regardless of where the mouse was. - *
+ * * * default true * @return the scroll wheel zoom @@ -294,7 +294,7 @@ public final double getZoom() { /** * Gets Whether the map can be zoomed in by double clicking on it and zoomed out by double clicking while holding shift. If passed 'center', double-click zoom will zoom to the center of the view regardless of where the mouse was. - *
+ * * * default true * @return the double click zoom @@ -305,7 +305,7 @@ public final double getZoom() { /** * Gets Whether the map can be zoomed to a rectangular area specified by dragging the mouse while pressing shift. - *
+ * * default true * @return the box zoom */ @@ -315,7 +315,7 @@ public final double getZoom() { /** * Gets mobile hacks for supporting instant taps (fixing 200ms click delay on iOS/Android) and touch holds (fired as contextmenu events). - *
+ * * default true * @return the tap */ @@ -325,7 +325,7 @@ public final double getZoom() { /** * Gets The max number of pixels a user can shift his finger during touch for it to be considered a valid tap. - *
+ * * default 15 * * @return the tap tolerance @@ -336,7 +336,7 @@ public final double getZoom() { /** * Gets Whether the map automatically handles browser window resize to update itself. - *
+ * * default true * @return the track resize */ @@ -346,7 +346,7 @@ public final double getZoom() { /** * With this option enabled, the map tracks when you pan to another "copy" of the world and seamlessly jumps to the original one so that all overlays like markers and vector layers are still visible. - *
+ * * default false * @return the world copy jump */ @@ -356,7 +356,7 @@ public final double getZoom() { /** * Gets whether the popups close when user clicks the map. - *
+ * * default true * @return the close popup on click */ @@ -366,7 +366,7 @@ public final double getZoom() { /** * Gets whether the map zooms beyond min/max zoom and then bounce back when pinch-zooming. - *
+ * * default true * @return the close popup on click */ @@ -376,7 +376,7 @@ public final double getZoom() { /** * Gets whether the map id focusable and allows users to navigate the map with keyboard arrows and +/- keys. - *
+ * * default true * @return the keyboard */ @@ -386,7 +386,7 @@ public final double getZoom() { /** * Gets Amount of pixels to pan when pressing an arrow key. - *
+ * * default 80 * * @return the keyboard pan offset @@ -398,7 +398,7 @@ public final double getZoom() { /** * Gets whether the panning of the map will have an inertia effect where the map builds momentum while dragging and continues moving in the same direction for some time. Feels especially nice on touch devices. - *
+ * * default true * @return the inertia */ @@ -408,7 +408,7 @@ public final double getZoom() { /** * Gets the rate with which the inertial movement slows down, in pixels/second2. - *
+ * * default 3000 * @return the inertia deceleration */ @@ -418,7 +418,7 @@ public final double getZoom() { /** * Gets the Max speed of the inertial movement, in pixels/second. - *
+ * * default 1500 * @return the inertia max speed */ @@ -429,7 +429,7 @@ public final double getZoom() { /** * Gets Whether the zoom control is added to the map by default. - *
+ * * default true * * @return the zoom control @@ -440,7 +440,7 @@ public final double getZoom() { /** * Gets Whether the attribution control is added to the map by default. - *
+ * * default true * @return the attribution control */ @@ -450,7 +450,7 @@ public final double getZoom() { /** * Gets Whether the tile fade animation is enabled. By default it's enabled in all browsers that support CSS3 Transitions except Android. - *
+ * * default true * @return the fade animation */ @@ -460,7 +460,7 @@ public final double getZoom() { /** * Gets Whether the tile zoom animation is enabled. By default it's enabled in all browsers that support CSS3 Transitions except Android. - *
+ * * * default true * @return the zoom animation @@ -471,7 +471,7 @@ public final double getZoom() { /** * Gets the value that will disable zoom animation if exceeded - *
+ * * default 4 * @return the zoom animation threshold */ @@ -481,7 +481,7 @@ public final double getZoom() { /** * Gets Whether markers animate their zoom with the zoom animation, if disabled they will disappear for the length of the animation. By default it's enabled in all browsers that support CSS3 Transitions except Android. - *
+ * * default true * @return the marker zoom animation */ @@ -780,7 +780,7 @@ public Builder closePopupOnClick(Boolean closePopupOnClick) { * Set it to false if you don't want the map to zoom beyond min/max zoom and then bounce back when pinch-zooming. * * default true - * @param closePopupOnClick true or false + * @param bounceAtZoomLimits true or false * @return the builder */ public Builder bounceAtZoomLimits(Boolean bounceAtZoomLimits) { @@ -804,7 +804,7 @@ public Builder keyboard(Boolean keyboard) { * Amount of pixels to pan when pressing an arrow key. * * default 80 - * @param keyboardPanOffset the keyboard pan offset + * @param keyboardPanDelta the keyboard pan offset * @return the builder */ public Builder keyboardPanDelta(double keyboardPanDelta) { diff --git a/src/main/java/com/gwidgets/api/leaflet/options/MarkerOptions.java b/src/main/java/com/gwidgets/api/leaflet/options/MarkerOptions.java index 51caf8d..6acf952 100644 --- a/src/main/java/com/gwidgets/api/leaflet/options/MarkerOptions.java +++ b/src/main/java/com/gwidgets/api/leaflet/options/MarkerOptions.java @@ -85,7 +85,7 @@ private MarkerOptions(){ /** * Gets Icon class to use for rendering the marker. Set to new L.Icon.Default() by default. - *
+ * * * @return the icon */ @@ -96,7 +96,7 @@ private MarkerOptions(){ /** * Gets whether the marker will not emit mouse events and will act as a part of the underlying map - *
+ * * default true * @return the clickable */ @@ -107,7 +107,7 @@ private MarkerOptions(){ /** * Gets Whether the marker is draggable with mouse/touch or not. - *
+ * * default false * @return the draggable */ @@ -118,7 +118,7 @@ private MarkerOptions(){ /** * Gets Whether the marker can be tabbed to with a keyboard and clicked by pressing enter. - *
+ * * default true * @return the keyboard */ @@ -129,7 +129,7 @@ private MarkerOptions(){ /** * Gets Text for the browser tooltip that appear on marker hover (no tooltip by default). - *
+ * * * @return the title */ @@ -139,7 +139,7 @@ private MarkerOptions(){ /** * Gets the text for the alt attribute of the icon image (useful for accessibility). - *
+ * * * @return the title */ @@ -150,7 +150,7 @@ private MarkerOptions(){ /** * Gets z index offset - *
+ * * default 0 * @return the z index offset */ @@ -161,7 +161,7 @@ private MarkerOptions(){ /** * Gets The opacity of the marker. - *
+ * * default 1.0 * @return the opacity */ @@ -172,7 +172,7 @@ private MarkerOptions(){ /** * Gets whether the marker will get on top of others when you hover the mouse over it. - *
+ * * default false * @return the rise on hover */ @@ -183,7 +183,7 @@ private MarkerOptions(){ /** * Gets The z-index offset used for the riseOnHover feature. - *
+ * * default 250 * @return the rise offset */ @@ -248,7 +248,7 @@ public Builder(){ /** * Icon class to use for rendering the marker. See Icon documentation for details on how to customize the marker icon. Set to new L.Icon.Default() by default - *
+ * * * @param icon the icon * @return the builder @@ -258,7 +258,7 @@ public Builder(){ /** * If false, the marker will not emit mouse events and will act as a part of the underlying map. - *
+ * * default true * @param clickable the clickable * @return the builder @@ -268,7 +268,7 @@ public Builder(){ /** * Whether the marker is draggable with mouse/touch or not. - *
+ * * default false * @param draggable the draggable * @return the builder @@ -278,7 +278,7 @@ public Builder(){ /** * Whether the marker can be tabbed to with a keyboard and clicked by pressing enter. - *
+ * * default true * @param keyboard the keyboard * @return the builder @@ -288,7 +288,7 @@ public Builder(){ /** * Text for the browser tooltip that appear on marker hover (no tooltip by default). - *
+ * * * @param title the title * @return the builder @@ -297,7 +297,7 @@ public Builder(){ /** * Text for the alt attribute of the icon image (useful for accessibility). - *
+ * * @param alt the alt * @return the builder */ @@ -306,7 +306,7 @@ public Builder(){ /** * By default, zIndex for the marker image is set automatically based on its latitude. Use this option if you want to put the marker on top of all others (or below), specifying a high value like 1000 (or high negative value, respectively). - *
+ * * default 0 * @param zIndexOffset the z index offset * @return the builder @@ -316,7 +316,7 @@ public Builder(){ /** * The opacity of the marker. - *
+ * * default 1.0 * @param opacity the opacity * @return the builder @@ -326,7 +326,7 @@ public Builder(){ /** * If true, the marker will get on top of others when you hover the mouse over it. - *
+ * * default false * @param riseOnHover the rise on hover * @return the builder @@ -336,7 +336,7 @@ public Builder(){ /** * The z-index offset used for the riseOnHover feature. - *
+ * * default 250 * @param riseOffset the rise offset * @return the builder diff --git a/src/main/java/com/gwidgets/api/leaflet/options/PanOptions.java b/src/main/java/com/gwidgets/api/leaflet/options/PanOptions.java index 068f3ff..1b5dec2 100644 --- a/src/main/java/com/gwidgets/api/leaflet/options/PanOptions.java +++ b/src/main/java/com/gwidgets/api/leaflet/options/PanOptions.java @@ -47,7 +47,7 @@ private PanOptions() { /** * Gets the duration of animated panning. - *
+ * * default 0.25 * @return the duration */ @@ -60,7 +60,7 @@ private PanOptions() { /** * Gets The curvature factor of panning animation easing (third parameter of the Cubic Bezier curve). 1.0 means linear animation, the less the more bowed the curve. - *
+ * * default 0.25 * @return the ease linearity */ @@ -73,7 +73,7 @@ private PanOptions() { /** * Gets whether If true, panning won't fire movestart event on start (used internally for panning inertia). - *
+ * * default false * @return the no move start */ @@ -104,7 +104,7 @@ public Builder() { /** * Duration of animated panning. - *
+ * * default 0.25 * @param duration the duration * @return the builder @@ -113,7 +113,7 @@ public Builder() { /** * The curvature factor of panning animation easing (third parameter of the Cubic Bezier curve). 1.0 means linear animation, the less the more bowed the curve. - *
+ * * default 0.25 * @param easeLinearity the ease linearity * @return the builder @@ -122,7 +122,7 @@ public Builder() { /** * If true, panning won't fire movestart event on start (used internally for panning inertia). - *
+ * * default false * @param noMoveStart the no move start * @return the builder diff --git a/src/main/java/com/gwidgets/api/leaflet/options/PathOptions.java b/src/main/java/com/gwidgets/api/leaflet/options/PathOptions.java index be47f71..8685761 100644 --- a/src/main/java/com/gwidgets/api/leaflet/options/PathOptions.java +++ b/src/main/java/com/gwidgets/api/leaflet/options/PathOptions.java @@ -24,8 +24,9 @@ /** * The Class PathOptions. - * + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative = true, namespace = GLOBAL, name = "Object") public class PathOptions { @@ -98,7 +99,7 @@ public class PathOptions { /** * Gets Whether to draw stroke along the path. Set it to false to disable - * borders on polygons or circles.
+ * borders on polygons or circles. * default true * * @return the stroke @@ -109,7 +110,7 @@ public final boolean getStroke() { } /** - * Gets the Stroke color.
+ * Gets the Stroke color. * default "#03f" * * @return the color @@ -120,7 +121,7 @@ public final String getColor() { } /** - * Gets the Stroke width in pixels.
+ * Gets the Stroke width in pixels. * default 5 * * @return the weight @@ -131,7 +132,7 @@ public final double getWeight() { } /** - * Gets the Stroke opacity.
+ * Gets the Stroke opacity. * default 0.5 * * @return the opacity @@ -143,7 +144,7 @@ public final double getOpacity() { /** * Gets Whether to fill the path with color. Set it to false to disable - * filling on polygons or circles.
+ * filling on polygons or circles. * default true * * @return the fill @@ -154,9 +155,9 @@ public final boolean getFill() { } /** - * Gets the fill color.
+ * Gets the fill color. * default "#03f" - * + * * @return the fill color */ @JsOverlay @@ -165,7 +166,7 @@ public final String getFillColor() { } /** - * Gets the fill opacity.
+ * Gets the fill opacity. * default 0.2 * * @return the fill opacity @@ -178,7 +179,7 @@ public final double getFillOpacity() { /** * Gets the string that defines how the inside of a shape is determined. See * - * docs for more info
+ * docs for more info * default "evenodd" * * @return the fill rule @@ -192,7 +193,7 @@ public final String getFillRule() { * Gets the string that defines the stroke dash * pattern. Doesn't work on canvas-powered layers (e.g. Android 2). - *
+ * * default null * * @return the dash array @@ -205,7 +206,7 @@ public final String getDashArray() { /** * Gets the string that defines - * shape to be used at the end of the stroke.
+ * shape to be used at the end of the stroke. * default null * * @return the line cap @@ -218,7 +219,7 @@ public final String getLineCap() { /** * Gets the string that defines - * shape to be used at the corners of the stroke.
+ * shape to be used at the corners of the stroke. * default null * * @return the line join @@ -231,7 +232,7 @@ public final String getLineJoin() { /** * Gets the pointer-events attribute on the path if SVG backend is used. - *
+ * * default null * * @return the pointer events @@ -242,7 +243,7 @@ public final String getPointerEvents() { } /** - * Gets the custom class name set on an element.
+ * Gets the custom class name set on an element. * default empty string * * @return the class name @@ -252,27 +253,52 @@ public final String getClassName() { return this.className; } + /** + *

Getter for the field dashOffset.

+ * + * @return a {@link java.lang.String} object + */ @JsOverlay public final String getDashOffset() { return this.dashOffset; } + /** + *

Getter for the field renderer.

+ * + * @return a {@link com.gwidgets.api.leaflet.Renderer} object + */ @JsOverlay public final Renderer getRenderer() { return this.renderer; } + /** + *

Getter for the field pane.

+ * + * @return a {@link java.lang.String} object + */ @JsOverlay public final String getPane() { return this.pane; } + /** + *

Getter for the field attribution.

+ * + * @return a {@link java.lang.String} object + */ @JsOverlay public final String getAttribution() { return this.attribution; } + /** + *

Getter for the field interactive.

+ * + * @return a boolean + */ @JsOverlay public final boolean getInteractive() { return this.interactive; @@ -328,7 +354,7 @@ public Builder() { /** * Whether to draw stroke along the path. Set it to false to disable - * borders on polygons or circles.
+ * borders on polygons or circles. * default true * * @param stroke @@ -341,7 +367,7 @@ public Builder stroke(Boolean stroke) { } /** - * Stroke color.
+ * Stroke color. * default "#03f" * * @param color @@ -354,7 +380,7 @@ public Builder color(String color) { } /** - * Stroke width in pixels.
+ * Stroke width in pixels. * default 5 * * @param weight @@ -367,7 +393,7 @@ public Builder weight(Double weight) { } /** - * Stroke opacity.
+ * Stroke opacity. * default 0.5 * * @param opacity @@ -381,7 +407,7 @@ public Builder opacity(Double opacity) { /** * Whether to fill the path with color. Set it to false to disable - * filling on polygons or circles.
+ * filling on polygons or circles. * default true * * @param fill @@ -394,7 +420,7 @@ public Builder fill(Boolean fill) { } /** - * Fill color.
+ * Fill color. * default "#03f" * * @param fillColor @@ -407,7 +433,7 @@ public Builder fillColor(String fillColor) { } /** - * Fill opacity.
+ * Fill opacity. * default 0.2 * * @param fillOpacity @@ -423,7 +449,7 @@ public Builder fillOpacity(Double fillOpacity) { * A string that defines how the inside of a shape is determined. See * - * docs for more info
+ * docs for more info * * @param fillRule * the fill rule @@ -438,7 +464,7 @@ public Builder fillRule(String fillRule) { * A string that defines the stroke * dash pattern. Doesn't work on canvas-powered layers (e.g. Android - * 2).
+ * 2). * default "evenodd" * * @param dashArray @@ -453,7 +479,7 @@ public Builder dashArray(String dashArray) { /** * A string that defines - * shape to be used at the end of the stroke.
+ * shape to be used at the end of the stroke. * default null * * @param lineCap @@ -468,7 +494,7 @@ public Builder lineCap(String lineCap) { /** * A string that defines - * shape to be used at the corners of the stroke.
+ * shape to be used at the corners of the stroke. * default null * * @param lineJoin @@ -483,7 +509,7 @@ public Builder lineJoin(String lineJoin) { /** * Sets the pointer-events attribute on the path if SVG backend is used. - *
+ * * default null * * @param pointerEvents @@ -496,7 +522,7 @@ public Builder pointerEvents(String pointerEvents) { } /** - * Custom class name set on an element.
+ * Custom class name set on an element. * default empty string * * @param className @@ -568,4 +594,4 @@ public PathOptions build() { } -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/options/PolylineOptions.java b/src/main/java/com/gwidgets/api/leaflet/options/PolylineOptions.java index 4493a92..51cffa8 100644 --- a/src/main/java/com/gwidgets/api/leaflet/options/PolylineOptions.java +++ b/src/main/java/com/gwidgets/api/leaflet/options/PolylineOptions.java @@ -45,7 +45,7 @@ private PolylineOptions() { * Gets How much to simplify the polyline on each zoom level. More means * better performance and smoother look, and less means more accurate * representation. - *
+ * * default 1.0 * @return the smooth factor */ @@ -56,7 +56,7 @@ public final double getSmoothFactor() { /** * Gets whether the polyline clipping is disabled. - *
+ * * default false * @return the no clip */ @@ -67,7 +67,7 @@ public final boolean getNoClip() { /** * Gets Whether to draw stroke along the path. Set it to false to disable - * borders on polygons or circles.
+ * borders on polygons or circles. * default true * * @return the stroke @@ -78,7 +78,7 @@ public final boolean getStroke_() { } /** - * Gets the Stroke color.
+ * Gets the Stroke color. * default "#03f" * * @return the color @@ -89,7 +89,7 @@ public final String getColor_() { } /** - * Gets the Stroke width in pixels.
+ * Gets the Stroke width in pixels. * default 5 * * @return the weight @@ -100,7 +100,7 @@ public final double getWeight_() { } /** - * Gets the Stroke opacity.
+ * Gets the Stroke opacity. * default 0.5 * * @return the opacity @@ -112,7 +112,7 @@ public final double getOpacity_() { /** * Gets Whether to fill the path with color. Set it to false to disable - * filling on polygons or circles.
+ * filling on polygons or circles. * default true * * @return the fill @@ -123,7 +123,7 @@ public final boolean getFill_() { } /** - * Gets the fill color.
+ * Gets the fill color. * default "#03f" * * @return the fill color @@ -134,7 +134,7 @@ public final String getFillColor_() { } /** - * Gets the fill opacity.
+ * Gets the fill opacity. * default 0.2 * * @return the fill opacity @@ -147,7 +147,7 @@ public final double getFillOpacity_() { /** * Gets the string that defines how the inside of a shape is determined. See * - * docs for more info
+ * docs for more info * default "evenodd" * * @return the fill rule @@ -161,7 +161,7 @@ public final String getFillRule_() { * Gets the string that defines the stroke dash * pattern. Doesn't work on canvas-powered layers (e.g. Android 2). - *
+ * * default null * * @return the dash array @@ -174,7 +174,7 @@ public final String getDashArray_() { /** * Gets the string that defines - * shape to be used at the end of the stroke.
+ * shape to be used at the end of the stroke. * default null * * @return the line cap @@ -187,7 +187,7 @@ public final String getLineCap_() { /** * Gets the string that defines - * shape to be used at the corners of the stroke.
+ * shape to be used at the corners of the stroke. * default null * * @return the line join @@ -201,7 +201,7 @@ public final String getLineJoin_() { /** * Gets the pointer-events attribute on the path if SVG backend is used. - *
+ * * default null * * @return the pointer events @@ -212,7 +212,7 @@ public final String getPointerEvents_() { } /** - * Gets the custom class name set on an element.
+ * Gets the custom class name set on an element. * default empty string * * @return the class name @@ -274,7 +274,7 @@ public Builder() { /** * How much to simplify the polyline on each zoom level. More means better performance and smoother look, and less means more accurate representation. - *
+ * * default 1.0 * @param smoothFactor * the smooth factor @@ -287,7 +287,7 @@ public Builder smoothFactor(Double smoothFactor) { /** * Disabled polyline clipping. - *
+ * * default false * @param noClip * the no clip @@ -300,7 +300,7 @@ public Builder noClip(Boolean noClip) { /** * Whether to draw stroke along the path. Set it to false to disable - * borders on polygons or circles.
+ * borders on polygons or circles. * default true * * @param stroke @@ -313,7 +313,7 @@ public Builder stroke(Boolean stroke) { } /** - * Stroke color.
+ * Stroke color. * default "#03f" * * @param color @@ -326,7 +326,7 @@ public Builder color(String color) { } /** - * Stroke width in pixels.
+ * Stroke width in pixels. * default 5 * * @param weight @@ -339,7 +339,7 @@ public Builder weight(Double weight) { } /** - * Stroke opacity.
+ * Stroke opacity. * default 0.5 * * @param opacity @@ -353,7 +353,7 @@ public Builder opacity(Double opacity) { /** * Whether to fill the path with color. Set it to false to disable - * filling on polygons or circles.
+ * filling on polygons or circles. * default true * * @param fill @@ -366,7 +366,7 @@ public Builder fill(Boolean fill) { } /** - * Fill color.
+ * Fill color. * default "#03f" * * @param fillColor @@ -379,7 +379,7 @@ public Builder fillColor(String fillColor) { } /** - * Fill opacity.
+ * Fill opacity. * default 0.2 * * @param fillOpacity @@ -395,7 +395,7 @@ public Builder fillOpacity(Double fillOpacity) { * A string that defines how the inside of a shape is determined. See * - * docs for more info
+ * docs for more info * * @param fillRule * the fill rule @@ -410,7 +410,7 @@ public Builder fillRule(String fillRule) { * A string that defines the stroke * dash pattern. Doesn't work on canvas-powered layers (e.g. Android - * 2).
+ * 2). * default "evenodd" * * @param dashArray @@ -425,7 +425,7 @@ public Builder dashArray(String dashArray) { /** * A string that defines - * shape to be used at the end of the stroke.
+ * shape to be used at the end of the stroke. * default null * * @param lineCap @@ -440,7 +440,7 @@ public Builder lineCap(String lineCap) { /** * A string that defines - * shape to be used at the corners of the stroke.
+ * shape to be used at the corners of the stroke. * default null * * @param lineJoin @@ -454,7 +454,7 @@ public Builder lineJoin(String lineJoin) { /** * Sets the pointer-events attribute on the path if SVG backend is used. - *
+ * * default null * * @param pointerEvents @@ -467,7 +467,7 @@ public Builder pointerEvents(String pointerEvents) { } /** - * Custom class name set on an element.
+ * Custom class name set on an element. * default empty string * * @param className diff --git a/src/main/java/com/gwidgets/api/leaflet/options/PopupOptions.java b/src/main/java/com/gwidgets/api/leaflet/options/PopupOptions.java index e89bf37..500a7ef 100644 --- a/src/main/java/com/gwidgets/api/leaflet/options/PopupOptions.java +++ b/src/main/java/com/gwidgets/api/leaflet/options/PopupOptions.java @@ -25,7 +25,9 @@ /** * The Class PopupOptions. + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative=true, namespace=GLOBAL, name="Object") public class PopupOptions { @@ -213,11 +215,21 @@ private PopupOptions() { } + /** + *

Getter for the field pane.

+ * + * @return a {@link java.lang.String} object + */ @JsOverlay public final String getPane() { return this.pane; } + /** + *

Getter for the field attribution.

+ * + * @return a {@link java.lang.String} object + */ @JsOverlay public final String getAttribution() { return this.attribution; } @@ -366,7 +378,7 @@ public Builder() { /** * Set it to false if you want to override the default behavior of the popup closing when user clicks the map (set globally by the Map closePopupOnClick option). * - * @param closeOnClick the close on click + * @param autoClose the close on click * @return the builder */ public Builder autoClose(Boolean autoClose){this.autoClose = autoClose; return this;} @@ -424,4 +436,4 @@ public PopupOptions build(){ return options; } } -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/options/RendererOptions.java b/src/main/java/com/gwidgets/api/leaflet/options/RendererOptions.java index ff9b6fa..471308e 100644 --- a/src/main/java/com/gwidgets/api/leaflet/options/RendererOptions.java +++ b/src/main/java/com/gwidgets/api/leaflet/options/RendererOptions.java @@ -6,6 +6,12 @@ import jsinterop.annotations.JsProperty; import jsinterop.annotations.JsType; +/** + *

RendererOptions class.

+ * + * @author zakaria + * @version $Id: $Id + */ @JsType(isNative=true, namespace=GLOBAL, name="Object") public class RendererOptions { @@ -24,16 +30,31 @@ private RendererOptions() { } + /** + *

Getter for the field padding.

+ * + * @return a double + */ @JsOverlay public final double getPadding() { return this.padding; } + /** + *

Getter for the field pane.

+ * + * @return a {@link java.lang.String} object + */ @JsOverlay public final String getPane() { return this.pane; } + /** + *

Getter for the field attribution.

+ * + * @return a {@link java.lang.String} object + */ @JsOverlay public final String getAttribution() { return this.attribution; @@ -79,4 +100,4 @@ public RendererOptions build(){ return rendererOptions; } } -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/options/TileLayerOptions.java b/src/main/java/com/gwidgets/api/leaflet/options/TileLayerOptions.java index dc9091a..2983597 100644 --- a/src/main/java/com/gwidgets/api/leaflet/options/TileLayerOptions.java +++ b/src/main/java/com/gwidgets/api/leaflet/options/TileLayerOptions.java @@ -139,7 +139,7 @@ public TileLayerOptions() { /** * Gets the min zoom. - *
+ * * default 0 * @return the min zoom */ @@ -149,7 +149,7 @@ public TileLayerOptions() { /** * Gets the max zoom. - *
+ * * default 18 * @return the max zoom */ @@ -159,7 +159,7 @@ public TileLayerOptions() { /** * Gets the Maximum zoom number the tiles source has available. If it is specified, the tiles on all zoom levels higher than maxNativeZoom will be loaded from maxNativeZoom level and auto-scaled. - *
+ * * default null * @return the max native zoom */ @@ -169,7 +169,7 @@ public TileLayerOptions() { /** * Gets the Tile size (width and height in pixels, assuming tiles are square). - *
+ * * default 256 * @return the tile size */ @@ -179,7 +179,7 @@ public TileLayerOptions() { /** * Gets the Subdomains of the tile service. Can be passed in the form of one string (where each letter is a subdomain name) or an array of strings. - *
+ * * default 'abc' * @return the subdomains */ @@ -189,7 +189,7 @@ public TileLayerOptions() { /** * Gets the URL to the tile image to show in place of the tile that failed to load. - *
+ * * default "" * @return the error tile url */ @@ -199,7 +199,7 @@ public TileLayerOptions() { /** * Gets the string used by the attribution control, describes the layer data. - *
+ * * default "" * @return the attribution */ @@ -209,7 +209,7 @@ public TileLayerOptions() { /** * Gets whether If true, inverses Y axis numbering for tiles (turn this on for TMS services). - *
+ * * default false * @return the tms */ @@ -220,7 +220,7 @@ public TileLayerOptions() { /** * Gets whether the tiles just won't load outside the world width (-180 to 180 longitude) instead of repeating. - *
+ * * default false * @return the no wrap */ @@ -230,7 +230,7 @@ public TileLayerOptions() { /** * Gets The zoom number used in tile URLs will be offset with this value. - *
+ * * default 0 * @return the zoom offset */ @@ -240,7 +240,7 @@ public TileLayerOptions() { /** * Gets the zoom number used in tile URLs will be reversed (maxZoom - zoom instead of zoom). - *
+ * * default false * @return the zoom reverse */ @@ -250,7 +250,7 @@ public TileLayerOptions() { /** * Gets the opacity of the tile layer. - *
+ * * default 1.0 * @return the opacity */ @@ -260,7 +260,7 @@ public TileLayerOptions() { /** * Gets The explicit zIndex of the tile layer. Not set by default. - *
+ * * default null * @return the z index */ @@ -271,7 +271,7 @@ public TileLayerOptions() { /** * Gets whether the new tiles are loaded during panning, otherwise only after it (for better performance). true by default on mobile WebKit, otherwise false. - *
+ * * default true * @return the update when idle */ @@ -281,7 +281,7 @@ public TileLayerOptions() { /** * Gets the detect retina option is set - *
+ * * default false * @return the detect retina */ @@ -292,7 +292,7 @@ public TileLayerOptions() { /** * Gets whether the TileLayer only loads tiles that are in the given geographical bounds. - *
+ * * default null * @return the bounds */ @@ -399,7 +399,7 @@ public Builder() { /** * Minimum zoom number. - *
+ * * default 0 * @param minZoom the min zoom * @return the builder @@ -411,7 +411,7 @@ public Builder minZoom(Integer minZoom) { /** * Maximum zoom double. - *
+ * * default 18 * @param maxZoom the max zoom * @return the builder @@ -423,7 +423,7 @@ public Builder maxZoom(Integer maxZoom) { /** * Maximum zoom number the tiles source has available. If it is specified, the tiles on all zoom levels higher than maxNativeZoom will be loaded from maxNativeZoom level and auto-scaled. - *
+ * * default null * @param maxNativeZoom the max native zoom * @return the builder @@ -435,7 +435,7 @@ public Builder maxNativeZoom(Double maxNativeZoom) { /** * Tile size (width and height in pixels, assuming tiles are square). - *
+ * * default 256 * @param tileSize the tile size * @return the builder @@ -447,7 +447,7 @@ public Builder tileSize(Integer tileSize) { /** * Subdomains of the tile service. Can be passed in the form of one string (where each letter is a subdomain name) or an array of strings. - *
+ * * default {"abc"} * @param subdomains the subdomains * @return the builder @@ -459,7 +459,7 @@ public Builder subdomains(String[] subdomains) { /** * URL to the tile image to show in place of the tile that failed to load. - *
+ * * default "" * @param errorTileUrl the error tile url * @return the builder @@ -471,7 +471,7 @@ public Builder errorTileUrl(String errorTileUrl) { /** *the string used by the attribution control, describes the layer data. - *
+ * * default "" * @param attribution the attribution * @return the builder @@ -483,7 +483,7 @@ public Builder attribution(String attribution) { /** * If true, inverses Y axis numbering for tiles (turn this on for TMS services). - *
+ * * default true * @param tms the tms * @return the builder @@ -507,7 +507,7 @@ public Builder noWrap(Boolean noWrap) { /** * The zoom number used in tile URLs will be offset with this value. - *
+ * * default 0 * @param zoomOffset the zoom offset * @return the builder @@ -519,7 +519,7 @@ public Builder zoomOffset(Integer zoomOffset) { /** * If set to true, the zoom number used in tile URLs will be reversed (maxZoom - zoom instead of zoom). - *
+ * * default false * @param zoomReverse the zoom reverse * @return the builder @@ -531,7 +531,7 @@ public Builder zoomReverse(Boolean zoomReverse) { /** * The opacity of the tile layer. - *
+ * * default 1.0 * @param opacity the opacity * @return the builder @@ -543,7 +543,7 @@ public Builder opacity(Double opacity) { /** * The explicit zIndex of the tile layer. Not set by default. - *
+ * * default null * @param zIndex the z index * @return the builder @@ -556,7 +556,7 @@ public Builder zIndex(Integer zIndex) { /** * If false, new tiles are loaded during panning, otherwise only after it (for better performance). true by default on mobile WebKit, otherwise false. - *
+ * * default true * @param updateWhenIdle the update when idle * @return the builder @@ -568,7 +568,7 @@ public Builder updateWhenIdle(Boolean updateWhenIdle) { /** * If true and user is on a retina display, it will request four tiles of half the specified size and a bigger zoom level in place of one to utilize the high resolution. - *
+ * * default false * @param detectRetina the detect retina * @return the builder @@ -581,7 +581,7 @@ public Builder detectRetina(Boolean detectRetina) { /** * When this option is set, the TileLayer only loads tiles that are in the given geographical bounds. - *
+ * * default null * @param bounds the bounds * @return the builder diff --git a/src/main/java/com/gwidgets/api/leaflet/options/TileLayerWMSOptions.java b/src/main/java/com/gwidgets/api/leaflet/options/TileLayerWMSOptions.java index 3461bd0..d0d38ed 100644 --- a/src/main/java/com/gwidgets/api/leaflet/options/TileLayerWMSOptions.java +++ b/src/main/java/com/gwidgets/api/leaflet/options/TileLayerWMSOptions.java @@ -164,7 +164,7 @@ public TileLayerWMSOptions() { *********************************************/ /** - * Gets the Comma-separated WMS layers.
+ * Gets the Comma-separated WMS layers. * * @return the layers */ @@ -174,7 +174,7 @@ public final String getLayers() { } /** - * Gets the Comma-separated list of WMS styles.
+ * Gets the Comma-separated list of WMS styles. * * @return the styles */ @@ -184,7 +184,7 @@ public final String getStyles() { } /** - * Gets the WMS image format.
+ * Gets the WMS image format. * default 'image/jpeg' * * @return the format @@ -195,7 +195,7 @@ public final String getFormat() { } /** - * Gets whether the WMS service will return images with transparency.
+ * Gets whether the WMS service will return images with transparency. * default false * * @return the transparent @@ -206,7 +206,7 @@ public final boolean getTransparent() { } /** - * Gets of the WMS service to use.
+ * Gets of the WMS service to use. * default '1.1.1' * * @return the version @@ -219,7 +219,7 @@ public final String getVersion() { /** * Gets the Coordinate Reference System to use for the WMS requests, * defaults to map CRS. Don't change this if you're not sure what it means. - *
+ * * * @return the crs */ @@ -418,7 +418,7 @@ public Builder(String layers) { } /** - * Comma-separated list of WMS styles.
+ * Comma-separated list of WMS styles. * * @param styles * the styles @@ -431,7 +431,7 @@ public Builder styles(String styles) { /** * WMS image format (use 'image/png' for layers with transparency). - *
+ * * default 'image/jpeg' * * @param format @@ -444,7 +444,7 @@ public Builder format(String format) { } /** - * If true, the WMS service will return images with transparency.
+ * If true, the WMS service will return images with transparency. * default false * * @param transparent @@ -457,7 +457,7 @@ public Builder transparent(Boolean transparent) { } /** - * Version of the WMS service to use.
+ * Version of the WMS service to use. * default "1.1.1" * * @param version @@ -471,7 +471,7 @@ public Builder version(String version) { /** * Coordinate Reference System to use for the WMS requests, defaults to - * map CRS. Don't change this if you're not sure what it means.
+ * map CRS. Don't change this if you're not sure what it means. * * @param crs * the crs @@ -484,7 +484,7 @@ public Builder crs(CRS crs) { /** * Minimum zoom number. - *
+ * * default 0 * @param minZoom the min zoom * @return the builder @@ -496,7 +496,7 @@ public Builder minZoom(Double minZoom) { /** * Maximum zoom number. - *
+ * * default 18 * @param maxZoom the max zoom * @return the builder @@ -508,7 +508,7 @@ public Builder maxZoom(Double maxZoom) { /** * Maximum zoom number the tiles source has available. If it is specified, the tiles on all zoom levels higher than maxNativeZoom will be loaded from maxNativeZoom level and auto-scaled. - *
+ * * default null * @param maxNativeZoom the max native zoom * @return the builder @@ -520,7 +520,7 @@ public Builder maxNativeZoom(Double maxNativeZoom) { /** * Tile size (width and height in pixels, assuming tiles are square). - *
+ * * default 256 * @param tileSize the tile size * @return the builder @@ -532,7 +532,7 @@ public Builder tileSize(Double tileSize) { /** * Subdomains of the tile service. Can be passed in the form of one string (where each letter is a subdomain name) or an array of strings. - *
+ * * default {"abc"} * @param subdomains the subdomains * @return the builder @@ -544,7 +544,7 @@ public Builder subdomains(String[] subdomains) { /** * URL to the tile image to show in place of the tile that failed to load. - *
+ * * default "" * @param errorTileUrl the error tile url * @return the builder @@ -556,7 +556,7 @@ public Builder errorTileUrl(String errorTileUrl) { /** * the string used by the attribution control, describes the layer data. - *
+ * * default "" * @param attribution the attribution * @return the builder @@ -568,7 +568,7 @@ public Builder attribution(String attribution) { /** * If true, inverses Y axis numbering for tiles (turn this on for TMS services). - *
+ * * default true * @param tms the tms * @return the builder @@ -592,7 +592,7 @@ public Builder noWrap(Boolean noWrap) { /** * The zoom number used in tile URLs will be offset with this value. - *
+ * * default 0 * @param zoomOffset the zoom offset * @return the builder @@ -604,7 +604,7 @@ public Builder zoomOffset(Double zoomOffset) { /** * If set to true, the zoom number used in tile URLs will be reversed (maxZoom - zoom instead of zoom). - *
+ * * default false * @param zoomReverse the zoom reverse * @return the builder @@ -616,7 +616,7 @@ public Builder zoomReverse(Boolean zoomReverse) { /** * The opacity of the tile layer. - *
+ * * default 1.0 * @param opacity the opacity * @return the builder @@ -628,7 +628,7 @@ public Builder opacity(Double opacity) { /** * The explicit zIndex of the tile layer. Not set by default. - *
+ * * default null * @param zIndex the z index * @return the builder @@ -641,7 +641,7 @@ public Builder zIndex(Double zIndex) { /** * If false, new tiles are loaded during panning, otherwise only after it (for better performance). true by default on mobile WebKit, otherwise false. - *
+ * * default true * @param updateWhenIdle the update when idle * @return the builder @@ -653,7 +653,7 @@ public Builder updateWhenIdle(Boolean updateWhenIdle) { /** * If true and user is on a retina display, it will request four tiles of half the specified size and a bigger zoom level in place of one to utilize the high resolution. - *
+ * * default false * @param detectRetina the detect retina * @return the builder @@ -666,7 +666,7 @@ public Builder detectRetina(Boolean detectRetina) { /** * When this option is set, the TileLayer only loads tiles that are in the given geographical bounds. - *
+ * * default null * @param bounds the bounds * @return the builder diff --git a/src/main/java/com/gwidgets/api/leaflet/options/TooltipOptions.java b/src/main/java/com/gwidgets/api/leaflet/options/TooltipOptions.java index 2698f8d..c94bb70 100644 --- a/src/main/java/com/gwidgets/api/leaflet/options/TooltipOptions.java +++ b/src/main/java/com/gwidgets/api/leaflet/options/TooltipOptions.java @@ -23,7 +23,9 @@ /** * The Class TooltipOptions. + * * @author Zakaria Amine + * @version $Id: $Id */ @JsType(isNative=true, namespace=GLOBAL, name="Object") public class TooltipOptions { @@ -71,9 +73,11 @@ private TooltipOptions(){ - /** Returns the popup bound to this layer. - * - */ + /** + * Returns the popup bound to this layer. + * + * @return a {@link java.lang.String} object + */ @JsOverlay public final String getPane() { return this.pane; @@ -81,23 +85,32 @@ public final String getPane() { - /** Optional offset of the tooltip position. - */ + /** + * Optional offset of the tooltip position. + * + * @return a {@link com.gwidgets.api.leaflet.Point} object + */ @JsOverlay public final Point getOffset() { return this.offset; } - /** Whether to open the tooltip permanently or only on mouseover. - */ + /** + * Whether to open the tooltip permanently or only on mouseover. + * + * @return a boolean + */ @JsOverlay public final boolean getPermanent() { return this.permanent; } - /** Direction where to open the tooltip. Possible values are: right, left, top, bottom, center, auto. auto will dynamicaly switch between right and left according to the tooltip position on the map. - */ + /** + * Direction where to open the tooltip. Possible values are: right, left, top, bottom, center, auto. auto will dynamicaly switch between right and left according to the tooltip position on the map. + * + * @return a {@link java.lang.String} object + */ @JsOverlay public final String getDirection() { return this.direction; @@ -106,8 +119,11 @@ public final String getDirection() { - /** If true, the tooltip will follow the mouse instead of being fixed at the feature center. - */ + /** + * If true, the tooltip will follow the mouse instead of being fixed at the feature center. + * + * @return a boolean + */ @JsOverlay public final boolean getSticky() { return this.sticky; @@ -115,8 +131,11 @@ public final boolean getSticky() { - /** If true, the tooltip will listen to the feature events. - */ + /** + * If true, the tooltip will listen to the feature events. + * + * @return a boolean + */ @JsOverlay public final boolean getInteractive() { return this.interactive; @@ -124,8 +143,11 @@ public final boolean getInteractive() { - /** Tooltip container opacity. - */ + /** + * Tooltip container opacity. + * + * @return a double + */ @JsOverlay public final double getOpacity() { return this.opacity; @@ -135,12 +157,22 @@ public final double getOpacity() { + /** + *

Getter for the field className.

+ * + * @return a {@link java.lang.String} object + */ @JsOverlay public final String getClassName() { return this.className; } + /** + *

Getter for the field attribution.

+ * + * @return a {@link java.lang.String} object + */ @JsOverlay public final String getAttribution() { return this.attribution; @@ -245,4 +277,4 @@ public TooltipOptions build(){ return toolTipOptions; } } -} \ No newline at end of file +} diff --git a/src/main/java/com/gwidgets/api/leaflet/options/ZoomOptions.java b/src/main/java/com/gwidgets/api/leaflet/options/ZoomOptions.java index c404556..b90eb92 100644 --- a/src/main/java/com/gwidgets/api/leaflet/options/ZoomOptions.java +++ b/src/main/java/com/gwidgets/api/leaflet/options/ZoomOptions.java @@ -40,7 +40,7 @@ private ZoomOptions() { /** * Gets whether zoom animation will happen if the zoom origin is inside the current view. If true, the map will attempt animating zoom disregarding where zoom origin is. Setting false will make it always reset the view completely without animation. - *
+ * * default true * @return the animate */ @@ -67,7 +67,7 @@ public Builder() { /** * zoom animation will happen if the zoom origin is inside the current view. If true, the map will attempt animating zoom disregarding where zoom origin is. Setting false will make it always reset the view completely without animation. - *
+ * * default true * * @param animate the animate diff --git a/src/main/java/com/gwidgets/api/leaflet/options/ZoomPanOptions.java b/src/main/java/com/gwidgets/api/leaflet/options/ZoomPanOptions.java index 54f3301..e2353bf 100644 --- a/src/main/java/com/gwidgets/api/leaflet/options/ZoomPanOptions.java +++ b/src/main/java/com/gwidgets/api/leaflet/options/ZoomPanOptions.java @@ -46,7 +46,7 @@ private ZoomPanOptions() { /** * Gets whether the map view will be completely reset (without any - * animations).
+ * animations). * default false * * @return the reset @@ -78,7 +78,7 @@ public final ZoomOptions getZoom() { /** * An equivalent of passing animate to both zoom and pan options (see below) - *
+ * * default true * * @return the animate diff --git a/src/main/java/com/gwidgets/api/leaflet/utils/JsFn.java b/src/main/java/com/gwidgets/api/leaflet/utils/JsFn.java index f41c5f7..d09321c 100644 --- a/src/main/java/com/gwidgets/api/leaflet/utils/JsFn.java +++ b/src/main/java/com/gwidgets/api/leaflet/utils/JsFn.java @@ -2,9 +2,21 @@ import jsinterop.annotations.JsFunction; +/** + *

JsFn interface.

+ * + * @author zakaria + * @version $Id: $Id + */ @JsFunction public interface JsFn { + /** + *

apply.

+ * + * @param arg1 a {@link java.lang.Object} object + * @return a {@link java.lang.Object} object + */ Object apply(Object ... arg1); } diff --git a/src/main/java/com/gwidgets/api/leaflet/utils/LeafletResources.java b/src/main/java/com/gwidgets/api/leaflet/utils/LeafletResources.java index c6ac2de..c33ad0a 100644 --- a/src/main/java/com/gwidgets/api/leaflet/utils/LeafletResources.java +++ b/src/main/java/com/gwidgets/api/leaflet/utils/LeafletResources.java @@ -8,7 +8,19 @@ import elemental2.dom.HTMLScriptElement; +/** + *

LeafletResources class.

+ * + * @author zakaria + * @version $Id: $Id + */ public class LeafletResources { + /** + *

whenReady.

+ * + * @param debug a boolean + * @param function a {@link elemental2.dom.Element.OnloadFn} object + */ public static void whenReady(boolean debug, Element.OnloadFn function){ HTMLScriptElement leafletScript = (HTMLScriptElement) DomGlobal.document.createElement("script"); if (debug) { @@ -28,4 +40,4 @@ public static void whenReady(boolean debug, Element.OnloadFn function){ leafletScript.onload = function; } -} \ No newline at end of file +}