Package com.luciad.edit.features

Class FeatureEditConfigurationBuilder

java.lang.Object

com.luciad.edit.features.FeatureEditConfigurationBuilder

All Implemented Interfaces:

AutoCloseable

public final class FeatureEditConfigurationBuilder
extends Object
implements AutoCloseable

This builder can be used to configure editing for a layer.

See FeatureLayer.Builder#editConfiguration.

See the related guide for more configuration options.

Method Summary

Modifier and Type	Method	Description
void	close()
protected void	finalize()
FeatureEditConfigurationBuilder	handlesProvider(IFeatureHandlesProvider handlesProvider)	Configures the handles provider that is used to provide the edit handles for a feature.
void	notEditable()	Disable editing for the current feature.
void	submit()	Submits the information to this builder, and confirm that the current feature can be edited.
FeatureEditConfigurationBuilder	updateMode(ModelUpdateMode updateMode)	This setting gives more control over when and how often the model is updated during interactive editing.

Methods inherited from class java.lang.Object

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

Method Details

finalize

protected void finalize()

Overrides:

finalize in class Object

close

public void close()

Specified by:

close in interface AutoCloseable

handlesProvider

@NotNull
public FeatureEditConfigurationBuilder handlesProvider(@NotNull
 IFeatureHandlesProvider handlesProvider)
                                                throws NullPointerException

Configures the handles provider that is used to provide the edit handles for a feature.

Calling this method is optional. If this method is not called, a default implementation will be configured. See CompositeFeatureHandlesProvider#createDefault().

Parameters:

handlesProvider - a handles provider for Features, cannot be null

Returns:

this

Throws:

NullPointerException - when null is passed.

updateMode

@NotNull
public FeatureEditConfigurationBuilder updateMode(@NotNull
 ModelUpdateMode updateMode)

This setting gives more control over when and how often the model is updated during interactive editing.

It is useful to make sure that the model is updated less often when model updates are expensive, for example for models with a database backend, or other models that don't keep Feature state in memory.

The default is ModelUpdateMode#OnAnyChange.

Parameters:

updateMode - the update mode

Returns:

this

notEditable

public void notEditable()

Disable editing for the current feature.

Either this method, or the submit() method must be called.

Note: you can disable editing for all features of a layer by not configuring an IFeatureEditConfiguration.

submit

public void submit()
            throws IllegalStateException

Submits the information to this builder, and confirm that the current feature can be edited.

Either this method, or the notEditable method must be called.

Throws:

IllegalStateException - on an illegal state, e.g. when already submitted.