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

java.lang.Object
  com.vividsolutions.jump.workbench.plugin.AbstractPlugIn
      com.vividsolutions.jump.workbench.ui.toolbox.ToolboxPlugIn

All Implemented Interfaces:

PlugIn

Direct Known Subclasses:

BeanShellPlugIn, ConnectionManagerToolboxPlugIn, EditingPlugIn, WarpingPlugIn, ZoomBarPlugIn

public abstract class ToolboxPlugIn

extends AbstractPlugIn

Constructor Summary

ToolboxPlugIn()

Method Summary

void	createMainMenuItem(java.lang.String[] menuPath, javax.swing.Icon icon, WorkbenchContext context) Creates a menu item with a checkbox beside it that appears when the toolbox is visible.
boolean	execute(PlugInContext context) Toolbox subclasses can override this method to implement their own behaviour when the plug-in is called.
ToolboxDialog	getToolbox(WorkbenchContext context)
protected abstract void	initializeToolbox(ToolboxDialog toolbox)

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

createName, execute, execute, getName, initialize, isRollingBackInvalidEdits, reportNothingToUndoYet, toActionListener, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ToolboxPlugIn

public ToolboxPlugIn()

Method Detail

getToolbox

public ToolboxDialog getToolbox(WorkbenchContext context)

Returns:

the toolbox for this plug-in class.

initializeToolbox

protected abstract void initializeToolbox(ToolboxDialog toolbox)

execute

public boolean execute(PlugInContext context)
                throws java.lang.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

Throws:

java.lang.Exception

createMainMenuItem

public void createMainMenuItem(java.lang.String[] menuPath,
                               javax.swing.Icon icon,
                               WorkbenchContext context)
                        throws java.lang.Exception

Creates a menu item with a checkbox beside it that appears when the toolbox is visible.

Parameters:

icon - null to leave unspecified

Throws:

java.lang.Exception