Package com.vividsolutions.jump.workbench.ui.cursortool

Class CursorToolPluginWrapper

java.lang.Object

com.vividsolutions.jump.workbench.ui.cursortool.CursorToolPluginWrapper

All Implemented Interfaces:

PlugIn

public class CursorToolPluginWrapper
extends Object
implements PlugIn

a simple wrapper to reuse a cursor tool as a plugin w/in the ui.

Constructor Summary

Constructors

Constructor	Description
CursorToolPluginWrapper(CursorTool cursorTool)	create a plugin instance for the given cursor tool make sure the cursor tool respects shortcuts by wrapping it into QuasimodeTool

Method Summary

Modifier and Type	Method	Description
boolean	execute(PlugInContext context)	Performs the action for this plugin.
ImageIcon	getIcon()
String	getName()	Returns a very brief description of this PlugIn e.g.
void	initialize(PlugInContext context)	Called when Workbench starts up to allow plugins to initialize themselves.

Methods inherited from class java.lang.Object

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

Constructor Detail

CursorToolPluginWrapper

public CursorToolPluginWrapper(CursorTool cursorTool)

create a plugin instance for the given cursor tool make sure the cursor tool respects shortcuts by wrapping it into QuasimodeTool

Parameters:

cursorTool - the cursor tool

Method Detail

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

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 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

Parameters:

context - context of this PlugIn

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:

Exception - if a problem occurs during plug-in execution

See Also:

ThreadedPlugIn

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

Returns:

the name of this PlugIn

getIcon

public ImageIcon getIcon()