Class EditingPlugIn

java.lang.Object

com.vividsolutions.jump.workbench.plugin.AbstractPlugIn

com.vividsolutions.jump.workbench.ui.toolbox.ToolboxPlugIn

com.vividsolutions.jump.workbench.ui.cursortool.editing.EditingPlugIn

All Implemented Interfaces:

CheckBoxed, EnableChecked, Iconified, PlugIn, Recordable, ShortcutEnabled

public class EditingPlugIn
extends ToolboxPlugIn

Field Summary

Fields

Modifier and Type	Field	Description
static ImageIcon	ICON
static final String	KEY

Fields inherited from class AbstractPlugIn

shortcutKeys, shortcutModifiers

Constructor Summary

Constructors

Constructor	Description
EditingPlugIn()	please use getInstance() to get unique runtime instance.

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.
static EditingPlugIn	getInstance()
String	getName()	Returns a very brief description of this PlugIn e.g. for display as a menu item
void	initialize(PlugInContext context)	Called when Workbench starts up to allow plugins to initialize themselves.
protected void	initializeToolbox(ToolboxDialog toolbox)

Methods inherited from class ToolboxPlugIn

createMainMenuItem, getEnableCheck, getToolbox, getToolbox

Methods inherited from class AbstractPlugIn

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

Methods inherited from class Object

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

Field Details

ICON

public static ImageIcon ICON

KEY

public static final String KEY

Constructor Details

EditingPlugIn

public EditingPlugIn()

please use getInstance() to get unique runtime instance.

Method Details

getName

public String getName()

Description copied from interface: PlugIn

Returns a very brief description of this PlugIn e.g. for display as a menu item

Specified by:

getName in interface PlugIn

Overrides:

getName in class AbstractPlugIn

Returns:

the class name, minus "PlugIn", with spaces inserted at the appropriate point before each uppercase+lowercase and lowercase+uppercase combination.

initialize

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

Parameters:

context - context of the PlugIn

Throws:

Exception - if an exception occur during initialization

execute

public boolean execute(PlugInContext context)
                throws Exception

Description copied from class: ToolboxPlugIn

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 ToolboxPlugIn

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

initializeToolbox

protected void initializeToolbox(ToolboxDialog toolbox)

Specified by:

initializeToolbox in class ToolboxPlugIn

getInstance

public static EditingPlugIn getInstance()