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

Interface HasGeoObjectSelect<E>

Type Parameters:

E - item type

All Superinterfaces:

SupportsFeatureSelect

All Known Implementing Classes:

DataVectorSource

public interface HasGeoObjectSelect<E>
extends SupportsFeatureSelect

Interface to be implemented by sources that support geo-object selection.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	HasGeoObjectSelect.SourceGeoObjectSelectEvent<E>	The event is fired when items are selected or deselected.

Method Summary

Modifier and Type	Method	Description
com.vaadin.flow.shared.Registration	addSourceGeoObjectSelectListener(Consumer<HasGeoObjectSelect.SourceGeoObjectSelectEvent<E>> listener)	Adds geo-object select listener.
void	deselectAllGeoObjects()	Deselects all items in the source.
void	deselectGeoObject(E item)	Deselects the provided item.
void	deselectGeoObjects(Collection<E> items)	Deselects the collection of items.
Collection<E>	getSelectedGeoObjects()
boolean	isGeoObjetSelected(E item)	Checks whether an item is selected.
void	selectAllGeoObjects()	Selects all items in the source.
void	selectGeoObject(E item)	Selects the provided item.
void	selectGeoObjects(Collection<E> items)	Selects the collection of items.

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

getFeatureSelectEnabled, setFeatureSelectEnabled

Method Details

isGeoObjetSelected

boolean isGeoObjetSelected(E item)

Checks whether an item is selected.

Parameters:

item - item to check

Returns:

true if feature is selected

getSelectedGeoObjects

Collection<E> getSelectedGeoObjects()

Returns:

unmodifiable collection of selected items

selectGeoObject

void selectGeoObject(E item)

Selects the provided item.

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

Parameters:

item - item to select

deselectGeoObject

void deselectGeoObject(E item)

Deselects the provided item.

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

Parameters:

item - item to deselect

selectGeoObjects

void selectGeoObjects(Collection<E> items)

Selects the collection of items.

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

Parameters:

items - items to select

deselectGeoObjects

void deselectGeoObjects(Collection<E> items)

Deselects the collection of items.

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

Parameters:

items - items to deselect

selectAllGeoObjects

void selectAllGeoObjects()

Selects all items in the source.

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

deselectAllGeoObjects

void deselectAllGeoObjects()

Deselects all items in the source.

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

addSourceGeoObjectSelectListener

com.vaadin.flow.shared.Registration addSourceGeoObjectSelectListener(Consumer<HasGeoObjectSelect.SourceGeoObjectSelectEvent<E>> listener)

Adds geo-object select listener.

Parameters:

listener - listener to add

Returns:

a registration object for removing an event listener