Class LegendPlugIn

java.lang.Object

com.vividsolutions.jump.workbench.plugin.AbstractPlugIn

com.vividsolutions.jump.workbench.ui.style.LegendPlugIn

All Implemented Interfaces:

EnableChecked, Iconified, PlugIn, Recordable, ShortcutEnabled

public class LegendPlugIn
extends AbstractPlugIn

Plugin to display the legend of correct symbology used into a view

Author:

Giuseppe Aruta

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LegendPlugIn.ColorThemingValue

Field Summary

Fields inherited from class AbstractPlugIn

shortcutKeys, shortcutModifiers

Constructor Summary

Constructors

Constructor	Description
LegendPlugIn()

Method Summary

Modifier and Type	Method	Description
static MultiEnableCheck	createEnableCheck(WorkbenchContext workbenchContext)
boolean	execute(PlugInContext context)	Execute the PlugIn.
static Set<String>	getAvailableValues(ColorThemingStyle style, FeatureCollection fc)
ImageIcon	getIcon()	Plugin icon assumed to be 16x16 by default
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.
JPanel	layersPanel(List<Layer> layers)

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

Constructor Details

LegendPlugIn

public LegendPlugIn()

Method Details

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

layersPanel

public JPanel layersPanel(List<Layer> layers)

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.

getAvailableValues

public static Set<String> getAvailableValues(ColorThemingStyle style,
 FeatureCollection fc)