com.javadocking.dockable.action
Interface DockableStateAction

All Superinterfaces:
javax.swing.Action, java.awt.event.ActionListener, java.util.EventListener
All Known Implementing Classes:
DefaultDockableStateAction

public interface DockableStateAction
extends javax.swing.Action

This is an action to change the state of the dockable.

The new state for the dockable is defined by an integer. This is an integer constant defined by DockableState.

Author:
Heidi Rakels.

Field Summary
 
Fields inherited from interface javax.swing.Action
ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON
 
Method Summary
 Dockable getDockable()
          Gets the dockable whose state is changed by this action.
 int getNewDockableState()
          Gets the state in which the dockable should be after performing the action.
 
Methods inherited from interface javax.swing.Action
addPropertyChangeListener, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled
 
Methods inherited from interface java.awt.event.ActionListener
actionPerformed
 

Method Detail

getDockable

Dockable getDockable()
Gets the dockable whose state is changed by this action.

Returns:
The dockable whose state is changed by this action.

getNewDockableState

int getNewDockableState()
Gets the state in which the dockable should be after performing the action. This is a constant defined by DockableState.

Returns:
The state in which the dockable should be after performing the action.