com.javadocking.dockable.action
Interface DockableStateActionFactory

All Known Implementing Classes:

DefaultDockableStateActionFactory

public interface DockableStateActionFactory

This is an interface for a factory that creates a DockableStateAction that is used to change the state of a dockable.

Author:

Heidi Rakels.

Method Summary

DockableStateAction

createDockableStateAction(Dockable dockable, int newDockableState) Creates the action to change the state of the dockable.

Method Detail

createDockableStateAction

DockableStateAction createDockableStateAction(Dockable dockable,
                                              int newDockableState)

Creates the action to change the state of the dockable.

Parameters:

dockable - The dockable whose state will be changed by the created action.

newDockableState - The action puts the dockable in this state. This is an integer constant defined by DockableState.

Returns:

The action to change the state of the dockable.

Throws:

java.lang.IllegalArgumentException - If the given dockable state is not valid.