com.objogate.wl.swing.gesture.MappedKeyStrokeProbe Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of windowlicker-swing Show documentation
This is the Windowlicker Swing library.
The newest version!
package com.objogate.wl.swing.gesture;

import javax.swing.InputMap;
import javax.swing.JComponent;
import javax.swing.KeyStroke;
import java.util.Comparator;
import java.util.SortedSet;
import java.util.TreeMap;
import java.util.TreeSet;
import org.hamcrest.Description;
import com.objogate.wl.Probe;
import com.objogate.wl.swing.ComponentSelector;

public class MappedKeyStrokeProbe implements Probe {
    private final ComponentSelector componentSelector;
    private final int inputMapId;
    private final Object actionName;

    public KeyStroke mappedKeyStroke = null;

    public MappedKeyStrokeProbe(ComponentSelector componentSelector, int inputMapId, Object actionName) {
		this.actionName = actionName;
        this.componentSelector = componentSelector;
        this.inputMapId = inputMapId;
    }

	public void probe() {
        componentSelector.probe();
        
        if (componentSelector.isSatisfied()) {
        	JComponent component = componentSelector.component();
        	mappedKeyStroke = preferredKeyStrokeBoundToAction(component);
        }
	}

    // Pick key strokes with lower valued key codes because higher key codes seem to be used for obscure keyboards
    // like the cut/copy/paste keys that only exist on old Sun keyboards.
	private KeyStroke preferredKeyStrokeBoundToAction(JComponent component) {
        TreeMap> invertedInputMap = invertInputMap(component.getInputMap(inputMapId));
        
        if (invertedInputMap.containsKey(actionName)) {
            return invertedInputMap.get(actionName).first();
        }
        else {
            return null;
        }
	}

    public boolean isSatisfied() {
		return mappedKeyStroke != null;
	}

	public void describeTo(Description description) {
		description.appendText(" key stroke for action ")
				   .appendValue(actionName);
	}

	public void describeFailureTo(Description description) {
        componentSelector.describeFailureTo(description);
        if (componentSelector.isSatisfied()) {
            description.appendText(" action not bound to any keystroke");
        }
	}
    
    public static TreeMap> invertInputMap(InputMap inputMap) {
        TreeMap> inverse = new TreeMap>();
        
        for (KeyStroke keyStroke : allKeysIn(inputMap)) {
            Object name = inputMap.get(keyStroke);

            SortedSet keyStrokesForName = inverse.get(name);
            if (keyStrokesForName == null) {
                keyStrokesForName = new TreeSet(new SortedByKeyCodeValue());
                inverse.put(name, keyStrokesForName);
            }

            keyStrokesForName.add(keyStroke);
        }
        
        return inverse;
    }

    private static KeyStroke[] allKeysIn(InputMap inputMap) {
        KeyStroke[] allKeys = inputMap.allKeys(); // Might be null -- crap API
        return allKeys == null ? new KeyStroke[0] : allKeys;
    }

    private static class SortedByKeyCodeValue implements Comparator {
        public int compare(KeyStroke o1, KeyStroke o2) {
            return new Integer(o1.getKeyCode()).compareTo(o2.getKeyCode());
        }
    }
}