io.jmix.mapsui.component.layer

Class WMSTileLayer

java.lang.Object

io.jmix.mapsui.component.layer.RasterLayer

io.jmix.mapsui.component.layer.TileLayer

io.jmix.mapsui.component.layer.WMSTileLayer

All Implemented Interfaces:

Layer, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class WMSTileLayer
extends TileLayer

A class containing information about WMS service along with parameters needed for GetMap operation requests to download tiles.

For more information about parameters format see WMS reference.

To find out information about capabilities of a WMS service (for example, available layers) request GetCapabilities operation.

It is convenient to use software like QGIS for the purpose.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.context.ApplicationContext	applicationContext
static java.lang.String	SERVICE_NAME

Constructor Summary

Constructors

Constructor and Description
WMSTileLayer(java.lang.String id)
WMSTileLayer(java.lang.String id, java.lang.String url)

Method Summary

Modifier and Type	Method and Description
protected void	fireLayerChangedEvent(LayerChangedEvent event)
CRS	getCrs() Returns CRS used in the WMS.
java.lang.String	getFormat() Returns format for the map output.
java.lang.String	getId()
java.lang.String	getLayers() Returns layers to display on a map.
int	getMaxZoom() Returns maximum layer zoom level.
int	getMinZoom() Returns minimum layer zoom level.
java.lang.String	getStyles() Returns comma-separated list of WMS styles.
java.lang.String	getVersion() Returns service version.
boolean	isEditable() Whether the layer is to be editable on a map.
boolean	isTransparent() Whether the map background is transparent.
boolean	isVisible() Whether the layer is to be visible on a map.
void	refresh() Notify clients that the layer has changed and need to be redrawn.
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setCrs(CRS crs) Sets CRS to be used in the WMS.
void	setEditable(boolean editable) Sets whether the layer is to be editable on a map.
void	setFormat(java.lang.String format) Formats for the map output.
void	setLayers(java.lang.String layers) Specifies layers to display on a map.
void	setMinZoom(int minZoom) Sets minimum zoom level down to which the layer is visible (inclusive).
void	setStyles(java.lang.String styles) Sets styles in which layers are to be rendered.
void	setTransparent(boolean transparent) Sets whether the map background is to be transparent.
void	setVersion(java.lang.String version) Sets service version.
void	setVisible(boolean visible) Sets whether the layer should be visible on a map.
java.lang.String	toString()

Methods inherited from class io.jmix.mapsui.component.layer.TileLayer

getAttributionString, getSubDomains, getUrl, setAttributionString, setMaxZoom, setSubDomains, setUrl

Methods inherited from class io.jmix.mapsui.component.layer.RasterLayer

getOpacity, setOpacity

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_NAME

public static final java.lang.String SERVICE_NAME

See Also:

Constant Field Values

applicationContext

protected org.springframework.context.ApplicationContext applicationContext

Constructor Detail

WMSTileLayer

public WMSTileLayer(java.lang.String id)

WMSTileLayer

public WMSTileLayer(java.lang.String id,
                    java.lang.String url)

Method Detail

getCrs

public CRS getCrs()

Returns CRS used in the WMS.

Returns:

CRS

setCrs

public void setCrs(CRS crs)

Sets CRS to be used in the WMS.

Parameters:

crs - CRS to be used in the WMS

getLayers

public java.lang.String getLayers()

Returns layers to display on a map.

Returns:

a comma-separated list of layer names

setLayers

@StudioProperty
public void setLayers(java.lang.String layers)

Specifies layers to display on a map.

To find out information about available layers of the WMS service, you can request GetCapabilities operation.

It's easier to use software like QGIS for the purpose.

Parameters:

layers - String which is a comma-separated list of layer names

getStyles

public java.lang.String getStyles()

Returns comma-separated list of WMS styles.

Returns:

String which is a comma-separated list of WMS styles

setStyles

@StudioProperty
public void setStyles(java.lang.String styles)

Sets styles in which layers are to be rendered.

Parameters:

styles - a comma-separated list of WMS styles

getFormat

public java.lang.String getFormat()

Returns format for the map output.

Returns:

format for the map output

setFormat

@StudioProperty
public void setFormat(java.lang.String format)

Formats for the map output. See WMS output formats for supported values.

Parameters:

format - String parameter

isTransparent

public boolean isTransparent()

Whether the map background is transparent.

Returns:

true if the map background is transparent; false otherwise

setTransparent

@StudioProperty
public void setTransparent(boolean transparent)

Sets whether the map background is to be transparent. Default value is false.

Parameters:

transparent - true/false

getVersion

public java.lang.String getVersion()

Returns service version.

Returns:

service version

setVersion

@StudioProperty(type=ENUMERATION,
                options={"1.0.0","1.1.0","1.1.1","1.3.0"},
                defaultValue="1.1.1")
public void setVersion(java.lang.String version)

Sets service version.

Value is one of: 1.0.0, 1.1.0, 1.1.1, 1.3.0. Default value is 1.1.1.

Parameters:

version - String parameter

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

getMaxZoom

public int getMaxZoom()

Description copied from interface: Layer

Returns maximum layer zoom level.

Specified by:

getMaxZoom in interface Layer

Returns:

maximum layer zoom level

setMinZoom

public void setMinZoom(int minZoom)

Description copied from interface: Layer

Sets minimum zoom level down to which the layer is visible (inclusive).

Default value: 0.

Specified by:

setMinZoom in interface Layer

Parameters:

minZoom - minimum layer zoom level

getMinZoom

public int getMinZoom()

Description copied from interface: Layer

Returns minimum layer zoom level.

Specified by:

getMinZoom in interface Layer

Returns:

minimum layer zoom level

getId

public java.lang.String getId()

Specified by:

getId in interface Layer

Returns:

ID of a layer

setVisible

public void setVisible(boolean visible)

Description copied from interface: Layer

Sets whether the layer should be visible on a map.

Default value: true.

Specified by:

setVisible in interface Layer

Parameters:

visible - true/false

isVisible

public boolean isVisible()

Description copied from interface: Layer

Whether the layer is to be visible on a map.

Specified by:

isVisible in interface Layer

Returns:

true if the layer is set to be visible; otherwise false

setEditable

public void setEditable(boolean editable)

Description copied from interface: Layer

Sets whether the layer is to be editable on a map.

Default value: false.

Specified by:

setEditable in interface Layer

Parameters:

editable - true/false

isEditable

public boolean isEditable()

Description copied from interface: Layer

Whether the layer is to be editable on a map.

Specified by:

isEditable in interface Layer

Returns:

true if the layer is set to be editable; otherwise false

fireLayerChangedEvent

protected void fireLayerChangedEvent(LayerChangedEvent event)

refresh

public void refresh()

Description copied from interface: Layer

Notify clients that the layer has changed and need to be redrawn.

Specified by:

refresh in interface Layer

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object