libjava/javax/swing/KeyStroke.java

   1 /* KeyStroke.java --
   2    Copyright (C) 2002, 2004, 2005  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
  39 package javax.swing;
  40
  41 import java.awt.AWTKeyStroke;
  42 import java.awt.event.KeyEvent;
  43 import java.io.Serializable;
  44
  45 public class KeyStroke
  46   extends AWTKeyStroke
  47   implements Serializable
  48 {
  49   private static final long serialVersionUID = -9060180771037902530L;
  50
  51   // Called by java.awt.AWTKeyStroke.registerSubclass via reflection.
  52   private KeyStroke()
  53   {
  54   }
  55
  56   private KeyStroke(char keyChar, int keyCode, int modifiers,
  57                     boolean onKeyRelease)
  58   {
  59     super(keyChar, keyCode, modifiers, onKeyRelease);
  60   }
  61
  62   static
  63   {
  64     AWTKeyStroke.registerSubclass(KeyStroke.class);
  65   }
  66
  67   public static KeyStroke getKeyStroke(char keyChar)
  68   {
  69     return (KeyStroke) getAWTKeyStroke(keyChar);
  70   }
  71
  72   /**
  73    * @deprecated Use {@link #getKeyStroke(char)}
  74    *
  75    * This method, unlike all the other factory methods on this object,
  76    * returns a non-cached, non-shared object. New code should not use it.
  77    */
  78   public static KeyStroke getKeyStroke(char keyChar, boolean onKeyRelease)
  79   {
  80     return new KeyStroke(keyChar, KeyEvent.VK_UNDEFINED, 0, onKeyRelease);
  81   }
  82
  83   public static KeyStroke getKeyStroke(Character keyChar, int modifiers)
  84   {
  85     return (KeyStroke) getAWTKeyStroke(keyChar, modifiers);
  86   }
  87
  88   public static KeyStroke getKeyStroke(int keyCode, int modifiers,
  89                                        boolean onKeyRelease)
  90   {
  91     return (KeyStroke) getAWTKeyStroke(keyCode, modifiers, onKeyRelease);
  92   }
  93
  94   public static KeyStroke getKeyStroke(int keyCode, int modifiers)
  95   {
  96     return (KeyStroke) getAWTKeyStroke(keyCode, modifiers);
  97   }
  98
  99   /**
 100    * Returns the KeyStroke according to <code>getAWTKeyStroke()</code>.
 101    * But it returns null instead of throwing
 102    * <code>IllegalArugmentException</code> when
 103    * the keystoke sequence cannot be parsed from the given string.
 104    */
 105   public static KeyStroke getKeyStroke(String str)
 106   {
 107     try
 108       {
 109         return (KeyStroke) getAWTKeyStroke(str);
 110       }
 111     catch (IllegalArgumentException iae)
 112       {
 113         return null;
 114       }
 115   }
 116
 117   public static KeyStroke getKeyStrokeForEvent(KeyEvent event)
 118   {
 119     return (KeyStroke) getAWTKeyStrokeForEvent(event);
 120   }
 121
 122 }