Package com.vividsolutions.jump.workbench.ui.toolbox

Class ToolboxPlugInV2

java.lang.Object

com.vividsolutions.jump.workbench.plugin.AbstractPlugIn

com.vividsolutions.jump.workbench.ui.toolbox.ToolboxPlugInV2

All Implemented Interfaces:

CheckBoxed, EnableChecked, Iconified, PlugIn, Recordable, ShortcutEnabled

Direct Known Subclasses:

PythonToolsPlugIn

public abstract class ToolboxPlugInV2
extends AbstractPlugIn
implements CheckBoxed

pretty much ToolboxPlugIn but cleaned up plus propagating errors from initializeToolbox() -> getToolbox() -> execute() making implementations easier and more failsafe

Field Summary

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

shortcutKeys, shortcutModifiers

Constructor Summary

Constructors

Constructor	Description
ToolboxPlugInV2()

Method Summary

Modifier and Type	Method	Description
boolean	execute(PlugInContext context)	Toolbox subclasses can override this method to implement their own behaviour when the plug-in is called.
EnableCheck	getEnableCheck()	Use reflection to find an EnableCheck object defined by old method createEnableCheck in this plugin.
ToolboxDialog	getToolbox()
protected abstract ToolboxDialog	initializeToolbox()

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

addParameter, createName, execute, execute, getBooleanParam, getContext, getDoubleParam, getIcon, getIcon, getIcon, getIntegerParam, getName, getParameter, getParameters, getShortcutKeys, getShortcutKeyStroke, getShortcutModifiers, getStringParam, getWorkbenchContext, initialize, isRollingBackInvalidEdits, isShortcutEnabled, 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

ToolboxPlugInV2

public ToolboxPlugInV2()

Method Detail

getToolbox

public ToolboxDialog getToolbox()
                         throws Exception

Returns:

the toolbox for this plug-in class.

Throws:

Exception - if an Exception occurs during Toolbox initialization

initializeToolbox

protected abstract ToolboxDialog initializeToolbox()
                                            throws Exception

Throws:

Exception

execute

public boolean execute(PlugInContext context)
                throws Exception

Toolbox subclasses can override this method to implement their own behaviour when the plug-in is called. Remember to call super.execute to make the toolbox visible.

Specified by:

execute in interface PlugIn

Overrides:

execute in class AbstractPlugIn

Parameters:

context - context of this PlugIn

Returns:

true if the PlugIn has been executed

Throws:

Exception - if an Exception occurs during execution

See Also:

ThreadedPlugIn

getEnableCheck

public EnableCheck getEnableCheck()

Description copied from class: AbstractPlugIn

Use reflection to find an EnableCheck object defined by old method createEnableCheck in this plugin.

Specified by:

getEnableCheck in interface EnableChecked

Overrides:

getEnableCheck in class AbstractPlugIn

Returns:

the EnableCheck defined the old way