com.vividsolutions.jump.workbench.plugin

Class StartMacroPlugIn

java.lang.Object

com.vividsolutions.jump.workbench.plugin.AbstractPlugIn

com.vividsolutions.jump.workbench.plugin.StartMacroPlugIn

All Implemented Interfaces:

EnableChecked, Iconified, MacroManager, PlugIn, Recordable, ShortcutEnabled

public class StartMacroPlugIn
extends AbstractPlugIn
implements MacroManager

Start recording a sequence of plugin execution

Field Summary

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
StartMacroPlugIn()

Method Summary

Methods

Modifier and Type	Method and Description
static EnableCheck	createEnableCheck(WorkbenchContext workbenchContext)
boolean	execute(PlugInContext context) Performs the action for this plugin.
void	initialize(PlugInContext context) Called when Workbench starts up to allow plugins to initialize themselves.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

StartMacroPlugIn

public StartMacroPlugIn()

Method Detail

initialize

public void initialize(PlugInContext context)
                throws java.lang.Exception

Description copied from interface: PlugIn

Called when Workbench starts up to allow plugins to initialize themselves.

Specified by:

initialize in interface PlugIn

Overrides:

initialize in class AbstractPlugIn

Throws:

java.lang.Exception

createEnableCheck

public static EnableCheck createEnableCheck(WorkbenchContext workbenchContext)

execute

public boolean execute(PlugInContext context)
                throws java.lang.Exception

Description copied from interface: PlugIn

Performs the action for this plugin. For threaded plugins with dialogs, this method contains the code to invoke the dialog. If the user cancels the dialog, this method should return false to prevent the run method from being called.

Specified by:

execute in interface PlugIn

Overrides:

execute in class AbstractPlugIn

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