Map (Leaflet Java API 1.0-SNAPSHOT API)

java.lang.Object
- net.java.html.leaflet.Map

```
public final class Map
extends Object
```
The central class of the API — it is used to create a map on a page and manipulate it.

Constructor Summary

Constructors
Constructor and Description

Map(String id)

Map(String id, MapOptions options)

Constructors
Constructor and Description
`Map(String id)`
`Map(String id, MapOptions options)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Map`	`addDragEndListener(DragEndEvent.Type type, DragEndListener listener)` Adds a drag end listener to a particular drag end event type of the object.
`Map`	`addErrorListener(ErrorEvent.Type type, ErrorListener listener)` Adds a error listener to a particular error event type of the object.
`Map`	`addEventListener(Event.Type type, EventListener listener)` Adds a event listener to a particular event type of the object.
`Map`	`addLayer(ILayer layer)` Adds the given layer to the map.
`Map`	`addLayerListener(LayerEvent.Type type, LayerListener listener)` Adds a layer listener to a particular layer event type of the object.
`Map`	`addLocationListener(LocationEvent.Type type, LocationListener listener)` Adds a location listener to a particular location event type of the object.
`Map`	`addMouseListener(MouseEvent.Type type, MouseListener listener)` Adds a mouse listener to a particular mouse event type of the object.
`Map`	`addPopupListener(PopupEvent.Type type, PopupListener listener)` Adds a popup listener to a particular popup event type of the object.
`Map`	`addResizeListener(ResizeEvent.Type type, ResizeListener listener)` Adds a resize listener to a particular resize event type of the object.
`Map`	`clearAllEventListeners()` Removes all listeners to all events on the object.
`Map`	`closePopup()` Closes the popup previously opened with `openPopup(java.lang.String, net.java.html.leaflet.LatLng)`.
`Map`	`closePopup(Popup popup)` Closes the given popup.
`LatLng`	`containerPointToLatLng(Point point)` Returns the geographical coordinates of a given map container point.
`Point`	`containerPointToLayerPoint(Point point)` Converts the point relative to the map container to a point relative to the map layer.
`LatLngBounds`	`getBounds()` Returns the LatLngBounds of the current map view.
`int`	`getBoundsZoom(LatLngBounds bounds)` Returns the maximum zoom level on which the given bounds fit to the map view in its entirety.
`int`	`getBoundsZoom(LatLngBounds bounds, boolean inside)` Returns the maximum zoom level on which the given bounds fit to the map view in its entirety.
`LatLng`	`getCenter()` Returns the geographical center of the map view.
`ILayer[]`	`getLayers()` Returns all layers.
`int`	`getMaxZoom()` Returns the maximum zoom level of the map.
`int`	`getMinZoom()` Returns the minimum zoom level of the map.
`Bounds`	`getPixelBounds()` Returns the bounds of the current map view in projected pixel coordinates (sometimes useful in layer and overlay implementations).
`Point`	`getPixelOrigin()` Returns the projected pixel coordinates of the top left point of the map layer (useful in custom layer and overlay implementations).
`Point`	`getSize()` Returns the current size of the map container.
`int`	`getZoom()` Returns the current zoom of the map view.
`boolean`	`hasLayer(ILayer layer)` Returns `true` if the given layer is currently added to the map.
`Point`	`latLngToContainerPoint(LatLng latlng)` Returns the map container point that corresponds to the given geographical coordinates.
`Point`	`latLngToLayerPoint(LatLng latlng)` Returns the map layer point that corresponds to the given geographical coordinates (useful for placing overlays on the map).
`Point`	`layerPointToContainerPoint(Point point)` Converts the point relative to the map layer to a point relative to the map container.
`LatLng`	`layerPointToLatLng(Point point)` Returns the geographical coordinates of a given map layer point.
`Map`	`openPopup(Popup popup, LatLng latlng)` Opens the specified popup while closing the previously opened (to make sure only one is opened at one time for usability).
`Map`	`openPopup(Popup popup, LatLng latlng, PopupOptions options)` Opens the specified popup while closing the previously opened (to make sure only one is opened at one time for usability).
`Map`	`openPopup(String html, LatLng latlng)` Creates a popup and opens it in the given point on a map.
`Point`	`project(LatLng latlng)` Projects the given geographical coordinates to absolute pixel coordinates for the given zoom level (current zoom level by default).
`Point`	`project(LatLng latlng, int zoom)` Projects the given geographical coordinates to absolute pixel coordinates for the given zoom level (current zoom level by default).
`Map`	`removeDragEndListener(DragEndEvent.Type type, DragEndListener listener)` Removes a drag end listener to a particular drag end event type of the object.
`Map`	`removeErrorListener(ErrorEvent.Type type, ErrorListener listener)` Removes a error listener to a particular error event type of the object.
`Map`	`removeEventListener(Event.Type type, EventListener listener)` Removes a event listener to a particular event type of the object.
`Map`	`removeLayer(ILayer layer)` Removes the given layer from the map.
`Map`	`removeLayerListener(LayerEvent.Type type, LayerListener listener)` Removes a layer listener to a particular layer event type of the object.
`Map`	`removeLocationListener(LocationEvent.Type type, LocationListener listener)` Removes a location listener to a particular location event type of the object.
`Map`	`removeMouseListener(MouseEvent.Type type, MouseListener listener)` Removes a mouse listener to a particular mouse event type of the object.
`Map`	`removePopupListener(PopupEvent.Type type, PopupListener listener)` Removes a popup listener to a particular popup event type of the object.
`Map`	`removeResizeListener(ResizeEvent.Type type, ResizeListener listener)` Removes a resize listener to a particular resize event type of the object.
`void`	`setView(LatLng center)` Sets the view of the map (geographical center and zoom) with the given animation options.
`void`	`setView(LatLng center, int zoom)` Sets the view of the map (geographical center and zoom) with the given animation options.
`void`	`setView(LatLng center, int zoom, ZoomPanOptions options)` Sets the view of the map (geographical center and zoom) with the given animation options.
`LatLng`	`unproject(Point point)` Projects the given absolute pixel coordinates to geographical coordinates for the given zoom level (current zoom level by default).
`LatLng`	`unproject(Point point, int zoom)` Projects the given absolute pixel coordinates to geographical coordinates for the given zoom level (current zoom level by default).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Map
```
public Map(String id)
```
  - Map
