com.vividsolutions.jump.workbench.plugin

Class RunMacroPlugIn

java.lang.Object

com.vividsolutions.jump.workbench.plugin.AbstractPlugIn

org.openjump.core.ui.plugin.AbstractUiPlugIn

org.openjump.core.ui.plugin.AbstractThreadedUiPlugIn

com.vividsolutions.jump.workbench.plugin.RunMacroPlugIn

All Implemented Interfaces:

EnableChecked, Iconified, MacroManager, PlugIn, Recordable, ShortcutEnabled, ThreadedPlugIn, java.awt.event.ActionListener, java.util.EventListener

public class RunMacroPlugIn
extends AbstractThreadedUiPlugIn
implements MacroManager

Run a macro composed of a sequence of plugins along with their parameters.

Field Summary

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

enableCheck, workbenchContext

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

shortcutKeys, shortcutModifiers

Fields inherited from interface com.vividsolutions.jump.workbench.plugin.MacroManager

MACRO, MACRO_RUNNING, MACRO_STARTED

Constructor Summary

Constructors

Constructor and Description
RunMacroPlugIn()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	execute(PlugInContext context) Method to be overridden by implementations to execute the plug-in.
void	initialize(PlugInContext context) Method to be overridden by implementations to initialize the plug-in.
void	process(TaskMonitor monitor, PlugInContext context)
void	run(TaskMonitor monitor, PlugInContext context) Runs the task.

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

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

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vividsolutions.jump.workbench.plugin.PlugIn

getName

Constructor Detail

RunMacroPlugIn

public RunMacroPlugIn()

Method Detail

initialize

public void initialize(PlugInContext context)
                throws java.lang.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:

java.lang.Exception

execute

public boolean execute(PlugInContext context)
                throws java.lang.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 action completed, false if it was aborted. Used by ThreadedPlugIns to indicate that their #run method needn't be called next.

Throws:

java.lang.Exception - if a problem occurs during plug-in execution

See Also:

ThreadedPlugIn

run

public void run(TaskMonitor monitor,
       PlugInContext context)
         throws java.lang.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.

Specified by:

run in interface ThreadedPlugIn

Parameters:

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

Throws:

java.lang.Exception

process

public void process(TaskMonitor monitor,
           PlugInContext context)
             throws java.lang.Exception

Throws:

java.lang.Exception