com.luciad.edit.features

Class FeatureStateEditCandidateProvider

java.lang.Object

com.luciad.edit.features.FeatureStateEditCandidateProvider

All Implemented Interfaces:

IFeatureEditCandidateProvider, AutoCloseable

public final class FeatureStateEditCandidateProvider
extends Object
implements AutoCloseable, IFeatureEditCandidateProvider

This IFeatureEditCandidateProvider uses enabled FeatureStates to determine editing candidates.

It can for example provide:

• selected objects (FeatureState#selected())
• hovered-over objects (FeatureState#hover())

Constructor Summary

Constructors

Constructor and Description
FeatureStateEditCandidateProvider(Map map, FeatureState featureState) Creates a new FeatureStateEditCandidateProvider for the given map, using the given FeatureState.

Method Summary

Modifier and Type	Method and Description
void	addObserver(IFeatureEditCandidateObserver observer) Adds an observer that allows you to receive change events from this edit candidate provider.
void	close()
protected void	finalize()
List<LayerFeatureId>	getEditCandidates()
void	removeObserver(IFeatureEditCandidateObserver observer) Removes the given observer.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FeatureStateEditCandidateProvider

public FeatureStateEditCandidateProvider(@NotNull
                                         Map map,
                                         @NotNull
                                         FeatureState featureState)

Creates a new FeatureStateEditCandidateProvider for the given map, using the given FeatureState.

Parameters:

map - the map

featureState - a FeatureState

Method Detail

finalize

protected void finalize()

Overrides:

finalize in class Object

close

public void close()

Specified by:

close in interface AutoCloseable

getEditCandidates

@NotNull
public List<LayerFeatureId> getEditCandidates()

Specified by:

getEditCandidates in interface IFeatureEditCandidateProvider

Returns:

the list of edit candidates

addObserver

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

Specified by:

addObserver in interface IFeatureEditCandidateProvider

Parameters:

observer - an observer

Throws:

IllegalArgumentException - when the observer was already added.

NullPointerException - when the observer is null.

removeObserver

public void removeObserver(@NotNull
                           IFeatureEditCandidateObserver observer)
                    throws NullPointerException,
                           IllegalArgumentException

Removes the given observer.

If the given observer was never added, an exception is thrown.

Specified by:

removeObserver in interface IFeatureEditCandidateProvider

Parameters:

observer - an observer

Throws:

IllegalArgumentException - when the observer is not known.

NullPointerException - when the observer is null.