libjava/javax/swing/KeyStroke.java

   1 /* KeyStroke.java --
   2    Copyright (C) 2002 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38 package javax.swing;
  39
  40 import java.awt.AWTKeyStroke;
  41 import java.awt.event.KeyEvent;
  42 import java.io.Serializable;
  43
  44 /**
  45  * KeyStroke
  46  * @author      Andrew Selkirk
  47  * @version     1.0
  48  */
  49 public class KeyStroke implements Serializable
  50 {
  51   static final long serialVersionUID = -9060180771037902530L;
  52
  53         //-------------------------------------------------------------
  54         // Variables --------------------------------------------------
  55         //-------------------------------------------------------------
  56
  57         /**
  58          * keyChar
  59          */
  60         private char    keyChar                 = 0;
  61
  62         /**
  63          * keyCode
  64          */
  65         private int             keyCode                 = 0;
  66
  67         /**
  68          * modifiers
  69          */
  70         private int             modifiers               = 0;
  71
  72         /**
  73          * onKeyRelease
  74          */
  75         private boolean onKeyRelease    = false;
  76
  77
  78         //-------------------------------------------------------------
  79         // Initialization ---------------------------------------------
  80         //-------------------------------------------------------------
  81
  82         /**
  83          * Constructor KeyStroke
  84          */
  85         private KeyStroke() {
  86         } // KeyStroke()
  87
  88
  89         //-------------------------------------------------------------
  90         // Methods ----------------------------------------------------
  91         //-------------------------------------------------------------
  92
  93         /**
  94          * hashCode
  95          * @returns int
  96          */
  97         public int hashCode() {
  98                 return 0; // TODO
  99         } // hashCode()
 100
 101         /**
 102          * equals
 103          * @param object TODO
 104          * @returns boolean
 105          */
 106         public boolean equals(Object object) {
 107
 108                 // Variables
 109                 KeyStroke       key;
 110
 111                 if (object instanceof KeyStroke) {
 112                         key = (KeyStroke) object;
 113                         if (key.keyChar == keyChar &&
 114                                 key.keyCode == keyCode &&
 115                                 key.modifiers == modifiers &&
 116                                 key.onKeyRelease == onKeyRelease) {
 117                                 return true;
 118                         } // if
 119                 } // if
 120                 return false;
 121
 122         } // equals()
 123
 124         /**
 125          * toString
 126          * @returns String
 127          */
 128         public String toString() {
 129                 return null; // TODO
 130         } // toString()
 131
 132         /**
 133          * getKeyStroke
 134          * @param keyChar TODO
 135          * @returns KeyStroke
 136          */
 137         public static KeyStroke getKeyStroke(char keyChar) {
 138
 139                 // Variables
 140                 KeyStroke       key;
 141
 142                 key = new KeyStroke();
 143                 key.keyChar = keyChar;
 144                 return key;
 145
 146         } // getKeyStroke()
 147
 148         /**
 149          * getKeyStroke - deprecated
 150          * @param keyChar TODO
 151          * @param onKeyRelease TODO
 152          * @returns KeyStroke
 153          */
 154         public static KeyStroke getKeyStroke(char keyChar, boolean onKeyRelease) {
 155                 KeyStroke key = getKeyStroke(keyChar);
 156                 key.onKeyRelease = onKeyRelease;
 157                 return key;
 158         } // getKeyStroke()
 159
 160         /**
 161          * getKeyStroke
 162          * @param keyChar TODO
 163          * @param modifiers TODO
 164          * @returns KeyStroke
 165          */
 166         public static KeyStroke getKeyStroke(Character keyChar, int modifiers) {
 167                 KeyStroke key = getKeyStroke(keyChar.charValue());
 168                 key.modifiers = modifiers;
 169                 return key;
 170         } // getKeyStroke()
 171
 172         /**
 173          * getKeyStroke
 174          * @param keyCode TODO
 175          * @param modifiers TODO
 176          * @param onKeyRelease TODO
 177          * @returns KeyStroke
 178          */
 179         public static KeyStroke getKeyStroke(int keyCode, int modifiers,
 180                                 boolean onKeyRelease) {
 181
 182                 // Variables
 183                 KeyStroke       key;
 184
 185                 key = new KeyStroke();
 186                 key.keyCode = keyCode;
 187                 key.modifiers = modifiers;
 188                 key.onKeyRelease = onKeyRelease;
 189                 return key;
 190
 191         } // getKeyStroke()
 192
 193         /**
 194          * getKeyStroke
 195          * @param keyCode TODO
 196          * @param modifiers TODO
 197          * @returns KeyStroke
 198          */
 199         public static KeyStroke getKeyStroke(int keyCode, int modifiers) {
 200                 return getKeyStroke(keyCode, modifiers, false);
 201         } // getKeyStroke()
 202
 203         /**
 204          * getKeyStroke
 205          * @param string TODO
 206          * @returns KeyStroke
 207          */
 208         public static KeyStroke getKeyStroke(String string) {
 209                 return null; // TODO
 210         } // getKeyStroke()
 211
 212         /**
 213          * getKeyStrokeForEvent
 214          * @param event TODO
 215          * @returns KeyStroke
 216          */
 217         public static KeyStroke getKeyStrokeForEvent(KeyEvent event) {
 218
 219                 // Variables
 220                 int     eventID;
 221                 int     eventMod;
 222
 223                 // Get Event ID
 224                 eventID = event.getID();
 225                 eventMod = event.getModifiers();
 226
 227                 // Check for KEY_TYPED event
 228                 if (eventID == KeyEvent.KEY_TYPED) {
 229                         return getKeyStroke(event.getKeyChar(), eventMod);
 230
 231                 // KEY_PRESSED or KEY_RELEASED event
 232                 } else {
 233                         return getKeyStroke(event.getKeyCode(), eventMod);
 234                 } // if
 235
 236         } // getKeyStrokeForEvent()
 237
 238         /**
 239          * getKeyChar
 240          * @returns char
 241          */
 242         public char getKeyChar() {
 243                 return keyChar;
 244         } // getKeyChar()
 245
 246         /**
 247          * getKeyCode
 248          * @returns int
 249          */
 250         public int getKeyCode() {
 251                 return keyCode;
 252         } // getKeyCode()
 253
 254         /**
 255          * getModifiers
 256          * @returns int
 257          */
 258         public int getModifiers() {
 259                 return modifiers; // TODO
 260         } // getModifiers()
 261
 262         /**
 263          * isOnKeyRelease
 264          * @returns boolean
 265          */
 266         public boolean isOnKeyRelease() {
 267                 return onKeyRelease;
 268         } // isOnKeyRelease()
 269
 270
 271 } // KeyStroke