com.vividsolutions.jump.workbench.plugin

Class AbstractPlugIn

java.lang.Object

com.vividsolutions.jump.workbench.plugin.AbstractPlugIn

All Implemented Interfaces:

EnableChecked, Iconified, PlugIn, Recordable, ShortcutEnabled

Direct Known Subclasses:

AboutPlugIn, AbstractSaveProjectPlugIn, AbstractUiPlugIn, AddNewCategoryPlugIn, AddNewLayerPlugIn, AddWMSDemoBoxEasterEggPlugIn, AdvancedMeasurePlugin, AffineTransformPlugIn, ArrangeViewsPlugIn, AttributeQueryPlugIn, AutoCompletePolygonPlugIn, BeanToolsPlugIn, BlendLineStringsPlugIn, BoundaryMatchDataPlugIn, CalculateAreasAndLengthsPlugIn, CalcVarianceAndMeanPerClassPlugIn, CenterZoomPlugIn, ChangeCoordinateSystemPlugIn, ChangeLayerableNamePlugIn, ChangeRasterImagePropertiesPlugIn, ChangeSRIDPlugIn, ChangeStylesPlugIn, ClassifyAttributesPlugIn, ClearSelectionPlugIn, ClipToFencePlugIn, CloneWindowPlugIn, CombineSelectedFeaturesPlugIn, CombineSelectedLayersPlugIn, ConstrainedMoveVertexPlugIn, ConvexHullPlugIn, ConvexHullPlugIn, CopyBBoxPlugin, CopySchemaPlugIn, CopySelectedItemsPlugIn, CopySelectedLayersToWarpingVectorsPlugIn, CopyStylesPlugIn, CopyThisCoordinatePlugIn, CreateBarPlotPlugIn, CreateHistogramPlugIn, CreateLatticeFromSelectedImageLayerPlugIn, CreatePolygonGridFromSelectedImageLayerPlugIn, CreateScatterPlotPlugIn, CreateThiessenPolygonsPlugIn, CustomFillPatternExamplePlugIn, CutPolygonSIGLEPlugIn, DeeChangeStylesPlugIn, DeleteAllFeaturesPlugIn, DeleteDuplicateGeometriesPlugIn, DeleteEmptyGeometriesPlugIn, DeleteSelectedItemsPlugIn, DrawCircleWithGivenRadiusPlugIn, DrawConstrainedArcPlugIn, DrawConstrainedCirclePlugIn, DrawConstrainedLineStringPlugIn, DrawConstrainedPolygonPlugIn, DuplicateItemPlugIn, EditablePlugIn, EditAttributeByFormulaPlugIn, EditSelectedSidePlugIn, EditWMSQueryPlugIn, EnsureAllLayersHaveSRIDStylePlugIn, ExplodeSelectedFeaturesPlugIn, ExportEnvelopeAsGeometryPlugIn, ExportImagePlugIn, ExtractCommonBoundaryBetweenPolysPlugIn, ExtractLayerInFence, ExtractLayersByAttribute, ExtractPointsPlugIn, ExtractSelectedPartOfImage, FeatureInfoPlugIn, FeatureStatisticsPlugIn, FillPolygonPlugIn, FirstTaskFramePlugIn, GenerateLogPlugIn, GeometryFunctionPlugIn, ImageLayerManagerPlugIn, ImportArcMapStylePlugIn, ImportSLDPlugIn, InstallDatastoreLayerRendererHintsPlugIn, InstallDummyReaderPlugIn, InstallKeyPanPlugIn, InstallRendererPlugIn, InstallSkinsPlugIn, InstallStandardDataSourceQueryChoosersPlugIn, InstallStandardFeatureTextWritersPlugIn, InstallZoomBarPlugIn, InvertSelectionPlugIn, JoinWithArcPlugIn, LayerableClipboardPlugIn, LayerableClipboardPlugIn, LayerPropertiesPlugIn, LayerStatisticsPlugIn, LayerStyle2SLDPlugIn, LineSimplifyJTS15AlgorithmPlugIn, LoadSextanteRasterImagePlugIn, MacroPlugIn, MapToolTipPlugIn, MapToolTipsPlugIn, MeasureM_FPlugIn, MergeSelectedFeaturesPlugIn, MergeTwoSelectedPolygonsPlugIn, MicroscopePlugIn, MoveAlongAnglePlugIn, MoveCategoryOneDown, MoveCategoryOneUp, MoveCategoryToBottom, MoveCategoryToTop, MoveLayerablePlugIn, MoveSelectedLayersPlugIn, MultiRingBufferSelectedPlugIn, NewTaskPlugIn, NorthArrowPlugIn, NoteToolPlugIn, OptionsPlugIn, OutputWindowPlugIn, OverlayPlugIn, PanToSelectedItemsPlugIn, PasteItemsPlugIn, PasteSchemaPlugIn, PasteStylesPlugIn, PersistentBlackboardPlugIn, PlumePlugIn, ProfileGraphPlugIn, ProjectionPlugIn, RandomArrowsPlugIn, RandomTrianglesPlugIn, RasterColorEditorPlugIn, RasterImageLayerPropertiesPlugIn, RasterQueryPlugIn, RedoPlugIn, ReducePointsISAPlugIn, RefreshDataStoreLayerPlugin, RemoveSelectedCategoriesPlugIn, RemoveSelectedLayersPlugIn, RemoveSelectedRasterImageLayersPlugIn, ReplaceValuePlugIn, ReplicateSelectedItemsPlugIn, ReverseOrientationPlugIn, RotatePlugIn, RotateSelectedItemPlugIn, SaveDatasetsPlugIn, SaveImageAsSVGPlugIn, SaveLayersWithoutDataSourcePlugIn, SaveLegendPlugIn, SaveRasterImageAsImagePlugIn, ScaleBarPlugIn, ScaleSelectedItemsPlugIn, SearchAllAttributes, SelectablePlugIn, SelectAllLayerItemsPlugIn, SelectAllModifiedFeaturesPlugIn, SelectByTypePlugIn, SelectFeaturesInFencePlugIn, SelectItemsByCircleFromSelectedLayersPlugIn, SelectItemsByFenceFromSelectedLayersPlugIn, SelectLayersWithSelectedItemsPlugIn, SelectOneItemPlugIn, SetCategoryVisibilityPlugIn, ShortcutKeysPlugIn, ShowFullPathPlugIn, ShowScalePlugIn, ShowTriangulationPlugIn, SimpleQueryPlugIn, SimplifyPolygonCoveragePlugIn, SortCategoryAbstractPlugIn, SortCategoryRestorePlugIn, SortCategorySavePlugIn, SpatialJoinPlugIn, SpatialQueryPlugIn, SplitPolygonPlugIn, StandardPirolPlugIn, StartMacroPlugIn, StatisticOverViewPlugIn, StopMacroPlugIn, TestColorThemingPlugIn, TestToolsTest.ExampleAbstractPlugIn, TestToolsTest.ExamplePlugInWithDialog, TestToolsTest.ExamplePlugInWithFields, ThreadedBasePlugIn, ToggleRasterImageVisibility, ToggleVisiblityPlugIn, ToolboxPlugIn, UndoPlugIn, UnionPlugIn, ValidateSelectedLayersPlugIn, VerticesInFencePlugIn, ViewAttributesPlugIn, ViewOptionsPlugIn, ViewSchemaPlugIn, WarpImageToFencePlugIn, WKTPlugIn, WorkbenchFrame.ExitPlugin, ZoomInPlugIn, ZoomNextPlugIn, ZoomOutPlugIn, ZoomPreviousPlugIn, ZoomToClickPlugIn, ZoomToCoordinatePlugIn, ZoomToFencePlugIn, ZoomToFullExtentPlugIn, ZoomToLayerPlugIn, ZoomToRasterImagePlugIn, ZoomToScalePlugIn, ZoomToSelectedItemsPlugIn, ZoomToWMSLayerPlugIn, ZoomToWMSPlugIn

