org.openjump.core.ui.plugin.window

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 and Description
static class	ArrangeViewsPlugIn.ArrangeAllPlugIn
static class	ArrangeViewsPlugIn.ArrangeCascadePlugIn
static class	ArrangeViewsPlugIn.ArrangeHorizontalPlugIn
static class	ArrangeViewsPlugIn.ArrangeVerticalPlugIn

Field Summary

Fields

Modifier and Type	Field and Description
static int	ARRANGE
static javax.swing.Icon	ARRANGE_ICON
static int	CASCADE
static javax.swing.Icon	CASCADE_ICON
static int	HORIZONTAL
static javax.swing.Icon	HORIZONTAL_ICON
static java.lang.String	NAME
static int	VERTICAL
static javax.swing.Icon	VERTICAL_ICON

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

shortcutKeys, shortcutModifiers

Constructor Summary

Constructors

Constructor and Description
ArrangeViewsPlugIn()
ArrangeViewsPlugIn(int type)

Method Summary

Methods

Modifier and Type	Method and Description
static EnableCheck	createEnableCheck(WorkbenchContext workbenchContext)
boolean	execute(PlugInContext context) Performs the action for this plugin.
javax.swing.Icon	getIcon()
java.lang.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 com.vividsolutions.jump.workbench.plugin.AbstractPlugIn

addParameter, createName, execute, execute, fetchShortcutEnabledPlugins, getBooleanParam, getDoubleParam, getEnableCheck, getEnableCheck, getIcon, getIcon, getIntegerParam, getParameter, getParameters, getShortcutKeys, getShortcutKeyStroke, getShortcutModifiers, getStringParam, isRollingBackInvalidEdits, isShortcutEnabled, registerShortcuts, 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

NAME

public static final java.lang.String NAME

HORIZONTAL_ICON

public static final javax.swing.Icon HORIZONTAL_ICON

VERTICAL_ICON

public static final javax.swing.Icon VERTICAL_ICON

CASCADE_ICON

public static final javax.swing.Icon CASCADE_ICON

ARRANGE_ICON

public static final javax.swing.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 Detail

ArrangeViewsPlugIn

public ArrangeViewsPlugIn()

ArrangeViewsPlugIn

public ArrangeViewsPlugIn(int type)

Method Detail

initialize

public void initialize(PlugInContext context)
                throws java.lang.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

Throws:

java.lang.Exception

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

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.

createEnableCheck

public static EnableCheck createEnableCheck(WorkbenchContext workbenchContext)

getIcon

public javax.swing.Icon getIcon()