net.sf.cuf.ui

Class DispatcherAction

java.lang.Object

javax.swing.AbstractAction

net.sf.cuf.ui.DispatcherAction

All Implemented Interfaces:

ActionListener, Serializable, Cloneable, EventListener, Action

public class DispatcherAction
extends AbstractAction

This class offers the Action benefits and also acts as a dispatcher. It is most useful in the context of SwingXMLBuilder, and if there are e.g. both toolbar and menu entries for one action.
DispatcherAction also adds support for "selected" buttons (through a shared ButtonModel).

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected EventListenerList	mListenerList A list of event listeners for this component.
protected Object	mRealSource Null or the "real" source of an ActionEvent, only set during the event delivery.
static String	TOGGLE_MODEL Key we store the ButtonModel into.

Fields inherited from class javax.swing.AbstractAction

changeSupport, enabled

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

Constructor Summary

Constructors

Constructor and Description
DispatcherAction() Default constuctor, this will create a non menubar/toolbar action, useful for pure dispatching.
DispatcherAction(String pEntryText, String pEntryAccelerator, String pEntryMnemonic, String pEntryTooltip, Icon pIcon, boolean pIsToggle) Create a dispatcher action with the handed information.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent pEvent) Callback method of our visual representations, dispatch the action to our listeners.
void	addActionListener(ActionListener pListener) Adds an ActionListener to the dispatcher.
String	getEntryAccelerator() Returns the entry accelerator.
Icon	getEntryIcon() Returns the (relativ) entry icon name.
String	getEntryMnemonic() Returns the entry mnemonic.
String	getEntryText() Returns the name of the entry for this action.
Object	getRealSource() Due to the way SwingConnectionManager works, we must change the source of the action event during callback.
ButtonModel	getToggleModel() Returns null if isToggle() is false, otherwise a ButtonModel for the toggle state.
String	getTooltip() Returns the tool tip for the entry.
boolean	isSelected() Returns the toggle state of our toggle model, always false if we are not toggable.
boolean	isToggle() Returns whether or not this action acts as a toggle entry.
void	removeActionListener(ActionListener pListener) Removes an ActionListener from the button.
void	setEnabled(boolean pNewValue) Enables or disables the action.
void	setSelected(boolean pSelected) Sets the toggle state of our button model, does nothing if we are not toggable.

Methods inherited from class javax.swing.AbstractAction

addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener

Methods inherited from class java.lang.Object

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

Field Detail

TOGGLE_MODEL

public static final String TOGGLE_MODEL

Key we store the ButtonModel into.

See Also:

Constant Field Values

mListenerList

protected EventListenerList mListenerList

A list of event listeners for this component.

mRealSource

protected Object mRealSource

Null or the "real" source of an ActionEvent, only set during the event delivery.

Constructor Detail

DispatcherAction

public DispatcherAction()

Default constuctor, this will create a non menubar/toolbar action, useful for pure dispatching.

DispatcherAction

public DispatcherAction(String pEntryText,
                String pEntryAccelerator,
                String pEntryMnemonic,
                String pEntryTooltip,
                Icon pIcon,
                boolean pIsToggle)

Create a dispatcher action with the handed information.

Parameters:

pEntryText - null or the text of the action

pEntryAccelerator - null or the action accelerator

pEntryMnemonic - null or the action mnemonic, the first character is used after converting it to upper case

pEntryTooltip - null or the action tooltip

pIcon - null or the action icon

pIsToggle - true if this is a toggle action

Throws:

IllegalArgumentException - if pEntryText is null

Method Detail

getEntryText

public String getEntryText()

Returns the name of the entry for this action.

Returns:

null or entry name

getEntryAccelerator

public String getEntryAccelerator()

Returns the entry accelerator.

Returns:

null or entry accelerator

getEntryMnemonic

public String getEntryMnemonic()

Returns the entry mnemonic.

Returns:

null or entry mnemonic

getTooltip

public String getTooltip()

Returns the tool tip for the entry.

Returns:

null or entry tool tip

getEntryIcon

public Icon getEntryIcon()

Returns the (relativ) entry icon name.

Returns:

null or entry icon

isToggle

public boolean isToggle()

Returns whether or not this action acts as a toggle entry.

Returns:

true if this action is a toggle action

getToggleModel

public ButtonModel getToggleModel()

Returns null if isToggle() is false, otherwise a ButtonModel for the toggle state.

Returns:

null or a toggle model for this action

setEnabled

public void setEnabled(boolean pNewValue)

Enables or disables the action.

Specified by:

setEnabled in interface Action

Overrides:

setEnabled in class AbstractAction

Parameters:

pNewValue - true to enable the action, false to disable it

See Also:

AbstractAction.setEnabled(boolean)

isSelected

public boolean isSelected()

Returns the toggle state of our toggle model, always false if we are not toggable.

Returns:

true if the toggle model is selected, false otherwise

setSelected

public void setSelected(boolean pSelected)

Sets the toggle state of our button model, does nothing if we are not toggable.

Parameters:

pSelected - new state

actionPerformed

public void actionPerformed(ActionEvent pEvent)

Callback method of our visual representations, dispatch the action to our listeners.

Parameters:

pEvent - the event describing the action

addActionListener

public void addActionListener(ActionListener pListener)

Adds an ActionListener to the dispatcher.

Parameters:

pListener - the ActionListener to be added

removeActionListener

public void removeActionListener(ActionListener pListener)

Removes an ActionListener from the button. If the listener is the currently set Action for the button, then the Action is set to null.

Parameters:

pListener - the ActionListener to be removed

getRealSource

public Object getRealSource()

Due to the way SwingConnectionManager works, we must change the source of the action event during callback. This method provides the "real" source of the event.

Returns:

null or the real source of the ActionEvent currently delivered