com.lf.commons.gui

Class ActionManager

java.lang.Object

com.lf.commons.gui.ActionManager

All Implemented Interfaces:

java.awt.event.ActionListener, java.util.EventListener

public class ActionManager
extends java.lang.Object
implements java.awt.event.ActionListener

Represents a high-level application shared action delegated to registered objects.

Applications can provide actions which can be called by clicking a menu item, button, or by pressing the accelerator key. Commonly used actions are "Print" or "Find". Normally such actions are simply delegated by calling their action listeners. In order to be able to support the multiple docking windows of a docking manager instance the events must be propagated on basis of the active window. Only the active window should process action events. Applications can add supported window actions to the manager. There are several default actions defined like "Print" or "Find", but applications can also add specific actions only applicable to a special set of docking windows.

Besides the propagation of action events the involved GUI components must be asked whether the supported actions are currently enabled or not. For instance the "Print" action must be disabled if a tree has no current selection. Docking windows can register for certain window actions supported by the manager (and of course by the application). As long as a docking window is the active window the manager can give control over to that window which now has the chance to enable or disable the involved action components. This allows for a consistent and performance efficient handling of GUI events.

Since:

1.6

Version:

$Revision: 1.11 $, $Date: 2012/12/28 11:44:25 $

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
protected SharedAction[]	actions The shared actions to be controlled by the delegate.
protected java.util.Hashtable<java.lang.String,SharedAction>	cacheActionByName Remembers the tab IDs.
protected ActionDelegate	delegate Instance responsible for processing shared actions.

Constructor Summary

Constructors

Constructor and Description
ActionManager() Constructor for the action manager.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e) Reacts on component interaction.
void	addAction(SharedAction action) Adds a new action to be managed.
protected void	finalize() Clean-up method to help the gc.
SharedAction	getAction(java.lang.String name) Adds a new action to be managed.
SharedAction	removeAction(SharedAction action) Removes an action.
SharedAction	removeAction(java.lang.String name) Removes an action.
void	setDelegate(ActionDelegate delegate) Sets the instance responsible for processing shared actions.

Methods inherited from class java.lang.Object

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

Field Detail

cacheActionByName

protected java.util.Hashtable<java.lang.String,SharedAction> cacheActionByName

Remembers the tab IDs.

delegate

protected ActionDelegate delegate

Instance responsible for processing shared actions.

actions

protected SharedAction[] actions

The shared actions to be controlled by the delegate.

Constructor Detail

ActionManager

public ActionManager()

Constructor for the action manager.

Since:

1.6

Method Detail

finalize

protected void finalize()
                 throws java.lang.Throwable

Clean-up method to help the gc.

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

Since:

1.6

addAction

public void addAction(SharedAction action)

Adds a new action to be managed.

Parameters:

action - The new action to be added

Throws:

java.lang.NullPointerException - If parameter or action name is null

Since:

1.6

removeAction

public SharedAction removeAction(java.lang.String name)

Removes an action.

Parameters:

name - The action name

Returns:

The removed action, null if not removed

Throws:

java.lang.NullPointerException - If parameter is null

Since:

1.6

removeAction

public SharedAction removeAction(SharedAction action)

Removes an action.

Parameters:

action - The action

Returns:

The removed action, null if not removed

Throws:

java.lang.NullPointerException - If parameter is null

Since:

1.6

getAction

public SharedAction getAction(java.lang.String name)

Adds a new action to be managed.

Parameters:

name - The action name

Returns:

Managed action, null if not managed

Throws:

java.lang.NullPointerException - If action name is null

Since:

1.6

setDelegate

public void setDelegate(ActionDelegate delegate)

Sets the instance responsible for processing shared actions.

Once a delegate is set it receives control over the action components. Control ends when another delegate is activated or reset by a null parameter. If one the action components is clicked then the delegate is advised to process the action.

Parameters:

delegate - The delegate instance, null deactives control

Since:

1.6

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Reacts on component interaction.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Parameters:

e - Event to be processed

Since:

1.6