com.vividsolutions.jump.workbench.plugin
Class MacroPlugIn
java.lang.Object
com.vividsolutions.jump.workbench.plugin.AbstractPlugIn
com.vividsolutions.jump.workbench.plugin.MacroPlugIn
- All Implemented Interfaces:
- PlugIn
- Direct Known Subclasses:
- CutSelectedItemsPlugIn, CutSelectedLayersPlugIn
public class MacroPlugIn
- extends AbstractPlugIn
A sequence of plug-ins treated as one.
Method Summary |
boolean |
execute(PlugInContext context)
Performs the action for this plugin. |
java.lang.String |
getName()
Returns a very brief description of this PlugIn e.g. |
void |
initialize(PlugInContext context)
Called when Workbench starts up to allow plugins to initialize themselves. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
MacroPlugIn
public MacroPlugIn(PlugIn[] plugIns)
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
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
appropraite point before each uppercase+lowercase and
lowercase+uppercase combination.