Package io.jmix.mapsflowui.component.model.source

Class ImageStaticSource

java.lang.Object

io.jmix.mapsflowui.kit.component.model.MapObservableObject

io.jmix.mapsflowui.kit.component.model.source.Source

io.jmix.mapsflowui.kit.component.model.source.ImageSource

io.jmix.mapsflowui.kit.component.model.source.AbstractImageStaticSource

io.jmix.mapsflowui.component.model.source.ImageStaticSource

All Implemented Interfaces:

AbstractImageStaticSource.HasImageExtent, AbstractImageStaticSource.HasImageStaticSourceOptions, AbstractImageStaticSource.HasResource, HasCrossOrigin, HasUrl, Source.HasAttributions, Source.HasProjection, Serializable

public class ImageStaticSource
extends AbstractImageStaticSource
implements AbstractImageStaticSource.HasImageStaticSourceOptions, Source.HasAttributions, Source.HasProjection

Source for displaying a single, static image. It can be used in ImageLayer.

For more details see: Static docs

See Also:

• ImageLayer
• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.mapsflowui.kit.component.model.source.AbstractImageStaticSource

AbstractImageStaticSource.HasImageExtent, AbstractImageStaticSource.HasImageStaticSourceOptions, AbstractImageStaticSource.HasResource

Nested classes/interfaces inherited from class io.jmix.mapsflowui.kit.component.model.source.Source

Source.HasAttributions, Source.HasAttributionsCollapsible, Source.HasProjection, Source.HasSourceOptions, Source.HasWrapX

Nested classes/interfaces inherited from class io.jmix.mapsflowui.kit.component.model.MapObservableObject

MapObservableObject.ObjectChangeEvent

Field Summary

Fields inherited from class io.jmix.mapsflowui.kit.component.model.source.AbstractImageStaticSource

crossOrigin, imageExtent, resource, url

Fields inherited from class io.jmix.mapsflowui.kit.component.model.source.Source

attributions, attributionsCollapsible, id, projection, wrapX

Fields inherited from class io.jmix.mapsflowui.kit.component.model.MapObservableObject

children, dirty, eventBus, listener, metaProperties, parent, removedChildren, syncId

Constructor Summary

Constructors

Constructor	Description
ImageStaticSource()

Method Summary

Modifier and Type	Method	Description
List<String>	getAttributions()	Source.HasAttributions.getAttributions()
String	getCrossOrigin()	HasCrossOrigin.getCrossOrigin()
Extent	getImageExtent()	AbstractImageStaticSource.HasImageExtent.getImageExtent()
CRS	getProjection()	Source.HasProjection.getProjection()
com.vaadin.flow.server.StreamResource	getResource()
protected String	getType()
String	getUrl()	HasUrl.getUrl()
void	setAttributions(List<String> attributions)	Source.HasAttributions.setAttributions(List)
void	setCrossOrigin(String crossOrigin)	Sets the cross-origin attribute for loaded images.
void	setImageExtent(Extent imageExtent)	AbstractImageStaticSource.HasImageExtent.setImageExtent(Extent)
void	setProjection(CRS projection)	Source.HasProjection.setProjection(CRS)
void	setResource(com.vaadin.flow.server.StreamResource resource)	Sets stream resource.
void	setUrl(String url)	Sets image URL.
ImageStaticSource	withAttributions(List<String> attributions)	See setAttributions(List).
ImageStaticSource	withCrossOrigin(String crossOrigin)	See setCrossOrigin(String).
ImageStaticSource	withImageExtent(Extent imageExtent)	See setImageExtent(Extent).
ImageStaticSource	withProjection(CRS projection)	See setProjection(CRS).
ImageStaticSource	withResource(com.vaadin.flow.server.StreamResource resource)	See setResource(StreamResource).
ImageStaticSource	withUrl(String url)	See setUrl(String).

Methods inherited from class io.jmix.mapsflowui.kit.component.model.source.Source

getAttributionsCollapsible, getId, getWrapX, setAttributionsCollapsible, setId, setWrapX

Methods inherited from class io.jmix.mapsflowui.kit.component.model.MapObservableObject

addChild, addListener, clearRemovedChildren, clearRemovedChildrenInDepth, equals, fireChangeEvent, getChildren, getEventBus, getMetaProperties, getRemovedChildren, getSyncId, hashCode, isDirty, isDirtyInDepth, markAsDirty, markAsDirtyInDepth, removeChild, setMapObjectChangeListener, setMetaProperty, setParent, unmarkDirtyInDepth

