com.gwidgets.api.leaflet

Class Control

java.lang.Object

com.gwidgets.api.leaflet.Control

All Implemented Interfaces:

IControl

Direct Known Subclasses:

Attribution, Layers, Scale, Zoom

@JsType(isNative=true)
public class Control
extends java.lang.Object
implements IControl

The base class for all Leaflet controls. Implements IControl interface. You can add controls to the map like this:

 control.addTo(map);
       // or
  map.addControl(control);

Author:

Zakaria Amine

Method Summary

Modifier and Type	Method and Description
L	addTo(Map map) Adds the control to the map.
HTMLElement	getContainer() Returns the HTML container of the control.
java.lang.String	getPosition() Returns the current position of the control.
HTMLElement	onAdd(Map map) Should contain code that creates all the neccessary DOM elements for the control, adds listeners on relevant map events, and returns the element containing the control.
void	onRemove(Map map) Optional, should contain all clean up code (e.g.
L	removeFrom(Map map) Removes the control from the map.
L	setPosition(java.lang.String position) Sets the position of the control.

Methods inherited from class java.lang.Object

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

Method Detail

setPosition

@JsMethod
public L setPosition(java.lang.String position)

Sets the position of the control.

Parameters:

position - the position

Returns:

the L class

getPosition

@JsMethod
public java.lang.String getPosition()

Returns the current position of the control.

Returns:

the position

addTo

@JsMethod
public L addTo(Map map)

Adds the control to the map.

Parameters:

map - the map

Returns:

the L class

removeFrom

@JsMethod
public L removeFrom(Map map)

Removes the control from the map.

Parameters:

map - the map

Returns:

the L class

getContainer

@JsMethod
public HTMLElement getContainer()

Returns the HTML container of the control.

Returns:

the container

onAdd

@JsMethod
public HTMLElement onAdd(Map map)

Description copied from interface: IControl

Should contain code that creates all the neccessary DOM elements for the control, adds listeners on relevant map events, and returns the element containing the control. Called on map.addControl(control) or control.addTo(map).

Specified by:

onAdd in interface IControl

Parameters:

map - the map

Returns:

the HTML element of the control

onRemove

@JsMethod
public void onRemove(Map map)

Description copied from interface: IControl

Optional, should contain all clean up code (e.g. removes control's event listeners). Called on map.removeControl(control) or control.removeFrom(map). The control's DOM container is removed automatically.

Specified by:

onRemove in interface IControl

Parameters:

map - the map