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

java.lang.Object
  extended by com.vividsolutions.jump.workbench.plugin.AbstractPlugIn
      extended by com.vividsolutions.jump.workbench.plugin.ThreadedBasePlugIn
          extended by com.vividsolutions.jump.workbench.ui.toolbox.MainButtonPlugIn
All Implemented Interfaces:
PlugIn, ThreadedPlugIn

public abstract class MainButtonPlugIn
extends ThreadedBasePlugIn

Convenience superclass used in toolboxes that have one primary button.


Field Summary
static java.lang.String GENERATED_KEY
           
 
Constructor Summary
MainButtonPlugIn(java.lang.String taskMonitorTitle, java.awt.Component toolboxPanel)
           
 
Method Summary
 boolean execute(PlugInContext context)
          Performs the action for this plugin.
 java.lang.String getName()
          Returns a very brief description of this PlugIn e.g.
abstract  java.lang.String validateInput()
           
 
Methods inherited from class com.vividsolutions.jump.workbench.plugin.ThreadedBasePlugIn
main
 
Methods inherited from class com.vividsolutions.jump.workbench.plugin.AbstractPlugIn
createName, execute, initialize, toActionListener, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.vividsolutions.jump.workbench.plugin.ThreadedPlugIn
run
 
Methods inherited from interface com.vividsolutions.jump.workbench.plugin.PlugIn
initialize
 

Field Detail

GENERATED_KEY

public static final java.lang.String GENERATED_KEY
Constructor Detail

MainButtonPlugIn

public MainButtonPlugIn(java.lang.String taskMonitorTitle,
                        java.awt.Component toolboxPanel)
Method Detail

getName

public java.lang.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 appropraite point before each uppercase+lowercase and lowercase+uppercase combination.

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

validateInput

public abstract java.lang.String validateInput()