Java Swing KeyStroke removeAcceleratorFromChildren(Container container, KeyStroke accelerator)

Description

Removes the specified keystroke form the input mappings of all JComponent subcomponents of the specified container.

License

Open Source License

Parameter

Parameter	Description
container	the container whose children will have the accelerator removed. The container itself does not lose the mappings it has for the accelerator.
accelerator	the accelerator to remove.

Declaration

private static void removeAcceleratorFromChildren(Container container, KeyStroke accelerator) 

Method Source Code

//package com.java2s;
/*//from w ww.  j  a  v  a  2  s.c  om
 * 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.InputMap;

import javax.swing.JComponent;

import javax.swing.KeyStroke;

public class Main {
    /**
     * 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);
        }
    }
}

Related

1. registerKeyBinding(final JComponent aComponent, final String aKeyStroke, final Action aAction)
2. registerKeyBoardAction(JComponent comp, Action action, KeyStroke stroke)
3. registerKeyHandler(JComponent component, KeyStroke stroke, final ActionListener listener, final String actionCommand)
4. registerKeystroke(final JComponent aComponent, final Action aAction, final String aCommandName)
5. registerTabKey(Container container)
6. removeAcceleratorFromComponent(JComponent component, KeyStroke accelerator)
7. removeAcceleratorFromMap(InputMap map, KeyStroke accelerator)
8. removeButtonClickKeystroke(AbstractButton b, KeyStroke key)
9. removeKeyBinding(JComponent component, String key)