edu.xtec.util

Class Actions

java.lang.Object

edu.xtec.util.Actions

public abstract class Actions
extends Object

Miscellaneous utilities for managing Action objects. EXAMPLES: Creation of a new action, with reference to a original key: AbstractAction beginAction=new AbstractAction(DefaultEditorKit.beginAction){ public void actionPerformed(ActionEvent e){ // ... } }; Creation of a new action, with a new key: AbstractAction prevTargetAction=new AbstractAction("prev-target"){ public void actionPerformed(ActionEvent e){ // ... } }; Action that references an existing one: Action kitUpAction=null; AbstractAction upAction=new AbstractAction(DefaultEditorKit.upAction){ public void actionPerformed(ActionEvent e){ if(kitUpAction!=null){ // .... pre-action kitUpAction.actionPerformed(e); // .... post-action } } }; Actions mapping: protected void setActions(){ // get existing actions: kitUpAction=getActionMap().get(DefaultEditorKit.upAction); // actionKeys init: java.util.HashMap actionKeys=Actions.getActionKeys(this); // build new ActionMap: ActionMap am=new ActionMap(); am.setParent(getActionMap()); setActionMap(am); //Actions derived to trace (only for debug purposes): Actions.mapTraceAction(this, actionKeys, DefaultEditorKit.readOnlyAction); Actions.mapTraceAction(this, actionKeys, DefaultEditorKit.writableAction); Actions.mapTraceAction(this, actionKeys, "requestFocus"); Actions.mapTraceAction(this, actionKeys, "toggle-componentOrientation"); //Actions to disable: Actions.mapNullAction(this, actionKeys, DefaultEditorKit.beepAction); //New actions: Actions.mapAction(this, actionKeys, beginAction); Actions.mapAction(this, actionKeys, upAction); //Original actions mapped to other methods: Actions.mapAction(this, actionKeys, beginAction, DefaultEditorKit.previousWordAction); Actions.mapAction(this, actionKeys, prevTargetAction, DefaultEditorKit.beginParagraphAction); //Uncomment this line only if you want to hide all other actions: //am.setParent(null); // // Assign keystrokes to a new action: getInputMap().put(KeyStroke.getKeyStroke(java.awt.event.KeyEvent.VK_TAB, java.awt.Event.SHIFT_MASK), prevTargetAction.getValue(Action.NAME)); }

Version:

13.08.08

Author:

Francesc Busquets (fbusquets@xtec.cat)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Actions.NullAction
static class	Actions.TraceAction

Constructor Summary

Constructors

Constructor and Description
Actions()

Method Summary

Methods

Modifier and Type	Method and Description
static void	dumpActionKeys(Map<String,Object[]> actionKeys, ActionMap am) This function is for debug purposes only.
static Map<String,Object[]>	getActionKeys(JComponent jc) Collects the keys of all the actions linked to a specific JComponent and groups them in arrays by action names.
static void	mapAction(JComponent jc, Map<String,Object[]> actionKeys, Action act)
static void	mapAction(JComponent jc, Map<String,Object[]> actionKeys, Action act, String key)
static void	mapNullAction(JComponent jc, Map<String,Object[]> actionKeys, String s)
static void	mapTraceAction(JComponent jc, Map<String,Object[]> actionKeys, String s)
static void	traceHierarchy(Component cmp, int level)

Methods inherited from class java.lang.Object

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

Constructor Detail

Actions

public Actions()

Method Detail

getActionKeys

public static Map<String,Object[]> getActionKeys(JComponent jc)

Collects the keys of all the actions linked to a specific JComponent and groups them in arrays by action names.

Parameters:

jc - The JComponent with the actions linked to.

Returns:

A HashMap formed by pairs of action names (key) and arrays of action keys (value). Usually each action name has only one action key associated to it, and the value of the pair is an object array with only one string, but this is not an imperative: several actions can be associated to a single name.

dumpActionKeys

public static void dumpActionKeys(Map<String,Object[]> actionKeys,
                  ActionMap am)

This function is for debug purposes only. Prints out the

Parameters:

actionKeys -

am -

mapAction

public static void mapAction(JComponent jc,
             Map<String,Object[]> actionKeys,
             Action act)

mapAction

public static void mapAction(JComponent jc,
             Map<String,Object[]> actionKeys,
             Action act,
             String key)

mapNullAction

public static void mapNullAction(JComponent jc,
                 Map<String,Object[]> actionKeys,
                 String s)

mapTraceAction

public static void mapTraceAction(JComponent jc,
                  Map<String,Object[]> actionKeys,
                  String s)

traceHierarchy

public static void traceHierarchy(Component cmp,
                  int level)