io.jmix.mapsui.component

Interface CanvasLayer.Polyline

All Superinterfaces:

CanvasLayer.Geometry

Enclosing interface:

CanvasLayer

public static interface CanvasLayer.Polyline
extends CanvasLayer.Geometry

A wrapper class encapsulating LineString on the canvas.

Nested Class Summary

Nested Classes

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

Method Summary

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

Returns a JTS linestring.

Specified by:

getGeometry in interface CanvasLayer.Geometry

setStyle

CanvasLayer.Polyline setStyle(PolylineStyle style)

Applies a style to the polyline.

Parameters:

style - polyline style

Returns:

current polyline. Useful for a fluent API.

setPopupContent

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

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

Parameters:

popupContent - content of the popup window

Returns:

current polyline. Useful for a fluent API.

setPopupOptions

CanvasLayer.Polyline setPopupOptions(PopupWindowOptions options)

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

Parameters:

options - popup window options

Returns:

current polyline. Useful for a fluent API.

setTooltipContent

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

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

Parameters:

tooltipContent - content of the tooltip box

Returns:

current polyline. Useful for a fluent API.

setTooltipOptions

CanvasLayer.Polyline setTooltipOptions(TooltipOptions options)

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

Parameters:

options - tooltip options

Returns:

current polyline. Useful for a fluent API.

setEditable

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

Registers a new polyline 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.Polyline.RightClickEvent> listener)

Registers a new polyline 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.Polyline.ModifiedEvent> listener)

Registers a new polyline modified listener.

Parameters:

listener - the listener to be added

Returns:

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