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;
\r
14 import org.eclipse.ui.IEditorInput;
\r
15 import org.simantics.db.ReadGraph;
\r
16 import org.simantics.db.exception.DatabaseException;
\r
17 import org.simantics.project.IProjectService;
\r
18 import org.simantics.utils.datastructures.hints.IHintContext.Key;
\r
19 import org.simantics.utils.datastructures.hints.IHintContext.KeyOf;
\r
22 * An IProject service for naming editors while working on a project.
\r
24 * @author Tuukka Lehtonen
\r
26 public interface IEditorNamingService extends IProjectService {
\r
29 * This key is used with an IProject for storing an
\r
30 * {@link IEditorNamingService} in it. If this hint exists in the project,
\r
31 * then the project has its own way of naming editors and it should be used
\r
32 * by editors to initialize their titles.
\r
34 Key KEY_EDITOR_NAMING_SERVICE = new KeyOf(IEditorNamingService.class);
\r
37 * Get the name that should be shown on an editor with the specified id and
\r
38 * the specified input.
\r
40 * @param graph a graph for reading information for constructing a name
\r
41 * @param editorId the ID of the editor to be named
\r
42 * @param input the input of the editor to be named
\r
43 * @return the service-preferred name for the editor
\r
44 * @throws DatabaseException on any errors that occur while reading the
\r
47 String getName(ReadGraph graph, String editorId, IEditorInput input) throws DatabaseException;
\r