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

Class VectorSource

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.AbstractVectorSource

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

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

io.jmix.mapsflowui.component.model.source.VectorSource

All Implemented Interfaces:

HasFeatureDrag, HasFeatureModify, HasFeatureSelect, SourceFeatureClickNotifier, AbstractVectorSource.HasOverlaps, AbstractVectorSource.HasUseSpatialIndex, AbstractVectorSource.HasVectorSourceOptions, Source.HasAttributions, Source.HasWrapX, SupportsFeatureDrag, SupportsFeatureModify, SupportsFeatureSelect, Serializable

public class VectorSource
extends AbstractFeatureSource
implements AbstractVectorSource.HasVectorSourceOptions, Source.HasAttributions, Source.HasWrapX, SourceFeatureClickNotifier, HasFeatureSelect, HasFeatureDrag, HasFeatureModify

Source for working with features. It can be used in VectorLayer.

For more details see: VectorSource docs

See Also:

• VectorLayer
• Serialized Form

Nested Class Summary

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

AbstractVectorSource.HasOverlaps, AbstractVectorSource.HasUseSpatialIndex, AbstractVectorSource.HasVectorSourceOptions

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

Nested classes/interfaces inherited from interface io.jmix.mapsflowui.component.model.source.HasFeatureDrag

HasFeatureDrag.AbstractSourceFeatureDragEvent, HasFeatureDrag.SourceFeatureDragEndEvent, HasFeatureDrag.SourceFeatureDragStartEvent

Nested classes/interfaces inherited from interface io.jmix.mapsflowui.component.model.source.HasFeatureModify

HasFeatureModify.AbstractSourceFeatureModifyEvent, HasFeatureModify.SourceFeatureDeleteEvent, HasFeatureModify.SourceFeatureModifyEndEvent, HasFeatureModify.SourceFeatureModifyStartEvent

Nested classes/interfaces inherited from interface io.jmix.mapsflowui.component.model.source.HasFeatureSelect

HasFeatureSelect.SourceFeatureSelectEvent

Nested classes/interfaces inherited from interface io.jmix.mapsflowui.component.model.source.SourceFeatureClickNotifier

SourceFeatureClickNotifier.AbstractFeatureClickEvent, SourceFeatureClickNotifier.SourceFeatureClickEvent, SourceFeatureClickNotifier.SourceFeatureDoubleClickEvent, SourceFeatureClickNotifier.SourceFeatureSingleClickEvent

Field Summary

Fields

Modifier and Type	Field	Description
protected Set<Feature>	selectedFeatures

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

features

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

featureDragEnabled, featureModifyEnabled, featureSelectEnabled, jmixSourceFeatureDeleteRegistration, jmixSourceFeatureDragEndRegistration, jmixSourceFeatureDragStartRegistration, jmixSourceFeatureModifyEndRegistration, jmixSourceFeatureModifyStartRegistration, jmixSourceFeatureSelectionRegistration

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

overlaps, useSpatialIndex

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, metaProperties, parent, removedChildren, syncId

Constructor Summary

Constructors

Constructor	Description
VectorSource()

Method Summary

