Package org.openjump.core.ui.plugin.tools

Class AddGeometryAttributesPlugIn

java.lang.Object

com.vividsolutions.jump.workbench.plugin.AbstractPlugIn

org.openjump.core.ui.plugin.AbstractUiPlugIn

org.openjump.core.ui.plugin.AbstractThreadedUiPlugIn

org.openjump.core.ui.plugin.tools.AddGeometryAttributesPlugIn

All Implemented Interfaces:

EnableChecked, Iconified, PlugIn, Recordable, ShortcutEnabled, ThreadedPlugIn, ActionListener, EventListener

public class AddGeometryAttributesPlugIn
extends AbstractThreadedUiPlugIn

User can add one or several of the following geometry attributes to a layer.

• X,Y
• Z
• Number of points
• Number of holes
• Number of components
• Total length
• Total area
• Geometry type
• Geometry in WKT format

Author:

Michaël Michaud

Field Summary

Fields inherited from class org.openjump.core.ui.plugin.AbstractUiPlugIn

enableCheck, workbenchContext

Fields inherited from class com.vividsolutions.jump.workbench.plugin.AbstractPlugIn

shortcutKeys, shortcutModifiers

Constructor Summary

Constructors

Constructor	Description
AddGeometryAttributesPlugIn()

Method Summary

Modifier and Type	Method	Description
static MultiEnableCheck	createEnableCheck(WorkbenchContext workbenchContext)
boolean	execute(PlugInContext context)	Method to be overridden by implementations to execute the plug-in.
void	initialize(PlugInContext context)	Method to be overridden by implementations to initialize the plug-in.
void	run(TaskMonitor monitor, PlugInContext context)	Runs the task.
void	setAddArea(boolean addArea)
void	setAddCircularity(boolean addCircularity)
void	setAddCompacity(boolean addCompacity)
void	setAddGeometryType(boolean addGeometryType)
void	setAddLength(boolean addLength)
void	setAddNbComponents(boolean addNbComponents)
void	setAddNbHoles(boolean addNbHoles)
void	setAddNbPoints(boolean addNbPoints)
void	setAddPolyLength(boolean addPolyLength)
void	setAddPolyWidth(boolean addPolyWidth)
void	setAddWKT(boolean addWKT)
void	setAddXY(boolean addXY)
void	setAddZ(boolean addZ)
void	setLayer(String sitesLayer)

Methods inherited from class org.openjump.core.ui.plugin.AbstractUiPlugIn

actionPerformed, getEnableCheck, getIcon, getName, getToolTip, isRollingBackInvalidEdits, reportNothingToUndoYet, setWorkbenchContext

Methods inherited from class com.vividsolutions.jump.workbench.plugin.AbstractPlugIn

addParameter, createName, execute, execute, getBooleanParam, getContext, getDoubleParam, getIcon, getIcon, getIntegerParam, getParameter, getParameters, getShortcutKeys, getShortcutKeyStroke, getShortcutModifiers, getStringParam, getWorkbenchContext, isShortcutEnabled, setParameters, setShortcutKeys, setShortcutModifiers, 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

Constructor Detail

AddGeometryAttributesPlugIn

public AddGeometryAttributesPlugIn()

Method Detail

initialize

public void initialize(PlugInContext context)
                throws Exception

Description copied from class: AbstractUiPlugIn

Method to be overridden by implementations to initialize the plug-in. Plug-ins must invoke super.initialize().

Specified by:

initialize in interface PlugIn

Overrides:

initialize in class AbstractUiPlugIn

Parameters:

context - The plug-in context.

Throws:

Exception - if an exception occur during initialization

createEnableCheck

public static MultiEnableCheck createEnableCheck(WorkbenchContext workbenchContext)

execute

public boolean execute(PlugInContext context)
                throws Exception

Description copied from class: AbstractUiPlugIn

Method to be overridden by implementations to execute the plug-in.

Specified by:

execute in interface PlugIn

Overrides:

execute in class AbstractUiPlugIn

Parameters:

context - The plug-in context.

Returns:

true if the PlugIn has been executed

Throws:

Exception - if an Exception occurs during execution

See Also:

ThreadedPlugIn

setLayer

public void setLayer(String sitesLayer)

setAddXY

public void setAddXY(boolean addXY)

setAddZ

public void setAddZ(boolean addZ)

setAddNbPoints

public void setAddNbPoints(boolean addNbPoints)

setAddNbHoles

public void setAddNbHoles(boolean addNbHoles)

setAddNbComponents

public void setAddNbComponents(boolean addNbComponents)

setAddLength

public void setAddLength(boolean addLength)

setAddArea

public void setAddArea(boolean addArea)

setAddPolyWidth

public void setAddPolyWidth(boolean addPolyWidth)

setAddPolyLength

public void setAddPolyLength(boolean addPolyLength)

setAddCircularity

public void setAddCircularity(boolean addCircularity)

setAddCompacity

public void setAddCompacity(boolean addCompacity)

setAddGeometryType

public void setAddGeometryType(boolean addGeometryType)

setAddWKT

public void setAddWKT(boolean addWKT)

run

public void run(TaskMonitor monitor,
                PlugInContext context)
         throws 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.

Parameters:

monitor - context to which this task can report its progress and check whether a party has requested its cancellation

context - context of this PlugIn

Throws:

Exception - if an Exception occurs during the run