io.jmix.mapsui.component

Class GeoMapImpl

java.lang.Object

io.jmix.ui.component.impl.AbstractComponent<LMap>

io.jmix.mapsui.component.GeoMapImpl

All Implemented Interfaces:

GeoMap, io.jmix.ui.component.AttachNotifier, io.jmix.ui.component.Component, io.jmix.ui.component.Component.BelongToFrame, io.jmix.ui.component.Component.HasCaption, io.jmix.ui.component.Component.HasDescription, io.jmix.ui.component.Component.HasIcon, io.jmix.ui.component.Component.HasXmlDescriptor, io.jmix.ui.component.Component.Wrapper, io.jmix.ui.component.HasContextHelp, io.jmix.ui.component.HasDebugId, io.jmix.ui.component.HasHtmlCaption, io.jmix.ui.component.HasHtmlDescription, io.jmix.ui.component.HasHtmlSanitizer, io.jmix.ui.component.HasSubParts

public class GeoMapImpl
extends io.jmix.ui.component.impl.AbstractComponent<LMap>
implements GeoMap

UI component that displays a geographical data provided by layers. Based on Leaflet JS.

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.mapsui.component.GeoMap

GeoMap.Bounds, GeoMap.ClickEvent, GeoMap.DragEndEvent, GeoMap.LayerAddedEvent, GeoMap.LayerRemovedEvent, GeoMap.MoveEndEvent, GeoMap.RightClickEvent, GeoMap.SelectedLayerChangedEvent, GeoMap.ZoomEndEvent

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

io.jmix.ui.component.Component.Alignment, io.jmix.ui.component.Component.BelongToFrame, io.jmix.ui.component.Component.Disposable, io.jmix.ui.component.Component.Editable, io.jmix.ui.component.Component.Focusable, io.jmix.ui.component.Component.HasCaption, io.jmix.ui.component.Component.HasDescription, io.jmix.ui.component.Component.HasIcon, io.jmix.ui.component.Component.HasXmlDescriptor, io.jmix.ui.component.Component.Wrapper

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasContextHelp

io.jmix.ui.component.HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields inherited from class io.jmix.ui.component.impl.AbstractComponent

alignment, applicationContext, component, contextHelpIconClickHandler, contextHelpIconClickListener, descriptionAsHtml, element, frame, htmlSanitizerEnabled, icon, ICON_STYLE, id, parent

Fields inherited from interface io.jmix.mapsui.component.GeoMap

NAME

Fields inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Constructor Summary

Constructors

Constructor and Description
GeoMapImpl()

Method Summary

