io.jmix.mapsui.component.layer

Class TileLayer

java.lang.Object

io.jmix.mapsui.component.layer.RasterLayer

io.jmix.mapsui.component.layer.TileLayer

All Implemented Interfaces:

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

Direct Known Subclasses:

WMSTileLayer

public class TileLayer
extends RasterLayer

A class representing raster layer based on tiles.

This class contains parameters needed to connect to a tile service.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.context.ApplicationContext	applicationContext

Constructor Summary

Constructors

Constructor and Description
TileLayer(java.lang.String id)
TileLayer(java.lang.String id, java.lang.String urlPattern)

Method Summary

Modifier and Type	Method and Description
protected void	fireLayerChangedEvent(LayerChangedEvent event)
java.lang.String	getAttributionString() Returns attribution string.
java.lang.String	getId()
int	getMaxZoom() Returns maximum layer zoom level.
int	getMinZoom() Returns minimum layer zoom level.
java.lang.String[]	getSubDomains() Returns explicitly defined subdomain values for the url pattern.
java.lang.String	getUrl() Returns URL of a service.
boolean	isEditable() Whether the layer is to be editable on a map.
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	setAttributionString(java.lang.String attributionString) Sets attribution string.
void	setEditable(boolean editable) Sets whether the layer is to be editable on a map.
void	setMaxZoom(int maxZoom) Sets maximum zoom level up to which the layer is visible (inclusive).
void	setMinZoom(int minZoom) Sets minimum zoom level down to which the layer is visible (inclusive).
void	setSubDomains(java.lang.String[] subDomains) Sets possible values for the {s} placeholder in the url pattern of xyz tiles.
void	setUrl(java.lang.String url) Sets URL of a service.
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.RasterLayer

getOpacity, setOpacity

Methods inherited from class java.lang.Object

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

Field Detail

applicationContext

protected org.springframework.context.ApplicationContext applicationContext

Constructor Detail

TileLayer

public TileLayer(java.lang.String id)

TileLayer

public TileLayer(java.lang.String id,
                 java.lang.String urlPattern)

Method Detail

getUrl

public java.lang.String getUrl()

Returns URL of a service.

Returns:

String URL of a service

setUrl

@StudioProperty(name="urlPattern")
public void setUrl(java.lang.String url)

Sets URL of a service.

Parameters:

url - String URL of a service

getAttributionString

public java.lang.String getAttributionString()

Returns attribution string.

Returns:

attribution string

setAttributionString

@StudioProperty(name="attribution")
public void setAttributionString(java.lang.String attributionString)

Sets attribution string.

Parameters:

attributionString - String parameter

getSubDomains

public java.lang.String[] getSubDomains()

Returns explicitly defined subdomain values for the url pattern.

setSubDomains

@StudioProperty(type=STRING)
public void setSubDomains(java.lang.String[] subDomains)

Sets possible values for the {s} placeholder in the url pattern of xyz tiles. These values are used sequentially to help with browser parallel requests per domain limitation.

Can be omitted in most cases. By default: a, b, c.

setMaxZoom

public void setMaxZoom(int maxZoom)

Sets maximum zoom level up to which the layer is visible (inclusive).

Default value: 18.

Specified by:

setMaxZoom in interface Layer

Parameters:

maxZoom - maximum layer zoom level

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