Java Swing KeyStroke setGlobalAccelerator(JComponent component, KeyStroke accelerator, Action action)

Description

Sets an accelerator for all subcomponents of the specified JComponent .

License

Open Source License

Parameter

Parameter	Description
component	the base component to set the accelerator for. If any of the components in the subtree of this one have a mapping for the accelerator, the mapping is removed from their user InputMap and parent InputMap (set by the LAF).
accelerator	the keystroke that activates the accelerator.
action	the action that is performed when the keystroke activates it.

Declaration

public static void setGlobalAccelerator(JComponent component, KeyStroke accelerator, Action action)

Method Source Code

//package com.java2s;
/*//from   w w w .ja  va2  s .co m
 * SwingUtilities.java (Class: com.madphysicist.tools.swing.SwingUtilities)
 *
 * Mad Physicist JTools Project (Swing Utilities)
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2013 by Joseph Fox-Rabinovitz
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

import java.awt.Component;
import java.awt.Container;

import javax.swing.Action;
import javax.swing.InputMap;

import javax.swing.JComponent;

import javax.swing.KeyStroke;

public class Main {
    /**
     * Sets an accelerator for all subcomponents of the specified {@code
     * JComponent}. This method can be run on the {@code RootPane} of a window
     * to set the accelerator globally for the window. Note that this method
     * can override the default behavior of the current look-and-feel, in which
     * case the accelerator it sets may be deactivated when the look-and-feel
     * changes.
     *
     * @param component the base component to set the accelerator for. If any of
     * the components in the subtree of this one have a mapping for the
     * accelerator, the mapping is removed from their user {@code InputMap} and
     * parent {@code InputMap} (set by the LAF).
     * @param accelerator the keystroke that activates the accelerator.
     * @param action the action that is performed when the keystroke activates
     * it.
     * @since 1.1.1
     */
    public static void setGlobalAccelerator(JComponent component, KeyStroke accelerator, Action action) {
        Object actionCommand = action.getValue(Action.ACTION_COMMAND_KEY);
        if (actionCommand == null) {
            actionCommand = action.getValue(Action.NAME);
        }
        component.getInputMap(JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT).put(accelerator, actionCommand);
        component.getActionMap().put(actionCommand, action);
        removeAcceleratorFromChildren(component, accelerator);
    }

    /**
     * Removes the specified keystroke form the input mappings of all {@code
     * JComponent} subcomponents of the specified container. This method is
     * recursive: all subcomponents that are also {@code Container}s are
     * processed.
     *
     * @param container the container whose children will have the accelerator
     * removed. The container itself does not lose the mappings it has for the
     * accelerator.
     * @param accelerator the accelerator to remove.
     * @since 1.1.1
     */
    private static void removeAcceleratorFromChildren(Container container, KeyStroke accelerator) {
        for (Component child : container.getComponents()) {
            if (child instanceof JComponent) {
                removeAcceleratorFromComponent((JComponent) child, accelerator);
            }
            if (child instanceof Container) {
                removeAcceleratorFromChildren((Container) child, accelerator);
            }
        }
    }

    /**
     * Removes the specified key mapping from a component. The mapping is
     * removed from all input maps and parent input maps. This affects the
     * behavior of the look-and-feel in some cases. The parent mappings will be
     * reinstated if the look-and-feel changes after this method is invoked.
     *
     * @param component the component to remove the mapping from.
     * @param accelerator the keystroke to remove.
     * @since 1.1.1
     */
    private static void removeAcceleratorFromComponent(JComponent component, KeyStroke accelerator) {
        removeAcceleratorFromMap(component.getInputMap(JComponent.WHEN_FOCUSED), accelerator);
        removeAcceleratorFromMap(component.getInputMap(JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT), accelerator);
        removeAcceleratorFromMap(component.getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW), accelerator);
    }

    /**
     * Removes a keystroke from an input map and its parent map.
     *
     * @param map the map to remove the keystroke from.
     * @param accelerator the keystroke to remove.
     * @since 1.1.1
     */
    private static void removeAcceleratorFromMap(InputMap map, KeyStroke accelerator) {
        map.remove(accelerator);
        InputMap parent = map.getParent();
        if (parent != null) {
            parent.remove(accelerator);
        }
    }
}

Java Swing KeyStroke setGlobalAccelerator(JComponent component, KeyStroke accelerator, Action action)

Description

License

Parameter

Declaration

Method Source Code

Related