Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.scenegraph / src / org / simantics / scenegraph / g2d / events / KeyEvent.java

diff --git a/bundles/org.simantics.scenegraph/src/org/simantics/scenegraph/g2d/events/KeyEvent.java b/bundles/org.simantics.scenegraph/src/org/simantics/scenegraph/g2d/events/KeyEvent.java
new file mode 100644 (file)
index 0000000..8715844
--- /dev/null
+++ b/bundles/org.simantics.scenegraph/src/org/simantics/scenegraph/g2d/events/KeyEvent.java
@@ -0,0 +1,110 @@
+/*******************************************************************************\r
+ * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
+ * in Industry THTH ry.\r
+ * All rights reserved. This program and the accompanying materials\r
+ * are made available under the terms of the Eclipse Public License v1.0\r
+ * which accompanies this distribution, and is available at\r
+ * http://www.eclipse.org/legal/epl-v10.html\r
+ *\r
+ * Contributors:\r
+ *     VTT Technical Research Centre of Finland - initial API and implementation\r
+ *******************************************************************************/\r
+/*\r
+ *\r
+ * @author Toni Kalajainen\r
+ */\r
+package org.simantics.scenegraph.g2d.events;\r
+\r
+/**\r
+ * Key event\r
+ * \r
+ * @see Event\r
+ * @see java.awt.event.KeyEvent for Virtual Key (VK) codes\r
+ */\r
+public abstract class KeyEvent extends org.simantics.scenegraph.g2d.events.Event {\r
+\r
+    private static final long serialVersionUID = 2802306097538088526L;\r
+\r
+    /** Key ascii character */\r
+    public final char         character;\r
+\r
+    /**\r
+     * AWT Key code\r
+     * \r
+     * @see java.awt.event.KeyEvent\r
+     */\r
+    public final int          keyCode;\r
+\r
+    /** AWT state mask */\r
+    public final int          stateMask;\r
+\r
+    public KeyEvent(Object context, long time, char character, int keyCode, int stateMask) {\r
+        super(context, time);\r
+        this.character = character;\r
+        this.keyCode = keyCode;\r
+        this.stateMask = stateMask;\r
+    }\r
+\r
+    public boolean hasAnyModifier(int mask) {\r
+        return (stateMask & mask) != 0;\r
+    }\r
+\r
+    public boolean hasAllModifiers(int mask) {\r
+        return (stateMask & mask) == mask;\r
+    }\r
+\r
+    /**\r
+     * Returns whether or not the Shift modifier is down on this event.\r
+     */\r
+    public boolean isShiftDown() {\r
+        return (stateMask & MouseEvent.SHIFT_MASK) != 0;\r
+    }\r
+\r
+    /**\r
+     * Returns whether or not the Control modifier is down on this event.\r
+     */\r
+    public boolean isControlDown() {\r
+        return (stateMask & MouseEvent.CTRL_MASK) != 0;\r
+    }\r
+\r
+    /**\r
+     * Returns whether or not the Alt modifier is down on this event.\r
+     */\r
+    public boolean isAltDown() {\r
+        return (stateMask & MouseEvent.ALT_MASK) != 0;\r
+    }\r
+\r
+    /**\r
+     * Returns whether or not the Alt Graph modifier is down on this event.\r
+     */\r
+    public boolean isAltGraphDown() {\r
+        return (stateMask & MouseEvent.ALT_GRAPH_MASK) != 0;\r
+    }\r
+\r
+    public static class KeyPressedEvent extends KeyEvent {\r
+        private static final long serialVersionUID = -648528900110788474L;\r
+\r
+        public KeyPressedEvent(Object context, long time, char character, int keyCode, int stateMask) {\r
+            super(context, time, character, keyCode, stateMask);\r
+        }\r
+\r
+        @Override\r
+        public String toString() {\r
+            return "Key press: character='" + character + "', keyCode='" + keyCode + "', stateMask='" + stateMask + "'";\r
+        }\r
+    }\r
+\r
+    public static class KeyReleasedEvent extends KeyEvent {\r
+        private static final long serialVersionUID = -5434711507289906052L;\r
+\r
+        public KeyReleasedEvent(Object context, long time, char character, int keyCode, int stateMask) {\r
+            super(context, time, character, keyCode, stateMask);\r
+        }\r
+\r
+        @Override\r
+        public String toString() {\r
+            return "Key release: character='" + character + "', keyCode='" + keyCode + "', stateMask='" + stateMask + "'";\r
+        }\r
+    }\r
+\r
+}\r