Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.ui / src / org / simantics / ui / workbench / editor / AbstractResourceEditorAdapter.java

diff --git a/bundles/org.simantics.ui/src/org/simantics/ui/workbench/editor/AbstractResourceEditorAdapter.java b/bundles/org.simantics.ui/src/org/simantics/ui/workbench/editor/AbstractResourceEditorAdapter.java
new file mode 100644 (file)
index 0000000..83303ca
--- /dev/null
+++ b/bundles/org.simantics.ui/src/org/simantics/ui/workbench/editor/AbstractResourceEditorAdapter.java
@@ -0,0 +1,125 @@
+/*******************************************************************************\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
+package org.simantics.ui.workbench.editor;\r
+\r
+import org.eclipse.jface.action.IAction;\r
+import org.eclipse.jface.resource.ImageDescriptor;\r
+import org.eclipse.ui.WorkbenchException;\r
+import org.simantics.db.ReadGraph;\r
+import org.simantics.db.Resource;\r
+import org.simantics.db.Session;\r
+import org.simantics.db.exception.DatabaseException;\r
+import org.simantics.ui.SimanticsUI;\r
+import org.simantics.ui.utils.ResourceAdaptionUtils;\r
+import org.simantics.ui.workbench.ResourceViewPartUtils;\r
+import org.simantics.ui.workbench.action.ResourceEditorAdapterAction;\r
+import org.simantics.utils.ui.ErrorLogger;\r
+import org.simantics.utils.ui.action.IPriorityAction;\r
+import org.simantics.utils.ui.action.PriorityActionAdapter;\r
+import org.simantics.utils.ui.workbench.WorkbenchUtils;\r
+\r
+/**\r
+ * A base implementation for {@link EditorAdapter} that adapts\r
+ * {@link #canHandle(ReadGraph, Object)} into\r
+ * {@link #canHandle(ReadGraph, Resource)} and {@link #openEditor(Object)} into\r
+ * {@link #openEditor(Resource)}.\r
+ * \r
+ * If you only plan to support {@link Resource} or {@link Resource}-adaptable\r
+ * editor inputs, this class is a bit easier to use than\r
+ * {@link AbstractEditorAdapter}.\r
+ * \r
+ * @author Tuukka Lehtonen\r
+ */\r
+public abstract class AbstractResourceEditorAdapter extends AbstractEditorAdapter {\r
+\r
+    public AbstractResourceEditorAdapter(String name) {\r
+        super(name, null, 0);\r
+    }\r
+\r
+    public AbstractResourceEditorAdapter(String name, ImageDescriptor icon) {\r
+        super(name, icon, 0);\r
+    }\r
+\r
+    public AbstractResourceEditorAdapter(String name, ImageDescriptor icon, int priority) {\r
+        super(name, icon, priority);\r
+    }\r
+\r
+    /**\r
+     * Override to perform the can handle check based on a single resource\r
+     * adapted from the Object input using default mechanisms provided by\r
+     * {@link ResourceAdaptionUtils}.\r
+     * \r
+     * Returns <code>false</code> by default.\r
+     * \r
+     * @param g\r
+     * @param input\r
+     * @return\r
+     * @throws DatabaseException\r
+     */\r
+    protected boolean canHandle(ReadGraph g, Resource input) throws DatabaseException {\r
+        return false;\r
+    }\r
+\r
+    /**\r
+     * Override to open an editor based on a single resource adapted from the\r
+     * Object input using default mechanisms provided by\r
+     * {@link ResourceAdaptionUtils}.\r
+     * \r
+     * @param input\r
+     * @throws Exception\r
+     */\r
+    protected void openEditor(Resource input) throws Exception {\r
+    }\r
+\r
+    @Override\r
+    public boolean canHandle(ReadGraph g, Object input) throws DatabaseException {\r
+        Resource r = ResourceAdaptionUtils.toSingleResource(input);\r
+        if (r == null)\r
+            return false;\r
+        return canHandle(g, r);\r
+    }\r
+\r
+    @Override\r
+    public void openEditor(Object input) throws Exception {\r
+        Resource r = ResourceAdaptionUtils.toSingleResource(input);\r
+        if (r != null)\r
+            openEditor(r);\r
+    }\r
+\r
+    protected void openViewWithId(String viewId, Resource id, String suffix) throws Exception {\r
+        Session ls = SimanticsUI.getSession();\r
+        ResourceViewPartUtils.activateViewForResource(viewId, ls, id, null);\r
+    }\r
+\r
+    protected void openViewWithId(String viewId, Resource id) throws Exception {\r
+        openViewWithId(viewId, id, null);\r
+    }\r
+\r
+    protected void openViewWithIdInPerspective(String viewId, Resource id, String perspectiveId) throws Exception {\r
+        try {\r
+            WorkbenchUtils.showPerspective(perspectiveId);\r
+        } catch (WorkbenchException e) {\r
+            ErrorLogger.getDefault().logError("Could not open perspective with ID'" + perspectiveId + "'.", e);\r
+        }\r
+\r
+        openViewWithId(viewId, id);\r
+    }\r
+\r
+    public IAction toAction(Resource r) {\r
+        return new ResourceEditorAdapterAction(this, r);\r
+    }\r
+\r
+    public IPriorityAction toPriorityAction(int priority, Resource r) {\r
+        return new PriorityActionAdapter(priority, toAction(r));\r
+    }\r
+\r
+}
\ No newline at end of file