Changeset 558 for trunk/quest-misc/src/main/java/de/ugoe/cs/tasktree/keyboardmaps/VirtualKey.java

Timestamp:

08/17/12 08:52:45 (12 years ago)

Author:

pharms

Message:

• adapted to new coding style in quest

File:

• trunk/quest-misc/src/main/java/de/ugoe/cs/tasktree/keyboardmaps/VirtualKey.java (modified) (3 diffs)

trunk/quest-misc/src/main/java/de/ugoe/cs/tasktree/keyboardmaps/VirtualKey.java

@@ -1 @@
-//-------------------------------------------------------------------------------------------------
 // Module    : $RCSfile: Key.java,v $
 // Version   : $Revision: 0.0 $  $Author: patrick $  $Date: 01.04.2012 $
@@ -5 +4 @@
 // Creation  : 2012 by patrick
 // Copyright : Patrick Harms, 2012
-//-------------------------------------------------------------------------------------------------
+
+
 package de.ugoe.cs.tasktree.keyboardmaps;
 
 import java.awt.event.KeyEvent;
 
-//-------------------------------------------------------------------------------------------------
 /**
  * TODO comment
- *
+ * 
  * @version $Revision: $ $Date: 01.04.2012$
  * @author 2012, last modified by $Author: patrick$
  */
