net.infonode.docking.action

Class StateDependentWindowAction

java.lang.Object

net.infonode.docking.action.DockingWindowAction

net.infonode.docking.action.StateDependentWindowAction

All Implemented Interfaces:

java.io.Serializable, IconProvider

public class StateDependentWindowAction
extends DockingWindowAction

Performs different actions on a window depending on the state of the window.

Since:

IDW 1.3.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static StateDependentWindowAction	MAXIMIZE_RESTORE If the window is maximized or minimized it is restored, otherwise it is maximized.
static StateDependentWindowAction	MAXIMIZE_RESTORE_WITH_ABORT If the window is maximized or minimized it is restored, otherwise it is maximized.

Constructor Summary

Constructors

Constructor and Description
StateDependentWindowAction(DockingWindowAction normalAction, DockingWindowAction minimizedAction, DockingWindowAction maximizedAction) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getName() Returns the name of this action.
boolean	isPerformable(DockingWindow window) Returns true if this action is performable on a window.
void	perform(DockingWindow window) Performs this action on a window.

Methods inherited from class net.infonode.docking.action.DockingWindowAction

getAction, getIcon, toString

Methods inherited from class java.lang.Object

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

Field Detail

MAXIMIZE_RESTORE

public static final StateDependentWindowAction MAXIMIZE_RESTORE

If the window is maximized or minimized it is restored, otherwise it is maximized.

MAXIMIZE_RESTORE_WITH_ABORT

public static final StateDependentWindowAction MAXIMIZE_RESTORE_WITH_ABORT

If the window is maximized or minimized it is restored, otherwise it is maximized. The operations can be aborted by a DockingWindowListener.

Since:

IDW 1.4.0

Constructor Detail

StateDependentWindowAction

public StateDependentWindowAction(DockingWindowAction normalAction,
                          DockingWindowAction minimizedAction,
                          DockingWindowAction maximizedAction)

Constructor.

Parameters:

normalAction - the action to perform if a window is in normal state

minimizedAction - the action to perform if a window is minimized

maximizedAction - the action to perform if a window is maximized

Method Detail

getName

public java.lang.String getName()

Description copied from class: DockingWindowAction

Returns the name of this action.

Specified by:

getName in class DockingWindowAction

Returns:

the name of this action

isPerformable

public boolean isPerformable(DockingWindow window)

Description copied from class: DockingWindowAction

Returns true if this action is performable on a window.

Specified by:

isPerformable in class DockingWindowAction

Parameters:

window - the window on which the action will be performed

Returns:

true if this action is performable on the window

perform

public void perform(DockingWindow window)

Description copied from class: DockingWindowAction

Performs this action on a window.

Specified by:

perform in class DockingWindowAction

Parameters:

window - the window on which to perform the action