```
public Map(String id,
           MapOptions options)
```
- Method Detail
  - setView
```
public void setView(LatLng center)
```
    Sets the view of the map (geographical center and zoom) with the given animation options.
    
    Parameters:
    
    center - The center value
  - setView
```
public void setView(LatLng center,
                    int zoom)
```
    Sets the view of the map (geographical center and zoom) with the given animation options.
    
    Parameters:
    
    center - The center value
    
    zoom - The zoom value
  - setView
```
public void setView(LatLng center,
                    int zoom,
                    ZoomPanOptions options)
```
    Sets the view of the map (geographical center and zoom) with the given animation options.
    
    Parameters:
    
    center - The center value
    
    zoom - The zoom value
    
    options - The zoom/pan options
  - addLayer
```
public Map addLayer(ILayer layer)
```
    Adds the given layer to the map.
    
    Parameters:
    
    layer - The added layer.
    
    Returns:
    
    The map object.
  - removeLayer
```
public Map removeLayer(ILayer layer)
```
    Removes the given layer from the map.
    
    Parameters:
    
    layer - The removed layer.
    
    Returns:
    
    The map object.
  - hasLayer
```
public boolean hasLayer(ILayer layer)
```
    Returns true if the given layer is currently added to the map.
    
    Parameters:
    
    layer - The layer.
    
    Returns:
    
    Returns true if the given layer is currently added to the map, false otherwise.
  - getLayers
```
public ILayer[] getLayers()
```
    Returns all layers.
    
    Returns:
    
    The layers.
  - addMouseListener
```
public Map addMouseListener(MouseEvent.Type type,
                            MouseListener listener)
```
    Adds a mouse listener to a particular mouse event type of the object.
    
    Parameters:
    
    type - The mouse event type. The types CLICK, DBLCLICK, MOUSEDOWN, MOUSEUP, MOUSEOVER, MOUSEOUT, MOUSEMOVE, CONTEXTMENU and PRECLICK are supported.
    
    listener - The registered listener.
    
    Returns:
    
    The map object.
  - addEventListener
```
public Map addEventListener(Event.Type type,
                            EventListener listener)
```
    Adds a event listener to a particular event type of the object.
    
    Parameters:
    
    type - The event type. The types FOCUS, BLUR, LOAD, UNLOAD, VIEWRESET, MOVESTART, MOVE, MOVEEND, DRAGSTART, DRAG, ZOOMSTART, ZOOMEND, ZOOMLEVELSCHANGE and AUTOPANSTART are supported.
    
    listener - The registered listener.
    
    Returns:
    
    The map object.
  - addDragEndListener
