Package eu.webtoolkit.jwt

Class WLeafletMap.AbstractOverlayItem

java.lang.Object

eu.webtoolkit.jwt.WObject

eu.webtoolkit.jwt.WLeafletMap.AbstractMapItem

eu.webtoolkit.jwt.WLeafletMap.AbstractOverlayItem

Direct Known Subclasses:

WLeafletMap.Popup, WLeafletMap.Tooltip

Enclosing class:

WLeafletMap

public abstract static class WLeafletMap.AbstractOverlayItem
extends WLeafletMap.AbstractMapItem

An abstract map item with text.

This is the base class for all AbstractMapItems that can be added to other AbstractMapItems. This is an abstract class, so it should not be used directly.

Nested Class Summary

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

WObject.FormData

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractOverlayItem(WLeafletMap.Coordinate pos)	Constructor.
protected	AbstractOverlayItem(WLeafletMap.Coordinate pos, WWidget content)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	bringToBack()	Brings this WLeafletMap.AbstractOverlayItem to the back.
void	bringToFront()	Brings this WLeafletMap.AbstractOverlayItem to the front.
void	close()	Closes the WLeafletMap.AbstractOverlayItem.
Signal	closed()	Signal emited after the WLeafletMap.AbstractOverlayItem was closed.
WWidget	getContent()	Get the content.
boolean	isOpen()	Returns whether the WLeafletMap.AbstractOverlayItem is open.
void	open()	Opens the WLeafletMap.AbstractOverlayItem.
Signal	opened()	Signal emited after the WLeafletMap.AbstractOverlayItem was opened.
void	setContent(WWidget content)	Set the content.
void	setContent(CharSequence content)	Set the content.
protected void	setMap(WLeafletMap map)	Set the map this item belongs to.
void	setOptions(com.google.gson.JsonObject options)	Set the options of the WLeafletMap.AbstractOverlayItem.
void	toggle()	Opens or closes the WLeafletMap.AbstractOverlayItem.

Methods inherited from class eu.webtoolkit.jwt.WLeafletMap.AbstractMapItem

clicked, createItemJS, doubleClicked, getMap, getPosition, mouseWentDown, mouseWentOut, mouseWentOver, mouseWentUp, move, needsUpdate, unrender, update

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 Details

AbstractOverlayItem

protected AbstractOverlayItem(WLeafletMap.Coordinate pos)

Constructor.

Creates a new WLeafletMap.AbstractOverlayItem that has the given coordinates.

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

AbstractOverlayItem

protected AbstractOverlayItem(WLeafletMap.Coordinate pos,
 WWidget content)

Constructor.

Creates a new WLeafletMap.AbstractOverlayItem with the given content and that has the given coordinates.

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

Method Details

setOptions

public void setOptions(com.google.gson.JsonObject options)

Set the options of the WLeafletMap.AbstractOverlayItem.

Set the options that will be passed to the WLeafletMap WLeafletMap.AbstractOverlayItem at construction.

See https://leafletjs.com/reference.html for the list of options.

Note: Modifying the options after the WLeafletMap.AbstractOverlayItem has been loaded by the user will not work as the WLeafletMap.AbstractOverlayItem was already constructed. Some option like 'content' can be changed after load using the appropriate function.

See Also:

• setContent(WWidget content)

setContent

public void setContent(WWidget content)

Set the content.

setContent

public void setContent(CharSequence content)

Set the content.

getContent

public WWidget getContent()

Get the content.

See Also:

• setContent(WWidget content)

open

public void open()

Opens the WLeafletMap.AbstractOverlayItem.

See Also:

• close()
• toggle()

close

public void close()

Closes the WLeafletMap.AbstractOverlayItem.

See Also:

• open()
• toggle()

toggle

public void toggle()

Opens or closes the WLeafletMap.AbstractOverlayItem.

See Also:

• open()
• close()

isOpen

public boolean isOpen()

Returns whether the WLeafletMap.AbstractOverlayItem is open.

See Also:

• close()
• toggle()

opened

public Signal opened()

Signal emited after the WLeafletMap.AbstractOverlayItem was opened.

See Also:

• closed()

closed

public Signal closed()

Signal emited after the WLeafletMap.AbstractOverlayItem was closed.

See Also:

• opened()

bringToFront

public void bringToFront()

Brings this WLeafletMap.AbstractOverlayItem to the front.

This brings this WLeafletMap.AbstractOverlayItem to the front of other WLeafletMap.AbstractOverlayItem of the same type.

Warning: This function only works after the WLeafletMap.AbstractOverlayItem is added to the map.

See Also:

• bringToBack()

bringToBack

public void bringToBack()

Brings this WLeafletMap.AbstractOverlayItem to the back.

This brings this WLeafletMap.AbstractOverlayItem to the back of other WLeafletMap.AbstractOverlayItem of the same type.

Warning: This function only works after the WLeafletMap.AbstractOverlayItem is added to the map.

See Also:

• bringToFront()

setMap

protected void setMap(WLeafletMap map)

Description copied from class: WLeafletMap.AbstractMapItem

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.

Overrides:

setMap in class WLeafletMap.AbstractMapItem

See Also:

• WLeafletMap.AbstractMapItem.getMap()