Package eu.webtoolkit.jwt

Class WLeafletMap.AbstractMapItem

java.lang.Object

eu.webtoolkit.jwt.WObject

eu.webtoolkit.jwt.WLeafletMap.AbstractMapItem

Direct Known Subclasses:

WLeafletMap.AbstractOverlayItem, WLeafletMap.Marker

Enclosing class:

WLeafletMap

public abstract static class WLeafletMap.AbstractMapItem
extends WObject

An abstract map item.

This is the base class for all items that can be added to a WLeafletMap. As this is an abstract class, it should not be added directly to a map as is. Instead, you should use one of the subclasses.

Nested Class Summary

Nested classes/interfaces inherited from class eu.webtoolkit.jwt.WObject

WObject.FormData

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractMapItem(WLeafletMap.Coordinate pos)	Constructor.

Method Summary

Modifier and Type	Method	Description
Signal	clicked()	Signal emitted when the user clicks on the map item.
protected abstract void	createItemJS(java.lang.StringBuilder ss, java.lang.StringBuilder postJS, long id)	Writes the JS code to create this item to the stream.
Signal	doubleClicked()	Signal emitted when the user double-clicks on the map item.
protected WLeafletMap	getMap()	Returns the map this item belongs to.
WLeafletMap.Coordinate	getPosition()	Get the current position.
Signal	mouseWentDown()	Signal emitted when the user holds the mouse click on the map item.
Signal	mouseWentOut()	Signal emitted when the user's mouse leaves the map item.
Signal	mouseWentOver()	Signal emitted when the user's mouse enters the map item.
Signal	mouseWentUp()	Signal emitted when the user releases the mouse click on the map item.
void	move(WLeafletMap.Coordinate pos)	Move the map item.
protected boolean	needsUpdate()	Return whether this item needs to be updated.
protected void	setMap(WLeafletMap map)	Set the map this item belongs to.
protected void	unrender()	Unrender the item.
protected void	update(java.lang.StringBuilder js)	Writes the JS to update this item to the stream.

Methods inherited from class eu.webtoolkit.jwt.WObject

getId, getObjectName, remove, setFormData, setObjectName, tr

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMapItem

protected AbstractMapItem(WLeafletMap.Coordinate pos)

Constructor.

Since this is an abstract class, it should not be used directly.

Method Detail

move

public void move(WLeafletMap.Coordinate pos)

Move the map item.

If this map item belongs to a map, this will trigger an update of the WLeafletMap to move the map item. If it doesn't belong to a map, the position is merely updated.

getPosition

public WLeafletMap.Coordinate getPosition()

Get the current position.

See Also:

move(WLeafletMap.Coordinate pos)

clicked

public Signal clicked()

Signal emitted when the user clicks on the map item.

Note: For WLeafletMap.AbstractOverlayItem, this signal is only triggered if their interactive option is set to true (by default, it is set to false).

See Also:

WLeafletMap.setOptions(com.google.gson.JsonObject options)

doubleClicked

public Signal doubleClicked()

Signal emitted when the user double-clicks on the map item.

Note: Double-clicking on a marker may trigger the doubleClickZoom from leaflet as well, which does zoom on the map, centered on where the click occurred.

Note: For WLeafletMap.AbstractOverlayItem, this signal is only triggered if their interactive option is set to true (by default, it is set to false).

See Also:

WLeafletMap.setOptions(com.google.gson.JsonObject options)

mouseWentDown

public Signal mouseWentDown()

Signal emitted when the user holds the mouse click on the map item.

Note: For WLeafletMap.AbstractOverlayItem, this signal is only triggered if their interactive option is set to true (by default, it is set to false).

See Also:

WLeafletMap.setOptions(com.google.gson.JsonObject options)

mouseWentUp

public Signal mouseWentUp()

Signal emitted when the user releases the mouse click on the map item.

Note: For WLeafletMap.AbstractOverlayItem, this signal is only triggered if their interactive option is set to true (by default, it is set to false).

See Also:

WLeafletMap.setOptions(com.google.gson.JsonObject options)

mouseWentOver

public Signal mouseWentOver()

Signal emitted when the user's mouse enters the map item.

Note: For WLeafletMap.AbstractOverlayItem, this signal is only triggered if their interactive option is set to true (by default, it is set to false).

See Also:

WLeafletMap.setOptions(com.google.gson.JsonObject options)

mouseWentOut

public Signal mouseWentOut()

Signal emitted when the user's mouse leaves the map item.

Note: For WLeafletMap.AbstractOverlayItem, this signal is only triggered if their interactive option is set to true (by default, it is set to false).

See Also:

WLeafletMap.setOptions(com.google.gson.JsonObject options)

createItemJS

protected abstract void createItemJS(java.lang.StringBuilder ss,
                                     java.lang.StringBuilder postJS,
                                     long id)

Writes the JS code to create this item to the stream.

This method should write in ss the JS code that creates the item. The postJS stream can be used to write JS code that should be executed after the item has been created.

unrender

protected void unrender()

Unrender the item.

This is called when the map needs to be recreated. You can override this function in case you need to do some cleanup before the map is recreated.

By default, this does nothing.

See Also:

WLeafletMap.setOptions(com.google.gson.JsonObject options)

needsUpdate

protected boolean needsUpdate()

Return whether this item needs to be updated.

This is called when the map is rendered. If this returns true, update() will be used to update the item.

getMap

protected WLeafletMap getMap()

Returns the map this item belongs to.

update

protected void update(java.lang.StringBuilder js)

Writes the JS to update this item to the stream.

This is called when the map is rendered if needsUpdate() returns true.

setMap

protected void setMap(WLeafletMap map)

Set the map this item belongs to.

This is called to set the map the item belongs to. You can override this function if you need to do something when the item is added to a map.

You should not call this function directly.

See Also:

getMap()