com.gwidgets.api.leaflet

Interface Evented

All Known Implementing Classes:

Canvas, Circle, CircleMarker, DivIcon, FeatureGroup, GeoJSON, GridLayer, Icon, ImageOverlay, LayerGroup, Map, Marker, Polygon, Polyline, Popup, Rectangle, Renderer, SVG, TileLayer, Tooltip, WMS

@JsType(isNative=true)
public interface Evented

Method Summary

Modifier and Type	Method and Description
L	addEventParent(Evented obj) Adds an event parent - an Evented that will receive propagated events
L	clearAllEventListeners() Clear all event listeners.
L	fire(String type) Fires an event of the specified type.
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	removeEventParent(Evented obj) Removes an event parent, so it will stop receiving propagated events

Method Detail

clearAllEventListeners

L clearAllEventListeners()

Clear all event listeners.

Returns:

the L class

on

L on(String type,
     EventCallback fn)

Adds a set of type/listener pairs.

Parameters:

type - the type

fn - the callback function

Returns:

the L class

once

L once(String type,
       EventCallback fn)

the listener will only get fired once and then removed.

Parameters:

type - the type

fn - the callback function

Returns:

the L class

off

L off(String type)

Removes a listener

Parameters:

type - the type

Returns:

the L class

off

L off(String[] type)

Removes a set of listener

Parameters:

type - the type

Returns:

the L class

off

L off()

Removes all listener

Parameters:

type - the type

Returns:

the L class

fire

L fire(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

listens

Boolean listens(String type)

Returns true if a particular event type has any listeners attached to it.

Returns:

true if there is listener, false otherwise

addEventParent

L addEventParent(Evented obj)

Adds an event parent - an Evented that will receive propagated events

Parameters:

the - parent object that will receive the propagated events

Returns:

the L class

removeEventParent

L removeEventParent(Evented obj)

Removes an event parent, so it will stop receiving propagated events

Parameters:

the - parent object that be removed

Returns:

the L class