```
public Map addDragEndListener(DragEndEvent.Type type,
                              DragEndListener listener)
```
    Adds a drag end listener to a particular drag end event type of the object.
    
    Parameters:
    
    type - The drag end event type. The type DRAGEND is supported.
    
    listener - The registered listener.
    
    Returns:
    
    The map object.
  - addResizeListener
```
public Map addResizeListener(ResizeEvent.Type type,
                             ResizeListener listener)
```
    Adds a resize listener to a particular resize event type of the object.
    
    Parameters:
    
    type - The resize event type. The type RESIZE is supported.
    
    listener - The registered listener.
    
    Returns:
    
    The map object.
  - addLayerListener
```
public Map addLayerListener(LayerEvent.Type type,
                            LayerListener listener)
```
    Adds a layer listener to a particular layer event type of the object.
    
    Parameters:
    
    type - The layer event type. The types LAYERADD, LAYERREMOVE, BASSELAYERCHANGE, OVERLAYADD and OVERLAYREMOVE are supported.
    
    listener - The registered listener.
    
    Returns:
    
    The map object.
  - addLocationListener
```
public Map addLocationListener(LocationEvent.Type type,
                               LocationListener listener)
```
    Adds a location listener to a particular location event type of the object.
    
    Parameters:
    
    type - The location event type. The type LOCATIONFOUND is supported.
    
    listener - The registered listener.
    
    Returns:
    
    The map object.
  - addErrorListener
```
public Map addErrorListener(ErrorEvent.Type type,
                            ErrorListener listener)
```
    Adds a error listener to a particular error event type of the object.
    
    Parameters:
    
    type - The error event type. The type LOCATIONERROR is supported.
    
    listener - The registered listener.
    
    Returns:
    
    The map object.
  - addPopupListener
```
public Map addPopupListener(PopupEvent.Type type,
                            PopupListener listener)
```
    Adds a popup listener to a particular popup event type of the object.
    
    Parameters:
    
    type - The popup event type. The types POPUPOPEN and POPUPCLOSE are supported.
    
    listener - The registered listener.
    
    Returns:
    
    The map object.
  - removeMouseListener
```
public Map removeMouseListener(MouseEvent.Type type,
                               MouseListener listener)
```
    Removes a mouse listener to a particular mouse event type of the object.
    
    Parameters:
    
    type - The mouse event type. The types CLICK, DBLCLICK, MOUSEDOWN, MOUSEUP, MOUSEOVER, MOUSEOUT, MOUSEMOVE, CONTEXTMENU and PRECLICK are supported.
    
    listener - The registered listener.
    
    Returns:
    
    The map object.
  - removeEventListener
```
public Map removeEventListener(Event.Type type,
                               EventListener listener)
```
    Removes a event listener to a particular event type of the object.
    
    Parameters:
    
    type - The event type. The types FOCUS, BLUR, LOAD, UNLOAD, VIEWRESET, MOVESTART, MOVE, MOVEEND, DRAGSTART, DRAG, ZOOMSTART, ZOOMEND, ZOOMLEVELSCHANGE and AUTOPANSTART are supported.
    
    listener - The registered listener.
    
    Returns:
    
    The map object.
  - removeDragEndListener
```
public Map removeDragEndListener(DragEndEvent.Type type,
                                 DragEndListener listener)
```
    Removes a drag end listener to a particular drag end event type of the object.
    
    Parameters:
    
    type - The drag end event type. The type DRAGEND is supported.
    
    listener - The registered listener.
    
    Returns:
    
    The map object.
  - removeResizeListener
```
public Map removeResizeListener(ResizeEvent.Type type,
                                ResizeListener listener)
```
    Removes a resize listener to a particular resize event type of the object.
    
    Parameters:
    
    type - The resize event type. The type RESIZE is supported.
    
    listener - The registered listener.
    
    Returns:
    
    The map object.
  - removeLayerListener
```
public Map removeLayerListener(LayerEvent.Type type,
                               LayerListener listener)
```
    Removes a layer listener to a particular layer event type of the object.
    
    Parameters:
    
    type - The layer event type. The types LAYERADD, LAYERREMOVE, BASSELAYERCHANGE, OVERLAYADD and OVERLAYREMOVE are supported.
    
    listener - The registered listener.
    
    Returns:
    
    The map object.
  - removeLocationListener
