com.jidesoft.swing

Class DelegateAction

java.lang.Object

javax.swing.AbstractAction

com.jidesoft.swing.DelegateAction

All Implemented Interfaces:

ActionListener, Serializable, Cloneable, EventListener, Action

Direct Known Subclasses:

DelegateAction.PassthroughDelegateAction

public abstract class DelegateAction
extends AbstractAction

DelegateAction is a special AbstractAction which can do something then delegate to another action depending on the return value of delegateActionPerformed(java.awt.event.ActionEvent). There are two usages of it. First, you can use replaceAction(javax.swing.JComponent, int, javax.swing.KeyStroke, DelegateAction) to replace the action associated with the specified keystroke with the DelegateAction. The DelegateAction will be triggered when the keystroke is pressed. After DelegateAction is done, it can return true or false. If false, the original action associated with the keystroke will be triggered as well. This solves the problem that JComponent.registerKeyboardAction(java.awt.event.ActionListener, String, javax.swing.KeyStroke, int) will replace the original action so that the original action will never be triggered.

The second way to use DelegateAction is to delegate the action from one component to another component using replaceAction(javax.swing.JComponent, int, javax.swing.JComponent, int, javax.swing.KeyStroke, DelegateAction). In this case, the keystroke on the first component parameter will be triggered the DelegateAction. If DelegateAction returns false, the registered action on the second component parameter will be triggered. If you pass in DelegateAction.PassthroughDelegateAction, the registered action on the second component will always be triggered.

Please notes, if you call replaceAction several times on the same component with the same keystroke, it will form a chain of DelegateActions. In this case, the first call will be the first DelegateAction. In the other words, the first one will have the highest priority and will be triggered first. Ideally, we should assign a priority to each DelegateAction. But for the sake of simplicity, we decided not doing it for now. So because of this, this class is not ready to be used as public API. We have to make it public because different packages in JIDE need to use it. If you want to use, please use it with caution. We don't guarantee that we will not change the public methods on this classes.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DelegateAction.PassthroughDelegateAction

Field Summary

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
DelegateAction()
DelegateAction(Action action)
DelegateAction(Action action, JComponent target)

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent e)
abstract boolean	delegateActionPerformed(ActionEvent e) Performs an action.
protected Action	getAction()
protected JComponent	getTarget()
boolean	isDelegateEnabled() Checks if an action can be performed.
boolean	isEnabled() Returns true if either delegateIsEnabled or the action is enabled.
static void	replaceAction(JComponent component, int condition, JComponent target, int targetCondition, KeyStroke keyStroke)
static void	replaceAction(JComponent component, int condition, JComponent target, int targetCondition, KeyStroke keyStroke, DelegateAction delegateAction)
static void	replaceAction(JComponent component, int condition, JComponent target, int targetCondition, KeyStroke keyStroke, DelegateAction delegateAction, boolean first)
static void	replaceAction(JComponent component, int condition, KeyStroke keyStroke, DelegateAction delegateAction)
static void	replaceAction(JComponent component, int condition, KeyStroke keyStroke, DelegateAction delegateAction, boolean first)
static void	restoreAction(JComponent component, int condition, KeyStroke keyStroke)
static void	restoreAction(JComponent component, int condition, KeyStroke keyStroke, Action actionToBeRemoved)
static void	restoreAction(JComponent component, int condition, KeyStroke keyStroke, Class<?> actionClass)
protected void	setAction(Action action)
protected void	setTarget(JComponent target)

Methods inherited from class javax.swing.AbstractAction

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DelegateAction

public DelegateAction()

DelegateAction

public DelegateAction(Action action)

DelegateAction

public DelegateAction(Action action,
              JComponent target)

Method Detail

isEnabled

public boolean isEnabled()

Returns true if either delegateIsEnabled or the action is enabled.

Specified by:

isEnabled in interface Action

Overrides:

isEnabled in class AbstractAction

actionPerformed

public final void actionPerformed(ActionEvent e)

getAction

protected Action getAction()

setAction

protected void setAction(Action action)

getTarget

protected JComponent getTarget()

setTarget

protected void setTarget(JComponent target)

isDelegateEnabled

public boolean isDelegateEnabled()

Checks if an action can be performed. Returns true if delegateActionPerformed would perform an action. Otherwise returns false.

Returns:

true if the action can be performed.

delegateActionPerformed

public abstract boolean delegateActionPerformed(ActionEvent e)

Performs an action. Returns true if no further action should be taken for this keystroke. Otherwise, returns false.

Parameters:

e - the action event.

Returns:

true if no further action should be taken for this keystroke. Otherwise, returns false.

replaceAction

public static void replaceAction(JComponent component,
                 int condition,
                 KeyStroke keyStroke,
                 DelegateAction delegateAction)

replaceAction

public static void replaceAction(JComponent component,
                 int condition,
                 KeyStroke keyStroke,
                 DelegateAction delegateAction,
                 boolean first)

replaceAction

public static void replaceAction(JComponent component,
                 int condition,
                 JComponent target,
                 int targetCondition,
                 KeyStroke keyStroke)

replaceAction

public static void replaceAction(JComponent component,
                 int condition,
                 JComponent target,
                 int targetCondition,
                 KeyStroke keyStroke,
                 DelegateAction delegateAction)

replaceAction

public static void replaceAction(JComponent component,
                 int condition,
                 JComponent target,
                 int targetCondition,
                 KeyStroke keyStroke,
                 DelegateAction delegateAction,
                 boolean first)

restoreAction

public static void restoreAction(JComponent component,
                 int condition,
                 KeyStroke keyStroke)

restoreAction

public static void restoreAction(JComponent component,
                 int condition,
                 KeyStroke keyStroke,
                 Class<?> actionClass)

restoreAction

public static void restoreAction(JComponent component,
                 int condition,
                 KeyStroke keyStroke,
                 Action actionToBeRemoved)