public abstract class AbstractPlugIn
extends java.lang.Object
implements PlugIn, ShortcutEnabled, EnableChecked, Iconified, Recordable

Default implementation of PlugIn, with useful functions for auto-generating a name, converting a PlugIn into an ActionListener (for use with JButtons, for example), and supporting undo.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	shortcutKeys
protected int	shortcutModifiers

Constructor Summary

Constructors

Constructor and Description
AbstractPlugIn()
AbstractPlugIn(java.lang.String name)

Method Summary

Methods

Modifier and Type	Method and Description
void	addParameter(java.lang.String name, java.lang.Object value)
static java.lang.String	createName(java.lang.Class plugInClass)
boolean	execute(PlugInContext context) Performs the action for this plugin.
static void	execute(UndoableCommand command, LayerManagerProxy layerManagerProxy)
protected void	execute(UndoableCommand command, PlugInContext context)
static PlugIn[]	fetchShortcutEnabledPlugins(PlugIn plugin) Convenience method to collect all plugins of a probably multi shortcut enabled plugin.
java.lang.Boolean	getBooleanParam(java.lang.String name)
java.lang.Double	getDoubleParam(java.lang.String name)
EnableCheck	getEnableCheck()
static EnableCheck	getEnableCheck(PlugIn plugin) Utility method to fetch enable checks from enablechecked plugins.
javax.swing.Icon	getIcon(java.awt.Dimension dim)
javax.swing.Icon	getIcon(int height)
java.lang.Integer	getIntegerParam(java.lang.String name)
java.lang.String	getName() Returns a very brief description of this PlugIn e.g. for display as a menu item
java.lang.Object	getParameter(java.lang.String name)
java.util.Map<java.lang.String,java.lang.Object>	getParameters()
int	getShortcutKeys()
javax.swing.KeyStroke	getShortcutKeyStroke() Convenience Method for getShortcutKeys() and getShortcutModifiers()
int	getShortcutModifiers()
java.lang.String	getStringParam(java.lang.String name)
void	initialize(PlugInContext context) Called when Workbench starts up to allow plugins to initialize themselves.
protected boolean	isRollingBackInvalidEdits(PlugInContext context)
boolean	isShortcutEnabled()
static boolean	registerShortcuts(PlugIn plugin) Utility method to register global shortcuts.
protected void	reportNothingToUndoYet(PlugInContext context) Indicates that this plug-in either (1) is undoable but hasn't modified the system yet or (2) does not modify the system.
void	setParameters(java.util.Map<java.lang.String,java.lang.Object> map) Set parameters with which to execute a plugin.
void	setShortcutKeys(int shortcutKeys)
void	setShortcutModifiers(int shortcutModifiers)
static java.awt.event.ActionListener	toActionListener(PlugIn plugIn, WorkbenchContext workbenchContext, TaskMonitorManager taskMonitorManager)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

