Luciad.Edit.Features.IFeatureEditCandidateProvider Interface Reference

An edit candidate provider determines which Features are considered for editing. More...

Inheritance diagram for Luciad.Edit.Features.IFeatureEditCandidateProvider:

Public Member Functions
void	AddObserver (Luciad.Edit.Features.IFeatureEditCandidateObserver observer)
	Adds an observer that allows you to receive change events from this edit candidate provider. More...
System.Collections.Generic.IList< Luciad.Layers.Features.LayerFeatureId >	GetEditCandidates ()
	Returns the list of edit candidates. More...
void	RemoveObserver (Luciad.Edit.Features.IFeatureEditCandidateObserver observer)
	Removes the given observer. More...

Detailed Description

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

Since

2020.1

Member Function Documentation

AddObserver()

void Luciad.Edit.Features.IFeatureEditCandidateProvider.AddObserver

(

Luciad.Edit.Features.IFeatureEditCandidateObserver

observer

)

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

Exceptions

System.ArgumentException	when the observer was already added.
System.ArgumentNullException	when the observer is null.

Implemented in Luciad.Edit.Features.FeatureStateEditCandidateProvider.

GetEditCandidates()

System.Collections.Generic.IList< Luciad.Layers.Features.LayerFeatureId > Luciad.Edit.Features.IFeatureEditCandidateProvider.GetEditCandidates

(

)

Returns the list of edit candidates.

Returns

the list of edit candidates

Implemented in Luciad.Edit.Features.FeatureStateEditCandidateProvider.

RemoveObserver()

void Luciad.Edit.Features.IFeatureEditCandidateProvider.RemoveObserver

(

Luciad.Edit.Features.IFeatureEditCandidateObserver

observer

)

Removes the given observer.

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

Parameters

observer

an observer

Exceptions

System.ArgumentException	when the observer is not known.
System.ArgumentNullException	when the observer is null.

Implemented in Luciad.Edit.Features.FeatureStateEditCandidateProvider.