| java.lang.Object
 javax.swing.AbstractAction
com.jidesoft.swing.DelegateAction
| DelegateAction | | abstract public class DelegateAction extends AbstractAction (Code) | | DelegateAction is a special AbstractAction which can do something then delegate to another action depending on
the return value of
DelegateAction.delegateActionPerformed(java.awt.event.ActionEvent) .
There are two usages of it. First, you can use
DelegateAction.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.ActionListenerStringjavax.swing.KeyStrokeint) will replace the original action so that the original actino will never be triggered.
The second way to use DelegateAction is to delegate the action from one component to another component using
DelegateAction.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
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 priroty 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 gurantee that we will not change the public methods on this classes.
|
| Inner Class :public static class PassthroughDelegateAction extends DelegateAction | |
| Method Summary | |
| final public void | actionPerformed(ActionEvent e)
| | abstract public boolean | delegateActionPerformed(ActionEvent e)
Performs an action. | | protected Action | getAction()
| | protected JComponent | getTarget()
| | public static void | replaceAction(JComponent component, int condition, KeyStroke keyStroke, DelegateAction delegateAction)
| | public static void | replaceAction(JComponent component, int condition, KeyStroke keyStroke, DelegateAction delegateAction, boolean first)
| | public static void | replaceAction(JComponent component, int condition, JComponent target, int targetCondition, KeyStroke keyStroke)
| | public static void | replaceAction(JComponent component, int condition, JComponent target, int targetCondition, KeyStroke keyStroke, DelegateAction delegateAction)
| | public static void | replaceAction(JComponent component, int condition, JComponent target, int targetCondition, KeyStroke keyStroke, DelegateAction delegateAction, boolean first)
| | public static void | restoreAction(JComponent component, int condition, KeyStroke keyStroke)
| | public static void | restoreAction(JComponent component, int condition, KeyStroke keyStroke, Class actionClass)
| | public static void | restoreAction(JComponent component, int condition, KeyStroke keyStroke, Action actionToBeRemoved)
| | protected void | setAction(Action action)
| | protected void | setTarget(JComponent target)
|
| DelegateAction | | public DelegateAction()(Code) | | |
| delegateActionPerformed | | abstract public boolean delegateActionPerformed(ActionEvent e)(Code) | | Performs an action. Returns true if no further action should be taken for this keystroke. Otherwise, returns false.
Parameters:
e - the action event. true if no further action should be taken for this keystroke. Otherwise, returns false. |
|
|