net.infonode.docking.action
Class DockingWindowAction

java.lang.Object
  extended bynet.infonode.docking.action.DockingWindowAction
All Implemented Interfaces:
IconProvider, Serializable
Direct Known Subclasses:
CloseOthersWindowAction, CloseWindowAction, CloseWithAbortWindowAction, DockWindowAction, DockWithAbortWindowAction, MaximizeWindowAction, MaximizeWithAbortWindowAction, MinimizeWithAbortWindowAction, NullWindowAction, RestoreFocusWindowAction, RestoreParentWindowAction, RestoreParentWithAbortWindowAction, RestoreViewWithAbortTitleBarAction, RestoreWithAbortWindowAction, StateDependentWindowAction, UndockWindowAction, UndockWithAbortWindowAction

public abstract class DockingWindowAction
extends Object
implements Serializable, IconProvider

An action that can be performed on a DockingWindow. It has a name and an optional icon.

Since:
IDW 1.3.0
Version:
$Revision: 1.4 $
See Also:
Serialized Form

Constructor Summary
DockingWindowAction()
           
 
Method Summary
 SimpleAction getAction(DockingWindow window)
          Creates a simple action that performs this action on a window.
 Icon getIcon()
          Returns the optional icon of this action.
abstract  String getName()
          Returns the name of this action.
abstract  boolean isPerformable(DockingWindow window)
          Returns true if this action is performable on a window.
abstract  void perform(DockingWindow window)
          Performs this action on a window.
 String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DockingWindowAction

public DockingWindowAction()
Method Detail

getName

public abstract String getName()
Returns the name of this action.

Returns:
the name of this action

perform

public abstract void perform(DockingWindow window)
Performs this action on a window.

Parameters:
window - the window on which to perform the action

isPerformable

public abstract boolean isPerformable(DockingWindow window)
Returns true if this action is performable on a window.

Parameters:
window - the window on which the action will be performed
Returns:
true if this action is performable on the window

getAction

public SimpleAction getAction(DockingWindow window)
Creates a simple action that performs this action on a window.

Parameters:
window - the window on which to perform the action
Returns:
the action that performs this action on a window.

getIcon

public Icon getIcon()
Returns the optional icon of this action.

Specified by:
getIcon in interface IconProvider
Returns:
the optional icon of this action, null if there is no icon

toString

public String toString()


Copyright © 2007 NNL Technology AB. All Rights Reserved.