Package org.openjump.core.ui.plugin.file

Class SaveWizardPlugIn

java.lang.Object

com.vividsolutions.jump.workbench.plugin.AbstractPlugIn

org.openjump.core.ui.plugin.AbstractUiPlugIn

org.openjump.core.ui.plugin.AbstractThreadedUiPlugIn

org.openjump.core.ui.plugin.file.SaveWizardPlugIn

All Implemented Interfaces:

EnableChecked, Iconified, PlugIn, Recordable, ShortcutEnabled, ThreadedPlugIn, ActionListener, EventListener

public class SaveWizardPlugIn
extends AbstractThreadedUiPlugIn

Field Summary

Fields

Modifier and Type	Field	Description
static String	DATAKEY_SELECTED_LAYERABLES
static String	DATAKEY_SIMPLIFIED_LAYERNAME

Fields inherited from class org.openjump.core.ui.plugin.AbstractUiPlugIn

enableCheck, workbenchContext

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

shortcutKeys, shortcutModifiers

Constructor Summary

Constructors

Constructor	Description
SaveWizardPlugIn()

Method Summary

Modifier and Type	Method	Description
static void	addWizard(WorkbenchContext workbenchContext, WizardGroup wizard)
boolean	execute(PlugInContext pluginContext)	Method to be overridden by implementations to execute the plug-in.
EnableCheck	getEnableCheck()	Use reflection to find an EnableCheck object defined by old method createEnableCheck in this plugin.
Icon	getIcon()	Get the icon for the plug-in.
String	getName()	Get the name of the plug-in.
void	initialize(PlugInContext context)	Method to be overridden by implementations to initialize the plug-in.
void	run(TaskMonitor monitor, PlugInContext context)	Runs the task.

Methods inherited from class org.openjump.core.ui.plugin.AbstractUiPlugIn

actionPerformed, getToolTip, isRollingBackInvalidEdits, reportNothingToUndoYet, setWorkbenchContext

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

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

Methods inherited from class java.lang.Object

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

Field Detail

DATAKEY_SIMPLIFIED_LAYERNAME

public static final String DATAKEY_SIMPLIFIED_LAYERNAME

DATAKEY_SELECTED_LAYERABLES

public static final String DATAKEY_SELECTED_LAYERABLES

Constructor Detail

SaveWizardPlugIn

public SaveWizardPlugIn()

Method Detail

addWizard

public static void addWizard(WorkbenchContext workbenchContext,
                             WizardGroup wizard)

initialize

public void initialize(PlugInContext context)
                throws Exception

Description copied from class: AbstractUiPlugIn

Method to be overridden by implementations to initialize the plug-in. Plug-ins must invoke super.initialize().

Specified by:

initialize in interface PlugIn

Overrides:

initialize in class AbstractUiPlugIn

Parameters:

context - The plug-in context.

Throws:

Exception - if an exception occur during initialization

execute

public boolean execute(PlugInContext pluginContext)
                throws 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:

pluginContext - The plug-in context.

Returns:

true if the PlugIn has been executed

Throws:

Exception - if an Exception occurs during execution

See Also:

ThreadedPlugIn

run

public void run(TaskMonitor monitor,
                PlugInContext context)
         throws 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

context - context of this PlugIn

Throws:

Exception - if an Exception occurs during the run

getEnableCheck

public EnableCheck getEnableCheck()

Description copied from class: AbstractPlugIn

Use reflection to find an EnableCheck object defined by old method createEnableCheck in this plugin.

Specified by:

getEnableCheck in interface EnableChecked

Overrides:

getEnableCheck in class AbstractUiPlugIn

Returns:

the EnableCheck defined the old way

getIcon

public Icon getIcon()

Description copied from class: AbstractUiPlugIn

Get the icon for the plug-in.

Specified by:

getIcon in interface Iconified

Overrides:

getIcon in class AbstractUiPlugIn

Returns:

The icon.

getName

public String getName()

Description copied from class: AbstractUiPlugIn

Get the name of the plug-in. If a name was not specified ask super class.

Specified by:

getName in interface PlugIn

Overrides:

getName in class AbstractUiPlugIn

Returns:

The plug-in name.