Modifier and Type	Method	Description
com.vaadin.flow.shared.Registration	addFeatureDragEndListener(Consumer<HasFeatureDrag.SourceFeatureDragEndEvent> listener)	Adds feature drag end listener.
com.vaadin.flow.shared.Registration	addFeatureDragStartListener(Consumer<HasFeatureDrag.SourceFeatureDragStartEvent> listener)	Adds feature drag start listener.
com.vaadin.flow.shared.Registration	addSourceFeatureClickListener(Consumer<SourceFeatureClickNotifier.SourceFeatureClickEvent> listener)	Adds feature click listener.
com.vaadin.flow.shared.Registration	addSourceFeatureDeleteListener(Consumer<HasFeatureModify.SourceFeatureDeleteEvent> listener)	Adds feature delete listener.
com.vaadin.flow.shared.Registration	addSourceFeatureDoubleClickListener(Consumer<SourceFeatureClickNotifier.SourceFeatureDoubleClickEvent> listener)	Adds feature double click listener.
com.vaadin.flow.shared.Registration	addSourceFeatureModifyEndListener(Consumer<HasFeatureModify.SourceFeatureModifyEndEvent> listener)	Adds feature modify end listener.
com.vaadin.flow.shared.Registration	addSourceFeatureModifyStartListener(Consumer<HasFeatureModify.SourceFeatureModifyStartEvent> listener)	Adds feature modify start listener.
com.vaadin.flow.shared.Registration	addSourceFeatureSelectListener(Consumer<HasFeatureSelect.SourceFeatureSelectEvent> listener)	Adds feature select listener.
com.vaadin.flow.shared.Registration	addSourceFeatureSingleClickListener(Consumer<SourceFeatureClickNotifier.SourceFeatureSingleClickEvent> listener)	Adds feature single click listener.
protected void	applyChangesToFeatures(Map<Feature,SimpleGeometry<?>> features)
void	deselectAllFeatures()	Deselects all features in the source.
void	deselectFeature(Feature feature)	Deselects the provided feature.
void	deselectFeatures(Collection<Feature> features)	Deselects the collection of features.
List<String>	getAttributions()	Source.HasAttributions.getAttributions()
Boolean	getFeatureDragEnabled()
Boolean	getFeatureModifyEnabled()
Boolean	getFeatureSelectEnabled()
Boolean	getOverlaps()
Collection<Feature>	getSelectedFeatures()
protected String	getType()
Boolean	getUseSpatialIndex()
Boolean	getWrapX()	Source.HasWrapX.getWrapX()
boolean	isFeatureSelected(Feature feature)	Checks whether a feature is selected.
protected void	onJmixSourceFeatureDelete(JmixSourceFeatureDeleteEvent event)
protected void	onJmixSourceFeatureDragEnd(JmixSourceFeatureDragEndEvent event)
protected void	onJmixSourceFeatureDragStart(JmixSourceFeatureDragStartEvent event)
protected void	onJmixSourceFeatureModifyEnd(JmixSourceFeatureModifyEndEvent event)
protected void	onJmixSourceFeatureModifyStart(JmixSourceFeatureModifyStartEvent event)
protected void	onJmixSourceFeatureSelection(JmixSourceFeatureSelectionEvent event)
void	removeAllFeatures()	Removes all features from the source.
void	removeFeature(Feature feature)	Removes a feature from the source.
void	selectAllFeatures()	Selects all features in the source.
void	selectFeature(Feature feature)	Selects the provided feature.
void	selectFeatures(Collection<Feature> features)	Selects the collection of features.
void	setAttributions(List<String> attributions)	Source.HasAttributions.setAttributions(List)
void	setFeatureDragEnabled(Boolean enabled)	Enables / disables feature drag mode.
void	setFeatureModifyEnabled(Boolean enabled)	Enables / disables feature modify mode.
void	setFeatureSelectEnabled(Boolean enabled)	Enables / disables feature select mode.
void	setOverlaps(Boolean overlaps)	Sets whether source may have overlapping geometries.
void	setUseSpatialIndex(Boolean useSpatialIndex)	Sets whether to use spatial index.
void	setWrapX(Boolean wrapX)	Sets whether the source should be looped along the X coordinate.
VectorSource	withAttributions(List<String> attributions)	See setAttributions(List).
VectorSource	withOverlaps(Boolean overlaps)	See setOverlaps(Boolean).
VectorSource	withUseSpatialIndex(Boolean useSpatialIndex)	See setUseSpatialIndex(Boolean).
VectorSource	withWrapX(Boolean wrapX)	See setWrapX(Boolean).

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

addAllFeatures, addFeature, getFeatures

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

attachJmixSourceFeatureDeleteListener, attachJmixSourceFeatureDragEndListener, attachJmixSourceFeatureDragStartListener, attachJmixSourceFeatureModifyEndListener, attachJmixSourceFeatureModifyStartListener, attachJmixSourceFeatureSelectionListener

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

getAttributionsCollapsible, getId, getProjection, setAttributionsCollapsible, setId, setProjection

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

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

Methods inherited from class java.lang.Object

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

Field Details

selectedFeatures

protected Set<Feature> selectedFeatures

Constructor Details

VectorSource

public VectorSource()

Method Details

getType

protected String getType()

Specified by:

getType in class MapObservableObject

removeFeature

public void removeFeature(Feature feature)

Description copied from class: AbstractFeatureSource

Removes a feature from the source.

Overrides:

removeFeature in class AbstractFeatureSource

Parameters:

feature - feature to remove

removeAllFeatures

