Package org.locationtech.jts.jump.workbench.ui.toolbox

Class MainButtonPlugIn

java.lang.Object

org.locationtech.jts.jump.workbench.plugin.AbstractPlugIn

org.locationtech.jts.jump.workbench.plugin.ThreadedBasePlugIn

org.locationtech.jts.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

Fields

Modifier and Type	Field	Description
static String	GENERATED_KEY

Constructor Summary

Constructors

Constructor	Description
MainButtonPlugIn(String taskMonitorTitle, Component toolboxPanel)

Method Summary

Modifier and Type	Method	Description
boolean	execute(PlugInContext context)	Performs the action for this plugin.
protected Layer	generateLayer(String name, String category, Color color, LayerManagerProxy proxy, FeatureCollection featureCollection, String description)
protected Layer	generateLineLayer(String name, String category, Color color, LayerManagerProxy proxy, FeatureCollection featureCollection, String description)
String	getName()	Returns a very brief description of this PlugIn e.g.
protected void	removeAndDisposeLayer(String name, PlugInContext context)
abstract String	validateInput()

Methods inherited from class org.locationtech.jts.jump.workbench.plugin.ThreadedBasePlugIn

main

Methods inherited from class org.locationtech.jts.jump.workbench.plugin.AbstractPlugIn

createName, execute, execute, initialize, isRollingBackInvalidEdits, reportNothingToUndoYet, toActionListener, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.locationtech.jts.jump.workbench.plugin.PlugIn

initialize

Methods inherited from interface org.locationtech.jts.jump.workbench.plugin.ThreadedPlugIn

run

Field Detail

GENERATED_KEY

public static final String GENERATED_KEY

Constructor Detail

MainButtonPlugIn

public MainButtonPlugIn(String taskMonitorTitle,
                        Component toolboxPanel)

Method Detail

getName

public 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.

generateLayer

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

generateLineLayer

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

execute

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

Exception - if a problem occurs during plug-in execution

See Also:

ThreadedPlugIn

removeAndDisposeLayer

protected void removeAndDisposeLayer(String name,
                                     PlugInContext context)

validateInput

public abstract String validateInput()