```
public Map removeLocationListener(LocationEvent.Type type,
                                  LocationListener listener)
```
    Removes a location listener to a particular location event type of the object.
    
    Parameters:
    
    type - The location event type. The type LOCATIONFOUND is supported.
    
    listener - The registered listener.
    
    Returns:
    
    The map object.
  - removeErrorListener
```
public Map removeErrorListener(ErrorEvent.Type type,
                               ErrorListener listener)
```
    Removes a error listener to a particular error event type of the object.
    
    Parameters:
    
    type - The error event type. The type LOCATIONERROR is supported.
    
    listener - The registered listener.
    
    Returns:
    
    The map object.
  - removePopupListener
```
public Map removePopupListener(PopupEvent.Type type,
                               PopupListener listener)
```
    Removes a popup listener to a particular popup event type of the object.
    
    Parameters:
    
    type - The popup event type. The types POPUPOPEN and POPUPCLOSE are supported.
    
    listener - The registered listener.
    
    Returns:
    
    The map object.
  - clearAllEventListeners
```
public Map clearAllEventListeners()
```
    Removes all listeners to all events on the object.
    
    Returns:
    
    The map object.
  - openPopup
```
public Map openPopup(String html,
                     LatLng latlng)
```
    Creates a popup and opens it in the given point on a map.
    
    Parameters:
    
    html - The html content.
    
    latlng - The point.
    
    Returns:
    
    The map object.
  - openPopup
```
public Map openPopup(Popup popup,
                     LatLng latlng)
```
    Opens the specified popup while closing the previously opened (to make sure only one is opened at one time for usability).
    
    Parameters:
    
    popup - The popup.
    
    latlng - The point.
    
    Returns:
    
    The map object.
  - openPopup
```
public Map openPopup(Popup popup,
                     LatLng latlng,
                     PopupOptions options)
```
    Opens the specified popup while closing the previously opened (to make sure only one is opened at one time for usability).
    
    Parameters:
    
    popup - The popup.
    
    latlng - The point.
    
    options - The PopupOptions.
    
    Returns:
    
    The map object.
  - closePopup
```
public Map closePopup()
```
    Closes the popup previously opened with openPopup(java.lang.String, net.java.html.leaflet.LatLng).
    
    Returns:
    
    The map object.
  - closePopup
```
public Map closePopup(Popup popup)
```
    Closes the given popup.
    
    Parameters:
    
    popup - The popup to close.
    
    Returns:
    
    The map object.
  - getCenter
```
public LatLng getCenter()
```
    Returns the geographical center of the map view.
    
    Returns:
    
    Returns the geographical center of the map view.
  - getZoom
```
public int getZoom()
```
    Returns the current zoom of the map view.
    
    Returns:
    
    Returns the current zoom of the map view.
  - getMinZoom
```
public int getMinZoom()
```
    Returns the minimum zoom level of the map.
    
    Returns:
    
    Returns the minimum zoom level of the map.
  - getMaxZoom
```
public int getMaxZoom()
```
    Returns the maximum zoom level of the map.
    
    Returns:
    
    Returns the maximum zoom level of the map.
  - getBounds
```
public LatLngBounds getBounds()
```
    Returns the LatLngBounds of the current map view.
    
    Returns:
    
    Returns the LatLngBounds of the current map view.
  - getBoundsZoom
```
public int getBoundsZoom(LatLngBounds bounds)
```
    Returns the maximum zoom level on which the given bounds fit to the map view in its entirety.
    
    Parameters:
    
    bounds - The bounds.
    
    Returns:
    
    The maximum zoom level.
  - getBoundsZoom
```
public int getBoundsZoom(LatLngBounds bounds,
                         boolean inside)
```
    Returns the maximum zoom level on which the given bounds fit to the map view in its entirety.
    
    Parameters:
    
    bounds - The bounds.
    
    inside - If inside is set true, the method instead returns the minimum zoom level on which the map view fits into the given bounds in its entirety.
    
    Returns:
    
    The maximum/minimum zoom level.
  - getSize
```
public Point getSize()
```
    Returns the current size of the map container.
    
    Returns:
    
    Returns the current size of the map container.
  - getPixelBounds