public void removeAllFeatures()

Description copied from class: AbstractFeatureSource

Removes all features from the source.

Overrides:

removeAllFeatures in class AbstractFeatureSource

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 VectorSource withAttributions(List<String> attributions)

See setAttributions(List).

Parameters:

attributions - info about copyrights and licences

Returns:

current instance

getWrapX

public Boolean getWrapX()

Source.HasWrapX.getWrapX()

Specified by:

getWrapX in interface Source.HasWrapX

Overrides:

getWrapX in class Source

Returns:

whether the source should be looped along the X coordinate or null if not set

setWrapX

public void setWrapX(Boolean wrapX)

Sets whether the source should be looped along the X coordinate. The default value for Source is true.

Note, wrapX attribute is set only at creation time and cannot be changed at runtime. For more details see: VectorSource docs

Specified by:

setWrapX in interface Source.HasWrapX

Overrides:

setWrapX in class Source

Parameters:

wrapX - whether the source should be looped along the X coordinate

withWrapX

public VectorSource withWrapX(Boolean wrapX)

See setWrapX(Boolean).

Parameters:

wrapX - whether the source should be looped along the X coordinate

Returns:

current instance

getOverlaps

public Boolean getOverlaps()

Specified by:

getOverlaps in interface AbstractVectorSource.HasOverlaps

Overrides:

getOverlaps in class AbstractVectorSource

Returns:

overlaps value or null if not set

setOverlaps

public void setOverlaps(Boolean overlaps)

Sets whether source may have overlapping geometries. The default value is true.

Setting this to false (e.g. for sources with polygons that represent administrative boundaries) allows the renderer to optimise fill and stroke operations.

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

Specified by:

setOverlaps in interface AbstractVectorSource.HasOverlaps

Overrides:

setOverlaps in class AbstractVectorSource

Parameters:

overlaps - overlaps option

withOverlaps

public VectorSource withOverlaps(Boolean overlaps)

See setOverlaps(Boolean).

Parameters:

overlaps - overlaps option

Returns:

current instance

getUseSpatialIndex

public Boolean getUseSpatialIndex()

Specified by:

getUseSpatialIndex in interface AbstractVectorSource.HasUseSpatialIndex

Overrides:

getUseSpatialIndex in class AbstractVectorSource

Returns:

useSpatialIndex value or null if not set

setUseSpatialIndex

public void setUseSpatialIndex(Boolean useSpatialIndex)

Sets whether to use spatial index. When features are removed and added frequently, and the total number of features is low, setting this to false may improve performance. The default value is true.

Specified by:

setUseSpatialIndex in interface AbstractVectorSource.HasUseSpatialIndex

Overrides:

setUseSpatialIndex in class AbstractVectorSource

Parameters:

useSpatialIndex - whether to use spatial index

withUseSpatialIndex

public VectorSource withUseSpatialIndex(Boolean useSpatialIndex)

See setUseSpatialIndex(Boolean).

Parameters:

useSpatialIndex - whether to use spatial index

Returns:

current instance

isFeatureSelected

public boolean isFeatureSelected(Feature feature)

Description copied from interface: HasFeatureSelect

Checks whether a feature is selected.

Specified by:

isFeatureSelected in interface HasFeatureSelect

Parameters:

feature - feature to check

Returns:

true if feature is selected

getSelectedFeatures

public Collection<Feature> getSelectedFeatures()

Specified by:

getSelectedFeatures in interface HasFeatureSelect

Returns:

unmodifiable collection of selected feature

selectFeature

public void selectFeature(Feature feature)

Description copied from interface: HasFeatureSelect

Selects the provided feature.

Note that selection works only when SupportsFeatureSelect.getFeatureSelectEnabled() is enabled.

Specified by:

selectFeature in interface HasFeatureSelect

Parameters:

feature - feature to select

deselectFeature

public void deselectFeature(Feature feature)

Description copied from interface: HasFeatureSelect

Deselects the provided feature.

Note that selection works only when SupportsFeatureSelect.getFeatureSelectEnabled() is enabled.

Specified by:

deselectFeature in interface HasFeatureSelect

Parameters:

feature - feature to deselect

selectFeatures

public void selectFeatures(Collection<Feature> features)

Description copied from interface: HasFeatureSelect

Selects the collection of features.

Note that selection works only when SupportsFeatureSelect.getFeatureSelectEnabled() is enabled.

