Package org.openjump.core.ui.plugin.tools

Class EraseLayerAWithLayerBPlugIn

java.lang.Object

com.vividsolutions.jump.workbench.plugin.AbstractPlugIn

org.openjump.core.ui.plugin.AbstractUiPlugIn

org.openjump.core.ui.plugin.AbstractThreadedUiPlugIn

org.openjump.core.ui.plugin.tools.EraseLayerAWithLayerBPlugIn

All Implemented Interfaces:

EnableChecked, Iconified, PlugIn, Recordable, ShortcutEnabled, ThreadedPlugIn, ActionListener, EventListener

public class EraseLayerAWithLayerBPlugIn
extends AbstractThreadedUiPlugIn

PlugIn to erase geometries of a layer with the geometries from another layer

Field Summary

Fields

Modifier and Type	Field	Description
static String	DECOMPOSE_MULTI
static String	DESCRIPTION
static String	LAYER_A
static String	LAYER_B
static String	MINUS
static String	SHOW_NEW_VERTICES
static String	VERTEX_LAYER_SUFFIX

Fields inherited from class org.openjump.core.ui.plugin.AbstractUiPlugIn

enableCheck, workbenchContext

Fields inherited from class com.vividsolutions.jump.workbench.plugin.AbstractPlugIn

shortcutKeys, shortcutModifiers

Constructor Summary

Constructors

Constructor	Description
EraseLayerAWithLayerBPlugIn()

Method Summary

Modifier and Type	Method	Description
static MultiEnableCheck	createEnableCheck(WorkbenchContext workbenchContext)
boolean	execute(PlugInContext context)	Method to be overridden by implementations to execute the plug-in.
String	getName()	Get the name of the plug-in.
void	initialize(PlugInContext context)	Method to be overridden by implementations to initialize the plug-in.
void	run(TaskMonitor monitor, PlugInContext context)	Runs the task.

Methods inherited from class org.openjump.core.ui.plugin.AbstractUiPlugIn

actionPerformed, getEnableCheck, getIcon, getToolTip, isRollingBackInvalidEdits, reportNothingToUndoYet, setWorkbenchContext

Methods inherited from class com.vividsolutions.jump.workbench.plugin.AbstractPlugIn

addParameter, createName, execute, execute, getBooleanParam, getContext, getDoubleParam, getIcon, getIcon, getIntegerParam, getParameter, getParameters, getShortcutKeys, getShortcutKeyStroke, getShortcutModifiers, getStringParam, getWorkbenchContext, isShortcutEnabled, setParameters, setShortcutKeys, setShortcutModifiers, toActionListener, toString

Methods inherited from class java.lang.Object

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

Field Detail

LAYER_A

public static String LAYER_A

LAYER_B

public static String LAYER_B

DESCRIPTION

public static String DESCRIPTION

SHOW_NEW_VERTICES

public static String SHOW_NEW_VERTICES

DECOMPOSE_MULTI

public static String DECOMPOSE_MULTI

MINUS

public static String MINUS

VERTEX_LAYER_SUFFIX

public static String VERTEX_LAYER_SUFFIX

Constructor Detail

EraseLayerAWithLayerBPlugIn

public EraseLayerAWithLayerBPlugIn()

Method Detail

getName

public String getName()

Description copied from class: AbstractUiPlugIn

Get the name of the plug-in. If a name was not specified ask super class.

Specified by:

getName in interface PlugIn

Overrides:

getName in class AbstractUiPlugIn

Returns:

The plug-in name.

initialize

public void initialize(PlugInContext context)
                throws Exception

Description copied from class: AbstractUiPlugIn

Method to be overridden by implementations to initialize the plug-in. Plug-ins must invoke super.initialize().

Specified by:

initialize in interface PlugIn

Overrides:

initialize in class AbstractUiPlugIn

Parameters:

context - The plug-in context.

Throws:

Exception - if an exception occur during initialization

createEnableCheck

public static MultiEnableCheck createEnableCheck(WorkbenchContext workbenchContext)

execute

public boolean execute(PlugInContext context)
                throws Exception

Description copied from class: AbstractUiPlugIn

Method to be overridden by implementations to execute the plug-in.

Specified by:

execute in interface PlugIn

Overrides:

execute in class AbstractUiPlugIn

Parameters:

context - The plug-in context.

Returns:

true if the PlugIn has been executed

Throws:

Exception - if an Exception occurs during execution

See Also:

ThreadedPlugIn

run

public void run(TaskMonitor monitor,
                PlugInContext context)
         throws Exception

Description copied from interface: ThreadedPlugIn

Runs the task. This method will be executed in a separate thread, so that the GUI remains responsive (but only partially so, as a modal progress dialog will be in the way). Don't call GUI classes in this method as it is not executed on the GUI thread.

Parameters:

monitor - context to which this task can report its progress and check whether a party has requested its cancellation

context - context of this PlugIn

Throws:

Exception - if an Exception occurs during the run