org.pepsoft.worldpainter.layers

Interface LayerEditor<L extends Layer>

Type Parameters:

L - The layer for which this is the editor.

All Known Implementing Classes:

AbstractLayerEditor

public interface LayerEditor<L extends Layer>

An editor of Layer settings.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	LayerEditor.LayerEditorContext A context from which the layer editor may obtain context information and to which it may report events.

Method Summary

Modifier and Type	Method and Description
void	commit() Save the current settings from the editor component to the layer.
L	createLayer() Create a new layer with default settings.
default java.util.List<java.awt.Component>	getAdditionalButtons() Get optional additional buttons which will be placed on the Edit Layer Dialog to the left of the OK and Cancel buttons.
javax.swing.JComponent	getComponent() Get the actual layer editor component.
L	getLayer() Get the layer currently being edited.
ExporterSettings	getSettings() Get a copy of the current settings from the editor component without saving them or applying them to the layer.
boolean	isCommitAvailable() Indicates whether the current settings are valid and complete and can therefore be committed.
void	reset() Discard the current settings from the editor component and reload the settings from the layer being edited.
void	setContext(LayerEditor.LayerEditorContext context) Set the context from which the layer editor must obtains its context information and to which it must report events.
void	setLayer(L layer) Set the layer to be edited.

Method Detail

getComponent

javax.swing.JComponent getComponent()

Get the actual layer editor component. Must be a singleton which is backed by this LayerEditor, in other words it should be possible to reuse the instance by invoking the other methods on the LayerEditor to set a layer, etc.

Returns:

The actual layer editor component.

getAdditionalButtons

default java.util.List<java.awt.Component> getAdditionalButtons()

Get optional additional buttons which will be placed on the Edit Layer Dialog to the left of the OK and Cancel buttons. The default implementation returns an empty list.

Returns:

Additional buttons to present to the user.

createLayer

L createLayer()

Create a new layer with default settings.

Returns:

A new instance of this editors layer type, with default settings.

getLayer

L getLayer()

Get the layer currently being edited.

Returns:

The layer currently being edited.

setLayer

void setLayer(L layer)

Set the layer to be edited. The layer's settings should be loaded into any previously returned editor component from getComponent().

Parameters:

layer - The layer to be edited.

commit

void commit()

Save the current settings from the editor component to the layer. Until this is called no changes must be made to the layer, even if the user changes settings on the editor component!

Throws:

java.lang.IllegalStateException - If invoked when the settings are incomplete or invalid, as indicated by isCommitAvailable().

reset

void reset()

Discard the current settings from the editor component and reload the settings from the layer being edited.

getSettings

ExporterSettings getSettings()

Get a copy of the current settings from the editor component without saving them or applying them to the layer.

Returns:

A copy of the current settings from the editor component.

Throws:

java.lang.IllegalStateException - If invoked when the settings are incomplete or invalid, as indicated by isCommitAvailable().

isCommitAvailable

boolean isCommitAvailable()

Indicates whether the current settings are valid and complete and can therefore be committed. If not, a commit() and getSettings() will result in an IllegalStateException.

Returns:

true if the current settings are valid and complete and can be committed.

setContext

void setContext(LayerEditor.LayerEditorContext context)

Set the context from which the layer editor must obtains its context information and to which it must report events. This will be invoked with a suitable context before any of the other methods are invoked.

Parameters:

context - The context to set.