Specified by:

selectFeatures in interface HasFeatureSelect

Parameters:

features - feature to select

deselectFeatures

public void deselectFeatures(Collection<Feature> features)

Description copied from interface: HasFeatureSelect

Deselects the collection of features.

Note that selection works only when SupportsFeatureSelect.getFeatureSelectEnabled() is enabled.

Specified by:

deselectFeatures in interface HasFeatureSelect

Parameters:

features - features to deselect

selectAllFeatures

public void selectAllFeatures()

Description copied from interface: HasFeatureSelect

Selects all features in the source.

Note that selection works only when SupportsFeatureSelect.getFeatureSelectEnabled() is enabled.

Specified by:

selectAllFeatures in interface HasFeatureSelect

deselectAllFeatures

public void deselectAllFeatures()

Description copied from interface: HasFeatureSelect

Deselects all features in the source.

Note that selection works only when SupportsFeatureSelect.getFeatureSelectEnabled() is enabled.

Specified by:

deselectAllFeatures in interface HasFeatureSelect

getFeatureSelectEnabled

public Boolean getFeatureSelectEnabled()

Specified by:

getFeatureSelectEnabled in interface SupportsFeatureSelect

Overrides:

getFeatureSelectEnabled in class AbstractEditableVectorSource

Returns:

whether select mode is enabled or not

setFeatureSelectEnabled

public void setFeatureSelectEnabled(Boolean enabled)

Description copied from interface: SupportsFeatureSelect

Enables / disables feature select mode.

The default value is false.

Specified by:

setFeatureSelectEnabled in interface SupportsFeatureSelect

Overrides:

setFeatureSelectEnabled in class AbstractEditableVectorSource

Parameters:

enabled - whether to enable select mode

getFeatureDragEnabled

public Boolean getFeatureDragEnabled()

Specified by:

getFeatureDragEnabled in interface SupportsFeatureDrag

Overrides:

getFeatureDragEnabled in class AbstractEditableVectorSource

Returns:

whether drag mode is enabled or not

setFeatureDragEnabled

public void setFeatureDragEnabled(Boolean enabled)

Description copied from interface: SupportsFeatureDrag

Enables / disables feature drag mode.

The default value is false.

Specified by:

setFeatureDragEnabled in interface SupportsFeatureDrag

Overrides:

setFeatureDragEnabled in class AbstractEditableVectorSource

Parameters:

enabled - whether to enable drag mode

getFeatureModifyEnabled

public Boolean getFeatureModifyEnabled()

Specified by:

getFeatureModifyEnabled in interface SupportsFeatureModify

Overrides:

getFeatureModifyEnabled in class AbstractEditableVectorSource

Returns:

whether modify mode is enabled or not

setFeatureModifyEnabled

public void setFeatureModifyEnabled(Boolean enabled)

Description copied from interface: SupportsFeatureModify

Enables / disables feature modify mode.

The default value is false.

Specified by:

setFeatureModifyEnabled in interface SupportsFeatureModify

Overrides:

setFeatureModifyEnabled in class AbstractEditableVectorSource

Parameters:

enabled - whether to enable modify mode

addSourceFeatureClickListener

public com.vaadin.flow.shared.Registration addSourceFeatureClickListener(Consumer<SourceFeatureClickNotifier.SourceFeatureClickEvent> listener)

Adds feature click listener. Note, if the user makes double click on a feature, the SourceFeatureClickNotifier.SourceFeatureClickEvent will be fired twice.

Specified by:

addSourceFeatureClickListener in interface SourceFeatureClickNotifier

Parameters:

listener - listener to add

Returns:

a registration object for removing an event listener

addSourceFeatureSingleClickListener

public com.vaadin.flow.shared.Registration addSourceFeatureSingleClickListener(Consumer<SourceFeatureClickNotifier.SourceFeatureSingleClickEvent> listener)

Adds feature single click listener. Single click means that an event won't be fired if the user makes double click.

Specified by:

addSourceFeatureSingleClickListener in interface SourceFeatureClickNotifier

Parameters:

listener - listener to add

Returns:

a registration object for removing an event listener

addSourceFeatureDoubleClickListener

public com.vaadin.flow.shared.Registration addSourceFeatureDoubleClickListener(Consumer<SourceFeatureClickNotifier.SourceFeatureDoubleClickEvent> listener)

