X-Git-Url: https://gerrit.simantics.org/r/gitweb?a=blobdiff_plain;f=bundles%2Forg.simantics.ui%2Fsrc%2Forg%2Fsimantics%2Fui%2Fworkbench%2FIEditorNamingService.java;fp=bundles%2Forg.simantics.ui%2Fsrc%2Forg%2Fsimantics%2Fui%2Fworkbench%2FIEditorNamingService.java;h=2640da028714d6f4430003c103f6ea4d0379e548;hb=969bd23cab98a79ca9101af33334000879fb60c5;hp=0000000000000000000000000000000000000000;hpb=866dba5cd5a3929bbeae85991796acb212338a08;p=simantics%2Fplatform.git

diff --git a/bundles/org.simantics.ui/src/org/simantics/ui/workbench/IEditorNamingService.java b/bundles/org.simantics.ui/src/org/simantics/ui/workbench/IEditorNamingService.java
new file mode 100644
index 000000000..2640da028
--- /dev/null
+++ b/bundles/org.simantics.ui/src/org/simantics/ui/workbench/IEditorNamingService.java
@@ -0,0 +1,49 @@
+/*******************************************************************************
+ * Copyright (c) 2007, 2010 Association for Decentralized Information Management
+ * in Industry THTH ry.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *     VTT Technical Research Centre of Finland - initial API and implementation
+ *******************************************************************************/
+package org.simantics.ui.workbench;
+
+import org.eclipse.ui.IEditorInput;
+import org.simantics.db.ReadGraph;
+import org.simantics.db.exception.DatabaseException;
+import org.simantics.project.IProjectService;
+import org.simantics.utils.datastructures.hints.IHintContext.Key;
+import org.simantics.utils.datastructures.hints.IHintContext.KeyOf;
+
+/**
+ * An IProject service for naming editors while working on a project.
+ * 
+ * @author Tuukka Lehtonen
+ */
+public interface IEditorNamingService extends IProjectService {
+
+    /**
+     * This key is used with an IProject for storing an
+     * {@link IEditorNamingService} in it. If this hint exists in the project,
+     * then the project has its own way of naming editors and it should be used
+     * by editors to initialize their titles.
+     */
+    Key KEY_EDITOR_NAMING_SERVICE = new KeyOf(IEditorNamingService.class);
+
+    /**
+     * Get the name that should be shown on an editor with the specified id and
+     * the specified input.
+     * 
+     * @param graph a graph for reading information for constructing a name
+     * @param editorId the ID of the editor to be named
+     * @param input the input of the editor to be named
+     * @return the service-preferred name for the editor
+     * @throws DatabaseException on any errors that occur while reading the
+     *         graph
+     */
+    String getName(ReadGraph graph, String editorId, IEditorInput input) throws DatabaseException;
+
+}