Package org.fest.swing.keystroke

Class KeyStrokeMap

java.lang.Object

org.fest.swing.keystroke.KeyStrokeMap

public class KeyStrokeMap
extends Object

Understands a collection of KeyStrokeMapping.

Field Summary

Fields

Modifier and Type	Field	Description
private static KeyStrokeMapCollection	maps

Constructor Summary

Constructors

Modifier	Constructor	Description
private	KeyStrokeMap()

Method Summary

Modifier and Type	Method	Description
private static void	add(Character character, KeyStroke keyStroke)
static void	addKeyStrokesFrom(KeyStrokeMappingProvider provider)	Adds the collection of KeyStrokeMappings from the given KeyStrokeMappingProvider to this map.
static char	charFor(KeyStroke keyStroke)	Given a KeyStroke, returns the equivalent character.
private static Character	charWithoutModifiersButShift(KeyStroke keyStroke)
static void	clearKeyStrokes()	Removes all the character-KeyStroke mappings.
static boolean	hasKeyStrokes()	Indicates whether KeyStrokeMap has mappings or not.
static KeyStroke	keyStrokeFor(char character)	Returns the KeyStroke corresponding to the given character, as best we can guess it, or null if we don't know how to generate it.
static void	reloadFromLocale()	Deprecated. use reloadFromSystemSettings() instead.
static void	reloadFromSystemSettings()	Reloads the key stroke mappings for the language using the current system settings.
(package private) static void	updateKeyStrokeMapCollection(KeyStrokeMapCollection c)

Methods inherited from class java.lang.Object

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

Field Details

maps

private static KeyStrokeMapCollection maps

Constructor Details

KeyStrokeMap

private KeyStrokeMap()

Method Details

reloadFromLocale

@Deprecated
public static void reloadFromLocale()

Deprecated.

use reloadFromSystemSettings() instead.

Reloads the key stroke mappings for the language from the default locale.

reloadFromSystemSettings

public static void reloadFromSystemSettings()

Reloads the key stroke mappings for the language using the current system settings.

Since:

1.2

updateKeyStrokeMapCollection

static void updateKeyStrokeMapCollection(KeyStrokeMapCollection c)

addKeyStrokesFrom

public static void addKeyStrokesFrom(KeyStrokeMappingProvider provider)

Adds the collection of KeyStrokeMappings from the given KeyStrokeMappingProvider to this map.

Parameters:

provider - the given KeyStrokeMappingProvider.

add

private static void add(Character character,
 KeyStroke keyStroke)

clearKeyStrokes

public static void clearKeyStrokes()

Removes all the character-KeyStroke mappings.

hasKeyStrokes

public static boolean hasKeyStrokes()

Indicates whether KeyStrokeMap has mappings or not.

Returns:

true if it has mappings, false otherwise.

keyStrokeFor

public static KeyStroke keyStrokeFor(char character)

Returns the KeyStroke corresponding to the given character, as best we can guess it, or null if we don't know how to generate it.

Parameters:

character - the given character.

Returns:

the key code-based KeyStroke corresponding to the given character, or null if we cannot generate it.

charFor

public static char charFor(KeyStroke keyStroke)

Given a KeyStroke, returns the equivalent character. Key strokes are defined properly for US keyboards only. To contribute your own, please add them using the method addKeyStrokesFrom(KeyStrokeMappingProvider).

Parameters:

keyStroke - the given KeyStroke.

Returns:

KeyEvent.VK_UNDEFINED if the result is unknown.

charWithoutModifiersButShift

private static Character charWithoutModifiersButShift(KeyStroke keyStroke)