Adds feature double click listener.

Specified by:

addSourceFeatureDoubleClickListener in interface SourceFeatureClickNotifier

Parameters:

listener - listener to add

Returns:

a registration object for removing an event listener

addSourceFeatureSelectListener

public com.vaadin.flow.shared.Registration addSourceFeatureSelectListener(Consumer<HasFeatureSelect.SourceFeatureSelectEvent> listener)

Description copied from interface: HasFeatureSelect

Adds feature select listener.

Specified by:

addSourceFeatureSelectListener in interface HasFeatureSelect

Parameters:

listener - listener to add

Returns:

a registration object for removing an event listener

addFeatureDragStartListener

public com.vaadin.flow.shared.Registration addFeatureDragStartListener(Consumer<HasFeatureDrag.SourceFeatureDragStartEvent> listener)

Description copied from interface: HasFeatureDrag

Adds feature drag start listener.

Specified by:

addFeatureDragStartListener in interface HasFeatureDrag

Parameters:

listener - listener to add

Returns:

a registration object for removing an event listener

addFeatureDragEndListener

public com.vaadin.flow.shared.Registration addFeatureDragEndListener(Consumer<HasFeatureDrag.SourceFeatureDragEndEvent> listener)

Description copied from interface: HasFeatureDrag

Adds feature drag end listener.

Specified by:

addFeatureDragEndListener in interface HasFeatureDrag

Parameters:

listener - listener to add

Returns:

a registration object for removing an event listener

addSourceFeatureModifyStartListener

public com.vaadin.flow.shared.Registration addSourceFeatureModifyStartListener(Consumer<HasFeatureModify.SourceFeatureModifyStartEvent> listener)

Description copied from interface: HasFeatureModify

Adds feature modify start listener.

Specified by:

addSourceFeatureModifyStartListener in interface HasFeatureModify

Parameters:

listener - listener to add

Returns:

a registration object for removing an event listener

addSourceFeatureModifyEndListener

public com.vaadin.flow.shared.Registration addSourceFeatureModifyEndListener(Consumer<HasFeatureModify.SourceFeatureModifyEndEvent> listener)

Description copied from interface: HasFeatureModify

Adds feature modify end listener.

Specified by:

addSourceFeatureModifyEndListener in interface HasFeatureModify

Parameters:

listener - listener to add

Returns:

a registration object for removing an event listener

addSourceFeatureDeleteListener

public com.vaadin.flow.shared.Registration addSourceFeatureDeleteListener(Consumer<HasFeatureModify.SourceFeatureDeleteEvent> listener)

Description copied from interface: HasFeatureModify

Adds feature delete listener.

Specified by:

addSourceFeatureDeleteListener in interface HasFeatureModify

Parameters:

listener - listener to add

Returns:

a registration object for removing an event listener

onJmixSourceFeatureSelection

protected void onJmixSourceFeatureSelection(JmixSourceFeatureSelectionEvent event)

Overrides:

onJmixSourceFeatureSelection in class AbstractEditableVectorSource

onJmixSourceFeatureDragStart

protected void onJmixSourceFeatureDragStart(JmixSourceFeatureDragStartEvent event)

Overrides:

onJmixSourceFeatureDragStart in class AbstractEditableVectorSource

onJmixSourceFeatureDragEnd

protected void onJmixSourceFeatureDragEnd(JmixSourceFeatureDragEndEvent event)

Overrides:

onJmixSourceFeatureDragEnd in class AbstractEditableVectorSource

onJmixSourceFeatureModifyStart

protected void onJmixSourceFeatureModifyStart(JmixSourceFeatureModifyStartEvent event)

Overrides:

onJmixSourceFeatureModifyStart in class AbstractEditableVectorSource

onJmixSourceFeatureModifyEnd

protected void onJmixSourceFeatureModifyEnd(JmixSourceFeatureModifyEndEvent event)

Overrides:

onJmixSourceFeatureModifyEnd in class AbstractEditableVectorSource

onJmixSourceFeatureDelete

protected void onJmixSourceFeatureDelete(JmixSourceFeatureDeleteEvent event)

Overrides:

onJmixSourceFeatureDelete in class AbstractEditableVectorSource

applyChangesToFeatures

protected void applyChangesToFeatures(Map<Feature,SimpleGeometry<?>> features)