org.fest.swing.keystroke

Class KeyStrokeMappingsParser

java.lang.Object

org.fest.swing.keystroke.KeyStrokeMappingsParser

public class KeyStrokeMappingsParser
extends Object

Understands creation of KeyStrokeMappings by parsing a text file.

Mappings for the following characters:

• Backspace
• Delete
• Enter
• Escape
• Tab

will be automatically added and should not be included to the file to parse.

The following is an example of a mapping file:

 a, A, NO_MASK
 A, A, SHIFT_MASK
 COMMA, COMMA, NO_MASK
 

Each line represents a character-keystroke mapping where each value is separated by a comma.

The first value represents the character to map. For example 'a' or 'A'. Since each field is separated by a comma, to map the ',' character we need to specify the text "COMMA."

The second value represents the key code, which should be the name of a key code from KeyEvent without the prefix "VK_". For example, if the key code is KeyEvent.VK_COMMA we just need to specify "COMMA".

The third value represents any modifiers to use, which should be the name of a modifier from InputEvent. For example, if the modifier to use is InputEvent.SHIFT_MASK we need to specify "SHIFT_MASK". If no modifiers are necessary, we just specify "NO_MASK".

Since:

1.2

Author:

Olivier DOREMIEUX, Alex Ruiz

Constructor Summary

Constructors

Constructor and Description
KeyStrokeMappingsParser()

Method Summary

Methods

Modifier and Type	Method and Description
KeyStrokeMappingProvider	parse(File file) Creates a KeyStrokeMappingProvider containing all the character-keystroke mappings specified in the given file.
KeyStrokeMappingProvider	parse(String file) Creates a KeyStrokeMappingProvider containing all the character-keystroke mappings specified in the file with the given name.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyStrokeMappingsParser

public KeyStrokeMappingsParser()

Method Detail

parse

public KeyStrokeMappingProvider parse(String file)

Creates a KeyStrokeMappingProvider containing all the character-keystroke mappings specified in the file with the given name.

Note: This attempts to read the file using ClassLoader.getResourceAsStream(String).

Parameters:

file - the name of the file to parse.

Returns:

the created KeyStrokeMappingProvider.

Throws:

NullPointerException - if the given name is null.

IllegalArgumentException - if the given name is empty.

ParsingException - if any error occurs during parsing.

See Also:

parse(File)

parse

public KeyStrokeMappingProvider parse(File file)

Creates a KeyStrokeMappingProvider containing all the character-keystroke mappings specified in the given file.

Parameters:

file - the file to parse.

Returns:

the created KeyStrokeMappingProvider.

Throws:

NullPointerException - if the given file is null.

IllegalArgumentException - if the given file does not represent an existing file.

ParsingException - if any error occurs during parsing.