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

Interface HasFeatureSelect

All Superinterfaces:

SupportsFeatureSelect

All Known Implementing Classes:

VectorSource

public interface HasFeatureSelect
extends SupportsFeatureSelect

Interface to be implemented by sources that support feature selection.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	HasFeatureSelect.SourceFeatureSelectEvent	The event is fired when features are selected or deselected.

Method Summary

Modifier and Type	Method	Description
com.vaadin.flow.shared.Registration	addSourceFeatureSelectListener(Consumer<HasFeatureSelect.SourceFeatureSelectEvent> listener)	Adds feature select listener.
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.
Collection<Feature>	getSelectedFeatures()
boolean	isFeatureSelected(Feature feature)	Checks whether a feature is selected.
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.

Methods inherited from interface io.jmix.mapsflowui.kit.component.model.source.SupportsFeatureSelect

getFeatureSelectEnabled, setFeatureSelectEnabled

Method Details

isFeatureSelected

boolean isFeatureSelected(Feature feature)

Checks whether a feature is selected.

Parameters:

feature - feature to check

Returns:

true if feature is selected

getSelectedFeatures

Collection<Feature> getSelectedFeatures()

Returns:

unmodifiable collection of selected feature

selectFeature

void selectFeature(Feature feature)

Selects the provided feature.

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

Parameters:

feature - feature to select

deselectFeature

void deselectFeature(Feature feature)

Deselects the provided feature.

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

Parameters:

feature - feature to deselect

selectFeatures

void selectFeatures(Collection<Feature> features)

Selects the collection of features.

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

Parameters:

features - feature to select

deselectFeatures

void deselectFeatures(Collection<Feature> features)

Deselects the collection of features.

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

Parameters:

features - features to deselect

selectAllFeatures

void selectAllFeatures()

Selects all features in the source.

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

deselectAllFeatures

void deselectAllFeatures()

Deselects all features in the source.

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

addSourceFeatureSelectListener

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

Adds feature select listener.

Parameters:

listener - listener to add

Returns:

a registration object for removing an event listener