Modifier and Type	Method and Description
io.jmix.core.common.event.Subscription	addClickListener(java.util.function.Consumer<GeoMap.ClickEvent> listener) Registers a new click listener.
io.jmix.core.common.event.Subscription	addDragEndListener(java.util.function.Consumer<GeoMap.DragEndEvent> listener) Registers a new drag end listener.
void	addLayer(Layer layer) Adds the given layer to the map.
io.jmix.core.common.event.Subscription	addLayerAddedListener(java.util.function.Consumer<GeoMap.LayerAddedEvent> listener) Registers a new layer added listener.
io.jmix.core.common.event.Subscription	addLayerRemovedListener(java.util.function.Consumer<GeoMap.LayerRemovedEvent> listener) Registers a new layer removed listener.
io.jmix.core.common.event.Subscription	addMoveEndListener(java.util.function.Consumer<GeoMap.MoveEndEvent> listener) Registers a new move end listener.
io.jmix.core.common.event.Subscription	addRightClickListener(java.util.function.Consumer<GeoMap.RightClickEvent> listener) Registers a new right click listener.
io.jmix.core.common.event.Subscription	addSelectedLayerChangedListener(java.util.function.Consumer<GeoMap.SelectedLayerChangedEvent> listener) Registers a new selected layer changed listener.
io.jmix.core.common.event.Subscription	addZoomEndListener(java.util.function.Consumer<GeoMap.ZoomEndEvent> listener) Registers a new zoom end listener.
GeoMap.Bounds	getBounds() Returns the bounds of the map which define the viewport of the map.
CanvasLayer	getCanvas() Returns the canvas layer of the map.
org.locationtech.jts.geom.Point	getCenter() Returns current geographic center of the map.
protected io.jmix.core.common.event.EventHub	getEventHub()
<T> java.util.Map<?,GeoObjectWrapper<T>>	getGeoObjectWrappersMap(VectorLayer<T> layer) Returns a map of pairs [geo-object ID: geoObjectWrapper] for geo-objects of the given vector layer.
<T extends Layer> T	getLayer(java.lang.String layerId) Returns a layer by its ID.
<T extends Layer> T	getLayerOrNull(java.lang.String layerId) Returns a layer by its ID, or null if the map does not contain a layer with the given ID.
java.util.List<Layer>	getLayers() Returns the list of layers currently added to the map.
Layer	getSelectedLayer() Returns the selected layer of the map.
java.lang.Object	getSubPart(java.lang.String name)
double	getZoomLevel() Returns current map zoom level.
void	openPopup(PopupWindow popupWindow) Opens the given popup window.
void	removeLayer(Layer layer) Removes the given layer from the map.
void	selectLayer(Layer layer) Sets the selected (i.e.
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setCenter(double x, double y) Sets the initial geographic center of the map.
void	setMaxZoom(int maxZoom) Set maximum map zoom level.
void	setMinZoom(int minZoom) Set minimum map zoom level.
void	setReadOnly(boolean readOnly) Switch map to a read-only mode.
void	setZoomLevel(double zoomLevel) Set map zoom level.
void	zoomToBounds(org.locationtech.jts.geom.Point topLeft, org.locationtech.jts.geom.Point bottomRight) Sets a map view that contains the given geographical bounds with the maximum zoom level possible.
void	zoomToGeometry(org.locationtech.jts.geom.Geometry geometry) Sets a map view that contains envelope of the given geometry with the maximum zoom level possible.

Methods inherited from class io.jmix.ui.component.impl.AbstractComponent

addAttachListener, addDetachListener, addStyleName, assignDebugId, attached, detached, getAlignment, getCaption, getComponent, getComposition, getContextHelpIconClickHandler, getContextHelpText, getDebugId, getDescription, getFrame, getHeight, getHeightSizeUnit, getHtmlSanitizer, getIcon, getIconName, getIconResource, getId, getParent, getStyleName, getUiComponentProperties, getUiProperties, getWidth, getWidthSizeUnit, getXmlDescriptor, hasSubscriptions, hasValidationError, isAttached, isCaptionAsHtml, isContextHelpTextHtmlEnabled, isDescriptionAsHtml, isEnabled, isEnabledRecursive, isHtmlSanitizerEnabled, isResponsive, isVisible, isVisibleRecursive, onContextHelpIconClick, publish, removeStyleName, sanitize, setAlignment, setCaption, setCaptionAsHtml, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled, setDebugId, setDescription, setDescriptionAsHtml, setEnabled, setFrame, setHeight, setHtmlSanitizerEnabled, setIcon, setIconFromSet, setId, setParent, setResponsive, setStyleName, setValidationError, setVisible, setWidth, setXmlDescriptor, unsubscribe, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jmix.mapsui.component.GeoMap

selectLayerById

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface io.jmix.ui.component.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface io.jmix.ui.component.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface io.jmix.ui.component.Component.HasCaption

getCaption, setCaption

Methods inherited from interface io.jmix.ui.component.Component.HasDescription

getDescription, setDescription

Constructor Detail

GeoMapImpl

public GeoMapImpl()

Method Detail

setApplicationContext

@Autowired
public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Overrides:

setApplicationContext in class io.jmix.ui.component.impl.AbstractComponent<LMap>

addLayer

public void addLayer(Layer layer)

Description copied from interface: GeoMap

Adds the given layer to the map.

Preserves an order of the layers, but tile layers (such as TileLayer or WMSTileLayer) should be added first, otherwise IllegalStateException is to be thrown.

If a layer with the same ID is already on the map, the given layer will not be added to the map and IllegalArgumentException is to be thrown.

Specified by:

addLayer in interface GeoMap

Parameters:

layer - to be added on the map

removeLayer

public void removeLayer(Layer layer)

Description copied from interface: GeoMap

Removes the given layer from the map.

Specified by:

removeLayer in interface GeoMap

Parameters:

layer - to be removed from the map

getLayer

@Nonnull
public <T extends Layer> T getLayer(java.lang.String layerId)

Description copied from interface: GeoMap

Returns a layer by its ID.

Specified by:

getLayer in interface GeoMap

Parameters:

layerId - ID of a layer

Returns:

layer

getLayerOrNull

@Nullable
public <T extends Layer> T getLayerOrNull(java.lang.String layerId)

Description copied from interface: GeoMap

Returns a layer by its ID, or null if the map does not contain a layer with the given ID.

Specified by:

getLayerOrNull in interface GeoMap

Parameters:

layerId - ID of a layer

Returns:

layer

getLayers

public java.util.List<Layer> getLayers()

Description copied from interface: GeoMap

Returns the list of layers currently added to the map. The resulting list preserves the order of layers (from the first added layer to the last). The Canvas layer is not included in this list.

Specified by:

getLayers in interface GeoMap

setCenter

public void setCenter(double x,
                      double y)

Description copied from interface: GeoMap

Sets the initial geographic center of the map.

Specified by:

setCenter in interface GeoMap

Parameters:

x - longitude

y - latitude

getCenter

public org.locationtech.jts.geom.Point getCenter()

Description copied from interface: GeoMap

Returns current geographic center of the map.

Specified by:

getCenter in interface GeoMap

setZoomLevel

public void setZoomLevel(double zoomLevel)

Set map zoom level.

Specified by:

setZoomLevel in interface GeoMap

Parameters:

zoomLevel - of the map

getZoomLevel

public double getZoomLevel()

Description copied from interface: GeoMap

Returns current map zoom level.

Specified by:

getZoomLevel in interface GeoMap

setMaxZoom

public void setMaxZoom(int maxZoom)

Set maximum map zoom level.

Specified by:

setMaxZoom in interface GeoMap

Parameters:

maxZoom - maximum map zoom level

setMinZoom

public void setMinZoom(int minZoom)

Set minimum map zoom level.

Specified by:

setMinZoom in interface GeoMap

Parameters:

minZoom - minimum map zoom level

setReadOnly

public void setReadOnly(boolean readOnly)

Switch map to a read-only mode. Virtually, it means an impossibility of changing zoom, position, etc., via mouse.

Specified by:

setReadOnly in interface GeoMap

Parameters:

readOnly - true/false

getCanvas

public CanvasLayer getCanvas()

Description copied from interface: GeoMap

Returns the canvas layer of the map.

Specified by:

getCanvas in interface GeoMap

Returns:

Canvas layer

selectLayer

public void selectLayer(Layer layer)

Description copied from interface: GeoMap

Sets the selected (i.e. the active) layer of the map.

A null parameter deselects currently selected layer.

Specified by:

selectLayer in interface GeoMap

Parameters:

layer - selected layer

getSelectedLayer

public Layer getSelectedLayer()

Description copied from interface: GeoMap

Returns the selected layer of the map.

Specified by:

getSelectedLayer in interface GeoMap

Returns:

the selected layer or null when none of the layers is selected

getBounds

public GeoMap.Bounds getBounds()

Description copied from interface: GeoMap

Returns the bounds of the map which define the viewport of the map.

Specified by:

getBounds in interface GeoMap

zoomToBounds

public void zoomToBounds(org.locationtech.jts.geom.Point topLeft,
                         org.locationtech.jts.geom.Point bottomRight)

Description copied from interface: GeoMap

Sets a map view that contains the given geographical bounds with the maximum zoom level possible.

Specified by:

zoomToBounds in interface GeoMap

Parameters:

topLeft - NorthWest point

bottomRight - SouthEast point

zoomToGeometry

public void zoomToGeometry(org.locationtech.jts.geom.Geometry geometry)

Description copied from interface: GeoMap

Sets a map view that contains envelope of the given geometry with the maximum zoom level possible.

Note: if the given geometry is point, map will be centered to this point with the current zoom level.

Specified by:

zoomToGeometry in interface GeoMap

openPopup

public void openPopup(PopupWindow popupWindow)

Description copied from interface: GeoMap

Opens the given popup window.

Specified by:

openPopup in interface GeoMap

addClickListener

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

Description copied from interface: GeoMap

Registers a new click listener.

Specified by:

addClickListener in interface GeoMap

Parameters:

listener - the listener to be added

Returns:

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

addRightClickListener

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

Description copied from interface: GeoMap

Registers a new right click listener.

Specified by:

addRightClickListener in interface GeoMap

Parameters:

listener - the listener to be added

Returns:

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

addMoveEndListener

public io.jmix.core.common.event.Subscription addMoveEndListener(java.util.function.Consumer<GeoMap.MoveEndEvent> listener)

Description copied from interface: GeoMap

Registers a new move end listener.

Specified by:

addMoveEndListener in interface GeoMap

Parameters:

listener - the listener to be added

Returns:

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

addZoomEndListener

public io.jmix.core.common.event.Subscription addZoomEndListener(java.util.function.Consumer<GeoMap.ZoomEndEvent> listener)

Description copied from interface: GeoMap

Registers a new zoom end listener.

Specified by:

addZoomEndListener in interface GeoMap

Parameters:

listener - the listener to be added

Returns:

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

addDragEndListener

public io.jmix.core.common.event.Subscription addDragEndListener(java.util.function.Consumer<GeoMap.DragEndEvent> listener)

Description copied from interface: GeoMap

Registers a new drag end listener.

Specified by:

addDragEndListener in interface GeoMap

Parameters:

listener - the listener to be added

Returns:

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

addLayerAddedListener

public io.jmix.core.common.event.Subscription addLayerAddedListener(java.util.function.Consumer<GeoMap.LayerAddedEvent> listener)

Description copied from interface: GeoMap

Registers a new layer added listener.

Specified by:

addLayerAddedListener in interface GeoMap

Parameters:

listener - the listener to be added

Returns:

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

addLayerRemovedListener

public io.jmix.core.common.event.Subscription addLayerRemovedListener(java.util.function.Consumer<GeoMap.LayerRemovedEvent> listener)

Description copied from interface: GeoMap

Registers a new layer removed listener.

Specified by:

addLayerRemovedListener in interface GeoMap

Parameters:

listener - the listener to be added

Returns:

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

addSelectedLayerChangedListener

public io.jmix.core.common.event.Subscription addSelectedLayerChangedListener(java.util.function.Consumer<GeoMap.SelectedLayerChangedEvent> listener)

Description copied from interface: GeoMap

Registers a new selected layer changed listener.

Specified by:

addSelectedLayerChangedListener in interface GeoMap

Parameters:

listener - the listener to be added

Returns:

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

getEventHub

protected io.jmix.core.common.event.EventHub getEventHub()

Overrides:

getEventHub in class io.jmix.ui.component.impl.AbstractComponent<LMap>

getGeoObjectWrappersMap

public <T> java.util.Map<?,GeoObjectWrapper<T>> getGeoObjectWrappersMap(VectorLayer<T> layer)

Returns a map of pairs [geo-object ID: geoObjectWrapper] for geo-objects of the given vector layer.

In case when geo-object's geometry is null, then wrapper is also null. So perform null check before operating with a wrapper. Geo-object wrappers can be replaced with another instance after layer refresh or geometry update, so always use this map to get the relevant wrapper instance.

Throws:

java.lang.IllegalArgumentException - when map does not contain the specified layer

getSubPart

@Nullable
public java.lang.Object getSubPart(java.lang.String name)

Specified by:

getSubPart in interface io.jmix.ui.component.HasSubParts