net.java.html.leaflet

Class LayerGroup

java.lang.Object

net.java.html.leaflet.ILayer

net.java.html.leaflet.LayerGroup

Direct Known Subclasses:

FeatureGroup

public class LayerGroup
extends ILayer

Used to group several layers and handle them as one. If you add it to the map, any layers added or removed from the group will be added/removed on the map as well.

Constructor Summary

Constructors

Constructor and Description
LayerGroup(ILayer[] layers) Creates a layer group from an array of layers

Method Summary

Modifier and Type	Method and Description
LayerGroup	addLayer(ILayer layer) Adds a given layer to the group.
LayerGroup	addTo(Map map) Adds the group of layers to the map.
LayerGroup	clearLayers() Removes all the layers from the group.
ILayer[]	getLayers() Returns all layers in the group
boolean	hasLayer(ILayer layer) Returns true if the given layer is currently added to the group.
LayerGroup	removeLayer(ILayer layer) Removes a given layer from the group.
LayerGroup	removeLayer(String layerId) Removes a given layer of the given id from the group.

Methods inherited from class java.lang.Object

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

Constructor Detail

LayerGroup

public LayerGroup(ILayer[] layers)

Creates a layer group from an array of layers

Parameters:

layers - array of layers

Method Detail

addTo

public LayerGroup addTo(Map map)

Adds the group of layers to the map.

Parameters:

map - The map

Returns:

this

addLayer

public LayerGroup addLayer(ILayer layer)

Adds a given layer to the group.

Parameters:

layer - The layer to add

Returns:

this

removeLayer

public LayerGroup removeLayer(ILayer layer)

Removes a given layer from the group.

Parameters:

layer - The layer to remove

Returns:

this

removeLayer

public LayerGroup removeLayer(String layerId)

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

Parameters:

layerId - The layer id of the layer to remove

Returns:

this

hasLayer

public boolean hasLayer(ILayer layer)

Returns true if the given layer is currently added to the group.

Parameters:

layer - layer to check whether in group

Returns:

true if the given layer is currently added to the group

getLayers

public ILayer[] getLayers()

Returns all layers in the group

Returns:

array of all layers in the group

clearLayers

public LayerGroup clearLayers()

Removes all the layers from the group.

Returns:

this