1 /*******************************************************************************
\r
2 * Copyright (c) 2007, 2010 Association for Decentralized Information Management
\r
3 * in Industry THTH ry.
\r
4 * All rights reserved. This program and the accompanying materials
\r
5 * are made available under the terms of the Eclipse Public License v1.0
\r
6 * which accompanies this distribution, and is available at
\r
7 * http://www.eclipse.org/legal/epl-v10.html
\r
10 * VTT Technical Research Centre of Finland - initial API and implementation
\r
11 *******************************************************************************/
\r
12 package org.simantics.ui.workbench.editor;
\r
14 import org.eclipse.jface.action.IAction;
\r
15 import org.eclipse.jface.resource.ImageDescriptor;
\r
16 import org.eclipse.ui.WorkbenchException;
\r
17 import org.simantics.db.ReadGraph;
\r
18 import org.simantics.db.Resource;
\r
19 import org.simantics.db.Session;
\r
20 import org.simantics.db.exception.DatabaseException;
\r
21 import org.simantics.ui.SimanticsUI;
\r
22 import org.simantics.ui.utils.ResourceAdaptionUtils;
\r
23 import org.simantics.ui.workbench.ResourceViewPartUtils;
\r
24 import org.simantics.ui.workbench.action.ResourceEditorAdapterAction;
\r
25 import org.simantics.utils.ui.ErrorLogger;
\r
26 import org.simantics.utils.ui.action.IPriorityAction;
\r
27 import org.simantics.utils.ui.action.PriorityActionAdapter;
\r
28 import org.simantics.utils.ui.workbench.WorkbenchUtils;
\r
31 * A base implementation for {@link EditorAdapter} that adapts
\r
32 * {@link #canHandle(ReadGraph, Object)} into
\r
33 * {@link #canHandle(ReadGraph, Resource)} and {@link #openEditor(Object)} into
\r
34 * {@link #openEditor(Resource)}.
\r
36 * If you only plan to support {@link Resource} or {@link Resource}-adaptable
\r
37 * editor inputs, this class is a bit easier to use than
\r
38 * {@link AbstractEditorAdapter}.
\r
40 * @author Tuukka Lehtonen
\r
42 public abstract class AbstractResourceEditorAdapter extends AbstractEditorAdapter {
\r
44 public AbstractResourceEditorAdapter(String name) {
\r
45 super(name, null, 0);
\r
48 public AbstractResourceEditorAdapter(String name, ImageDescriptor icon) {
\r
49 super(name, icon, 0);
\r
52 public AbstractResourceEditorAdapter(String name, ImageDescriptor icon, int priority) {
\r
53 super(name, icon, priority);
\r
57 * Override to perform the can handle check based on a single resource
\r
58 * adapted from the Object input using default mechanisms provided by
\r
59 * {@link ResourceAdaptionUtils}.
\r
61 * Returns <code>false</code> by default.
\r
66 * @throws DatabaseException
\r
68 protected boolean canHandle(ReadGraph g, Resource input) throws DatabaseException {
\r
73 * Override to open an editor based on a single resource adapted from the
\r
74 * Object input using default mechanisms provided by
\r
75 * {@link ResourceAdaptionUtils}.
\r
80 protected void openEditor(Resource input) throws Exception {
\r
84 public boolean canHandle(ReadGraph g, Object input) throws DatabaseException {
\r
85 Resource r = ResourceAdaptionUtils.toSingleResource(input);
\r
88 return canHandle(g, r);
\r
92 public void openEditor(Object input) throws Exception {
\r
93 Resource r = ResourceAdaptionUtils.toSingleResource(input);
\r
98 protected void openViewWithId(String viewId, Resource id, String suffix) throws Exception {
\r
99 Session ls = SimanticsUI.getSession();
\r
100 ResourceViewPartUtils.activateViewForResource(viewId, ls, id, null);
\r
103 protected void openViewWithId(String viewId, Resource id) throws Exception {
\r
104 openViewWithId(viewId, id, null);
\r
107 protected void openViewWithIdInPerspective(String viewId, Resource id, String perspectiveId) throws Exception {
\r
109 WorkbenchUtils.showPerspective(perspectiveId);
\r
110 } catch (WorkbenchException e) {
\r
111 ErrorLogger.getDefault().logError("Could not open perspective with ID'" + perspectiveId + "'.", e);
\r
114 openViewWithId(viewId, id);
\r
117 public IAction toAction(Resource r) {
\r
118 return new ResourceEditorAdapterAction(this, r);
\r
121 public IPriorityAction toPriorityAction(int priority, Resource r) {
\r
122 return new PriorityActionAdapter(priority, toAction(r));
\r