shortcutModifiers

protected int shortcutModifiers

shortcutKeys

protected int shortcutKeys

Constructor Detail

AbstractPlugIn

public AbstractPlugIn()

AbstractPlugIn

public AbstractPlugIn(java.lang.String name)

Method Detail

addParameter

public void addParameter(java.lang.String name,
                java.lang.Object value)

getParameter

public java.lang.Object getParameter(java.lang.String name)

getBooleanParam

public java.lang.Boolean getBooleanParam(java.lang.String name)

getIntegerParam

public java.lang.Integer getIntegerParam(java.lang.String name)

getDoubleParam

public java.lang.Double getDoubleParam(java.lang.String name)

getStringParam

public java.lang.String getStringParam(java.lang.String name)

setParameters

public void setParameters(java.util.Map<java.lang.String,java.lang.Object> map)

Description copied from interface: Recordable

Set parameters with which to execute a plugin.

Specified by:

setParameters in interface Recordable

Parameters:

map - a map of parameters

getParameters

public java.util.Map<java.lang.String,java.lang.Object> getParameters()

execute

protected void execute(UndoableCommand command,
           PlugInContext context)

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

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

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

reportNothingToUndoYet

protected void reportNothingToUndoYet(PlugInContext context)

Indicates that this plug-in either (1) is undoable but hasn't modified the system yet or (2) does not modify the system. In either case, the undo history will be preserved. If this method is not called, then this plug-in will be assumed to be non-undoable, and the undo history will be truncated.

isRollingBackInvalidEdits

protected boolean isRollingBackInvalidEdits(PlugInContext context)

isShortcutEnabled

public boolean isShortcutEnabled()

Specified by:

isShortcutEnabled in interface ShortcutEnabled

getShortcutModifiers

public final int getShortcutModifiers()

Specified by:

getShortcutModifiers in interface ShortcutEnabled

setShortcutModifiers

public void setShortcutModifiers(int shortcutModifiers)

Specified by:

setShortcutModifiers in interface ShortcutEnabled

getShortcutKeys

public final int getShortcutKeys()

Specified by:

getShortcutKeys in interface ShortcutEnabled

setShortcutKeys

public void setShortcutKeys(int shortcutKeys)

Specified by:

setShortcutKeys in interface ShortcutEnabled

getShortcutKeyStroke

public javax.swing.KeyStroke getShortcutKeyStroke()

Description copied from interface: ShortcutEnabled

Convenience Method for getShortcutKeys() and getShortcutModifiers()

Specified by:

getShortcutKeyStroke in interface ShortcutEnabled

getEnableCheck

public EnableCheck getEnableCheck()

Specified by:

getEnableCheck in interface EnableChecked

getIcon

public javax.swing.Icon getIcon(int height)

Specified by:

getIcon in interface Iconified

getIcon

public javax.swing.Icon getIcon(java.awt.Dimension dim)

Specified by:

getIcon in interface Iconified

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

Returns:

the class name, minus "PlugIn", with spaces inserted at the appropriate point before each uppercase+lowercase and lowercase+uppercase combination.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

createName

public static java.lang.String createName(java.lang.Class plugInClass)

toActionListener

public static java.awt.event.ActionListener toActionListener(PlugIn plugIn,
                                             WorkbenchContext workbenchContext,
                                             TaskMonitorManager taskMonitorManager)

Parameters:

taskMonitorManager - can be null if you do not wish to use the Task Monitor progress-reporting framework

execute

public static void execute(UndoableCommand command,
           LayerManagerProxy layerManagerProxy)

getEnableCheck

public static EnableCheck getEnableCheck(PlugIn plugin)

Utility method to fetch enable checks from enablechecked plugins.

Parameters:

plugin -

Returns:

enable check

fetchShortcutEnabledPlugins

public static PlugIn[] fetchShortcutEnabledPlugins(PlugIn plugin)

Convenience method to collect all plugins of a probably multi shortcut enabled plugin. Used to register multiple shortcut enabled plugins in one go.

Parameters:

plugin -

Returns:

plugins array

registerShortcuts

public static boolean registerShortcuts(PlugIn plugin)

Utility method to register global shortcuts. Should be preferred to the more direct approach using WorkbenchFrame.addKeyboardShortcut() .

Parameters:

plugin -

Returns:

done