com.vividsolutions.jump.workbench.ui.plugin.analysis
Class GeometryFunctionPlugIn

java.lang.Object
  extended bycom.vividsolutions.jump.workbench.plugin.AbstractPlugIn
      extended bycom.vividsolutions.jump.workbench.ui.plugin.analysis.GeometryFunctionPlugIn
All Implemented Interfaces:
PlugIn, ThreadedPlugIn

public class GeometryFunctionPlugIn
extends AbstractPlugIn
implements ThreadedPlugIn

Provides basic functions for computation with Geometry objects.

Uses GeometryFunction objects obtained from the Registry by the key GEOMETRY_FUNCTION_REG_KEY. Other plug-ins can add further Geometry functions to the Registry.

See Also:
GeometryFunction

Field Summary
static java.lang.String GEOMETRY_FUNCTION_REG_KEY
           
 
Constructor Summary
GeometryFunctionPlugIn()
           
 
Method Summary
 boolean execute(PlugInContext context)
          Performs the action for this plugin.
 void initialize(PlugInContext context)
          Called when Workbench starts up to allow plugins to initialize themselves.
 void run(TaskMonitor monitor, PlugInContext context)
          Runs the task.
 void setAddToSourceAllowed(boolean value)
           
 void setCategoryName(java.lang.String value)
           
 
Methods inherited from class com.vividsolutions.jump.workbench.plugin.AbstractPlugIn
createName, execute, execute, getName, 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 com.vividsolutions.jump.workbench.plugin.PlugIn
getName
 

Field Detail

GEOMETRY_FUNCTION_REG_KEY

public static final java.lang.String GEOMETRY_FUNCTION_REG_KEY
See Also:
Constant Field Values
Constructor Detail

GeometryFunctionPlugIn

public GeometryFunctionPlugIn()
Method Detail

setCategoryName

public void setCategoryName(java.lang.String value)

setAddToSourceAllowed

public void setAddToSourceAllowed(boolean value)

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
Throws:
java.lang.Exception

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.

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