Package com.luciad.edit.features
Interface IFeatureEditCandidateProvider
- All Known Implementing Classes:
FeatureStateEditCandidateProvider
public interface IFeatureEditCandidateProvider
An edit candidate provider determines which Features are considered for editing.
This interface is used by Editor
, who will use it to determine which Features are edited. An edit candidate can be configured using Editor.Builder#editCandidateProvider
.
Edit candidates are typically determined using feature states
. FeatureStateEditCandidateProvider
for example allows you to return selected or hovered-over Features (or other FeatureStates).
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addObserver
(IFeatureEditCandidateObserver observer) Adds an observer that allows you to receive change events from this edit candidate provider.List
<@NotNull LayerFeatureId> Returns the list of edit candidates.void
removeObserver
(IFeatureEditCandidateObserver observer) Removes the given observer.
-
Method Details
-
getEditCandidates
Returns the list of edit candidates.- Returns:
- the list of edit candidates
-
addObserver
void addObserver(@NotNull IFeatureEditCandidateObserver observer) throws NullPointerException, IllegalArgumentException Adds an observer that allows you to receive change events from this edit candidate provider.Adding the same observer twice is forbidden, and will cause an exception.
- Parameters:
observer
- an observer- Throws:
IllegalArgumentException
- when the observer was already added.NullPointerException
- when the observer isnull
.
-
removeObserver
void removeObserver(@NotNull IFeatureEditCandidateObserver observer) throws NullPointerException, IllegalArgumentException Removes the given observer.If the given observer was never added, an exception is thrown.
- Parameters:
observer
- an observer- Throws:
IllegalArgumentException
- when the observer is not known.NullPointerException
- when the observer isnull
.
-