+ * This class is used to define key strokes. + *
* - * @version $Revision: $ $Date: 11.07.2012$ - * @author 2012, last modified by $Author: patrick$ + * @version 1.0 + * @author Patrick Harms */ public class KeyStroke { - /** */ + /** + *+ * Name of the key stroke. + *
+ */ private String keyStrokeName; - /** */ + /** + *+ * {@link VirtualKey} associated with the key stroke. + *
+ */ private VirtualKey virtualKey; - /** */ + /** + *+ * Defines whether numlock is pressed during the stroke. + *
+ */ private boolean numlock; - /** */ + /** + *+ * Defines whether localstate is pressed during the stroke. + *
+ */ private boolean localstate; - /** */ + /** + *+ * Defines whether shift is pressed during the stroke. + *
+ */ private boolean shift; - /** */ + /** + *+ * Defines whether altgr is pressed during the stroke. + *
+ */ private boolean altgr; - /** */ + /** + *+ * Defines whether inhibit is pressed during the stroke. + *
+ */ private boolean inhibit; - /** */ + /** + *+ * Defines the character in which the key stroke results. + *
+ */ private char character; /** - * TODO: comment + *+ * Constructor. Creates a new key stroke + *
* * @param keyStrokeName - * @param mapKeyIdToVirtualKey + * name of the key stroke + * @param virtualKey + * virtual key associated with the key stroke * @param numlock + * defines whether numlock is pressed during the key stroke * @param localstate - * @param b + * defines whether localstate is pressed during the key stroke + * @param shift + * defines whether shift is pressed during the key stroke * @param altgr + * defines whether altgr is pressed during the key stroke * @param inhibit + * defines whether inhibit is pressed during the key stroke + * @param character + * defines that character in which the key stroke results */ public KeyStroke(String keyStrokeName, @@ -64,5 +110,9 @@ /** - * @return the keyStrokeName + *+ * Returns the name of the key stroke. + *
+ * + * @return the name */ public String getKeyStrokeName() { @@ -71,7 +121,9 @@ /** - * TODO: comment - * - * @return + *+ * Returns the virtual key associated with the key stroke. + *
+ * + * @return the virtual key */ public VirtualKey getVirtualKey() { @@ -80,7 +132,9 @@ /** - * TODO: comment - * - * @return + *+ * Returns the character in which the key stroke results. + *
+ * + * @return the character */ public char getCharacter() { @@ -89,7 +143,9 @@ /** - * TODO: comment - * - * @return + *+ * Returns whether inhibit is pressed. + *
+ * + * @return true if pressed; false otherwise */ public boolean getInhibit() { @@ -98,7 +154,9 @@ /** - * TODO: comment - * - * @return + *+ * Returns whether altgr is pressed. + *
+ * + * @return true if pressed; false otherwise */ public boolean getAltgr() { @@ -107,7 +165,9 @@ /** - * TODO: comment - * - * @return + *+ * Returns whether shift is pressed. + *
+ * + * @return true if pressed; false otherwise */ public boolean getShift() { @@ -116,7 +176,9 @@ /** - * TODO: comment - * - * @return + *+ * Returns whether localstate is pressed. + *
+ * + * @return true if pressed; false otherwise */ public boolean getLocalstate() { @@ -125,7 +187,9 @@ /** - * TODO: comment - * - * @return + *+ * Returns whether numlock is pressed. + *
+ * + * @return true if pressed; false otherwise */ public boolean getNumlock() { Index: /trunk/quest-misc/src/main/java/de/ugoe/cs/tasktree/keyboardmaps/KeyboardMap.java =================================================================== --- /trunk/quest-misc/src/main/java/de/ugoe/cs/tasktree/keyboardmaps/KeyboardMap.java (revision 837) +++ /trunk/quest-misc/src/main/java/de/ugoe/cs/tasktree/keyboardmaps/KeyboardMap.java (revision 838) @@ -1,2 +1,3 @@ + package de.ugoe.cs.tasktree.keyboardmaps; @@ -16,28 +17,42 @@ /** - * TODO comment + *+ * Helper class that maps keyboard input based on a key map. + *
* - * @version $Revision: $ $Date: 11.07.2012$ - * @author 2012, last modified by $Author: patrick$ + * @version 1.0 + * @author Patrick Harms */ public class KeyboardMap { - /** */ + /** + *+ * Locale used for the mapping. + *
+ */ private Locale locale; - /** */ + /** + *+ * Name of the mappings-file. + *
+ */ private String fileName; - /** */ + /** + *+ * Map that defines which key strokes define a virtual key. + *
+ */ private Map+ * Creates a new KeyboardMap. + *
* * @param locale + * Locale that is used for the keyboard map */ KeyboardMap(Locale locale) { @@ -58,20 +73,26 @@ /** - * TODO: comment + *+ * Returns a character that is generated, given a {@link VirtualKey} is pressed while the + * respective modifiers are active. + *
* - * @param digit1 - * @param b - * @param c - * @param d - * @param e - * @param f - * @return + * @param key + * key that is pressed + * @param numlock + * true, if numlock is pressed; false otherwise + * @param shift + * true, if shift is pressed; false otherwise + * @param altgr + * true, if altgr is pressed; false otherwise + * @param inhibit + * true, if inhibit is pressed; false otherwise + * @return generated character */ public char getCharacterFor(VirtualKey key, - boolean numlock, - boolean shift, - boolean altgr, - boolean inhibit) - throws IllegalArgumentException + boolean numlock, + boolean shift, + boolean altgr, + boolean inhibit) { List+ * Initializes the keyboard map. + *
+ * + * @throws IllegalArgumentException thrown if there is a problem loading the keyboard map */ void init() throws IllegalArgumentException { @@ -115,24 +140,23 @@ Console.traceln(Level.FINER, "read " + keyStrokes.size() + " key strokes and " + - deadKeySequences.size() + " dead key sequences"); + deadKeySequences.size() + " dead key sequences"); VirtualKeySynonyms virtualKeySynonyms = determineVirtualKeySynonyms(keyStrokes); processKeyStrokes(keyStrokes, virtualKeySynonyms); - processDeadKeySequences(deadKeySequences); - - for (Object[] keyId : mKeyIds) { - System.out.println(Integer.toHexString((Integer) keyId[0]) + " " + keyId[1]); - } + // TODO still required? processDeadKeySequences(deadKeySequences); } /** - * TODO: comment + *+ * Returns a {@link InputStream} for a given filename. + *
* - * @param fileName - * @return + * @param name + * the filename + * @return the {@link InputStream} */ private InputStream getStream(String name) { - Console.traceln - (Level.FINER, "reading keymap for locale " + locale + " from resource keymaps/" + name); + Console.traceln(Level.FINER, "reading keymap for locale " + locale + + " from resource keymaps/" + name); InputStream stream = @@ -147,14 +171,20 @@ /** - * TODO: comment + *+ * Reads a keyboard map from a input stream. + *
* * @param stream - * @param virtualKeySynonyms + * input stream with the keyboard map * @param deadKeySequences + * the dead key sequences + * @param keyStrokes + * the keystrokes + * @throws IllegalArgumentException + * thrown if there is an error reading the keyboard map */ - private void readStream(InputStream stream, + private void readStream(InputStream stream, List+ * Processes a line of a keyboard map file. + *
* * @param line + * the line in the keyboard map file * @param deadKeySequences + * the dead key sequences + * @param keyStrokes + * the keystrokes */ - private void processLine(String line, - List+ * Determines synonyms for virtual keys for the keyboard map. + *
* * @param keyStrokes - * @return + * the keystrokes + * @return the synonyms */ private VirtualKeySynonyms determineVirtualKeySynonyms(List+ * Converts a hexadecimal Id that is contained in a string into the integer Id of the key. + *
* - * @param string - * @return + * @param keyIdString + * the Id string + * @return the Id as integer */ private int getKeyId(String keyIdString) { @@ -305,8 +345,12 @@ /** - * TODO: comment + *+ * Processes a list of key strokes. + *
* * @param keyStrokes + * the key strokes * @param virtualKeySynonyms + * synonyms of the involved virtual keys */ private void processKeyStrokes(List+ * Handles a key stroke. + *
* * @param values + * contains the name, string Id, and modifiers of the key stroke + * @param virtualKeySynonyms + * synonyms of the involved virtual keys */ private void handleKeyStroke(String[] values, VirtualKeySynonyms virtualKeySynonyms) { @@ -379,23 +428,35 @@ /** - * TODO: comment + *+ * Adds a key stroke and all synonyms to the keyboard map. + *
* * @param keyStrokeName + * name of the key stroke * @param keyId + * id of the key stroke * @param numlock + * true, if numlock is pressed; false otherwise * @param localstate + * true, if localstate is pressed; false otherwise * @param shift + * true, if shift is pressed; false otherwise * @param altgr + * true, if altgr is pressed; false otherwise * @param addupper + * true, if addupper is pressed; false otherwise * @param inhibit + * true, if inhibit is pressed; false otherwise + * @param virtualKeySynonyms + * synonyms of the involved virtual keys */ - private void addAllRepresentedKeyStrokes(String keyStrokeName, - int keyId, - boolean numlock, - boolean localstate, - boolean shift, - boolean altgr, - boolean addupper, - boolean inhibit, + private void addAllRepresentedKeyStrokes(String keyStrokeName, + int keyId, + boolean numlock, + boolean localstate, + boolean shift, + boolean altgr, + boolean addupper, + boolean inhibit, VirtualKeySynonyms virtualKeySynonyms) { @@ -404,7 +465,5 @@ if (virtualKeys == null) { Console.traceln(Level.SEVERE, "no virtual key mapped to key stroke " + keyStrokeName + - " of keyboard map for locale " + locale); - // throw new IllegalArgumentException("no keyboard map available for locale " + - // mLocale); + " of keyboard map for locale " + locale); return; } @@ -413,15 +472,15 @@ if (addupper) { char c = determineCharacter(keyStrokeName, true); - addKeyStroke - (keyStrokeName, virtualKey, numlock, localstate, true, altgr, inhibit, c); + addKeyStroke(keyStrokeName, virtualKey, numlock, localstate, true, altgr, inhibit, + c); c = determineCharacter(keyStrokeName, false); - addKeyStroke - (keyStrokeName, virtualKey, numlock, localstate, false, altgr, inhibit, c); + addKeyStroke(keyStrokeName, virtualKey, numlock, localstate, false, altgr, inhibit, + c); } else { char c = determineCharacter(keyStrokeName, false); - addKeyStroke - (keyStrokeName, virtualKey, numlock, localstate, shift, altgr, inhibit, c); + addKeyStroke(keyStrokeName, virtualKey, numlock, localstate, shift, altgr, inhibit, + c); } } @@ -429,19 +488,39 @@ /** - * TODO: comment + *+ * Adds a key stroke and to the keyboard map. + *
* - * @param keyStroke + * @param keyStrokeName + * name of the key stroke + * @param virtualKey + * the associated virtual key + * @param numlock + * true, if numlock is pressed; false otherwise + * @param localstate + * true, if localstate is pressed; false otherwise + * @param shift + * true, if shift is pressed; false otherwise + * @param altgr + * true, if altgr is pressed; false otherwise + * @param addupper + * true, if addupper is pressed; false otherwise + * @param inhibit + * true, if inhibit is pressed; false otherwise + * @param character + * the resulting character */ - private void addKeyStroke(String keyStrokeName, + private void addKeyStroke(String keyStrokeName, VirtualKey virtualKey, - boolean numlock, - boolean localstate, - boolean shift, - boolean altgr, - boolean inhibit, - char character) + boolean numlock, + boolean localstate, + boolean shift, + boolean altgr, + boolean inhibit, + char character) { - KeyStroke keyStroke = new KeyStroke - (keyStrokeName, virtualKey, numlock, localstate, shift, altgr, inhibit, character); + KeyStroke keyStroke = + new KeyStroke(keyStrokeName, virtualKey, numlock, localstate, shift, altgr, inhibit, + character); List+ * Adds key strokes independent of numlock. + *
*/ private void addKeyStrokesIndependentOfNumLock() { @@ -492,19 +572,11 @@ /** - * TODO: comment - * - * @param deadKeySequences - */ - private void processDeadKeySequences(List+ * Determines a {@link VirtualKey} depending on a key stroke name + *
* * @param keyStrokeName - * @param shift - * @return + * name of the key stroke + * @return related virtual key */ private VirtualKey determineVirtualKey(String keyStrokeName) { @@ -1021,5 +1093,5 @@ else { Console.traceln(Level.FINEST, "unknown virtual key for key stroke " + keyStrokeName + - " specified through " + "keyboard map for locale " + locale); + " specified through " + "keyboard map for locale " + locale); return null; @@ -1053,9 +1125,11 @@ /** - * TODO: comment - * - * @param keyStrokeName - * @param shift - * @return + *+ * Determines the character that is generated by a key stroke. + *
+ * + * @param keyStrokeName name of the key stroke + * @param getUpper defines whether the upper case version of the key stroke is returned or not + * @return the character */ private char determineCharacter(String keyStrokeName, boolean getUpper) { @@ -2042,114 +2116,3 @@ } } - - /** - * this is a former implementation - * - * @param keyId - * @return - */ - /* - * private VirtualKey[] mapKeyIdToVirtualKeys(int keyId, String keyStrokeName) { - * - * Set+ * Creates keyboard maps. + *
* - * @version $Revision: $ $Date: 11.07.2012$ - * @author 2012, last modified by $Author: patrick$ + * @version 1.0 + * @author Patrick Harms */ public class KeyboardMapFactory { /** - * TODO: comment - * + *+ * Constructor. Private to prevent initialization of this class. + *
*/ private KeyboardMapFactory() { - // TODO Auto-generated constructor stub } /** - * TODO: comment - * + *+ * Returns a {@link KeyboardMap} for the given {@link Locale}. + *
+ * + * @param locale the locale + * @return the keyboard map */ public static KeyboardMap createKeyboardMap(Locale locale) { Index: /trunk/quest-misc/src/main/java/de/ugoe/cs/tasktree/keyboardmaps/VirtualKey.java =================================================================== --- /trunk/quest-misc/src/main/java/de/ugoe/cs/tasktree/keyboardmaps/VirtualKey.java (revision 837) +++ /trunk/quest-misc/src/main/java/de/ugoe/cs/tasktree/keyboardmaps/VirtualKey.java (revision 838) @@ -4,8 +4,10 @@ /** - * TODO comment + *+ * Enumeration of virtual keys. + *
* - * @version $Revision: $ $Date: 01.04.2012$ - * @author 2012, last modified by $Author: patrick$ + * @version 1.0 + * @author Patrick Harms */ public enum VirtualKey { @@ -233,13 +235,26 @@ */ - /** the virtual key code of the virtual key. */ + /** + *+ * Virtual key code of the virtual key. + *
+ */ private int virtualKeyCode = -1; - /** the description of the virtual key */ + /** + *+ * Description of the virtual key. + *
+ */ private String description; /** - * - */ + *+ * Constructor. Creates a new VirtualKey. + *
+ * + * @param virtualKeyCode + * key code of the virtual key + */ private VirtualKey(int virtualKeyCode) { this.virtualKeyCode = virtualKeyCode; @@ -248,5 +263,9 @@ /** - * @return Returns the description. + *+ * Returns the description of the virtual key. + *
+ * + * @return the description. */ String getDescription() { @@ -255,6 +274,10 @@ /** - * - */ + *+ * Returns whether the key is a combination key (e.g., shift, alt) or not. + *
+ * + * @return true, if the key is a combiniation key; false otherwise + */ public boolean isCombinationKey() { switch (this) @@ -273,6 +296,10 @@ /** - * - */ + *+ * Returns whether the key is a lock key (e.g., caps lock, num lock) or not. + *
+ * + * @return true, if the key is a lock key; false otherwise + */ public boolean isLockKey() { switch (this) @@ -289,6 +316,10 @@ /** - * - */ + *+ * Returns whether the key is shift. + *
+ * + * @return true, if the key is shift; false otherwise + */ public boolean isShiftKey() { switch (this) @@ -303,6 +334,10 @@ /** - * - */ + *+ * Returns whether the is an alt key. + *
+ * + * @return true, if the key is alt or altgr; false otherwise + */ public boolean isAltKey() { switch (this) @@ -318,6 +353,10 @@ /** - * - */ + *+ * Returns whether the key is control. + *
+ * + * @return true, if the key is control; false otherwise + */ public boolean isControlKey() { switch (this) @@ -332,6 +371,10 @@ /** - * - */ + *+ * Returns whether the key is the windows key. + *
+ * + * @return true, if the key is the windows key; false otherwise + */ public boolean isWindowsKey() { switch (this) @@ -346,6 +389,10 @@ /** - * - */ + *+ * Returns whether the key is the meta key. + *
+ * + * @return true, if the key is the meta key; false otherwise + */ public boolean isMetaKey() { switch (this) @@ -360,6 +407,10 @@ /** - * - */ + *+ * Returns whether the key is a letter. + *
+ * + * @return true, if the key is a letter; false otherwise + */ public boolean isLetter() { if (virtualKeyCode > -1) { @@ -372,6 +423,10 @@ /** - * - */ + *+ * Returns whether the key is a digit. + *
+ * + * @return true, if the key is a digit; false otherwise + */ public boolean isDigit() { if (virtualKeyCode > -1) { @@ -384,8 +439,13 @@ /** - * TODO: comment - * - * @param parameter - * @return + *+ * Parses an {@link String} and returns the respective VirtualKey if possible. + *
+ * + * @param numberString + * String representation of the virtual key + * @return created VirtualKey + * @throws IllegalArgumentException + * thrown if there is no VirtualKey that correlates to string */ public static VirtualKey parseVirtualKey(String string) { @@ -401,6 +461,14 @@ /** - * - */ + *+ * Returns the VirtualKey associated with an integer. + *
+ * + * @param number + * integer to which the according VirtualKey is returned + * @return the VirtualKey + * @throws IllegalArgumentException + * thrown if there is no VirtualKey that correlates to number + */ public static VirtualKey valueOf(int number) { for (VirtualKey virtualKey : VirtualKey.values()) { Index: /trunk/quest-misc/src/main/java/de/ugoe/cs/tasktree/keyboardmaps/VirtualKeySynonyms.java =================================================================== --- /trunk/quest-misc/src/main/java/de/ugoe/cs/tasktree/keyboardmaps/VirtualKeySynonyms.java (revision 837) +++ /trunk/quest-misc/src/main/java/de/ugoe/cs/tasktree/keyboardmaps/VirtualKeySynonyms.java (revision 838) @@ -1,2 +1,3 @@ + package de.ugoe.cs.tasktree.keyboardmaps; @@ -10,22 +11,36 @@ /** - * TODO comment + *+ * Helper class to handle synonymous {@link VirtualKey}s. + *
* - * @version $Revision: $ $Date: 12.07.2012$ - * @author 2012, last modified by $Author: pharms$ + * @version 1.0 + * @author Patrick Harms */ class VirtualKeySynonyms { - - /** */ + + /** + *+ * Map of synonymous keys. + *
+ */ private Map+ * Mapping of {@link VirtualKey}s to integer Ids. + *
+ */ private Map+ * Adds a new synonymous key. + *
* * @param keyId + * id of the synonym * @param virtualKey + * the synonym */ public void add(int keyId, VirtualKey virtualKey) { @@ -46,6 +61,6 @@ if ((existingKeyId != null) && (existingKeyId != keyId)) { Console.traceln(Level.FINEST, "virtual key " + virtualKey + " is mapped to more " + - "than one key id (current is " + existingKeyId + ", new is " + keyId + - "). New key id will be used (" + keyId + ")."); + "than one key id (current is " + existingKeyId + ", new is " + keyId + + "). New key id will be used (" + keyId + ")."); } @@ -54,6 +69,12 @@ /** - * - */ + *+ * Returns whether a key is contained in the set of synonyms. + *
+ * + * @param keyId + * id of the key + * @return true, if the key is contained; false otherwise + */ public boolean containsKey(int keyId) { return synonyms.containsKey(keyId); @@ -61,8 +82,11 @@ /** - * TODO: comment + *+ * Returns all synonyms known for a given key. + *
* * @param keyId - * @return + * the id of the key + * @return the synonyms */ public VirtualKey[] getVirtualKeySynonyms(int keyId) {