Package org.openjump.core.ui.plugin.layer.pirolraster

Class ToggleRasterImageVisibility

java.lang.Object

com.vividsolutions.jump.workbench.plugin.AbstractPlugIn

org.openjump.core.ui.plugin.layer.pirolraster.ToggleRasterImageVisibility

All Implemented Interfaces:

EnableChecked, Iconified, PlugIn, Recordable, ShortcutEnabled, EventListener, PopupMenuListener

public class ToggleRasterImageVisibility
extends AbstractPlugIn
implements PopupMenuListener

TODO: comment class

Version:

$Rev: 2509 $ [sstein] - 22.Feb.2009 - modified to work in OpenJUMP

Author:

Ole Rahn

FH Osnabrück - University of Applied Sciences Osnabrück,
Project: PIROL (2006),
Subproject: Daten- und Wissensmanagement

Field Summary

Fields

Modifier and Type	Field	Description
protected JCheckBoxMenuItem	menuItem
protected WorkbenchContext	wbContext

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

shortcutKeys, shortcutModifiers

Constructor Summary

Constructors

Constructor	Description
ToggleRasterImageVisibility(WorkbenchContext wbContext)

Method Summary

Modifier and Type	Method	Description
boolean	execute(PlugInContext context)	Execute the PlugIn.
String	getIconString()
JCheckBoxMenuItem	getMenuItem()
String	getName()	Returns a very brief description of this PlugIn e.g.
void	initialize(PlugInContext context)	Called when Workbench starts up to allow plugins to initialize themselves.
void	popupMenuCanceled(PopupMenuEvent arg0)
void	popupMenuWillBecomeInvisible(PopupMenuEvent arg0)
void	popupMenuWillBecomeVisible(PopupMenuEvent arg0)
void	setMenuItem(JCheckBoxMenuItem menuItem)

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

addParameter, createName, execute, execute, getBooleanParam, getContext, getDoubleParam, getEnableCheck, getIcon, getIcon, getIcon, getIntegerParam, getParameter, getParameters, getShortcutKeys, getShortcutKeyStroke, getShortcutModifiers, getStringParam, getWorkbenchContext, isRollingBackInvalidEdits, isShortcutEnabled, reportNothingToUndoYet, setParameters, setShortcutKeys, setShortcutModifiers, toActionListener, toString

Methods inherited from class java.lang.Object

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

Field Detail

wbContext

protected WorkbenchContext wbContext

menuItem

protected JCheckBoxMenuItem menuItem

Constructor Detail

ToggleRasterImageVisibility

public ToggleRasterImageVisibility(WorkbenchContext wbContext)

Method Detail

getIconString

public String getIconString()

getName

public 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

Overrides:

getName in class AbstractPlugIn

Returns:

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

initialize

public void initialize(PlugInContext context)
                throws Exception

Description copied from interface: PlugIn

Called when Workbench starts up to allow plugins to initialize themselves.

Specified by:

initialize in interface PlugIn

Overrides:

initialize in class AbstractPlugIn

Parameters:

context - context of the PlugIn

Throws:

Exception - if an exception occur during initialization

execute

public boolean execute(PlugInContext context)
                throws Exception

Description copied from class: AbstractPlugIn

Execute the PlugIn.

Specified by:

execute in interface PlugIn

Overrides:

execute in class AbstractPlugIn

Parameters:

context - context of this PlugIn

Returns:

true if the PlugIn has been executed

Throws:

Exception - if an Exception occurs during execution

See Also:

ThreadedPlugIn

popupMenuCanceled

public void popupMenuCanceled(PopupMenuEvent arg0)

Specified by:

popupMenuCanceled in interface PopupMenuListener

Parameters:

arg0 - an event on the PopupMenu

popupMenuWillBecomeInvisible

public void popupMenuWillBecomeInvisible(PopupMenuEvent arg0)

Specified by:

popupMenuWillBecomeInvisible in interface PopupMenuListener

Parameters:

arg0 - an event on the PopupMenu

popupMenuWillBecomeVisible

public void popupMenuWillBecomeVisible(PopupMenuEvent arg0)

Specified by:

popupMenuWillBecomeVisible in interface PopupMenuListener

Parameters:

arg0 - an event on the PopupMenu

getMenuItem

public JCheckBoxMenuItem getMenuItem()

setMenuItem

public void setMenuItem(JCheckBoxMenuItem menuItem)