com.gwidgets.api.leaflet

Class LayerGroup

java.lang.Object

com.gwidgets.api.leaflet.LayerGroup

All Implemented Interfaces:

ILayer

@JsType(isNative=true)
public class LayerGroup
extends java.lang.Object
implements 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.

Author:

Zakaria Amine

Method Summary

Modifier and Type	Method and Description
L	addLayer(ILayer layer) Adds a given layer to the group.
L	addTo(Map map) Adds the group of layers to the map.
L	clearLayers() Removes all the layers from the group.
L	eachLayer(Function fn, com.google.gwt.core.client.JavaScriptObject context) Iterates over the layers of the group, optionally specifying context of the iterator function.
java.lang.Boolean	getLayer(java.lang.String id) Returns the layer with the given id.
com.google.gwt.core.client.JsArray<com.google.gwt.core.client.JavaScriptObject>	getLayers() Returns an array of all the layers added to the group.
java.lang.Boolean	hasLayer(ILayer layer) Returns true if the given layer is currently added to the group.
void	onAdd(Map map) Should contain code that creates DOM elements for the overlay, adds them to map panes where they should belong and puts listeners on relevant map events.
void	onRemove(Map map) Should contain all clean up code that removes the overlay's elements from the DOM and removes listeners previously added in onAdd.
L	removeLayer(ILayer layer) Removes a given layer from the group.
L	removeLayer(java.lang.String id) Removes a given layer from the group.
com.google.gwt.core.client.JavaScriptObject	toGeoJSON() Returns a GeoJSON representation of the layer group (GeoJSON FeatureCollection).

Methods inherited from class java.lang.Object

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

Method Detail

addTo

@JsMethod
public L addTo(Map map)

Adds the group of layers to the map.

Parameters:

map - the map

Returns:

the L class

addLayer

@JsMethod
public L addLayer(ILayer layer)

Adds a given layer to the group.

Parameters:

layer - the layer

Returns:

the l

removeLayer

@JsMethod
public L removeLayer(ILayer layer)

Removes a given layer from the group.

Parameters:

layer - the layer

Returns:

the l

removeLayer

@JsMethod
public L removeLayer(java.lang.String id)

Removes a given layer from the group.

Parameters:

id - the id

Returns:

the l

hasLayer

@JsMethod
public java.lang.Boolean hasLayer(ILayer layer)

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

Parameters:

layer - the layer

Returns:

the boolean

getLayer

@JsMethod
public java.lang.Boolean getLayer(java.lang.String id)

Returns the layer with the given id.

Parameters:

id - the id

Returns:

true/false

getLayers

@JsMethod
public com.google.gwt.core.client.JsArray<com.google.gwt.core.client.JavaScriptObject> getLayers()

Returns an array of all the layers added to the group.

Returns:

the layers

clearLayers

@JsMethod
public L clearLayers()

Removes all the layers from the group.

Returns:

the l

eachLayer

@JsMethod
public L eachLayer(Function fn,
                              com.google.gwt.core.client.JavaScriptObject context)

Iterates over the layers of the group, optionally specifying context of the iterator function.

Parameters:

fn - the action function

context - the context

Returns:

the l

toGeoJSON

@JsMethod
public com.google.gwt.core.client.JavaScriptObject toGeoJSON()

Returns a GeoJSON representation of the layer group (GeoJSON FeatureCollection).

Returns:

the object

onAdd

@JsMethod
public void onAdd(Map map)

Description copied from interface: ILayer

Should contain code that creates DOM elements for the overlay, adds them to map panes where they should belong and puts listeners on relevant map events. Called on map.addLayer(layer).

Specified by:

onAdd in interface ILayer

Parameters:

map - the map

onRemove

@JsMethod
public void onRemove(Map map)

Description copied from interface: ILayer

Should contain all clean up code that removes the overlay's elements from the DOM and removes listeners previously added in onAdd. Called on map.removeLayer(layer).

Specified by:

onRemove in interface ILayer

Parameters:

map - the map