Interface PlugIn

All Known Subinterfaces:
ThreadedPlugIn
All Known Implementing Classes:
AboutPlugIn, AbstractAddDatastoreLayerPlugIn, AbstractLinearReferencingPlugIn, AbstractLoadDatasetPlugIn, AbstractLoadSaveDatasetPlugIn, AbstractPlugIn, AbstractSaveDatasetAsPlugIn, AbstractSaveProjectPlugIn, AbstractThreadedUiPlugIn, AbstractUiPlugIn, AbstractWizardPlugin, Add3DGeometryAttributesPlugIn, AddDatastoreLayerPlugIn, AddGeometryAttributesPlugIn, AddImageLayerPlugIn, AdditionalResultsPlugIn, AddNewCategoryPlugIn, AddNewFeaturesPlugIn, AddNewLayerPlugIn, AddNewLayerViewPlugIn, AddWMSDemoBoxEasterEggPlugIn, AdvancedMeasurePlugin, AffineTransformationPlugIn, AffineTransformPlugIn, ArrangeViewsPlugIn, ArrangeViewsPlugIn.ArrangeAllPlugIn, ArrangeViewsPlugIn.ArrangeCascadePlugIn, ArrangeViewsPlugIn.ArrangeHorizontalPlugIn, ArrangeViewsPlugIn.ArrangeVerticalPlugIn, AttributeQueryPlugIn, AutoAssignAttributePlugIn, AutoCompletePolygonPlugIn, BeanshellAttributeCalculatorPlugIn, BeanShellPlugIn, BeanToolsPlugIn, BlendLineStringsPlugIn, BoundaryMatchDataPlugIn, BufferPlugIn, CalculateAreasAndLengthsPlugIn, CalculateDistancesPlugIn, CalcVarianceAndMeanPerClassPlugIn, CenterZoomPlugIn, ChangeCoordinateSystemPlugIn, ChangeLayerableNamePlugIn, ChangeNoDataValuePlugIn, ChangeRangeValuesToNoDataPlugIn, ChangeRasterImagePropertiesPlugIn, ChangeSRIDPlugIn, ChangeStylesPlugIn, ChangeValueToNoDataPlugIn, ClassifyAttributesPlugIn, ClearSelectionPlugIn, ClipToFencePlugIn, CloneWindowPlugIn, CombineSelectedFeaturesPlugIn, CombineSelectedLayersPlugIn, ConnectionManagerToolboxPlugIn, ConstrainedMoveVertexPlugIn, ConvexHullPlugIn, ConvexHullPlugIn, CopyBBoxPlugin, CopyImagePlugIn, CopySchemaPlugIn, CopySelectedItemsPlugIn, CopySelectedLayersPlugIn, CopySelectedLayersToWarpingVectorsPlugIn, CopySelectedRasterImageLayersPlugIn, CopyStylesPlugIn, CopyThisCoordinatePlugIn, CoverageSimplifierPlugIn, CreateBarPlotPlugIn, CreateGridPlugIn, CreateHistogramPlugIn, CreateLatticeFromSelectedImageLayerPlugIn, CreatePolygonGridFromSelectedImageLayerPlugIn, CreateScatterPlotPlugIn, CreateThiessenPolygonsPlugIn, CropWarpPlugIn, CTSPlugIn, CursorToolPluginWrapper, CustomFillPatternExamplePlugIn, CutFeaturesPlugIn, CutPolygonSIGLEPlugIn, CutSelectedItemsPlugIn, CutSelectedLayersPlugIn, CutSelectedRasterImageLayersPlugIn, DataStoreTransactionManagerPlugIn, DeeChangeStylesPlugIn, DeleteAllFeaturesPlugIn, DeleteDuplicateGeometriesPlugIn, DeleteEmptyGeometriesPlugIn, DeleteSelectedItemsPlugIn, DEMStatisticsPlugIn, DiffGeometryPlugIn, DisposeSelectedLayersPlugIn, Dissolve2PlugIn, DissolvePlugIn, DrawCircleWithGivenRadiusPlugIn, DrawConstrainedArcPlugIn, DrawConstrainedCirclePlugIn, DrawConstrainedLineStringPlugIn, DrawConstrainedPolygonPlugIn, DuplicateItemPlugIn, EasyButtonsPlugin, EditablePlugIn, EditAttributeByFormulaPlugIn, EditDataStoreQueryPlugIn, EditingPlugIn, EditSelectedFeaturePlugIn, EditSelectedSidePlugIn, EditWMSQueryPlugIn, EnsureAllLayersHaveSRIDStylePlugIn, EraseLayerAWithLayerBPlugIn, ExplodeSelectedFeaturesPlugIn, ExportEnvelopeAsGeometryPlugIn, ExportImagePlugIn, ExportLayerableEnvelopeAsGeometryPlugIn, ExtCorePlugIn, ExtensionManagerPlugIn, ExtractCommonBoundaryBetweenPolysPlugIn, ExtractLayerInFence, ExtractLayersByAttribute, ExtractLayersByGeometry, ExtractPointsPlugIn, ExtractSegmentsPlugIn, ExtractSelectedPartOfImage, FeatureInfoPlugIn, FeatureStatisticsPlugIn, FileDragDropPlugin, FillPolygonPlugIn, FirstTaskFramePlugIn, GCPlugin, GenerateLogPlugIn, GenerateRandomNumberPlugIn, GenerateRandomStringPlugIn, GenerateUniqueRandomIdPlugIn, GeometryFunctionPlugIn, GeometrySnapperPlugIn, HistogramPlugIn, ImageLayerManagerPlugIn, ImportArcMapStylePlugIn, ImportSLDPlugIn, InstallDatastoreLayerRendererHintsPlugIn, InstallDummyReaderPlugIn, InstallGridPlugIn, InstallKeyPanPlugIn, InstallRendererPlugIn, InstallScaleBarPlugIn, InstallShowScalePlugIn, InstallSkinsPlugIn, InstallStandardDataSourceQueryChoosersPlugIn, InstallStandardFeatureTextWritersPlugIn, InstallZoomBarPlugIn, IntersectPolygonLayersPlugIn, IntersectPolygonsOneLayerPlugIn, InvertSelectionPlugIn, JoinAttributesSpatiallyPlugIn, JoinTableFromExistingLayerPlugIn, JoinTablePlugIn, JoinWithArcPlugIn, KernelAnalysisPlugIn, LayerableClipboardPlugIn, LayerableClipboardPlugIn, LayerableStylePlugIn, LayerPropertiesPlugIn, LayerStatisticsPlugIn, LayerStyle2SLDPlugIn, LegendPlugIn, LinearReferencingOnLayerPlugIn, LinearReferencingOnSelectionPlugIn, LineNoderPlugIn, LoadDatasetPlugIn, LoadStylePlugIn, MacroPlugIn, MainButtonPlugIn, MakeValidPlugIn, ManageDataPlugIn, MapToolTipPlugIn, MapToolTipsPlugIn, MeasureM_FPlugIn, MeasureSelectedPlugIn, MergePolygonsWithNeighbourPlugIn, MergeSelectedFeaturesPlugIn, MergeSelectedPolygonsWithNeighbourPlugIn, MergeTwoSelectedPolygonsPlugIn, MicroscopePlugIn, MosaicInternalFramesPlugIn, MoveAlongAnglePlugIn, MoveCategoryOneDown, MoveCategoryOneUp, MoveCategoryToBottom, MoveCategoryToTop, MoveLayerablePlugIn, MoveLayerablePlugIn.MoveLayerableDownPlugIn, MoveLayerablePlugIn.MoveLayerableUpPlugIn, MoveSelectedLayersPlugIn, MultiRingBufferSelectedPlugIn, NewLayerPropertiesPlugIn, NewTaskPlugIn, NodeFeaturesPlugIn, NodeLinesPlugIn, NodePolygonsPlugIn, NoderPlugIn, NorthArrowInstallRenderer, NorthArrowPlugIn, NoteToolPlugIn, OffsetCurvePlugIn, OpenFilePlugIn, OpenProjectPlugIn, OpenProjectPlugIn, OpenRecentPlugIn, OpenWizardPlugIn, OptionsPlugIn, OutputWindowPlugIn, OverlayPlugIn, PanToSelectedItemsPlugIn, PasteItemsAtPlugIn, PasteItemsPlugIn, PasteLayersPlugIn, PasteRasterImageLayersPlugIn, PasteSchemaPlugIn, PasteStylesPlugIn, PersistentBlackboardPlugIn, PlanarGraphPlugIn, PlumePlugIn, PointLayerFromAttributeTablePlugIn, PointsToPathsPlugIn, PolygonizerPlugIn, PrecisionReducerPlugIn, ProfileGraphPlugIn, ProgressReportingPlugIn, ProjectionPlugIn, ProjectiveTransformPlugIn, PythonToolsPlugIn, RandomArrowsPlugIn, RandomTrianglesPlugIn, RasterColorEditorPlugIn, RasterImageLayerPropertiesPlugIn, RasterizePlugIn, RasterLegendPlugIn, RasterQueryPlugIn, RasterStylesPlugIn, RedoPlugIn, ReducePointsISAPlugIn, RefreshDataStoreLayerPlugin, RefreshDataStoreQueryPlugIn, RemodelerPlugIn, RemoveSelectedCategoriesPlugIn, RemoveSelectedLayersPlugIn, RemoveSelectedRasterImageLayersPlugIn, RemoveSpikePlugIn, ReplaceValuePlugIn, ReplicateSelectedItemsPlugIn, ReverseOrientationPlugIn, RotatePlugIn, RotateSelectedItemPlugIn, RunDatastoreQueryPlugIn, RunMacroPlugIn, SaveDatasetAsFilePlugIn, SaveDatasetAsPlugIn, SaveDatasetsPlugIn, SaveImageAsPlugIn, SaveImageAsSVGPlugIn, SaveLayersWithoutDataSourcePlugIn, SaveLegendPlugIn, SaveProjectAsPlugIn, SaveProjectPlugIn, SaveRasterImageAsImagePlugIn, SaveStylePlugIn, SaveToH2PlugIn, SaveToPostGIS2PlugIn, SaveToPostGISPlugIn, SaveWizardPlugIn, ScaleBarPlugIn, ScaleSelectedItemsPlugIn, SearchAllAttributes, SearchCommandPlugIn, SelectablePlugIn, SelectAllLayerItemsPlugIn, SelectAllModifiedFeaturesPlugIn, SelectAllOrderedFeaturesFromAttributeTablePlugIn, SelectByTypePlugIn, SelectFeaturesInFencePlugIn, SelectGeometryCollectionsPlugIn, SelectItemsByCircleFromSelectedLayersPlugIn, SelectItemsByFenceFromSelectedLayersPlugIn, SelectLayersWithSelectedItemsPlugIn, SelectMultiItemsPlugIn, SelectOneItemPlugIn, SetCategoryVisibilityPlugIn, ShortcutKeysPlugIn, ShowFullPathPlugIn, ShowScalePlugIn, ShowTriangulationPlugIn, ShowViewCenterInstallRenderer, ShowViewCenterPlugIn, SimpleQueryPlugIn, SimplifyPolygonCoveragePlugIn, SimplifyWithJTSAlgorithmPlugIn, SortCategoryAbstractPlugIn, SortCategoryByFeaturesPlugIn, SortCategoryByNamePlugIn, SortCategoryRestorePlugIn, SortCategorySavePlugIn, SpatialJoinPlugIn, SpatialJoinPlugIn, SpatialQueryPlugIn, SplitFeaturesPlugIn, SplitLinesNodePolygonsPlugIn, SplitPolygonPlugIn, SplitPolygonsNodeLinesPlugIn, StandardPirolPlugIn, StartMacroPlugIn, StatisticOverViewPlugIn, StopMacroPlugIn, SynchronizationPlugIn, TaskPropertiesPlugIn, TestColorThemingPlugIn, ThreadedBasePlugIn, ToggleRasterImageVisibility, ToggleVisibilityPlugIn, ToolboxPlugIn, ToolboxPlugInV2, TriangulationPlugIn, UndoPlugIn, UnionByAttributePlugIn, UnionPlugIn, UniqueFeatureInfoPlugIn, UpdateWithJoinPlugIn, ValidateSelectedLayersPlugIn, VectorizeToContoursPlugIn, VectorizeToPolygonsPlugIn, VerticesInFencePlugIn, ViewAttributesPlugIn, ViewOptionsPlugIn, ViewSchemaPlugIn, VoronoiDiagramPlugIn, WarpImageToFencePlugIn, WarpingPlugIn, WKTPlugIn, WMSLegendPlugIn, WMSStylePlugIn, WorkbenchFrame.ExitPlugin, ZoomBarPlugIn, ZoomInPlugIn, ZoomNextPlugIn, ZoomOutPlugIn, ZoomPreviousPlugIn, ZoomToClickPlugIn, ZoomToCoordinatePlugIn, ZoomToFencePlugIn, ZoomToFullExtentPlugIn, ZoomToLayerPlugIn, ZoomToRasterImagePlugIn, ZoomToScalePlugIn, ZoomToSelectedItemsPlugIn, ZoomToWMSLayerPlugIn, 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:

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    execute(PlugInContext context)
    Performs the action for this plugin.
    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.

  • Method Details

    • initialize

      void initialize(PlugInContext context) throws Exception
      Called when Workbench starts up to allow plugins to initialize themselves.
      Parameters:
      context - context of the PlugIn
      Throws:
      Exception - if an exception occur during initialization

    • execute

      boolean execute(PlugInContext context) throws 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.
      Parameters:
      context - context of this PlugIn
      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:

    • getName

      String getName()
      Returns a very brief description of this PlugIn e.g. for display as a menu item
      Returns:
      the name of this PlugIn