io.jmix.mapsui.component

Interface CanvasLayer.Point

All Superinterfaces:

CanvasLayer.Geometry

Enclosing interface:

CanvasLayer

public static interface CanvasLayer.Point
extends CanvasLayer.Geometry

A wrapper class encapsulating Point on the canvas.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CanvasLayer.Point.ClickEvent An event that is fired after click on the point.
static class	CanvasLayer.Point.ModifiedEvent An event that is fired after modifying the point (as a result of drag and drop via UI).
static class	CanvasLayer.Point.RightClickEvent An event that is fired after right click on the point.

Method Summary

Modifier and Type	Method and Description
io.jmix.core.common.event.Subscription	addClickListener(java.util.function.Consumer<CanvasLayer.Point.ClickEvent> listener) Registers a new point click listener.
io.jmix.core.common.event.Subscription	addModifiedListener(java.util.function.Consumer<CanvasLayer.Point.ModifiedEvent> listener) Registers a new point modified (drag end) listener.
io.jmix.core.common.event.Subscription	addRightClickListener(java.util.function.Consumer<CanvasLayer.Point.RightClickEvent> listener) Registers a new point right click listener.
org.locationtech.jts.geom.Point	getGeometry() Returns a JTS point.
CanvasLayer.Point	setEditable(boolean editable) Sets whether the geometry is to be modifiable on a canvas.
CanvasLayer.Point	setPopupContent(java.lang.String popupContent) Adds a popup window to be opened as user clicks on the point.
CanvasLayer.Point	setPopupOptions(PopupWindowOptions options) Specifies options for a popup window added by setPopupContent(String).
CanvasLayer.Point	setStyle(PointStyle style) Applies a style to the point.
CanvasLayer.Point	setTooltipContent(java.lang.String tooltipContent) Adds a tooltip to be opened as user hovers on the point.
CanvasLayer.Point	setTooltipOptions(TooltipOptions options) Specifies options for a tooltip added by setTooltipContent(String).

Methods inherited from interface io.jmix.mapsui.component.CanvasLayer.Geometry

closePopup, closeTooltip, isEditable, openPopup, openTooltip

Method Detail

getGeometry

org.locationtech.jts.geom.Point getGeometry()

Returns a JTS point.

Specified by:

getGeometry in interface CanvasLayer.Geometry

setStyle

CanvasLayer.Point setStyle(PointStyle style)

Applies a style to the point.

Parameters:

style - point style

Returns:

current point. Useful for a fluent API.

setPopupContent

CanvasLayer.Point setPopupContent(java.lang.String popupContent)

Adds a popup window to be opened as user clicks on the point.

Parameters:

popupContent - content of the popup window

Returns:

current point. Useful for a fluent API.

setPopupOptions

CanvasLayer.Point setPopupOptions(PopupWindowOptions options)

Specifies options for a popup window added by setPopupContent(String).

Parameters:

options - popup window options

Returns:

current point. Useful for a fluent API.

setTooltipContent

CanvasLayer.Point setTooltipContent(java.lang.String tooltipContent)

Adds a tooltip to be opened as user hovers on the point.

Parameters:

tooltipContent - content of the tooltip box

Returns:

current point. Useful for a fluent API.

setTooltipOptions

CanvasLayer.Point setTooltipOptions(TooltipOptions options)

Specifies options for a tooltip added by setTooltipContent(String).

Parameters:

options - tooltip options

Returns:

current point. Useful for a fluent API.

setEditable

CanvasLayer.Point setEditable(boolean editable)

Description copied from interface: CanvasLayer.Geometry

Sets whether the geometry is to be modifiable on a canvas.

Specified by:

setEditable in interface CanvasLayer.Geometry

addClickListener

io.jmix.core.common.event.Subscription addClickListener(java.util.function.Consumer<CanvasLayer.Point.ClickEvent> listener)

Registers a new point click listener.

Parameters:

listener - the listener to be added

Returns:

a registration object for removing an event listener added to a source

addRightClickListener

io.jmix.core.common.event.Subscription addRightClickListener(java.util.function.Consumer<CanvasLayer.Point.RightClickEvent> listener)

Registers a new point right click listener.

Parameters:

listener - the listener to be added

Returns:

a registration object for removing an event listener added to a source

addModifiedListener

io.jmix.core.common.event.Subscription addModifiedListener(java.util.function.Consumer<CanvasLayer.Point.ModifiedEvent> listener)

Registers a new point modified (drag end) listener.

Parameters:

listener - the listener to be added

Returns:

a registration object for removing an event listener added to a source