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

Class CreateGridPlugIn

java.lang.Object

com.vividsolutions.jump.workbench.plugin.AbstractPlugIn

org.openjump.core.ui.plugin.AbstractUiPlugIn

org.openjump.core.ui.plugin.tools.generate.CreateGridPlugIn

All Implemented Interfaces:

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

public class CreateGridPlugIn
extends AbstractUiPlugIn
implements ThreadedPlugIn

Create a grid or graticule for the map.

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
CreateGridPlugIn()

Method Summary

Modifier and Type	Method	Description
MultiEnableCheck	createEnableCheck(WorkbenchContext workbenchContext)
void	createGrid(PlugInContext context)
boolean	execute(PlugInContext context)	Method to be overridden by implementations to execute the plug-in.
Icon	getIcon()	Get the icon for 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.

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

actionPerformed, getEnableCheck, 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

CreateGridPlugIn

public CreateGridPlugIn()

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 MultiEnableCheck createEnableCheck(WorkbenchContext workbenchContext)

getIcon

public Icon getIcon()

Description copied from class: AbstractUiPlugIn

Get the icon for the plug-in.

Specified by:

getIcon in interface Iconified

Overrides:

getIcon in class AbstractUiPlugIn

Returns:

The icon.

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

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.

Specified by:

run in interface ThreadedPlugIn

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

createGrid

public void createGrid(PlugInContext context)