001/* KeyStroke.java --
002   Copyright (C) 2002, 2004, 2005  Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package javax.swing;
040
041import java.awt.AWTKeyStroke;
042import java.awt.event.KeyEvent;
043import java.io.Serializable;
044
045public class KeyStroke 
046  extends AWTKeyStroke
047  implements Serializable
048{
049  private static final long serialVersionUID = -9060180771037902530L;
050  
051  // Called by java.awt.AWTKeyStroke.registerSubclass via reflection.
052  private KeyStroke()
053  {
054    // Nothing to do here.
055  }
056  
057  private KeyStroke(char keyChar, int keyCode, int modifiers,
058                    boolean onKeyRelease)
059  {
060    super(keyChar, keyCode, modifiers, onKeyRelease);
061  }
062
063  static
064  {
065    AWTKeyStroke.registerSubclass(KeyStroke.class);
066  }
067
068  public static KeyStroke getKeyStroke(char keyChar) 
069  {
070    return (KeyStroke) getAWTKeyStroke(keyChar);
071  }
072
073  /** 
074   * @deprecated Use {@link #getKeyStroke(char)}
075   *
076   * This method, unlike all the other factory methods on this object,
077   * returns a non-cached, non-shared object. New code should not use it.
078   */
079  public static KeyStroke getKeyStroke(char keyChar, boolean onKeyRelease) 
080  {
081    return new KeyStroke(keyChar, KeyEvent.VK_UNDEFINED, 0, onKeyRelease);
082  }
083
084  public static KeyStroke getKeyStroke(Character keyChar, int modifiers) 
085  {
086    return (KeyStroke) getAWTKeyStroke(keyChar, modifiers);
087  }
088
089  public static KeyStroke getKeyStroke(int keyCode, int modifiers, 
090                                       boolean onKeyRelease) 
091  {
092    return (KeyStroke) getAWTKeyStroke(keyCode, modifiers, onKeyRelease);
093  }
094
095  public static KeyStroke getKeyStroke(int keyCode, int modifiers) 
096  {
097    return (KeyStroke) getAWTKeyStroke(keyCode, modifiers);
098  }
099
100  /**
101   * Returns the KeyStroke according to <code>getAWTKeyStroke()</code>.
102   * But it returns null instead of throwing
103   * <code>IllegalArugmentException</code> when
104   * the keystoke sequence cannot be parsed from the given string.
105   */
106  public static KeyStroke getKeyStroke(String str) 
107  {
108    try
109      {
110        return (KeyStroke) getAWTKeyStroke(str);
111      }
112    catch (IllegalArgumentException iae)
113      {
114        return null;
115      }
116  }
117
118  public static KeyStroke getKeyStrokeForEvent(KeyEvent event) 
119  {
120    return (KeyStroke) getAWTKeyStrokeForEvent(event);
121  }
122
123}