com.vividsolutions.jump.workbench.plugin
Interface PlugIn
- All Known Subinterfaces:
- ThreadedPlugIn
- All Known Implementing Classes:
- AboutPlugIn, AbstractAddDatastoreLayerPlugIn, AbstractLoadDatasetPlugIn, AbstractLoadSaveDatasetPlugIn, AbstractPlugIn, AbstractSaveDatasetAsPlugIn, AbstractSaveProjectPlugIn, AbstractThreadedUiPlugIn, AbstractUiPlugIn, AbstractWizardPlugin, AddDatastoreLayerPlugIn, AddImageLayerPlugIn, AddNewCategoryPlugIn, AddNewFeaturesPlugIn, AddNewLayerPlugIn, AddSIDLayerPlugIn, AddWMSDemoBoxEasterEggPlugIn, AddWMSQueryPlugIn, AffineTransformationPlugIn, AffineTransformPlugIn, AttributeQueryPlugIn, AutoAssignAttributePlugIn, AutoCompletePolygonPlugIn, BeanShellPlugIn, BeanToolsPlugIn, BlendLineStringsPlugIn, BoundaryMatchDataPlugIn, BufferPlugIn, CalculateAreasAndLengthsPlugIn, ChangeCoordinateSystemPlugIn, ChangeLayerableNamePlugIn, ChangeRasterImagePropertiesPlugIn, ChangeSRIDPlugIn, ChangeStylesPlugIn, ClearSelectionPlugIn, ClipToFencePlugIn, CloneWindowPlugIn, CombineSelectedFeaturesPlugIn, CombineSelectedLayersPlugIn, ConnectionManagerToolboxPlugIn, ConstrainedMoveVertexPlugIn, ConvexHullPlugIn, ConvexHullPlugIn, CopyBBoxPlugin, CopyImagePlugIn, CopySelectedItemsPlugIn, CopySelectedLayersPlugIn, CopySelectedLayersToWarpingVectorsPlugIn, CopySelectedRasterImageLayersPlugIn, CopyStylesPlugIn, CopyThisCoordinatePlugIn, CreateThiessenPolygonsPlugIn, CustomFillPatternExamplePlugIn, CutPolygonSIGLEPlugIn, CutSelectedItemsPlugIn, CutSelectedLayersPlugIn, CutSelectedRasterImageLayersPlugIn, DeeChangeStylesPlugIn, DeleteAllFeaturesPlugIn, DeleteDuplicateGeometriesPlugIn, DeleteEmptyGeometriesPlugIn, DeleteSelectedItemsPlugIn, DiffGeometryPlugIn, DiffSegmentsPlugIn, DrawCircleWithGivenRadiusPlugIn, DrawConstrainedArcPlugIn, DrawConstrainedCirclePlugIn, DrawConstrainedLineStringPlugIn, DrawConstrainedPolygonPlugIn, EditablePlugIn, EditAttributeByFormulaPlugIn, EditingPlugIn, EditSelectedFeaturePlugIn, EditSelectedSidePlugIn, EditWMSQueryPlugIn, EnsureAllLayersHaveSRIDStylePlugIn, ExplodeSelectedFeaturesPlugIn, ExportEnvelopeAsGeometryPlugIn, ExportImagePlugIn, ExtensionManagerPlugIn, ExtractCommonBoundaryBetweenPolysPlugIn, ExtractLayerInFence, ExtractLayersByAttribute, ExtractLayersByGeometry, ExtractPointsPlugIn, ExtractSegmentsPlugIn, ExtractSelectedPartOfImage, FeatureInfoPlugIn, FeatureStatisticsPlugIn, FileDragDropPlugin, FirstTaskFramePlugIn, GenerateLogPlugIn, GeometryFunctionPlugIn, ImageLayerManagerPlugIn, ImportArcMapStylePlugIn, ImportSLDPlugIn, InstallDatastoreLayerRendererHintsPlugIn, InstallGridPlugIn, InstallKeyPanPlugIn, InstallReferencedImageFactoriesPlugin, InstallRendererPlugIn, InstallScaleBarPlugIn, InstallShowScalePlugIn, InstallSkinsPlugIn, InstallStandardDataSourceQueryChoosersPlugIn, InstallStandardFeatureTextWritersPlugIn, InstallZoomBarPlugIn, IntersectPolygonLayersPlugIn, JoinAttributesSpatiallyPlugIn, JoinTablePlugIn, JoinWithArcPlugIn, LayerableClipboardPlugIn, LayerableClipboardPlugIn, LayerPropertiesPlugIn, LayerStatisticsPlugIn, LayerStyle2SLDPlugIn, LineNoderPlugIn, LineSimplifyJTS15AlgorithmPlugIn, LoadDatasetPlugIn, LoadSextanteRasterImagePlugIn, MacroPlugIn, MainButtonPlugIn, MapToolTipPlugIn, MapToolTipsPlugIn, MeasureM_FPlugIn, MergeTwoSelectedPolygonsPlugIn, MicroscopePlugIn, MosaicInternalFramesPlugIn, MoveAlongAnglePlugIn, MoveCategoryOneDown, MoveCategoryOneUp, MoveCategoryToBottom, MoveCategoryToTop, MoveLayerablePlugIn, MultiRingBufferSelectedPlugIn, NewTaskPlugIn, NoteToolPlugIn, OpenFilePlugIn, OpenProjectPlugIn, OpenProjectPlugIn, OpenRecentPlugIn, OpenWizardPlugIn, OptionsPlugIn, OutputWindowPlugIn, OverlayPlugIn, PasteItemsAtPlugIn, PasteItemsPlugIn, PasteLayersPlugIn, PasteRasterImageLayersPlugIn, PasteStylesPlugIn, PersistentBlackboardPlugIn, PlanarGraphPlugIn, PlumePlugIn, PolygonizerPlugIn, PrecisionReducerPlugIn, ProgressReportingPlugIn, ProjectionPlugIn, PythonToolsPlugIn, RandomArrowsPlugIn, RandomTrianglesPlugIn, RedoPlugIn, ReducePointsISAPlugIn, RefreshDataStoreLayerPlugin, RemoveSelectedCategoriesPlugIn, RemoveSelectedLayersPlugIn, RemoveSelectedRasterImageLayersPlugIn, ReplaceValuePlugIn, ReplicateSelectedItemsPlugIn, RotatePlugIn, RotateSelectedItemPlugIn, RunDatastoreQueryPlugIn, SaveDatasetAsPlugIn, SaveDatasetsPlugIn, SaveImageAsPlugIn, SaveImageAsSVGPlugIn, SaveLegendPlugIn, SaveProjectAsPlugIn, SaveProjectPlugIn, SaveRasterImageAsImagePlugIn, ScaleBarPlugIn, ScaleSelectedItemsPlugIn, SearchAllAttributes, SelectablePlugIn, SelectAllLayerItemsPlugIn, SelectByTypePlugIn, SelectFeaturesInFencePlugIn, SelectItemsByCircleFromSelectedLayersPlugIn, SelectItemsByFenceFromSelectedLayersPlugIn, SelectLayersWithSelectedItemsPlugIn, SelectOneItemPlugIn, SetCategoryVisibilityPlugIn, ShortcutKeysPlugIn, ShowFullPathPlugIn, ShowScalePlugIn, ShowTriangulationPlugIn, SimpleQueryPlugIn, SimplifyPolygonCoveragePlugIn, SortCategoryAbstractPlugIn, SortCategoryByFeaturesPlugIn, SortCategoryByNamePlugIn, SortCategoryRestorePlugIn, SortCategorySavePlugIn, SpatialJoinPlugIn, SpatialJoinPlugIn, SpatialQueryPlugIn, SplitPolygonPlugIn, StandardPirolPlugIn, StatisticOverViewPlugIn, SynchronizationPlugIn, TestColorThemingPlugIn, ThreadedBasePlugIn, ToggleRasterImageVisibility, ToggleVisiblityPlugIn, ToolboxPlugIn, UndoPlugIn, UnionByAttributePlugIn, UnionPlugIn, ValidateSelectedLayersPlugIn, VerticesInFencePlugIn, ViewAttributesPlugIn, ViewSchemaPlugIn, WarpImageToFencePlugIn, WarpingPlugIn, WKTPlugIn, ZoomBarPlugIn, ZoomNextPlugIn, ZoomPreviousPlugIn, ZoomToClickPlugIn, ZoomToCoordinatePlugIn, ZoomToFencePlugIn, ZoomToFullExtentPlugIn, ZoomToLayerPlugIn, ZoomToRasterImagePlugIn, ZoomToScalePlugIn, ZoomToSelectedItemsPlugIn, ZoomToWMSPlugIn
public interface PlugIn
Plug-ins are code modules that can be easily added to or
removed from JUMP Workbench. For example, each menu item in the
JUMP Workbench is a PlugIn. Typically plug-ins are executed with a
menu item -- FeatureInstaller has methods for adding plug-ins as
menu items. Alternatively, a plug-in need not be associated with a
menu-item; it might, for example, simply run some code when the
Workbench starts up.
"Built-in" plug-ins are configured in a Setup class. Third-party plug-ins reside
in a JAR file that also contains an Extension class that configures them.
During development, third-party plug-ins may be specified in the
workbench-properties.xml file, to avoid having to build a JAR file.
- See Also:
Setup,
Extension,
PlugInManager
|
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. for display as a menu item |
void |
initialize(PlugInContext context)
Called when Workbench starts up to allow plugins to initialize themselves. |
initialize
void initialize(PlugInContext context)
throws java.lang.Exception
- Called when Workbench starts up to allow plugins to initialize themselves.
- Throws:
java.lang.Exception
execute
boolean execute(PlugInContext context)
throws java.lang.Exception
- 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.
- 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
java.lang.String getName()
- Returns a very brief description of this PlugIn e.g. for display as a menu item
- Returns:
- the name of this PlugIn