org.openjump.core.ui.plugin
Class AbstractWizardPlugin

java.lang.Object
  extended by org.openjump.core.ui.plugin.AbstractUiPlugIn
      extended by org.openjump.core.ui.plugin.AbstractThreadedUiPlugIn
          extended by org.openjump.core.ui.plugin.AbstractWizardPlugin
All Implemented Interfaces:
PlugIn, ThreadedPlugIn, java.awt.event.ActionListener, java.util.EventListener
Direct Known Subclasses:
AddWMSQueryPlugIn, OpenFilePlugIn, OpenProjectPlugIn

public class AbstractWizardPlugin
extends AbstractThreadedUiPlugIn


Field Summary
 
Fields inherited from class org.openjump.core.ui.plugin.AbstractUiPlugIn
enableCheck, workbenchContext
 
Constructor Summary
AbstractWizardPlugin()
           
AbstractWizardPlugin(javax.swing.Icon icon)
           
AbstractWizardPlugin(java.lang.String name)
           
AbstractWizardPlugin(java.lang.String name, javax.swing.Icon icon)
           
AbstractWizardPlugin(java.lang.String name, javax.swing.Icon icon, java.lang.String toolTip)
           
AbstractWizardPlugin(java.lang.String name, java.lang.String toolTip)
           
 
Method Summary
 boolean execute(PlugInContext context)
          Method to be overridden by implementations to execute the plug-in.
 WizardGroup getWizard()
           
 void run(TaskMonitor monitor, PlugInContext context)
          Runs the task.
protected  void setWizard(WizardGroup wizard)
           
 
Methods inherited from class org.openjump.core.ui.plugin.AbstractUiPlugIn
actionPerformed, createName, getEnableCheck, getIcon, getName, getToolTip, initialize, isRollingBackInvalidEdits, reportNothingToUndoYet, setWorkbenchContext, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.vividsolutions.jump.workbench.plugin.PlugIn
getName, initialize
 

Constructor Detail

AbstractWizardPlugin

public AbstractWizardPlugin()

AbstractWizardPlugin

public AbstractWizardPlugin(javax.swing.Icon icon)

AbstractWizardPlugin

public AbstractWizardPlugin(java.lang.String name,
                            javax.swing.Icon icon,
                            java.lang.String toolTip)

AbstractWizardPlugin

public AbstractWizardPlugin(java.lang.String name,
                            javax.swing.Icon icon)

AbstractWizardPlugin

public AbstractWizardPlugin(java.lang.String name,
                            java.lang.String toolTip)

AbstractWizardPlugin

public AbstractWizardPlugin(java.lang.String name)
Method Detail

execute

public boolean execute(PlugInContext context)
                throws java.lang.Exception
Description copied from class: AbstractUiPlugIn
Method to be overridden by implementations to execute the plug-in.

Specified by:
execute in interface PlugIn
Overrides:
execute in class AbstractUiPlugIn
Parameters:
context - The plug-in context.
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

run

public void run(TaskMonitor monitor,
                PlugInContext context)
         throws java.lang.Exception
Description copied from interface: ThreadedPlugIn
Runs the task. This method will be executed in a separate thread, so that the GUI remains responsive (but only partially so, as a modal progress dialog will be in the way). Don't call GUI classes in this method as it is not executed on the GUI thread.

Parameters:
monitor - context to which this task can report its progress and check whether a party has requested its cancellation
Throws:
java.lang.Exception

getWizard

public WizardGroup getWizard()

setWizard

protected void setWizard(WizardGroup wizard)