LayerGroup (gwty-leaflet 1.0 API)

java.lang.Object
- com.gwidgets.api.leaflet.LayerGroup

All Implemented Interfaces:

Evented, Layer

Direct Known Subclasses:

FeatureGroup
```
@JsType(isNative=true)
public class LayerGroup
extends Object
implements Layer, Evented
```
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

Constructor Summary

Constructors
Constructor and Description

LayerGroup()

Constructors
Constructor and Description
`LayerGroup()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`L`	`addEventParent(Evented obj)` Adds an event parent - an Evented that will receive propagated events
`L`	`addLayer(Layer layer)` Adds a given layer to the group.
`L`	`addTo(Map map)` Adds the tooltip to the given map
`L`	`bindPopup(elemental2.dom.HTMLElement content, PopupOptions options)` Binds a popup to the layer with the passed content and sets up the neccessary event listeners.
`L`	`bindPopup(String id, PopupOptions options)` Binds a popup to the layer with the passed content and sets up the neccessary event listeners.
`L`	`bindTooltip(elemental2.dom.HTMLElement content, TooltipOptions options)` Binds a tooltip to the layer with the passed *content and sets up the neccessary event listeners.
`L`	`bindTooltip(String content, TooltipOptions options)` Binds a tooltip to the layer with the passed *content and sets up the neccessary event listeners.
`L`	`bindTooltip(Tooltip content, TooltipOptions options)` Binds a tooltip to the layer with the passed content and sets up the neccessary event listeners.
`L`	`clearAllEventListeners()` Clear all event listeners.
`L`	`clearLayers()` Removes all the layers from the group.
`L`	`closePopup()` Closes the popup bound to this layer if it is open.
`L`	`closeTooltip()` Closes the tooltip bound to this layer if it is open.
`L`	`eachLayer(elemental2.core.Function fn, com.google.gwt.core.client.JavaScriptObject context)` Iterates over the layers of the group, optionally specifying context of the iterator function.
`L`	`fire(String type)` Fires an event of the specified type.
`Boolean`	`getLayer(String id)` Returns the layer with the given id.
`double`	`getLayerId(Layer layer)` Returns the internal ID for a layer.
`Layer[]`	`getLayers()` Returns an array of all the layers added to the group.
`elemental2.dom.HTMLElement`	`getPane(String name)` Returns the HTMLElement representing the named pane on the map.
`Popup`	`getPopup()` Returns the popup bound to this layer.
`Tooltip`	`getTooltip()` Returns the tooltip bound to this layer.
`Boolean`	`hasLayer(Layer layer)` Returns true if the given layer is currently added to the group.
`L`	`invoke(String methodName)` Calls methodName on every layer contained in this group, passing any additional parameters.
`boolean`	`isPopupOpen()` Returns true if the popup bound to this layer is currently open.
`boolean`	`isTooltipOpen()` Returns true if the tooltip bound to this layer is currently open.
`Boolean`	`listens(String type)` Returns true if a particular event type has any listeners attached to it.
`L`	`off()` Removes all listener
`L`	`off(String type)` Removes a listener
`L`	`off(String[] type)` Removes a set of listener
`L`	`on(String type, EventCallback fn)` Adds a set of type/listener pairs.
`L`	`once(String type, EventCallback fn)` the listener will only get fired once and then removed.
`L`	`openPopup(LatLng latlng)` Opens the bound popup at the specificed latlng or at the default popup anchor if no latlng is passed.
`L`	`openTooltip(LatLng latlng)` Opens the bound tooltip at the specificed latlng or at the default tooltip anchor if no latlng is passed.
`L`	`remove()` Removes the tooltip from the map it is currently active on.
`L`	`removeEventParent(Evented obj)` Removes an event parent, so it will stop receiving propagated events
`L`	`removeFrom(Map map)` Removes the tooltip from the given map
`L`	`removeLayer(Layer layer)` Removes a given layer from the group.
`L`	`removeLayer(String id)` Removes a given layer from the group.
`L`	`setPopupContent(elemental2.dom.HTMLElement content)` Sets the content of the popup bound to this layer.
`L`	`setPopupContent(Popup content)` Sets the content of the popup bound to this layer.
`L`	`setPopupContent(String content)` Sets the content of the popup bound to this layer.
`L`	`setTooltipContent(elemental2.dom.HTMLElement content)` Sets the content of the tooltip bound to this layer.
`L`	`setTooltipContent(String content)` Sets the content of the tooltip bound to this layer.
`L`	`setTooltipContent(Tooltip content)` Sets the content of the tooltip bound to this layer.
`L`	`setZIndex(double zIndex)` Calls setZIndex on every layer contained in this group, passing the z-index.
`com.google.gwt.core.client.JavaScriptObject`	`toGeoJSON()` Returns a GeoJSON representation of the layer group (GeoJSON FeatureCollection).
`L`	`togglePopup()` Opens or closes the popup bound to this layer depending on its current state.
`L`	`toggleTooltip()` Opens or closes the tooltip bound to this layer depending on its current state.
`L`	`unbindPopup()` Removes the popup previously bound with bindPopup.
`L`	`unbindTooltip()` Removes the tooltip previously bound with *bindTooltip.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LayerGroup
```
public LayerGroup()
```
- Method Detail
  - addLayer
```
@JsMethod
public L addLayer(Layer layer)
```
    Adds a given layer to the group.
    
    Parameters:
    
    layer - the layer
    
    Returns:
    
    the l
  - removeLayer
```
@JsMethod
public L removeLayer(Layer layer)
```
    Removes a given layer from the group.
    
    Parameters:
    
    layer - the layer
    
    Returns:
    
    the l
  - removeLayer
```
@JsMethod
public L removeLayer(String id)
```
    Removes a given layer from the group.
    
    Parameters:
    
    id - the id
    
    Returns:
    
    the l
  - hasLayer
```
@JsMethod
public Boolean hasLayer(Layer layer)
```
    Returns true if the given layer is currently added to the group.
    
    Parameters:
    
    layer - the layer
    
    Returns:
    
    the boolean
  - getLayer
```
@JsMethod
public Boolean getLayer(String id)
```
    Returns the layer with the given id.
    
    Parameters:
    
    id - the id
    
    Returns:
    
    true/false
  - getLayers
```
@JsMethod
public Layer[] 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(elemental2.core.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
  - setZIndex
```
@JsMethod
public L setZIndex(double zIndex)
```
    Calls setZIndex on every layer contained in this group, passing the z-index.
    
    Parameters:
    
    zIndex - the z index
    
    Returns:
    
    the L class
  - getLayerId
```
@JsMethod
public double getLayerId(Layer layer)
```
    Returns the internal ID for a layer.
    
    Parameters:
    
    layer - the layer
    
    Returns:
    
    the layer id
  - invoke
```
@JsMethod
public L invoke(String methodName)
```
    Calls methodName on every layer contained in this group, passing any additional parameters. Has no effect if the layers contained do not implement methodName
    
    Parameters:
    
    methodName - the method name
    
    Returns:
    
    the L class
  - bindPopup
```
@JsMethod
public L bindPopup(elemental2.dom.HTMLElement content,
                             PopupOptions options)
```
    Description copied from interface: Layer
    
    Binds a popup to the layer with the passed content and sets up the neccessary event listeners.
    
    Specified by:
    
    bindPopup in interface Layer
    
    Returns:
    
    the L class
  - bindPopup
```
@JsMethod
public L bindPopup(String id,
                             PopupOptions options)
```
    Description copied from interface: Layer
    
    Binds a popup to the layer with the passed content and sets up the neccessary event listeners.
    
    Specified by:
    
    bindPopup in interface Layer
    
    Returns:
    
    the L class
  - unbindPopup
```
@JsMethod
public L unbindPopup()
```
    Description copied from interface: Layer
    
    Removes the popup previously bound with bindPopup.
    
    Specified by:
    
    unbindPopup in interface Layer
    
    Returns:
    
    the L class
  - openPopup
```
@JsMethod
public L openPopup(LatLng latlng)
```
    Description copied from interface: Layer
    
    Opens the bound popup at the specificed latlng or at the default popup anchor if no latlng is passed.
    
    Specified by:
    
    openPopup in interface Layer
    
    Returns:
    
    the L class
  - closePopup
```
@JsMethod
public L closePopup()
```
    Description copied from interface: Layer
    
    Closes the popup bound to this layer if it is open.
    
    Specified by:
    
    closePopup in interface Layer
    
    Returns:
    
    the L class
  - togglePopup
```
@JsMethod
public L togglePopup()
```
    Description copied from interface: Layer
    
    Opens or closes the popup bound to this layer depending on its current state.
    
    Specified by:
    
    togglePopup in interface Layer
    
    Returns:
    
    the L class
  - isPopupOpen
```
@JsMethod
public boolean isPopupOpen()
```
    Description copied from interface: Layer
    
    Returns true if the popup bound to this layer is currently open.
    
    Specified by:
    
    isPopupOpen in interface Layer
    
    Returns:
    
    true if pop up is open false if closed
  - setPopupContent
```
@JsMethod
public L setPopupContent(String content)
```
    Description copied from interface: Layer
    
    Sets the content of the popup bound to this layer.
    
    Specified by:
    
    setPopupContent in interface Layer
    
    Returns:
    
    the L class
  - setPopupContent
```
@JsMethod
public L setPopupContent(elemental2.dom.HTMLElement content)
```
    Description copied from interface: Layer
    
    Sets the content of the popup bound to this layer.
    
    Specified by:
    
    setPopupContent in interface Layer
    
    Returns:
    
    the L class
  - setPopupContent
```
@JsMethod
public L setPopupContent(Popup content)
```
    Description copied from interface: Layer
    
    Sets the content of the popup bound to this layer.
    
    Specified by:
    
    setPopupContent in interface Layer
    
    Returns:
    
    the L class
  - getPopup
```
@JsMethod
public Popup getPopup()
```
    Description copied from interface: Layer
    
    Returns the popup bound to this layer.
    
    Specified by:
    
    getPopup in interface Layer
    
    Returns:
    
    Popup the Pop bound to this layer.
  - bindTooltip
```
public L bindTooltip(String content,
                     TooltipOptions options)
```
    Description copied from interface: Layer
    
    Binds a tooltip to the layer with the passed *content and sets up the neccessary event listeners. If a Function is passed it will receive the layer as the first argument and should return a String or HTMLElement.
    
    Specified by:
    
    bindTooltip in interface Layer
    
    Returns:
    
    the L class
  - bindTooltip
```
public L bindTooltip(elemental2.dom.HTMLElement content,
                     TooltipOptions options)
```
    Description copied from interface: Layer
    
    Binds a tooltip to the layer with the passed *content and sets up the neccessary event listeners. If a Function is passed it will receive the layer as the first argument and should return a String or HTMLElement.
    
    Specified by:
    
    bindTooltip in interface Layer
    
    Returns:
    
    the L class
  - bindTooltip
```
public L bindTooltip(Tooltip content,
                     TooltipOptions options)
```
    Description copied from interface: Layer
    
    Binds a tooltip to the layer with the passed content and sets up the neccessary event listeners. If a Function is passed it will receive the layer as the first argument and should return a String or HTMLElement.
    
    Specified by:
    
    bindTooltip in interface Layer
    
    Returns:
    
    the L class
  - unbindTooltip
```
public L unbindTooltip()
```
    Description copied from interface: Layer
    
    Removes the tooltip previously bound with *bindTooltip.
    
    Specified by:
    
    unbindTooltip in interface Layer
    
    Returns:
    
    the L class
  - openTooltip
```
public L openTooltip(LatLng latlng)
```
    Description copied from interface: Layer
    
    Opens the bound tooltip at the specificed latlng or at the default tooltip anchor if no latlng is passed.
    
    Specified by:
    
    openTooltip in interface Layer
    
    Returns:
    
    the L class
  - closeTooltip
```
public L closeTooltip()
```
    Description copied from interface: Layer
    
    Closes the tooltip bound to this layer if it is open.
    
    Specified by:
    
    closeTooltip in interface Layer
    
    Returns:
    
    the L class
  - toggleTooltip
```
public L toggleTooltip()
```
    Description copied from interface: Layer
    
    Opens or closes the tooltip bound to this layer depending on its current state.
    
    Specified by:
    
    toggleTooltip in interface Layer
    
    Returns:
    
    the L class
  - isTooltipOpen
```
public boolean isTooltipOpen()
```
    Description copied from interface: Layer
    
    Returns true if the tooltip bound to this layer is currently open.
    
    Specified by:
    
    isTooltipOpen in interface Layer
    
    Returns:
    
    boolean true if tooltip is open, false otherwise
  - setTooltipContent
```
public L setTooltipContent(String content)
```
    Description copied from interface: Layer
    
    Sets the content of the tooltip bound to this layer.
    
    Specified by:
    
    setTooltipContent in interface Layer
    
    Returns:
    
    the L class
  - setTooltipContent
```
public L setTooltipContent(elemental2.dom.HTMLElement content)
```
    Description copied from interface: Layer
    
    Sets the content of the tooltip bound to this layer.
    
    Specified by:
    
    setTooltipContent in interface Layer
    
    Returns:
    
    the L class
  - setTooltipContent
```
public L setTooltipContent(Tooltip content)
```
    Description copied from interface: Layer
    
    Sets the content of the tooltip bound to this layer.
    
    Specified by:
    
    setTooltipContent in interface Layer
    
    Returns:
    
    the L class
  - getTooltip
```
public Tooltip getTooltip()
```
    Description copied from interface: Layer
    
    Returns the tooltip bound to this layer.
    
    Specified by:
    
    getTooltip in interface Layer
    
    Returns:
    
    ToolTip the tooltip
  - addTo
```
public L addTo(Map map)
```
    Description copied from interface: Layer
    
    Adds the tooltip to the given map
    
    Specified by:
    
    addTo in interface Layer
    
    Returns:
    
    the L class
  - remove
```
public L remove()
```
    Description copied from interface: Layer
    
    Removes the tooltip from the map it is currently active on.
    
    Specified by:
    
    remove in interface Layer
    
    Returns:
    
    the L class
  - removeFrom
```
public L removeFrom(Map map)
```
    Description copied from interface: Layer
    
    Removes the tooltip from the given map
    
    Specified by:
    
    removeFrom in interface Layer
    
    Returns:
    
    the L class
  - getPane
```
public elemental2.dom.HTMLElement getPane(String name)
```
    Description copied from interface: Layer
    
    Returns the HTMLElement representing the named pane on the map. If name is omitted, returns the pane for this layer.
    
    Specified by:
    
    getPane in interface Layer
    
    Returns:
    
    HTMLElement the element
  - clearAllEventListeners
```
public L clearAllEventListeners()
```
    Description copied from interface: Evented
    
    Clear all event listeners.
    
    Specified by:
    
    clearAllEventListeners in interface Evented
    
    Returns:
    
    the L class
  - on
```
public L on(String type,
            EventCallback fn)
```
    Description copied from interface: Evented
    
    Adds a set of type/listener pairs.
    
    Specified by:
    
    on in interface Evented
    
    Parameters:
    
    type - the type
    
    fn - the callback function
    
    Returns:
    
    the L class
  - once
```
public L once(String type,
              EventCallback fn)
```
    Description copied from interface: Evented
    
    the listener will only get fired once and then removed.
    
    Specified by:
    
    once in interface Evented
    
    Parameters:
    
    type - the type
    
    fn - the callback function
    
    Returns:
    
    the L class
  - off
```
public L off(String type)
```
    Description copied from interface: Evented
    
    Removes a listener
    
    Specified by:
    
    off in interface Evented
    
    Parameters:
    
    type - the type
    
    Returns:
    
    the L class
  - off
```
public L off(String[] type)
```
    Description copied from interface: Evented
    
    Removes a set of listener
    
    Specified by:
    
    off in interface Evented
    
    Parameters:
    
    type - the type
    
    Returns:
    
    the L class
  - off
```
public L off()
```
    Description copied from interface: Evented
    
    Removes all listener
    
    Specified by:
    
    off in interface Evented
    
    Returns:
    
    the L class
  - fire
```
public L fire(String type)
```
    Description copied from interface: Evented
    
    Fires an event of the specified type. You can optionally provide an data object — the first argument of the listener function will contain its properties.
    
    Specified by:
    
    fire in interface Evented
    
    Parameters:
    
    type - the type
    
    Returns:
    
    the L class
  - listens
```
public Boolean listens(String type)
```
    Description copied from interface: Evented
    
    Returns true if a particular event type has any listeners attached to it.
    
    Specified by:
    
    listens in interface Evented
    
    Returns:
    
    true if there is listener, false otherwise
  - addEventParent
```
public L addEventParent(Evented obj)
```
    Description copied from interface: Evented
    
    Adds an event parent - an Evented that will receive propagated events
    
    Specified by:
    
    addEventParent in interface Evented
    
    Returns:
    
    the L class
  - removeEventParent
```
public L removeEventParent(Evented obj)
```
    Description copied from interface: Evented
    
    Removes an event parent, so it will stop receiving propagated events
    
    Specified by:
    
    removeEventParent in interface Evented
    
    Returns:
    
    the L class

Class LayerGroup

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LayerGroup

Method Detail

addLayer

removeLayer

removeLayer

hasLayer

getLayer

getLayers

clearLayers

eachLayer

toGeoJSON

setZIndex

getLayerId

invoke

bindPopup

bindPopup

unbindPopup

openPopup

closePopup

togglePopup

isPopupOpen

setPopupContent

setPopupContent

setPopupContent

getPopup

bindTooltip

bindTooltip

bindTooltip

unbindTooltip

openTooltip

closeTooltip

toggleTooltip

isTooltipOpen

setTooltipContent

setTooltipContent

setTooltipContent

getTooltip

addTo

remove

removeFrom

getPane

clearAllEventListeners

on

once

off

off

off

fire

listens

addEventParent

removeEventParent