KeyStrokeConverter


1   /*--
2    $Id: KeyStrokeConverter.java,v 1.1 2004/03/01 07:56:01 wolfpaulus Exp $
3   
4    Copyright (C) 2003-2004 Wolf Paulus.
5    All rights reserved.
6   
7    Redistribution and use in source and binary forms, with or without
8    modification, are permitted provided that the following conditions
9    are met:
10  
11   1. Redistributions of source code must retain the above copyright
12   notice, this list of conditions, and the following disclaimer.
13  
14   2. Redistributions in binary form must reproduce the above copyright
15   notice, this list of conditions, and the disclaimer that follows
16   these conditions in the documentation and/or other materials provided
17   with the distribution.
18  
19   3. The end-user documentation included with the redistribution,
20   if any, must include the following acknowledgment:
21          "This product includes software developed by the
22           SWIXML Project (http://www.swixml.org/)."
23   Alternately, this acknowledgment may appear in the software itself,
24   if and wherever such third-party acknowledgments normally appear.
25  
26   4. The name "Swixml" must not be used to endorse or promote products
27   derived from this software without prior written permission. For
28   written permission, please contact <info_AT_swixml_DOT_org>
29  
30   5. Products derived from this software may not be called "Swixml",
31   nor may "Swixml" appear in their name, without prior written
32   permission from the Swixml Project Management.
33  
34   THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
35   WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
36   OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
37   DISCLAIMED.  IN NO EVENT SHALL THE SWIXML PROJECT OR ITS
38   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
39   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
40   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
41   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
42   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
43   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
44   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
45   SUCH DAMAGE.
46   ====================================================================
47  
48   This software consists of voluntary contributions made by many
49   individuals on behalf of the Swixml Project and was originally
50   created by Wolf Paulus <wolf_AT_swixml_DOT_org>. For more information
51   on the Swixml Project, please see <http://www.swixml.org/>.
52  */
53  
54  package org.swixml.converters;
55  
56  import org.jdom.Attribute;
57  import org.swixml.Converter;
58  import org.swixml.Localizer;
59  import org.swixml.Parser;
60  
61  import javax.swing.*;
62  
63  /**
64   * A Converter that turns a Strings in the form of a filename into an KeyStroke objects.
65   * <pre>
66   *   Valild syntax includes:
67   *   <ul>
68   *   <li>accelerator="F7"
69   *   <li>accelerator="control N"
70   *   <li>accelerator="alt A"
71   *   </ul>
72   * </pre>
73   * <hr>
74   * @author <a HREF="mailto:wolf@paulus.com">Wolf Paulus</a>
75   * @author <a HREF="mailto:Eric.LAFARGUE@cec.eu.int">Eric Lafargue</a>
76   * @version $Revision: 1.1 $
77   * @see javax.swing.KeyStroke#getKeyStroke(java.lang.String)
78   * @see org.swixml.ConverterLibrary
79   */
80  public class KeyStrokeConverter implements Converter {
81  
82    /** converter's return type */
83    public static final Class   TEMPLATE = KeyStroke.class;
84  
85    /**
86     * Converts a String into an KeyStroke through a Resource lookup
87     * @param type <code>Class</code> not used
88     * @param attr <code>Attribute</code> attribute provides the value to be converted
89     * @param localizer <code>Localizer</code> allow the use of resource lookups
90     * @return <code>Object</code> - a <code>KeyStroke</code>
91     */
92    public Object   convert( final Class   type, final Attribute attr, Localizer localizer ) {
93      return KeyStrokeConverter.conv( type, attr, localizer );
94    }
95  
96    /**
97     * Converts a String into an KeyStroke.
98     *
99     *  Parses a string and returns a <code>KeyStroke</code>.
100    * The string must have the following syntax:
101    * <pre>
102    *    &lt;modifiers&gt;* (&lt;typedID&gt; | &lt;pressedReleasedID&gt;)
103    *
104    *    modifiers := shift | control | ctrl | meta | alt | button1 | button2 | button3
105    *    typedID := typed &lt;typedKey&gt;
106    *    typedKey := string of length 1 giving Unicode character.
107    *    pressedReleasedID := (pressed | released) key
108    *    key := KeyEvent key code name, i.e. the name following "VK_".
109    * </pre>
110    * If typed, pressed or released is not specified, pressed is assumed. Here
111    * are some examples:
112    * <pre>
113    *     "INSERT" => getKeyStroke(KeyEvent.VK_INSERT, 0);
114    *     "control DELETE" => getKeyStroke(KeyEvent.VK_DELETE, InputEvent.CTRL_MASK);
115    *     "alt shift X" => getKeyStroke(KeyEvent.VK_X, InputEvent.ALT_MASK | InputEvent.SHIFT_MASK);
116    *     "alt shift released X" => getKeyStroke(KeyEvent.VK_X, InputEvent.ALT_MASK | InputEvent.SHIFT_MASK, true);
117    *     "typed a" => getKeyStroke('a');
118    * </pre>
119    *
120    * In order to maintain backward-compatibility, specifying a null String,
121    * or a String which is formatted incorrectly, returns null.
122    *
123    * @param type <code>Class</code> not used
124    * @param attr <code>Attribute</code> attribute provides the value to be converted
125    * @param localizer <code>Localizer</code> allow the use of resource lookups
126    * @return <code>Object</code> - a <code>KeyStroke</code> object for that String,
127    *          or null if the specified String is null, or is formatted incorrectly
128    */
129   public static Object   conv( final Class   type, final Attribute attr, Localizer localizer ) {
130     KeyStroke keyStroke = null;
131     if (attr != null) {
132       if (Parser.LOCALIZED_ATTRIBUTES.contains( attr.getName().toLowerCase() )) {
133         if (attr.getAttributeType() == Attribute.CDATA_TYPE) {
134           attr.setValue( localizer.getString( attr.getValue() ) );
135         }
136       }
137       keyStroke = KeyStroke.getKeyStroke( attr.getValue() );
138     }
139     return keyStroke;
140   }
141 
142   /**
143    * A <code>Converters</code> conversTo method informs about the Class type the converter
144    * is returning when its <code>convert</code> method is called
145    * @return <code>Class</code> - the Class the converter is returning when its convert method is called
146    */
147   public Class   convertsTo() {
148     return TEMPLATE;
149   }
150 }
151
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags