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, java.awt.event.ActionListener, java.util.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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ADD_AREA
static java.lang.String	ADD_GEOMETRY_TYPE
static java.lang.String	ADD_LENGTH
static java.lang.String	ADD_NB_COMPONENTS
static java.lang.String	ADD_NB_HOLES
static java.lang.String	ADD_NB_POINTS
static java.lang.String	ADD_WKT
static java.lang.String	ADD_XY
static java.lang.String	ADD_Z
static java.lang.String	AREA
static java.lang.String	COMPUTE_ATTRIBUTES
static java.lang.String	GEOM_ATTRIBUTES
static java.lang.String	GEOM_TYPE
static java.lang.String	LAYER
static java.lang.String	LENGTH
static java.lang.String	NB_COMPONENTS
static java.lang.String	NB_HOLES
static java.lang.String	NB_POINTS
static java.lang.String	WKT
static java.lang.String	X
static java.lang.String	Y
static java.lang.String	Z

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 and Description
AddGeometryAttributesPlugIn()

Method Summary

Methods

Modifier and Type	Method and 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	setAddGeometryType(boolean addGeometryType)
void	setAddLength(boolean addLength)
void	setAddNbComponents(boolean addNbComponents)
void	setAddNbHoles(boolean addNbHoles)
void	setAddNbPoints(boolean addNbPoints)
void	setAddWKT(boolean addWKT)
void	setAddXY(boolean addXY)
void	setAddZ(boolean addZ)
void	setLayer(java.lang.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, fetchShortcutEnabledPlugins, getBooleanParam, getDoubleParam, getEnableCheck, getIcon, getIcon, getIntegerParam, getParameter, getParameters, getShortcutKeys, getShortcutKeyStroke, getShortcutModifiers, getStringParam, isShortcutEnabled, registerShortcuts, 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

Field Detail

LAYER

public static java.lang.String LAYER

X

public static java.lang.String X

Y

public static java.lang.String Y

ADD_XY

public static java.lang.String ADD_XY

Z

public static java.lang.String Z

ADD_Z

public static java.lang.String ADD_Z

NB_POINTS

public static java.lang.String NB_POINTS

ADD_NB_POINTS

public static java.lang.String ADD_NB_POINTS

NB_HOLES

public static java.lang.String NB_HOLES

ADD_NB_HOLES

public static java.lang.String ADD_NB_HOLES

NB_COMPONENTS

public static java.lang.String NB_COMPONENTS

ADD_NB_COMPONENTS

public static java.lang.String ADD_NB_COMPONENTS

LENGTH

public static java.lang.String LENGTH

ADD_LENGTH

public static java.lang.String ADD_LENGTH

AREA

public static java.lang.String AREA

ADD_AREA

public static java.lang.String ADD_AREA

GEOM_TYPE

public static java.lang.String GEOM_TYPE

ADD_GEOMETRY_TYPE

public static java.lang.String ADD_GEOMETRY_TYPE

WKT

public static java.lang.String WKT

ADD_WKT

public static java.lang.String ADD_WKT

GEOM_ATTRIBUTES

public static java.lang.String GEOM_ATTRIBUTES

COMPUTE_ATTRIBUTES

public static java.lang.String COMPUTE_ATTRIBUTES

Constructor Detail

AddGeometryAttributesPlugIn

public AddGeometryAttributesPlugIn()

Method Detail

initialize

public void initialize(PlugInContext context)
                throws java.lang.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:

java.lang.Exception

createEnableCheck

public static MultiEnableCheck createEnableCheck(WorkbenchContext workbenchContext)

execute

public boolean execute(PlugInContext context)
                throws java.lang.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 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

setLayer

public void setLayer(java.lang.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)

setAddGeometryType

public void setAddGeometryType(boolean addGeometryType)

setAddWKT

public void setAddWKT(boolean addWKT)

run

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

Throws:

java.lang.Exception