Java Swing KeyStroke registerKeystroke(final JComponent aComponent, final Action aAction, final String aCommandName)

Description

Registers the keystroke of the given action as "command" of the given component.

License

Open Source License

Parameter

Parameter	Description
aComponent	the component that should react on the keystroke, cannot be <code>null</code>;
aAction	the action of the keystroke, cannot be <code>null</code>;
aCommandName	the name of the command to register the keystore under.

Declaration

public static void registerKeystroke(final JComponent aComponent, final Action aAction,
        final String aCommandName) 

Method Source Code

//package com.java2s;
/*/*  w  w w  . j  a  v  a  2 s.com*/
 * OpenBench LogicSniffer / SUMP project
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or (at
 * your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
 *
 * 
 * Copyright (C) 2010-2011 - J.W. Janssen, http://www.lxtreme.nl
 */

import javax.swing.*;

public class Main {
    /**
     * Registers the keystroke of the given action as "command" of the given
     * component.
     * <p>
     * This code is based on the Sulky-tools, found at
     * &lt;http://github.com/huxi/sulky&gt;.
     * </p>
     * 
     * @param aComponent
     *          the component that should react on the keystroke, cannot be
     *          <code>null</code>;
     * @param aAction
     *          the action of the keystroke, cannot be <code>null</code>;
     * @param aCommandName
     *          the name of the command to register the keystore under.
     */
    public static void registerKeystroke(final JComponent aComponent, final Action aAction,
            final String aCommandName) {
        final KeyStroke keyStroke = (KeyStroke) aAction.getValue(Action.ACCELERATOR_KEY);
        if (keyStroke == null) {
            return;
        }

        InputMap inputMap = aComponent.getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW);
        ActionMap actionMap = aComponent.getActionMap();
        inputMap.put(keyStroke, aCommandName);
        actionMap.put(aCommandName, aAction);

        inputMap = aComponent.getInputMap(JComponent.WHEN_FOCUSED);
        Object value = inputMap.get(keyStroke);
        if (value != null) {
            inputMap.put(keyStroke, aCommandName);
        }

        inputMap = aComponent.getInputMap(JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT);
        value = inputMap.get(keyStroke);
        if (value != null) {
            inputMap.put(keyStroke, aCommandName);
        }
    }
}

Related

1. registerAction(JComponent component, int condition, KeyStroke key, Action action, String command)
2. registerAsAction(final KeyStroke keyStroke, final String actionKey, final Runnable action, final JComponent component)
3. registerKeyBinding(final JComponent aComponent, final String aKeyStroke, final Action aAction)
4. registerKeyBoardAction(JComponent comp, Action action, KeyStroke stroke)
5. registerKeyHandler(JComponent component, KeyStroke stroke, final ActionListener listener, final String actionCommand)
6. registerTabKey(Container container)
7. removeAcceleratorFromChildren(Container container, KeyStroke accelerator)
8. removeAcceleratorFromComponent(JComponent component, KeyStroke accelerator)
9. removeAcceleratorFromMap(InputMap map, KeyStroke accelerator)