Author: slotia
Date: 2009-04-16 06:03:08 -0700 (Thu, 16 Apr 2009)
New Revision: 16595
Added:
cytoscape3/trunk/application/src/main/java/cytoscape/util/AcceleratorParser.java
Modified:
cytoscape3/trunk/application/src/main/java/cytoscape/internal/util/CytoscapeMenuBar.java
Log:
Added ability to read key stroke combinations
Modified:
cytoscape3/trunk/application/src/main/java/cytoscape/internal/util/CytoscapeMenuBar.java
===================================================================
---
cytoscape3/trunk/application/src/main/java/cytoscape/internal/util/CytoscapeMenuBar.java
2009-04-16 13:02:42 UTC (rev 16594)
+++
cytoscape3/trunk/application/src/main/java/cytoscape/internal/util/CytoscapeMenuBar.java
2009-04-16 13:03:08 UTC (rev 16595)
@@ -169,9 +169,9 @@
index_object = action.getPrefferedIndex();
- if (action.isAccelerated()) {
-
menu_item.setAccelerator(javax.swing.KeyStroke.getKeyStroke(action.getKeyCode(),
-
action.getKeyModifiers()));
+ if (action.isAccelerated() &&
(action.getValue(Action.ACCELERATOR_KEY) == null)) {
+ KeyStroke keyStroke =
KeyStroke.getKeyStroke(action.getKeyCode(), action.getKeyModifiers());
+ menu_item.setAccelerator(keyStroke);
}
menu.addMenuListener(action);
Added:
cytoscape3/trunk/application/src/main/java/cytoscape/util/AcceleratorParser.java
===================================================================
---
cytoscape3/trunk/application/src/main/java/cytoscape/util/AcceleratorParser.java
2009-04-16 13:02:42 UTC (rev 16594)
+++
cytoscape3/trunk/application/src/main/java/cytoscape/util/AcceleratorParser.java
2009-04-16 13:03:08 UTC (rev 16595)
@@ -0,0 +1,138 @@
+package cytoscape.util;
+
+import java.util.StringTokenizer;
+import java.awt.event.InputEvent;
+import java.awt.event.KeyEvent;
+import javax.swing.KeyStroke;
+import java.awt.Toolkit;
+import java.util.Map;
+import java.util.HashMap;
+
+/**
+ * Parses accelerator combinations to be used with menu items.
+ * <code>javax.swing.KeyStroke</code> provides a method called
+ * <code>getKeyStroke</code> that parses accelerator combinations.
+ * The purpose of this class is to address certain limitations of
+ * <code>getKeyStroke</code>:
+ * <ol>
+ * <li>
+ * <code>KeyStroke</code> is designed to parse any key combination,
+ * whereas <code>AcceleratorParser</code> is designed specifically
+ * for menu items. One can parse correctly formatted strings with
+ * <code>getKeyStroke</code> that is not acceptable for menu items.
+ * However, <code>AcceleratorParser</code> will always return
+ * <code>KeyStroke</code>s valid for menu items.
+ * </li>
+ * <li>
+ * If one attempts to parse an incorrectly formatted accelerator combination
+ * string with <code>getKeyStroke</code>, it will return <code>null</code>
+ * without describing a reason why the string is not formatted correctly.
+ * <code>AcceleratorParser</code> attempts to provide the user with
+ * as much information as necessary to determine why the string is
+ * not formatted correctly.
+ * </li>
+ * <li>
+ * On Linux and Windows, one typically uses the Command key to
+ * issue a keyboard shortcut. On Mac, it is the Apple key. If the programmer
+ * specifies that the Control key should be used in the accelerator
combination,
+ * <code>AcceleratorParser</code> will convert the Control key modifier to an
+ * Apple key modifier if one is running on a Mac and vice-versa.
+ * </li>
+ * </ol>
+ */
+public class AcceleratorParser
+{
+ static final Map<String,Integer> modifiers = new
HashMap<String,Integer>(8, 1.0f);
+ static
+ {
+ modifiers.put("command",
Toolkit.getDefaultToolkit().getMenuShortcutKeyMask());
+ modifiers.put("cmd",
Toolkit.getDefaultToolkit().getMenuShortcutKeyMask());
+ modifiers.put("meta",
Toolkit.getDefaultToolkit().getMenuShortcutKeyMask());
+ modifiers.put("control",
Toolkit.getDefaultToolkit().getMenuShortcutKeyMask());
+ modifiers.put("ctrl",
Toolkit.getDefaultToolkit().getMenuShortcutKeyMask());
+ modifiers.put("shift", InputEvent.SHIFT_MASK);
+ modifiers.put("alt", InputEvent.ALT_MASK);
+ modifiers.put("option", InputEvent.ALT_MASK);
+ modifiers.put("opt", InputEvent.ALT_MASK);
+ }
+
+ /**
+ * Parses an accelerator combination.
+ *
+ * A well formed accelerator combination has the following syntax:
+ * <pre>
+ * <modifiers>* <virtualKey>
+ * modifiers := command | cmd | meta | control |
+ * ctrl | shift | alt | option | opt
+ * virtualKey := a constant in java.awt.event.KeyEvent beginning
with VK_
+ * </pre>
+ * <p>Modifiers do not necessarily have the same meaning as those
listed in
+ * <code>KeyEvent</code> or <code>InputEvent</code>.
+ * Modifiers have the following meanings:
+ * <ul>
+ * <li><code>command</code>, <code>cmd</code>, <code>meta</code>,
+ * <code>control</code>, <code>ctrl</code>: the Control key for Windows
+ * and Linux users or the Apple key for Mac users</li>
+ * <li><code>shift</code>: the Shift key</li>
+ * <li><code>alt</code>, <code>option</code>, <code>opt</code>:
+ * the Alt key, also called the Option key on Mac keyboards</li>
+ * </ul></p>
+ *
+ * <p>Examples of valid accelerator combinations:
+ * <ul>
+ * <li><code>cmd shift a</code></li>
+ * <li><code>insert</code></li>
+ * <li><code>shift circumflex</code></li>
+ * </ul></p>
+ * @param string A well formatted accelerator combination described
above.
+ * @throws IllegalArgumentException if <code>string</code> is not well
formed
+ */
+ public static KeyStroke parse(String string)
+ {
+ int keyCode = 0;
+ int modifierCode = 0;
+ final StringTokenizer tokenizer = new StringTokenizer(string);
+ while (tokenizer.hasMoreTokens())
+ {
+ String token = tokenizer.nextToken();
+ if (tokenizer.hasMoreTokens())
+ {
+ Integer modifier = modifiers.get(token);
+ if (modifier == null)
+ throw new
IllegalArgumentException(String.format("The modifier \'%s\' in \'%s\' is
invalid; valid modifiers are: %s", token, string,
modifiers.keySet().toString()));
+ modifierCode |= modifier.intValue();
+ }
+ else
+ {
+ keyCode = lookupVKCode(token);
+ }
+ }
+
+ if (keyCode == 0)
+ throw new IllegalArgumentException("No virtual key was
specified");
+
+ return KeyStroke.getKeyStroke(keyCode, modifierCode);
+ }
+
+ static int lookupVKCode(String name)
+ {
+ String error = String.format("The virtual key \'%s\' does not
exist", name);
+ name = "VK_" + name.toUpperCase();
+
+ int code = 0;
+ try
+ {
+ code =
KeyEvent.class.getField(name).getInt(KeyEvent.class);
+ }
+ catch (NoSuchFieldException ex)
+ {
+ throw new IllegalArgumentException(error, ex);
+ }
+ catch (IllegalAccessException ex)
+ {
+ throw new IllegalArgumentException(error, ex);
+ }
+
+ return code;
+ }
+}
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"cytoscape-cvs" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to
[email protected]
For more options, visit this group at
http://groups.google.com/group/cytoscape-cvs?hl=en
-~----------~----~----~----~------~----~------~--~---
