net.java.html.leaflet

Class FeatureGroup

java.lang.Object

net.java.html.leaflet.ILayer

net.java.html.leaflet.LayerGroup

net.java.html.leaflet.FeatureGroup

Direct Known Subclasses:

MultiPolygon, MultiPolyline

public class FeatureGroup
extends LayerGroup

A group of features.

Author:

Stefan Wurzinger

Constructor Summary

Constructors

Constructor and Description
FeatureGroup(ILayer[] layers)

Method Summary

Modifier and Type	Method and Description
FeatureGroup	addLayer(ILayer layer) Adds a given layer to the group.
FeatureGroup	addLayerListener(LayerEvent.Type type, LayerListener listener) Adds a layer listener to a particular layer event type of the object.
FeatureGroup	addMouseListener(MouseEvent.Type type, MouseListener listener) Adds a mouse listener to a particular mouse event type of the object.
FeatureGroup	addTo(Map map) Adds the group of layers to the map.
FeatureGroup	bindPopup(String html) Binds a popup with a particular HTML content to a click on this group.
FeatureGroup	bindPopup(String html, PopupOptions options) Binds a popup with a particular HTML content and the given options to the group.
FeatureGroup	bringToBack() Brings the layer to the bottom of all path layers.
FeatureGroup	bringToFront() Brings the layer to the top of all path layers.
FeatureGroup	clearAllEventListeners() Removes all listeners to all events on the object.
FeatureGroup	clearLayers() Removes all the layers from the group.
LatLngBounds	getBounds() Returns the LatLngBounds of the layers.
FeatureGroup	removeLayer(ILayer layer) Removes a given layer from the group.
FeatureGroup	removeLayer(String layerId) Removes a given layer of the given id from the group.
FeatureGroup	removeLayerListener(LayerEvent.Type type, LayerListener listener) Removes a layer listener to a particular layer event type of the object.
FeatureGroup	removeMouseListener(MouseEvent.Type type, MouseListener listener) Removes a mouse listener to a particular mouse event type of the object.
FeatureGroup	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.LayerGroup

getLayers, hasLayer

Methods inherited from class java.lang.Object

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

Constructor Detail

FeatureGroup

public FeatureGroup(ILayer[] layers)

Method Detail

addMouseListener

public FeatureGroup 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, MOUSEOVER, MOUSEOUT and MOUSEMOVE are supported.

listener - The registered listener.

Returns:

The map object.

addLayerListener

public FeatureGroup 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 and LAYERREMOVE are supported.

listener - The registered listener.

Returns:

The map object.

removeMouseListener

public FeatureGroup 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, MOUSEOVER, MOUSEOUT and MOUSEMOVE are supported.

listener - The registered listener.

Returns:

The map object.

removeLayerListener

public FeatureGroup 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 and LAYERREMOVE are supported.

listener - The registered listener.

Returns:

The map object.

clearAllEventListeners

public FeatureGroup clearAllEventListeners()

Removes all listeners to all events on the object.

Returns:

The map object.

bindPopup

public FeatureGroup bindPopup(String html)

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

Parameters:

html - poup HTML content

Returns:

this

bindPopup

public FeatureGroup bindPopup(String html,
                              PopupOptions options)

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

Parameters:

html - poup HTML content

options - popup configuration object

Returns:

this

setStyle

public FeatureGroup setStyle(PathOptions options)

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

Parameters:

options - path configuration options

Returns:

this

getBounds

public LatLngBounds getBounds()

Returns the LatLngBounds of the layers.

Returns:

LatLngBounds of the layers

bringToFront

public FeatureGroup bringToFront()

Brings the layer to the top of all path layers.

Returns:

this

bringToBack

public FeatureGroup bringToBack()

Brings the layer to the bottom of all path layers.

Returns:

this

addTo

public FeatureGroup addTo(Map map)

Adds the group of layers to the map.

Overrides:

addTo in class LayerGroup

Parameters:

map - The map

Returns:

this

addLayer

public FeatureGroup addLayer(ILayer layer)

Adds a given layer to the group.

Overrides:

addLayer in class LayerGroup

Parameters:

layer - The layer to add

Returns:

this

removeLayer

public FeatureGroup removeLayer(ILayer layer)

Removes a given layer from the group.

Overrides:

removeLayer in class LayerGroup

Parameters:

layer - The layer to remove

Returns:

this

removeLayer

public FeatureGroup removeLayer(String layerId)

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

Overrides:

removeLayer in class LayerGroup

Parameters:

layerId - The layer id of the layer to remove

Returns:

this

clearLayers

public FeatureGroup clearLayers()

Removes all the layers from the group.

Overrides:

clearLayers in class LayerGroup

Returns:

this