```
public Bounds getPixelBounds()
```
    Returns the bounds of the current map view in projected pixel coordinates (sometimes useful in layer and overlay implementations).
    
    Returns:
    
    Returns the bounds of the current map view in projected pixel coordinates (sometimes useful in layer and overlay implementations).
  - getPixelOrigin
```
public Point getPixelOrigin()
```
    Returns the projected pixel coordinates of the top left point of the map layer (useful in custom layer and overlay implementations).
    
    Returns:
    
    Returns the projected pixel coordinates of the top left point of the map layer (useful in custom layer and overlay implementations).
  - latLngToLayerPoint
```
public Point latLngToLayerPoint(LatLng latlng)
```
    Returns the map layer point that corresponds to the given geographical coordinates (useful for placing overlays on the map).
    
    Parameters:
    
    latlng - The geographical coordinates.
    
    Returns:
    
    Returns the map layer point.
  - layerPointToLatLng
```
public LatLng layerPointToLatLng(Point point)
```
    Returns the geographical coordinates of a given map layer point.
    
    Parameters:
    
    point - The map layer point.
    
    Returns:
    
    Returns the geographical coordinates.
  - containerPointToLayerPoint
```
public Point containerPointToLayerPoint(Point point)
```
    Converts the point relative to the map container to a point relative to the map layer.
    
    Parameters:
    
    point - A point relative to the map container.
    
    Returns:
    
    Returns a point relative to the map layer.
  - layerPointToContainerPoint
```
public Point layerPointToContainerPoint(Point point)
```
    Converts the point relative to the map layer to a point relative to the map container.
    
    Parameters:
    
    point - A point relative to the map layer.
    
    Returns:
    
    Returns a point relative to the map container.
  - latLngToContainerPoint
```
public Point latLngToContainerPoint(LatLng latlng)
```
    Returns the map container point that corresponds to the given geographical coordinates.
    
    Parameters:
    
    latlng - The geographical coordinates.
    
    Returns:
    
    Returns the map container point.
  - containerPointToLatLng
```
public LatLng containerPointToLatLng(Point point)
```
    Returns the geographical coordinates of a given map container point.
    
    Parameters:
    
    point - The map container point.
    
    Returns:
    
    Returns the geographical coordinates.
  - project
```
public Point project(LatLng latlng)
```
    Projects the given geographical coordinates to absolute pixel coordinates for the given zoom level (current zoom level by default).
    
    Parameters:
    
    latlng - The geographical coordinates.
    
    Returns:
    
    Returns the absolute pixel coordinates.
  - project
```
public Point project(LatLng latlng,
                     int zoom)
```
    Projects the given geographical coordinates to absolute pixel coordinates for the given zoom level (current zoom level by default).
    
    Parameters:
    
    latlng - The geographical coordinates.
    
    zoom - The zoom level.
    
    Returns:
    
    Returns the absolute pixel coordinates.
  - unproject
```
public LatLng unproject(Point point)
```
    Projects the given absolute pixel coordinates to geographical coordinates for the given zoom level (current zoom level by default).
    
    Parameters:
    
    point - The absolute pixel coordinates.
    
    Returns:
    
    Returns the geographical coordinates.
  - unproject
```
public LatLng unproject(Point point,
                        int zoom)
```
    Projects the given absolute pixel coordinates to geographical coordinates for the given zoom level (current zoom level by default).
    
    Parameters:
    
    point - The absolute pixel coordinates.
    
    zoom - The zoom level.
    
    Returns:
    
    Returns the geographical coordinates.

Class Map

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Map

Map

Method Detail

setView

setView

setView

addLayer

removeLayer

hasLayer

getLayers

addMouseListener

addEventListener

addDragEndListener

addResizeListener

addLayerListener

addLocationListener

addErrorListener

addPopupListener

removeMouseListener

removeEventListener

removeDragEndListener

removeResizeListener

removeLayerListener

removeLocationListener

removeErrorListener

removePopupListener

clearAllEventListeners

openPopup

openPopup

openPopup

closePopup

closePopup

getCenter

getZoom

getMinZoom

getMaxZoom

getBounds

getBoundsZoom

getBoundsZoom

getSize

getPixelBounds

getPixelOrigin

latLngToLayerPoint

layerPointToLatLng

containerPointToLayerPoint

layerPointToContainerPoint

latLngToContainerPoint

containerPointToLatLng

project

project

unproject

unproject