com.vividsolutions.jump.workbench.ui.toolbox

Class MainButtonPlugIn

java.lang.Object

com.vividsolutions.jump.workbench.plugin.AbstractPlugIn

com.vividsolutions.jump.workbench.plugin.ThreadedBasePlugIn

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

All Implemented Interfaces:

EnableChecked, Iconified, PlugIn, Recordable, ShortcutEnabled, ThreadedPlugIn

public abstract class MainButtonPlugIn
extends ThreadedBasePlugIn

Convenience superclass used in toolboxes that have one primary button.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GENERATED_KEY

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

shortcutKeys, shortcutModifiers

Constructor Summary

Constructors

Constructor and Description
MainButtonPlugIn(java.lang.String taskMonitorTitle, java.awt.Component toolboxPanel)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	execute(PlugInContext context) Performs the action for this plugin.
protected Layer	generateLayer(java.lang.String name, java.lang.String category, java.awt.Color color, LayerManagerProxy proxy, FeatureCollection featureCollection, java.lang.String description)
protected Layer	generateLineLayer(java.lang.String name, java.lang.String category, java.awt.Color color, LayerManagerProxy proxy, FeatureCollection featureCollection, java.lang.String description)
java.lang.String	getName() Returns a very brief description of this PlugIn e.g. for display as a menu item
protected void	removeAndDisposeLayer(java.lang.String name, PlugInContext context)
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

addParameter, createName, execute, execute, fetchShortcutEnabledPlugins, getBooleanParam, getDoubleParam, getEnableCheck, getEnableCheck, getIcon, getIcon, getIntegerParam, getParameter, getParameters, getShortcutKeys, getShortcutKeyStroke, getShortcutModifiers, getStringParam, initialize, 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

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

generateLayer

protected Layer generateLayer(java.lang.String name,
                  java.lang.String category,
                  java.awt.Color color,
                  LayerManagerProxy proxy,
                  FeatureCollection featureCollection,
                  java.lang.String description)

generateLineLayer

protected Layer generateLineLayer(java.lang.String name,
                      java.lang.String category,
                      java.awt.Color color,
                      LayerManagerProxy proxy,
                      FeatureCollection featureCollection,
                      java.lang.String description)

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

removeAndDisposeLayer

protected void removeAndDisposeLayer(java.lang.String name,
                         PlugInContext context)

validateInput

public abstract java.lang.String validateInput()