Package com.luciad.create

Class Creator

java.lang.Object

com.luciad.create.Creator

All Implemented Interfaces:

AutoCloseable

public final class Creator
extends Object
implements AutoCloseable

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

A Creator should only be used once, i.e. to create a single Feature. Afterwards, it can be discarded.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
void	addObserver(ICreatorObserver observer)	Adds an observer that is called when a Feature was created and added to the model, or when feature creation failed.
void	close()
boolean	equals(Object other)
protected void	finalize()
FeatureLayer	getPreviewLayer()	Returns the layer that can paint a preview of the Feature that is being created.
int	hashCode()
static Creator.Builder	newBuilder()	Returns a new builder for creating a Creator.
EventResult	onEvent(IInputEvent inputEvent)	Handles the given event, and returns if the event was handled or not.
void	removeObserver(ICreatorObserver observer)	Removes the given observer.

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 Creator.Builder newBuilder()

Returns a new builder for creating a Creator.

Returns:

a new builder for creating a Creator.

onEvent

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

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

Parameters:

inputEvent - an event, cannot be null.

Returns:

if the event was consumed or not

Throws:

NullPointerException - when the input event is null.

getPreviewLayer

@NotNull
public FeatureLayer getPreviewLayer()

Returns the layer that can paint a preview of the Feature that is being created.

Returns:

the layer that can paint a preview of the Feature that is being created.

addObserver

public void addObserver(@NotNull
 ICreatorObserver observer)
                 throws NullPointerException,
IllegalArgumentException

Adds an observer that is called when a Feature was created and added to the model, or when feature creation failed.

Parameters:

observer - an observer

Throws:

IllegalArgumentException - when the observer was already added.

NullPointerException - when the observer is null.

removeObserver

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

Removes the given observer.

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

Parameters:

observer - an observer.

Throws:

IllegalArgumentException - when the observer is not known.

NullPointerException - when the observer is null.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable
 Object other)

Overrides:

equals in class Object