Methods inherited from class java.lang.Object

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

Constructor Details

ImageStaticSource

public ImageStaticSource()

Method Details

getType

protected String getType()

Specified by:

getType in class MapObservableObject

getAttributions

public List<String> getAttributions()

Source.HasAttributions.getAttributions()

Specified by:

getAttributions in interface Source.HasAttributions

Overrides:

getAttributions in class Source

Returns:

the attributions of the source or null if not set

setAttributions

public void setAttributions(List<String> attributions)

Source.HasAttributions.setAttributions(List)

Specified by:

setAttributions in interface Source.HasAttributions

Overrides:

setAttributions in class Source

Parameters:

attributions - info about copyrights and licences

withAttributions

public ImageStaticSource withAttributions(List<String> attributions)

See setAttributions(List).

Parameters:

attributions - info about copyrights and licences

Returns:

current instance

getProjection

public CRS getProjection()

Source.HasProjection.getProjection()

Specified by:

getProjection in interface Source.HasProjection

Overrides:

getProjection in class Source

Returns:

projection or null if not set

setProjection

public void setProjection(CRS projection)

Source.HasProjection.setProjection(CRS)

Specified by:

setProjection in interface Source.HasProjection

Overrides:

setProjection in class Source

Parameters:

projection - projection to set

withProjection

public ImageStaticSource withProjection(CRS projection)

See setProjection(CRS).

Parameters:

projection - projection to set

Returns:

current instance

getCrossOrigin

public String getCrossOrigin()

HasCrossOrigin.getCrossOrigin()

Specified by:

getCrossOrigin in interface HasCrossOrigin

Overrides:

getCrossOrigin in class AbstractImageStaticSource

Returns:

cross-origin or null if not set

setCrossOrigin

public void setCrossOrigin(String crossOrigin)

Sets the cross-origin attribute for loaded images.

Note, cross-origin is set only at creation time and cannot be changed at runtime.

For more details see: Static docs

Specified by:

setCrossOrigin in interface HasCrossOrigin

Overrides:

setCrossOrigin in class AbstractImageStaticSource

Parameters:

crossOrigin - cross-origin to set

withCrossOrigin

public ImageStaticSource withCrossOrigin(String crossOrigin)

See setCrossOrigin(String).

Parameters:

crossOrigin - cross-origin to set

Returns:

current instance

getImageExtent

public Extent getImageExtent()

AbstractImageStaticSource.HasImageExtent.getImageExtent()

Specified by:

getImageExtent in interface AbstractImageStaticSource.HasImageExtent

Overrides:

getImageExtent in class AbstractImageStaticSource

Returns:

extent of the image in map coordinates or null if not set.

setImageExtent

public void setImageExtent(Extent imageExtent)

AbstractImageStaticSource.HasImageExtent.setImageExtent(Extent)

Specified by:

setImageExtent in interface AbstractImageStaticSource.HasImageExtent

Overrides:

setImageExtent in class AbstractImageStaticSource

Parameters:

imageExtent - image extent to set

withImageExtent

public ImageStaticSource withImageExtent(Extent imageExtent)

See setImageExtent(Extent).

Parameters:

imageExtent - image extent to set

Returns:

current instance

getUrl

public String getUrl()

HasUrl.getUrl()

Specified by:

getUrl in interface HasUrl

Overrides:

getUrl in class AbstractImageStaticSource

Returns:

URL or null if not set

setUrl

public void setUrl(String url)

Sets image URL.

Note, URL attribute is set only at creation time and cannot be changed at runtime.

For more details see: Static docs

Specified by:

setUrl in interface HasUrl

Overrides:

setUrl in class AbstractImageStaticSource

Parameters:

url - url to set

withUrl

public ImageStaticSource withUrl(String url)

See setUrl(String).

Parameters:

url - url to set

Returns:

current instance

getResource

public com.vaadin.flow.server.StreamResource getResource()

Specified by:

getResource in interface AbstractImageStaticSource.HasResource

Overrides:

getResource in class AbstractImageStaticSource

Returns:

stream resource or null if not set

setResource

public void setResource(com.vaadin.flow.server.StreamResource resource)

Sets stream resource.

Specified by:

setResource in interface AbstractImageStaticSource.HasResource

Overrides:

setResource in class AbstractImageStaticSource

Parameters:

resource - stream resource to set

withResource

public ImageStaticSource withResource(com.vaadin.flow.server.StreamResource resource)

See setResource(StreamResource).

Parameters:

resource - stream resource to set

Returns:

current instance