-//-------------------------------------------------------------------------------------------------
-public enum VirtualKey
-{
+public enum VirtualKey {
+
     ENTER(KeyEvent.VK_ENTER),
     BACK_SPACE(KeyEvent.VK_BACK_SPACE),
@@ -228 +226 @@
 
     UNDEFINED(KeyEvent.VK_UNDEFINED);
-    
-    /*BAR(KeyEvent.VK_UNDEFINED),
-    APOSTROPHE(KeyEvent.VK_UNDEFINED),
-    QUESTIONMARK(KeyEvent.VK_UNDEFINED),
-    DEGREE(KeyEvent.VK_UNDEFINED),
-    HENKAN_MODE(KeyEvent.VK_UNDEFINED),
-    MUHENKAN(KeyEvent.VK_UNDEFINED),
-    EISU_TOGGLE(KeyEvent.VK_UNDEFINED),
-    HANGUL(KeyEvent.VK_UNDEFINED),
-    HANGUL_HANJA(KeyEvent.VK_UNDEFINED),
-    EXECUTE(KeyEvent.VK_UNDEFINED);*/
-
-  /** the virtual key code of the virtual key. */
-  private int mVirtualKeyCode = -1;
-
-  /** the description of the virtual key */
-  private String mDescription;
-
-  //-----------------------------------------------------------------------------------------------
-  /**
-   *
-   */
-  //-----------------------------------------------------------------------------------------------
-  private VirtualKey(int virtualKeyCode)
-  {
-    mVirtualKeyCode = virtualKeyCode;
-    mDescription = KeyEvent.getKeyText(mVirtualKeyCode);
-  }
-
-  //-----------------------------------------------------------------------------------------------
-  /**
-   * @return Returns the description.
-   */
-  //-----------------------------------------------------------------------------------------------
-  String getDescription()
-  {
-    return mDescription;
-  }
-
-  //-----------------------------------------------------------------------------------------------
-  /**
-   *
-   */
-  //-----------------------------------------------------------------------------------------------
-  public boolean isCombinationKey()
-  {
-    switch (this)
-    {
-      case SHIFT:
-      case CONTROL:
-      case ALT:
-      case ALT_GRAPH:
-      case WINDOWS:
-        return true;
-
-    default:
-      return false;
-    }
-  }
-
-  //-----------------------------------------------------------------------------------------------
-  /**
-   *
-   */
-  //-----------------------------------------------------------------------------------------------
-  public boolean isLockKey()
-  {
-    switch (this)
-    {
-      case CAPS_LOCK :
-      case NUM_LOCK:
-      case SCROLL_LOCK:
-
-      return true;
-
-    default:
-      return false;
-    }
-  }
-
-  //-----------------------------------------------------------------------------------------------
-  /**
-   *
-   */
-  //-----------------------------------------------------------------------------------------------
-  public boolean isShiftKey()
-  {
-    switch (this)
-    {
-      case SHIFT:
-        return true;
-
-      default:
-        return false;
-    }
-  }
-
-  //-----------------------------------------------------------------------------------------------
-  /**
-   *
-   */
-  //-----------------------------------------------------------------------------------------------
-  public boolean isAltKey()
-  {
-    switch (this)
-    {
-      case ALT:
-      case ALT_GRAPH:
-        return true;
-
-      default:
-        return false;
-    }
-  }
-
-  //-----------------------------------------------------------------------------------------------
-  /**
-   *
-   */
-  //-----------------------------------------------------------------------------------------------
-  public boolean isControlKey()
-  {
-    switch (this)
-    {
-      case CONTROL:
-        return true;
-
-      default:
-        return false;
-    }
-  }
-
-  //-----------------------------------------------------------------------------------------------
-  /**
-   *
-   */
-  //-----------------------------------------------------------------------------------------------
-  public boolean isWindowsKey()
-  {
-    switch (this)
-    {
-      case WINDOWS:
-        return true;
-
-      default:
-        return false;
-    }
-  }
-
-  //-----------------------------------------------------------------------------------------------
-  /**
-   *
-   */
-  //-----------------------------------------------------------------------------------------------
-  public boolean isMetaKey()
-  {
-    switch (this)
-    {
-      case META:
-        return true;
-
-      default:
-        return false;
-    }
-  }
-
-  //-----------------------------------------------------------------------------------------------
-  /**
-   *
-   */
-  //-----------------------------------------------------------------------------------------------
-  public boolean isLetter()
-  {
-    if (mVirtualKeyCode > -1)
-    {
-      return Character.isLetter((char) mVirtualKeyCode);
-    }
-    else
-    {
-      return false;
-    }
-  }
-
-  //-----------------------------------------------------------------------------------------------
-  /**
-   *
-   */
-  //-----------------------------------------------------------------------------------------------
-  public boolean isDigit()
-  {
-    if (mVirtualKeyCode > -1)
-    {
-      return Character.isDigit(mVirtualKeyCode);
-    }
-    else
-    {
-      return false;
-    }
-  }
-
-  //-----------------------------------------------------------------------------------------------
-  /**
-   * TODO: comment
-   *
-   * @param parameter
-   * @return
-   */
-  //-----------------------------------------------------------------------------------------------
-  public static VirtualKey parseVirtualKey(String string)
-  {
-    int virtualKeyCode = Integer.parseInt(string);
-    for (VirtualKey key1 : VirtualKey.values())
-    {
-      if (key1.mVirtualKeyCode == virtualKeyCode)
-      {
-        return key1;
-      }
-    }
-      
-    throw new IllegalArgumentException("there is no virtual key with id " + string);
-  }
-
-  //-----------------------------------------------------------------------------------------------
-  /**
-   *
-   */
-  //-----------------------------------------------------------------------------------------------
-  public static VirtualKey valueOf(int number)
-  {
-    for (VirtualKey virtualKey : VirtualKey.values())
-    {
-      if (virtualKey.mVirtualKeyCode == number)
-      {
-        return virtualKey;
-      }
-    }
-    
-    throw new IllegalArgumentException("there is no virtual key with number " + number);
-  }
+
+    /*
+     * BAR(KeyEvent.VK_UNDEFINED),
+     * APOSTROPHE(KeyEvent.VK_UNDEFINED),
+     * QUESTIONMARK(KeyEvent.VK_UNDEFINED),
+     * DEGREE(KeyEvent.VK_UNDEFINED),
+     * HENKAN_MODE(KeyEvent.VK_UNDEFINED),
+     * MUHENKAN(KeyEvent.VK_UNDEFINED),
+     * EISU_TOGGLE(KeyEvent.VK_UNDEFINED),
+     * HANGUL(KeyEvent.VK_UNDEFINED),
+     * HANGUL_HANJA(KeyEvent.VK_UNDEFINED),
+     * EXECUTE(KeyEvent.VK_UNDEFINED);
+     */
+
+    /** the virtual key code of the virtual key. */
+    private int virtualKeyCode = -1;
+
+    /** the description of the virtual key */
+    private String description;
+
+    /**
+   *
+   */
+    private VirtualKey(int virtualKeyCode) {
+        this.virtualKeyCode = virtualKeyCode;
+        this.description = KeyEvent.getKeyText(this.virtualKeyCode);
+    }
+
+    /**
+     * @return Returns the description.
+     */
+    String getDescription() {
+        return description;
+    }
+
+    /**
+   *
+   */
+    public boolean isCombinationKey() {
+        switch (this)
+        {
+            case SHIFT:
+            case CONTROL:
+            case ALT:
+            case ALT_GRAPH:
+            case WINDOWS:
+                return true;
+
+            default:
+                return false;
+        }
+    }
+
+    /**
+   *
+   */
+    public boolean isLockKey() {
+        switch (this)
+        {
+            case CAPS_LOCK:
+            case NUM_LOCK:
+            case SCROLL_LOCK:
+                return true;
+
+            default:
+                return false;
+        }
+    }
+
+    /**
+   *
+   */
+    public boolean isShiftKey() {
+        switch (this)
+        {
+            case SHIFT:
+                return true;
+
+            default:
+                return false;
+        }
+    }
+
+    /**
+   *
+   */
+    public boolean isAltKey() {
+        switch (this)
+        {
+            case ALT:
+            case ALT_GRAPH:
+                return true;
+
+            default:
+                return false;
+        }
+    }
+
+    /**
+   *
+   */
+    public boolean isControlKey() {
+        switch (this)
+        {
+            case CONTROL:
+                return true;
+
+            default:
+                return false;
+        }
+    }
+
+    /**
+   *
+   */
+    public boolean isWindowsKey() {
+        switch (this)
+        {
+            case WINDOWS:
+                return true;
+
+            default:
+                return false;
+        }
+    }
+
+    /**
+   *
+   */
+    public boolean isMetaKey() {
+        switch (this)
+        {
+            case META:
+                return true;
+
+            default:
+                return false;
+        }
+    }
+
+    /**
+   *
+   */
+    public boolean isLetter() {
+        if (virtualKeyCode > -1) {
+            return Character.isLetter((char) virtualKeyCode);
+        }
+        else {
+            return false;
+        }
+    }
+
+    /**
+   *
+   */
+    public boolean isDigit() {
+        if (virtualKeyCode > -1) {
+            return Character.isDigit(virtualKeyCode);
+        }
+        else {
+            return false;
+        }
+    }
+
+    /**
+     * TODO: comment
+     * 
+     * @param parameter
+     * @return
+     */
+    public static VirtualKey parseVirtualKey(String string) {
+        int virtualKeyCode = Integer.parseInt(string);
+        for (VirtualKey key1 : VirtualKey.values()) {
+            if (key1.virtualKeyCode == virtualKeyCode) {
+                return key1;
+            }
+        }
+
+        throw new IllegalArgumentException("there is no virtual key with id " + string);
+    }
+
+    /**
+   *
+   */
+    public static VirtualKey valueOf(int number) {
+        for (VirtualKey virtualKey : VirtualKey.values()) {
+            if (virtualKey.virtualKeyCode == number) {
+                return virtualKey;
+            }
+        }
+
+        throw new IllegalArgumentException("there is no virtual key with number " + number);
+    }
 
 }