net.java.html.leaflet

Class Polygon

java.lang.Object

net.java.html.leaflet.ILayer

net.java.html.leaflet.Path

net.java.html.leaflet.PolyLine

net.java.html.leaflet.Polygon

Direct Known Subclasses:

Rectangle

public class Polygon
extends PolyLine

A class for drawing polygon overlays on a map.

Constructor Summary

Constructors

Constructor and Description
Polygon(LatLng[] latlngs) Instantiates a polygon object given an array of geographical points.
Polygon(LatLng[] latlngs, PolyLineOptions options) Instantiates a polygon object given an array of geographical points and an options object (the same as for Polyline).

Method Summary

Modifier and Type	Method and Description
Polygon	addLatLng(LatLng latlng) Adds a given point to the polygon.
Polygon	addTo(Map map) Adds the layer to the map.
Polygon	bindPopup(Popup popup) Binds a popup to a click on this polygon.
Polygon	bindPopup(Popup popup, PopupOptions options) Binds a popup with a particular popup configuration options to a click on this polygon.
Polygon	bindPopup(String html) Binds a popup with a particular HTML content to a click on this polygon.
Polygon	bringToBack() Brings the layer to the bottom of all path layers.
Polygon	bringToFront() Brings the layer to the top of all path layers.
Polygon	closePopup() Closes the bound popup of the polygon if it's opened.
Polygon	openPopup() Opens the popup previously bound by the bindPopup method.
Polygon	redraw() Redraws the layer.
Polygon	setLatLngs(LatLng[] latlngs) Replaces all the points in the polygon with the given array of geographical points.
Polygon	setStyle(PathOptions options) Changes the appearance of a Path based on the options in the PathOptions object.
Polygon	unbindPopup() Unbinds the popup previously bound to the polygon with bindPopup.

Methods inherited from class net.java.html.leaflet.PolyLine

getLatLngs, spliceLatLngs

Methods inherited from class net.java.html.leaflet.Path

addEventListener, addMouseListener, addPopupListener, clearAllEventListeners, getBounds, removeEventListener, removeMouseListener, removePopupListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Polygon

public Polygon(LatLng[] latlngs)

Instantiates a polygon object given an array of geographical points.

Parameters:

latlngs - Points of the polygon. Shouldn't contain an additional last point equal to the first one.

Polygon

public Polygon(LatLng[] latlngs,
               PolyLineOptions options)

Instantiates a polygon object given an array of geographical points and an options object (the same as for Polyline).

Parameters:

latlngs - Points of the polygon. Shouldn't contain an additional last point equal to the first one.

options - configuration options

Method Detail

addLatLng

public Polygon addLatLng(LatLng latlng)

Adds a given point to the polygon.

Overrides:

addLatLng in class PolyLine

Parameters:

latlng - point to add

Returns:

this

setLatLngs

public Polygon setLatLngs(LatLng[] latlngs)

Replaces all the points in the polygon with the given array of geographical points.

Overrides:

setLatLngs in class PolyLine

Parameters:

latlngs - array of points that replace the existing ones

Returns:

this

addTo

public Polygon addTo(Map map)

Adds the layer to the map.

Overrides:

addTo in class PolyLine

Parameters:

map - The map

Returns:

this

setStyle

public Polygon setStyle(PathOptions options)

Changes the appearance of a Path based on the options in the PathOptions object.

Overrides:

setStyle in class PolyLine

Parameters:

options - path configuration options

Returns:

this

bringToFront

public Polygon bringToFront()

Brings the layer to the top of all path layers.

Overrides:

bringToFront in class PolyLine

Returns:

this

bringToBack

public Polygon bringToBack()

Brings the layer to the bottom of all path layers.

Overrides:

bringToBack in class PolyLine

Returns:

this

redraw

public Polygon redraw()

Redraws the layer. Sometimes useful after you changed the coordinates that the path uses.

Overrides:

redraw in class PolyLine

Returns:

this

bindPopup

public Polygon bindPopup(String html)

Binds a popup with a particular HTML content to a click on this polygon. You can also open the bound popup with the Polygon openPopup method.

Overrides:

bindPopup in class PolyLine

Parameters:

html - HTML content of the popup

Returns:

this

bindPopup

public Polygon bindPopup(Popup popup)

Binds a popup to a click on this polygon. You can also open the bound popup with the Polygon openPopup method.

Overrides:

bindPopup in class PolyLine

Parameters:

popup - popup object

Returns:

this

bindPopup

public Polygon bindPopup(Popup popup,
                         PopupOptions options)

Binds a popup with a particular popup configuration options to a click on this polygon. You can also open the bound popup with the Polygon openPopup method.

Overrides:

bindPopup in class PolyLine

Parameters:

popup - popup object

options - popup configuration options

Returns:

this

unbindPopup

public Polygon unbindPopup()

Unbinds the popup previously bound to the polygon with bindPopup.

Overrides:

unbindPopup in class PolyLine

Returns:

this

openPopup

public Polygon openPopup()

Opens the popup previously bound by the bindPopup method.

Overrides:

openPopup in class PolyLine

Returns:

this

closePopup

public Polygon closePopup()

Closes the bound popup of the polygon if it's opened.

Overrides:

closePopup in class PolyLine

Returns:

this