Class SetCategoryVisibilityPlugIn

java.lang.Object

com.vividsolutions.jump.workbench.plugin.AbstractPlugIn

org.openjump.core.ui.plugin.mousemenu.category.SetCategoryVisibilityPlugIn

All Implemented Interfaces:

EnableChecked, Iconified, PlugIn, Recordable, ShortcutEnabled

public class SetCategoryVisibilityPlugIn
extends AbstractPlugIn

Author:

Ole Rahn FH Osnabrück - University of Applied Sciences Osnabrück Project PIROL 2005 Daten- und Wissensmanagement

Field Summary

Fields

Modifier and Type	Field	Description
protected PlugInContext	context
protected static SetCategoryVisibilityPlugIn	instance
protected Map	layer2Visibility
protected JCheckBoxMenuItem	menuItem

Fields inherited from class AbstractPlugIn

shortcutKeys, shortcutModifiers

Constructor Summary

Constructors

Constructor	Description
SetCategoryVisibilityPlugIn()	Constructor needed to load PlugIn from classes, should NOT be used by any other code --> use getInstance() method instead!!

Method Summary

Modifier and Type	Method	Description
static MultiEnableCheck	createEnableCheck(WorkbenchContext workbenchContext)
boolean	execute(PlugInContext context)	Execute the PlugIn.
Icon	getIcon()	Plugin icon assumed to be 16x16 by default
static SetCategoryVisibilityPlugIn	getInstance(PlugInContext context)
String	getName()	Returns a very brief description of this PlugIn e.g. for display as a menu item
void	initialize(PlugInContext context)	Called when Workbench starts up to allow plugins to initialize themselves.
void	updateMenuItem()

Methods inherited from class AbstractPlugIn

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

Methods inherited from class Object

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

Field Details

layer2Visibility

protected Map layer2Visibility

context

protected PlugInContext context

menuItem

protected JCheckBoxMenuItem menuItem

instance

protected static SetCategoryVisibilityPlugIn instance

Constructor Details

SetCategoryVisibilityPlugIn

public SetCategoryVisibilityPlugIn()

Constructor needed to load PlugIn from classes, should NOT be used by any other code --> use getInstance() method instead!!

Method Details

getInstance

public static SetCategoryVisibilityPlugIn getInstance(PlugInContext context)

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

createEnableCheck

public static MultiEnableCheck createEnableCheck(WorkbenchContext workbenchContext)

getIcon

public Icon getIcon()

Description copied from class: AbstractPlugIn

Plugin icon assumed to be 16x16 by default

Specified by:

getIcon in interface Iconified

Overrides:

getIcon in class AbstractPlugIn

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

updateMenuItem

public void updateMenuItem()