Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.diagram / src / org / simantics / diagram / participant / SGFocusParticipant.java

diff --git a/bundles/org.simantics.diagram/src/org/simantics/diagram/participant/SGFocusParticipant.java b/bundles/org.simantics.diagram/src/org/simantics/diagram/participant/SGFocusParticipant.java
new file mode 100644 (file)
index 0000000..6adc34a
--- /dev/null
+++ b/bundles/org.simantics.diagram/src/org/simantics/diagram/participant/SGFocusParticipant.java
@@ -0,0 +1,101 @@
+/*******************************************************************************\r
+ * Copyright (c) 2007, 2013 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
+package org.simantics.diagram.participant;\r
+\r
+import java.awt.event.FocusEvent;\r
+import java.awt.event.FocusListener;\r
+\r
+import org.simantics.g2d.canvas.ICanvasContext;\r
+import org.simantics.g2d.canvas.impl.AbstractCanvasParticipant;\r
+import org.simantics.g2d.canvas.impl.DependencyReflection.Reference;\r
+import org.simantics.g2d.chassis.AWTChassis;\r
+import org.simantics.g2d.chassis.SWTChassis;\r
+\r
+/**\r
+ * The purpose of this participant is to properly handle contexts in Eclipse/SWT\r
+ * based deployments G2D canvases where it is possible that Eclipse eats input\r
+ * events based on UI contexts, key bindings, etc.\r
+ * \r
+ * This participant depends on the {@link ContextUtil} canvas participant.\r
+ * \r
+ * When some other scene graph component or UI Part, besides the root pane, gets focus,\r
+ * this participant will deactivate its {@link #contextId}. When the root pane gets the \r
+ * focus back, it will restore {@link #contextId} to allow Eclipse key bindings\r
+ * for that {@link #contextId} to work properly. \r
+ * \r
+ * @see ContextUtil\r
+ * \r
+ * @author J-P Laine\r
+ * @author Tuukka Lehtonen\r
+ * @author Teemu Lempinen\r
+ */\r
+public class SGFocusParticipant extends AbstractCanvasParticipant implements FocusListener {\r
+\r
+    @Reference\r
+    ContextUtil                 contextUtil;\r
+    \r
+    @Reference\r
+    org.simantics.diagram.participant.e4.ContextUtil e4ContextUtil;\r
+\r
+    final SWTChassis            chassis;\r
+    String                      contextId;\r
+    ContextState                originalContextState;\r
+\r
+    public SGFocusParticipant(SWTChassis chassis, String contextId) {\r
+        super();\r
+        this.chassis = chassis;\r
+        this.contextId = contextId;\r
+    }\r
+\r
+    @Override\r
+    public void addedToContext(ICanvasContext ctx) {\r
+        super.addedToContext(ctx);\r
+        chassis.getAWTComponent().addFocusListener(this);\r
+    }\r
+\r
+    @Override\r
+    public void removedFromContext(ICanvasContext ctx) {\r
+        if (!chassis.isDisposed()) {\r
+            AWTChassis component = chassis.getAWTComponent();\r
+            if (component != null)\r
+                component.removeFocusListener(this);\r
+        }\r
+        super.removedFromContext(ctx);\r
+    }\r
+\r
+    @Override\r
+    public void focusGained(FocusEvent e) {\r
+        ContextUtil util = contextUtil;\r
+        if (util != null) {\r
+            DiagramCommandBindings.activateBindings(util, contextId);\r
+        } else {\r
+            org.simantics.diagram.participant.e4.ContextUtil e4Util = e4ContextUtil;\r
+            if (e4Util != null) {\r
+                DiagramCommandBindings.activateBindings(e4Util, contextId);\r
+            }\r
+        }\r
+    }\r
+\r
+    @Override\r
+    public void focusLost(FocusEvent e) {\r
+        ContextUtil util = contextUtil;\r
+        if (util != null) {\r
+            DiagramCommandBindings.deactivateBindings(util, contextId);\r
+        } else {\r
+            org.simantics.diagram.participant.e4.ContextUtil e4Util = e4ContextUtil;\r
+            if (e4Util != null) {\r
+                DiagramCommandBindings.deactivateBindings(e4Util, contextId);\r
+            }\r
+        }\r
+    }\r
+\r
+}
\ No newline at end of file