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

java.lang.Object
  extended by com.vividsolutions.jump.workbench.plugin.AbstractPlugIn
      extended by org.openjump.core.ui.plugin.layer.pirolraster.ToggleRasterImageVisibility
All Implemented Interfaces:
PlugIn, java.util.EventListener, javax.swing.event.PopupMenuListener

public class ToggleRasterImageVisibility
extends AbstractPlugIn
implements javax.swing.event.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
protected  javax.swing.JCheckBoxMenuItem menuItem
           
protected  WorkbenchContext wbContext
           
 
Constructor Summary
ToggleRasterImageVisibility(WorkbenchContext wbContext)
           
 
Method Summary
 boolean execute(PlugInContext context)
          Performs the action for this plugin.
 java.lang.String getIconString()
           
 javax.swing.JCheckBoxMenuItem getMenuItem()
           
 java.lang.String getName()
          Returns a very brief description of this PlugIn e.g. for display as a menu item
 void popupMenuCanceled(javax.swing.event.PopupMenuEvent arg0)
           
 void popupMenuWillBecomeInvisible(javax.swing.event.PopupMenuEvent arg0)
           
 void popupMenuWillBecomeVisible(javax.swing.event.PopupMenuEvent arg0)
           
 void setMenuItem(javax.swing.JCheckBoxMenuItem menuItem)
           
 
Methods inherited from class com.vividsolutions.jump.workbench.plugin.AbstractPlugIn
createName, execute, execute, initialize, isRollingBackInvalidEdits, reportNothingToUndoYet, 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 javax.swing.JCheckBoxMenuItem menuItem
Constructor Detail

ToggleRasterImageVisibility

public ToggleRasterImageVisibility(WorkbenchContext wbContext)
Method Detail

getIconString

public java.lang.String getIconString()

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
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.

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
Overrides:
execute in class AbstractPlugIn
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

popupMenuCanceled

public void popupMenuCanceled(javax.swing.event.PopupMenuEvent arg0)
Specified by:
popupMenuCanceled in interface javax.swing.event.PopupMenuListener
Parameters:
arg0 -

popupMenuWillBecomeInvisible

public void popupMenuWillBecomeInvisible(javax.swing.event.PopupMenuEvent arg0)
Specified by:
popupMenuWillBecomeInvisible in interface javax.swing.event.PopupMenuListener
Parameters:
arg0 -

popupMenuWillBecomeVisible

public void popupMenuWillBecomeVisible(javax.swing.event.PopupMenuEvent arg0)
Specified by:
popupMenuWillBecomeVisible in interface javax.swing.event.PopupMenuListener
Parameters:
arg0 -

getMenuItem

public javax.swing.JCheckBoxMenuItem getMenuItem()

setMenuItem

public void setMenuItem(javax.swing.JCheckBoxMenuItem menuItem)