org.openjump.core.ui.plugin.file

Class SaveLayersWithoutDataSourcePlugIn

java.lang.Object

com.vividsolutions.jump.workbench.plugin.AbstractPlugIn

org.openjump.core.ui.plugin.file.SaveLayersWithoutDataSourcePlugIn

All Implemented Interfaces:

EnableChecked, Iconified, PlugIn, Recordable, ShortcutEnabled

public class SaveLayersWithoutDataSourcePlugIn
extends AbstractPlugIn

Subclass this to implement a 'Save Project' plugin.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DONOTSAVE
static java.lang.String	FILECHOOSER
static javax.swing.ImageIcon	ICON
static java.lang.String	LAYERS_WITHOUT_DATASOURCE
static java.lang.String	SAVEASJML
static java.lang.String	SAVEASSHP
static java.lang.String	WARN_USER

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

shortcutKeys, shortcutModifiers

Constructor Summary

Constructors

Constructor and Description
SaveLayersWithoutDataSourcePlugIn()

Method Summary

Methods

Modifier and Type	Method and Description
EnableCheck	createEnableCheck(WorkbenchContext workbenchContext)
boolean	execute(PlugInContext context) Performs the action for this plugin.
boolean	execute(PlugInContext context, java.util.Collection<Layer> collection, java.io.File dir)
java.lang.String	getName() Returns a very brief description of this PlugIn e.g. for display as a menu item
void	initialize(PlugInContext context) Called when Workbench starts up to allow plugins to initialize themselves.

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

addParameter, createName, execute, execute, fetchShortcutEnabledPlugins, getBooleanParam, getDoubleParam, getEnableCheck, getEnableCheck, getIcon, getIcon, getIntegerParam, getParameter, getParameters, getShortcutKeys, getShortcutKeyStroke, getShortcutModifiers, getStringParam, isRollingBackInvalidEdits, isShortcutEnabled, registerShortcuts, reportNothingToUndoYet, setParameters, setShortcutKeys, setShortcutModifiers, toActionListener, toString

Methods inherited from class java.lang.Object

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

Field Detail

LAYERS_WITHOUT_DATASOURCE

public static final java.lang.String LAYERS_WITHOUT_DATASOURCE

DONOTSAVE

public static final java.lang.String DONOTSAVE

SAVEASJML

public static final java.lang.String SAVEASJML

SAVEASSHP

public static final java.lang.String SAVEASSHP

FILECHOOSER

public static final java.lang.String FILECHOOSER

WARN_USER

public static final java.lang.String WARN_USER

ICON

public static final javax.swing.ImageIcon ICON

Constructor Detail

SaveLayersWithoutDataSourcePlugIn

public SaveLayersWithoutDataSourcePlugIn()

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 appropriate point before each uppercase+lowercase and lowercase+uppercase combination.

initialize

public void initialize(PlugInContext context)
                throws java.lang.Exception

Description copied from interface: PlugIn

Called when Workbench starts up to allow plugins to initialize themselves.

Specified by:

initialize in interface PlugIn

Overrides:

initialize in class AbstractPlugIn

Throws:

java.lang.Exception

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

execute

public boolean execute(PlugInContext context,
              java.util.Collection<Layer> collection,
              java.io.File dir)
                throws java.lang.Exception

Throws:

java.lang.Exception

createEnableCheck

public EnableCheck createEnableCheck(WorkbenchContext workbenchContext)

Parameters:

workbenchContext -

Returns:

an enable check