org.pepsoft.worldpainter.operations

Interface Operation

All Known Subinterfaces:

GardenOfEdenOperation, GlobalOperation

public interface Operation

A WorldPainter operation or tool which affects the world in some way, directed by the user.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Get the short description of the operation.
java.awt.image.BufferedImage	getIcon() Get the icon of the operation.
java.lang.String	getName() Get the short name of the operation.
javax.swing.JPanel	getOptionsPanel() Get the options panel of the operation, if any.
void	interrupt() Interrupt the operation if it is a continuous operations that is currently in progress (for instance because a button is being held down).
boolean	isActive() Determine whether the operation is currently active.
void	setActive(boolean active) Activate or deactivate the operation.
void	setView(WorldPainterView view) Set the WorldPainterView with which the operation should associate.

Method Detail

setView

void setView(WorldPainterView view)

Set the WorldPainterView with which the operation should associate. Will be invoked once by WorldPainter when the operation is initialised.

Parameters:

view - The WorldPainterView with which the operation should associate.

getName

java.lang.String getName()

Get the short name of the operation. Displayed to the user as part of the tooltip for the operation.

Returns:

The short name of the operation.

getDescription

java.lang.String getDescription()

Get the short description of the operation. May be used in a tooltip.

Returns:

The short description of the operation.

isActive

boolean isActive()

Determine whether the operation is currently active.

Returns:

true if the operation is currently active.

setActive

void setActive(boolean active)
        throws java.beans.PropertyVetoException

Activate or deactivate the operation. Will be invoked by WorldPainter when the user activates or deactivates the operation, for example by pressing a toggle button.

Please note: it is the operation's own responsibility to install listeners, etc. on the view if necessary to detect user activity while the operation is active, and uninstall them when deactivated.

Parameters:

active - Whether the operation should activatate itself (when true) or deactivate itself (when false).

Throws:

java.beans.PropertyVetoException - If the operation failed to activate for some reason, for instance because some dependency is not met, or some state is inappropriate.

getIcon

java.awt.image.BufferedImage getIcon()

Get the icon of the operation. Should be 16x16 and have a transparent background.

Returns:

The icon of the operation.

getOptionsPanel

javax.swing.JPanel getOptionsPanel()

Get the options panel of the operation, if any. Should be a live and modifiable view of the current options of the operation. May be null if the operation has no options.

interrupt

void interrupt()

Interrupt the operation if it is a continuous operations that is currently in progress (for instance because a button is being held down). This will be called in some circumstances to prevent hanging operations due to focus stealing or similar problems. It must emulate the user ceasing to press the button or otherwise signalling that the operation should no longer be applied.