net.java.html.leaflet

Class MultiPolygon

java.lang.Object

net.java.html.leaflet.ILayer

net.java.html.leaflet.LayerGroup

net.java.html.leaflet.FeatureGroup

net.java.html.leaflet.MultiPolygon

public final class MultiPolygon
extends FeatureGroup

Extends FeatureGroup to allow creating multi-polygons (single layer that consists of several polygons that share styling/popup).

Constructor Summary

Constructors

Constructor and Description
MultiPolygon(LatLng[][] latlngs) Instantiates a multi-polygon object given an array of latlngs arrays (one for each individual polygon).
MultiPolygon(LatLng[][] latlngs, PolyLineOptions options) Instantiates a multi-polygon object given an array of latlngs arrays (one for each individual polygon) and an options object.

Method Summary

Modifier and Type	Method and Description
MultiPolygon	addLayer(ILayer layer) Adds a given layer to the group.
MultiPolygon	addTo(Map map) Adds the group of layers to the map.
MultiPolygon	bindPopup(String html) Binds a popup with a particular HTML content to a click on this group.
MultiPolygon	bindPopup(String html, PopupOptions options) Binds a popup with a particular HTML content and the given options to the group.
MultiPolygon	bringToBack() Brings the layer to the bottom of all path layers.
MultiPolygon	bringToFront() Brings the layer to the top of all path layers.
MultiPolygon	clearLayers() Removes all the layers from the group.
LatLng[][]	getLatLngs() Returns an array of arrays of geographical points in each polygon.
MultiPolygon	openPopup() Opens the popup previously bound by bindPopup.
MultiPolygon	removeLayer(ILayer layer) Removes a given layer from the group.
MultiPolygon	removeLayer(String layerId) Removes a given layer of the given id from the group.
MultiPolygon	setLatLngs(LatLng[][] latlngs) Replace all polygons and their paths with the given array of arrays of geographical points.
MultiPolygon	setStyle(PathOptions options) Changes the appearance of a FeatureGroup based on the options in the PathOptions object.

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

addLayerListener, addMouseListener, clearAllEventListeners, getBounds, removeLayerListener, removeMouseListener

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

getLayers, hasLayer

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiPolygon

public MultiPolygon(LatLng[][] latlngs)

Instantiates a multi-polygon object given an array of latlngs arrays (one for each individual polygon).

Parameters:

latlngs - array of latlngs arrays

MultiPolygon

public MultiPolygon(LatLng[][] latlngs,
                    PolyLineOptions options)

Instantiates a multi-polygon object given an array of latlngs arrays (one for each individual polygon) and an options object.

Parameters:

latlngs - array of latlngs arrays

options - configuration options

Method Detail

setLatLngs

public MultiPolygon setLatLngs(LatLng[][] latlngs)

Replace all polygons and their paths with the given array of arrays of geographical points.

Parameters:

latlngs - array of arrays of geographical points

Returns:

this

getLatLngs

public LatLng[][] getLatLngs()

Returns an array of arrays of geographical points in each polygon.

Returns:

array of arrays of geographical points

openPopup

public MultiPolygon openPopup()

Opens the popup previously bound by bindPopup.

Returns:

this

bindPopup

public MultiPolygon bindPopup(String html)

Binds a popup with a particular HTML content to a click on this group.

Overrides:

bindPopup in class FeatureGroup

Parameters:

html - poup HTML content

Returns:

this

bindPopup

public MultiPolygon bindPopup(String html,
                              PopupOptions options)

Binds a popup with a particular HTML content and the given options to the group.

Overrides:

bindPopup in class FeatureGroup

Parameters:

html - poup HTML content

options - popup configuration object

Returns:

this

setStyle

public MultiPolygon setStyle(PathOptions options)

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

Overrides:

setStyle in class FeatureGroup

Parameters:

options - path configuration options

Returns:

this

bringToFront

public MultiPolygon bringToFront()

Brings the layer to the top of all path layers.

Overrides:

bringToFront in class FeatureGroup

Returns:

this

bringToBack

public MultiPolygon bringToBack()

Brings the layer to the bottom of all path layers.

Overrides:

bringToBack in class FeatureGroup

Returns:

this

addTo

public MultiPolygon addTo(Map map)

Adds the group of layers to the map.

Overrides:

addTo in class FeatureGroup

Parameters:

map - The map

Returns:

this

addLayer

public MultiPolygon addLayer(ILayer layer)

Adds a given layer to the group.

Overrides:

addLayer in class FeatureGroup

Parameters:

layer - The layer to add

Returns:

this

removeLayer

public MultiPolygon removeLayer(ILayer layer)

Removes a given layer from the group.

Overrides:

removeLayer in class FeatureGroup

Parameters:

layer - The layer to remove

Returns:

this

removeLayer

public MultiPolygon removeLayer(String layerId)

Removes a given layer of the given id from the group.

Overrides:

removeLayer in class FeatureGroup

Parameters:

layerId - The layer id of the layer to remove

Returns:

this

clearLayers

public MultiPolygon clearLayers()

Removes all the layers from the group.

Overrides:

clearLayers in class FeatureGroup

Returns:

this