com.gwidgets.api.leaflet

Class FeatureGroup

java.lang.Object

com.gwidgets.api.leaflet.FeatureGroup

All Implemented Interfaces:

ILayer

Direct Known Subclasses:

GeoJSON, MultiPolygon, MultiPolyline

@JsType(isNative=true)
public class FeatureGroup
extends java.lang.Object
implements ILayer

Extended layerGroup that also has mouse events (propagated from members of the group) and a shared bindPopup method.

Author:

Zakaria Amine

Method Summary

Modifier and Type	Method and Description
L	bindPopup(java.lang.String htmlContent, PopupOptions options) Binds a popup with a particular HTML content to a click on any layer from the group that has a bindPopup method.
L	bringToBack() Brings the layer group to the bottom of all other layers.
L	bringToFront() Brings the layer group to the top of all other layers.
static L	clearAllEventListeners() Clear all event listeners.
static L	fire(java.lang.String type) Fires an event of the specified type.
LatLngBounds	getBounds() Returns the LatLngBounds of the Feature Group (created from bounds and coordinates of its children).
static L	off(java.lang.String type, Function fn) the listener will only get fired once and then removed.
static L	on(java.lang.String type, Function fn) Adds a set of type/listener pairs
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.
static L	once(java.lang.String type, Function fn) Once.
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	setStyle(PathOptions style) Sets the given path options to each layer of the group that has a setStyle method.

Methods inherited from class java.lang.Object

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

Method Detail

bindPopup

@JsMethod
public L bindPopup(java.lang.String htmlContent,
                              PopupOptions options)

Binds a popup with a particular HTML content to a click on any layer from the group that has a bindPopup method.

Parameters:

htmlContent - the html content

options - the Popup options

Returns:

the L class

getBounds

@JsMethod
public LatLngBounds getBounds()

Returns the LatLngBounds of the Feature Group (created from bounds and coordinates of its children).

Returns:

the bounds

setStyle

@JsMethod
public L setStyle(PathOptions style)

Sets the given path options to each layer of the group that has a setStyle method.

Parameters:

style - the style

Returns:

the L class

bringToFront

@JsMethod
public L bringToFront()

Brings the layer group to the top of all other layers.

Returns:

the L class

bringToBack

@JsMethod
public L bringToBack()

Brings the layer group to the bottom of all other layers.

Returns:

the L class

clearAllEventListeners

@JsMethod
public static L clearAllEventListeners()

Clear all event listeners.

Returns:

the L class

on

@JsMethod
public static L on(java.lang.String type,
                              Function fn)

Adds a set of type/listener pairs

Parameters:

type - the type

fn - the callback function

Returns:

the L class

once

@JsMethod
public static L once(java.lang.String type,
                                Function fn)

Once.

Parameters:

type - the type

fn - the callback function

Returns:

the L class

off

@JsMethod
public static L off(java.lang.String type,
                               Function fn)

the listener will only get fired once and then removed.

Parameters:

type - the type

fn - the callback function

Returns:

the L class

fire

@JsMethod
public static L fire(java.lang.String type)

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.

Parameters:

type - the type

Returns:

the L class

onAdd

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

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