io.jmix.mapsui.component

Interface CanvasLayer.Polygon

All Superinterfaces:

CanvasLayer.Geometry

Enclosing interface:

CanvasLayer

public static interface CanvasLayer.Polygon
extends CanvasLayer.Geometry

A wrapper class encapsulating Polygon on the canvas.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CanvasLayer.Polygon.ClickEvent An event that is fired after click on the polygon.
static class	CanvasLayer.Polygon.ModifiedEvent An event that is fired after modifying the polygon via UI.
static class	CanvasLayer.Polygon.RightClickEvent An event that is fired after right click on the polygon.

Method Summary

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

Returns a JTS polygon.

Specified by:

getGeometry in interface CanvasLayer.Geometry

setStyle

CanvasLayer.Polygon setStyle(PolygonStyle style)

Applies a style to the polygon.

Parameters:

style - polygon style

Returns:

current polygon. Useful for a fluent API.

setPopupContent

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

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

Parameters:

popupContent - content of the popup window

Returns:

current polygon. Useful for a fluent API.

setPopupOptions

CanvasLayer.Polygon setPopupOptions(PopupWindowOptions options)

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

Parameters:

options - popup window options

Returns:

current polygon. Useful for a fluent API.

setTooltipContent

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

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

Parameters:

tooltipContent - content of the tooltip box

Returns:

current polygon. Useful for a fluent API.

setTooltipOptions

CanvasLayer.Polygon setTooltipOptions(TooltipOptions options)

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

Parameters:

options - tooltip options

Returns:

current polygon. Useful for a fluent API.

setEditable

CanvasLayer.Polygon 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.Polygon.ClickEvent> listener)

Registers a new polygon 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.Polygon.RightClickEvent> listener)

Registers a new polygon 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.Polygon.ModifiedEvent> listener)

Registers a new polygon modified listener.

Parameters:

listener - the listener to be added

Returns:

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