Package com.luciad.edit

Class Editor

java.lang.Object

com.luciad.edit.Editor

All Implemented Interfaces:

AutoCloseable

public final class Editor
extends Object
implements AutoCloseable

This class allows you to interactively edit Features on the Map.

See the related guide for an overview of the editing API.

It manages the editing state and provides visualization capabilities by:

• tracking edit candidates (IFeatureEditCandidateProvider)
• tracking which Feature is being edited, and which handles are used for it
• creating IFeatureModel instances with handles, and keeping them up-to-date
• providing a LayerList that can be used to visualize the handle models

Editing can be configured using:

• Editor.Builder
• FeatureLayer.Builder#editConfiguration
• FeatureLayer.Builder#editCreateGeometryProvider

It is allowed to access this class on the UI thread only. See the related article: Threading rules for the Map

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Editor.Builder	Builder for the Editor class.

Method Summary

Modifier and Type	Method	Description
void	close()
boolean	equals(Object other)
protected void	finalize()
FeatureLayer	getEditHandleLayer()	Returns the layer that paint IEditHandles.
int	hashCode()
static Editor.Builder	newBuilder()	Returns a new builder for creating an Editor.
EventResult	onEvent(IInputEvent inputEvent)	Handles the given event, and returns if the event was handled or not.

Methods inherited from class java.lang.Object

clone, getClass, 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

newBuilder

@NotNull
public static Editor.Builder newBuilder()

Returns a new builder for creating an Editor.

Returns:

a new builder for creating an Editor.

onEvent

@NotNull
public EventResult onEvent(@NotNull
 IInputEvent inputEvent)
                    throws NullPointerException

Handles the given event, and returns if the event was handled or not.

This method delegates the given event to one of the currently available handles. The order in which this event is passed to the handles is determined by the handle's state, and the order in which they are returned from IEditHandles:

• Active handles have priority over Highlighted handles, and Highlighted handles have priority over Inactive handles.
• If multiple handles have the same state, the order in which they are returned from IEditHandles is used

Parameters:

inputEvent - an event, cannot be null.

Returns:

if the event was consumed or not

Throws:

NullPointerException - when null is passed.

getEditHandleLayer

@NotNull
public FeatureLayer getEditHandleLayer()

Returns the layer that paint IEditHandles.

This layer can contain the edit handles of multiple feature layers. The returned layer instance will always be the same, but the layer's model gets updated as edit handles are added, removed or modified.

A controller implementation typically adds this layer to its layer list, although it can also add this layer to the Map's layer list.

Returns:

the layer that paint IEditHandles.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable
 Object other)

Overrides:

equals in class Object