Class ArrangeViewsPlugIn

java.lang.Object

com.vividsolutions.jump.workbench.plugin.AbstractPlugIn

org.openjump.core.ui.plugin.window.ArrangeViewsPlugIn

All Implemented Interfaces:

EnableChecked, Iconified, PlugIn, Recordable, ShortcutEnabled

Direct Known Subclasses:

ArrangeViewsPlugIn.ArrangeAllPlugIn, ArrangeViewsPlugIn.ArrangeCascadePlugIn, ArrangeViewsPlugIn.ArrangeHorizontalPlugIn, ArrangeViewsPlugIn.ArrangeVerticalPlugIn

public class ArrangeViewsPlugIn
extends AbstractPlugIn

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ArrangeViewsPlugIn.ArrangeAllPlugIn
static class	ArrangeViewsPlugIn.ArrangeCascadePlugIn
static class	ArrangeViewsPlugIn.ArrangeHorizontalPlugIn
static class	ArrangeViewsPlugIn.ArrangeVerticalPlugIn

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ARRANGE
static final Icon	ARRANGE_ICON
static final int	CASCADE
static final Icon	CASCADE_ICON
static final int	HORIZONTAL
static final Icon	HORIZONTAL_ICON
static final String	NAME
static final int	VERTICAL
static final Icon	VERTICAL_ICON

Fields inherited from class AbstractPlugIn

shortcutKeys, shortcutModifiers

Constructor Summary

Constructors

Constructor	Description
ArrangeViewsPlugIn()
ArrangeViewsPlugIn(int type)

Method Summary

Modifier and Type	Method	Description
static EnableCheck	createEnableCheck(WorkbenchContext workbenchContext)
boolean	execute(PlugInContext context)	Execute the PlugIn.
Icon	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.

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

NAME

public static final String NAME

HORIZONTAL_ICON

public static final Icon HORIZONTAL_ICON

VERTICAL_ICON

public static final Icon VERTICAL_ICON

CASCADE_ICON

public static final Icon CASCADE_ICON

ARRANGE_ICON

public static final Icon ARRANGE_ICON

HORIZONTAL

public static final int HORIZONTAL

See Also:

• Constant Field Values

VERTICAL

public static final int VERTICAL

See Also:

• Constant Field Values

CASCADE

public static final int CASCADE

See Also:

• Constant Field Values

ARRANGE

public static final int ARRANGE

See Also:

• Constant Field Values

Constructor Details

ArrangeViewsPlugIn

public ArrangeViewsPlugIn()

ArrangeViewsPlugIn

public ArrangeViewsPlugIn(int type)

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

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

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.

createEnableCheck

public static EnableCheck 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