Package com.luciad.edit

Class Editor.Builder

java.lang.Object

com.luciad.edit.Editor.Builder

All Implemented Interfaces:

AutoCloseable

Enclosing class:

Editor

public static final class Editor.Builder
extends Object
implements AutoCloseable

Builder for the Editor class.

Constructor Summary

Constructors

Constructor	Description
Builder(Editor.Builder other)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
Editor	build()	Returns a new editor, based on the properties set on this builder.
void	close()
Editor.Builder	defaultSettings(EditSettings editSettings)	Sets the default settings that can be used by the handles that are used to edit features and geometries.
Editor.Builder	editCandidateProvider(IFeatureEditCandidateProvider editCandidateProvider)	Sets the IFeatureEditCandidateProvider to use.
protected void	finalize()
Editor.Builder	map(Map map)	Sets the map on which features are edited.
Editor.Builder	mouseCursorCallback(IMouseCursorCallback mouseCursorCallback)	Sets the IMouseCursorCallback to use.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(@NotNull
 Editor.Builder other)

Copy constructor.

Parameters:

other - the builder to copy.

Method Details

finalize

protected void finalize()

Overrides:

finalize in class Object

close

public void close()

Specified by:

close in interface AutoCloseable

build

@NotNull
public Editor build()
             throws IllegalStateException

Returns a new editor, based on the properties set on this builder.

Returns:

a new editor.

Throws:

IllegalStateException - if not all mandatory parameters are set

map

@NotNull
public Editor.Builder map(@NotNull
 Map map)
                   throws NullPointerException

Sets the map on which features are edited.

This parameter is mandatory. If it is not set, Editor.Builder#build will throw an exception.

Parameters:

map - the Map on which to edit features

Returns:

this builder

Throws:

NullPointerException - when null is passed.

editCandidateProvider

@NotNull
public Editor.Builder editCandidateProvider(@NotNull
 IFeatureEditCandidateProvider editCandidateProvider)
                                     throws NullPointerException

Sets the IFeatureEditCandidateProvider to use.

This parameter is optional. When it is not set, edit candidates will be based on selection through FeatureStateEditCandidateProvider.

Parameters:

editCandidateProvider - the edit candidate provider to use.

Returns:

this builder

Throws:

NullPointerException - when null is passed.

mouseCursorCallback

@NotNull
public Editor.Builder mouseCursorCallback(@Nullable
 IMouseCursorCallback mouseCursorCallback)

Sets the IMouseCursorCallback to use.

This callback is called when the Editor's cursor has changed.

Typically, this method is called by an IController implementation that supports Feature editing. This implementation can call Map#setCursor to effectively change the mouse cursor.

This callback is called on the UI thread only.

This parameter is optional.

Parameters:

mouseCursorCallback - a callback that is called when the editor's cursor has changed.

Returns:

this builder

defaultSettings

@NotNull
public Editor.Builder defaultSettings(@NotNull
 EditSettings editSettings)
                               throws NullPointerException

Sets the default settings that can be used by the handles that are used to edit features and geometries.

Feature and Geometry implementations are encouraged to use these default settings. The settings are available in the context given as parameter to their methods.

This parameter is optional. If it is not provided, a default EditSettings instance will be used.

Parameters:

editSettings - the default settings to use. Should not be null.

Returns:

this builder

Throws:

NullPointerException - when null is passed.