MenuShortcut.java 10.1 KB
Newer Older
Tom Tromey committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
/* MenuShortcut.java -- A class for menu accelerators
   Copyright (C) 1999, 2002 Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */


package java.awt;

/**
  * This class implements a keyboard accelerator for a menu item.
  *
  * @author Aaron M. Renn (arenn@urbanophile.com)
  */
public class MenuShortcut implements java.io.Serializable
{

/*
 * Static Variables
 */

// Serialization Constant
private static final long serialVersionUID = 143448358473180225L;

/*************************************************************************/

/*
 * Instance Variables
 */

/**
  * @serial The virtual keycode for the shortcut.
  */
private int key;

/**
  * @serial <code>true</code> if the shift key was used with this shortcut,
  * or <code>false</code> otherwise.
  */
private boolean usesShift;

73 74
private String keyName;

Tom Tromey committed
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
/*************************************************************************/

/**
  * Initializes a new instance of <code>MenuShortcut</code> with the
  * specified virtual key value.
  *
  * @param key The virtual keycode for the shortcut.
  */
public
MenuShortcut(int key)
{
  this(key, false);
}

/*************************************************************************/

/**
  * Initializes a new instance of <code>MenuShortcut</code> with the
  * specified virtual key value and shift setting.
  *
  * @param key The virtual keycode for the shortcut.
  * @param usesShift <code>true</code> if the shift key was pressed,
  * <code>false</code> otherwise.
  */
public
MenuShortcut(int key, boolean usesShift)
{
  this.key = key;
  this.usesShift = usesShift;
104
  setKeyName(key);
Tom Tromey committed
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
}

/*************************************************************************/

/*
 * Instance Methods
 */

/**
  * Returns the virtual keycode for this shortcut.
  *
  * @return The virtual keycode for this shortcut.
  */
public int
getKey()
{
  return(key);
}

/*************************************************************************/

/**
  * Returns the shift setting for this shortcut.
  *
  * @return <code>true</code> if the shift key was pressed, <code>false</code>
  * otherwise.
  */
public boolean
usesShiftModifier()
{
  return(usesShift);
}

/*************************************************************************/

/**
  * Tests this object for equality against the specified object.  The two
  * objects will be considered equal if and only if the specified object
  * is an instance of <code>MenuShortcut</code> and has the same key value
  * and shift setting as this object.
  *
  * @param obj The object to test for equality against.
  *
  * @return <code>true</code> if the two objects are equal, <code>false</code>
  * otherwise.
  */
public boolean
equals(MenuShortcut obj)
{
  if (obj == null)
    return(false);

  if (obj.key != this.key)
    return(false);

  if (obj.usesShift != this.usesShift)
    return(false);

  return(true);
}

public boolean
equals(Object obj)
{
  if (obj instanceof MenuShortcut)
    {
      MenuShortcut ms = (MenuShortcut) obj;
      return (ms.key == key && ms.usesShift == usesShift);
173
    }
Tom Tromey committed
174 175 176 177 178 179 180 181 182 183 184 185 186
  return false;
}

/*************************************************************************/

/**
  * Returns a string representation of this shortcut.
  *
  * @return A string representation of this shortcut.
  */
public String
toString()
{
187 188 189 190 191
  String temp = "Ctrl+";
  if (usesShift)
    temp = temp + "Shift+";
  temp = temp + keyName;
  return temp;
Tom Tromey committed
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
}

public int
hashCode()
{
  // Arbitrary.
  return key + (usesShift ? 23 : 57);
}

/*************************************************************************/

/**
  * Returns a debugging string for this object.
  *
  * @return A debugging string for this object.
  */
protected String
paramString()
{
  return "key=" + key + ",usesShift=" + usesShift;
}

214
private void
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
setKeyName(int key)
{
  if (key == '\n')
    keyName = "Enter";
  else if (key == '\b')
    keyName = "Backspace";
  else if (key == '\t')
    keyName = "Tab";
  else if (key == ' ')
    keyName = "Space";
  else if (key == ',')
    keyName = "Comma";
  else if (key == '.')
    keyName = "Period";
  else if (key == '/')
    keyName = "Slash";
  else if (key == '\\')
    keyName = "Back Slash";
  else if (key == ';')
    keyName = "Semicolon";
  else if (key == '=')
    keyName = "Equals";
  else if (key == '[')
    keyName = "Open Bracket";
  else if (key == ']')
    keyName = "Close Bracket";
  else if (key == '0')
    keyName = "0";
  else if (key == '1')
    keyName = "1";
  else if (key == '2')
    keyName = "2";
  else if (key == '3')
    keyName = "3";
  else if (key == '4')
    keyName = "4";
  else if (key == '5')
    keyName = "5";
  else if (key == '6')
    keyName = "6";
  else if (key == '7')
    keyName = "7";
  else if (key == '8')
    keyName = "8";
  else if (key == '9')
    keyName = "9";
  else if (key == 'A')
    keyName = "A";
  else if (key == 'B')
    keyName = "B";
  else if (key == 'C')
    keyName = "C";
  else if (key == 'D')
    keyName = "D";
  else if (key == 'E')
    keyName = "E";
  else if (key == 'F')
    keyName = "F";
  else if (key == 'G')
    keyName = "G";
  else if (key == 'H')
    keyName = "H";
  else if (key == 'I')
    keyName = "I";
  else if (key == 'J')
    keyName = "J";
  else if (key == 'K')
    keyName = "K";
  else if (key == 'L')
    keyName = "L";
  else if (key == 'M')
    keyName = "M";
  else if (key == 'N')
    keyName = "N";
  else if (key == 'O')
    keyName = "O";
  else if (key == 'P')
    keyName = "P";
  else if (key == 'Q')
    keyName = "Q";
  else if (key == 'R')
    keyName = "R";
  else if (key == 'S')
    keyName = "S";
  else if (key == 'T')
    keyName = "T";
  else if (key == 'U')
    keyName = "U";
  else if (key == 'V')
    keyName = "V";
  else if (key == 'W')
    keyName = "W";
  else if (key == 'X')
    keyName = "X";
  else if (key == 'Y')
    keyName = "Y";
  else if (key == 'Z')
    keyName = "Z";
  else if (key == 3)
    keyName = "Cancel";
  else if (key == 12)
    keyName = "Clear";
  else if (key == 16)
    keyName = "Shift";
  else if (key == 17)
    keyName = "Ctrl";
  else if (key == 18)
    keyName = "Alt";
  else if (key == 19)
    keyName = "Pause";
  else if (key == 20)
    keyName = "Caps Lock";
  else if (key == 21)
    keyName = "Kana";
  else if (key == 24)
    keyName = "Final";
  else if (key == 25)
    keyName = "Kanji";
  else if (key == 27)
    keyName = "Escape";
  else if (key == 28)
    keyName = "Convert";
  else if (key == 29)
    keyName = "No Convert";
  else if (key == 30)
    keyName = "Accept";
  else if (key == 31)
    keyName = "Mode Change";
  else if (key == 33)
    keyName = "Page Up";
  else if (key == 34)
    keyName = "Page Down";
  else if (key == 35)
    keyName = "End";
  else if (key == 36)
    keyName = "Home";
  else if (key == 37)
    keyName = "Left";
  else if (key == 38)
    keyName = "Up";
  else if (key == 39)
    keyName = "Right";
  else if (key == 40)
    keyName = "Down";
  else if (key == 96)
    keyName = "NumPad-0";
  else if (key == 97)
    keyName = "NumPad-1";
  else if (key == 98)
    keyName = "NumPad-2";
  else if (key == 99)
    keyName = "NumPad-3";
  else if (key == 100)
    keyName = "NumPad-4";
  else if (key == 101)
    keyName = "NumPad-5";
  else if (key == 102)
    keyName = "NumPad-6";
  else if (key == 103)
    keyName = "NumPad-7";
  else if (key == 104)
    keyName = "NumPad-8";
  else if (key == 105)
    keyName = "NumPad-9";
  else if (key == 106)
    keyName = "NumPad *";
  else if (key == 107)
    keyName = "NumPad +";
  else if (key == 108)
    keyName = "NumPad ,";
  else if (key == 109)
    keyName = "NumPad -";
  else if (key == 110)
    keyName = "NumPad .";
  else if (key == 111)
    keyName = "NumPad /";
  else if (key == 112)
    keyName = "F1";
  else if (key == 113)
    keyName = "F2";
  else if (key == 114)
    keyName = "F3";
  else if (key == 115)
    keyName = "F4";
  else if (key == 116)
    keyName = "F5";
  else if (key == 117)
    keyName = "F6";
  else if (key == 118)
    keyName = "F7";
  else if (key == 119)
    keyName = "F8";
  else if (key == 120)
    keyName = "F9";
  else if (key == 121)
    keyName = "F10";
  else if (key == 122)
    keyName = "F11";
  else if (key == 123)
    keyName = "F12";
  else if (key == 127)
    keyName = "Delete";
  else if (key == 144)
    keyName = "Num Lock";
  else if (key == 145)
    keyName = "Scroll Lock";
  else if (key == 154)
    keyName = "Print Screen";
  else if (key == 155)
    keyName = "Insert";
  else if (key == 156)
    keyName = "Help";
  else if (key == 157)
    keyName = "Meta";
  else if (key == 192)
    keyName = "Back Quote";
  else if (key == 222)
    keyName = "Quote";
}
} // class MenuShortcut