bundles/org.simantics.ui/src/org/simantics/ui/workbench/IEditorNamingService2.java

   1 /*******************************************************************************
   2  * Copyright (c) 2007, 2010 Association for Decentralized Information Management
   3  * in Industry THTH ry.
   4  * All rights reserved. This program and the accompanying materials
   5  * are made available under the terms of the Eclipse Public License v1.0
   6  * which accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *     VTT Technical Research Centre of Finland - initial API and implementation
  11  *******************************************************************************/
  12 package org.simantics.ui.workbench;
  13
  14 import org.eclipse.ui.IEditorInput;
  15 import org.simantics.db.ReadGraph;
  16 import org.simantics.db.exception.DatabaseException;
  17
  18 /**
  19  * An IProject service for naming editors while working on a project.
  20  *
  21  * @author Tuukka Lehtonen
  22  */
  23 public interface IEditorNamingService2 extends IEditorNamingService {
  24
  25     /**
  26      * Get the tool tip text that should be shown on an editor with the specified
  27      * id and the specified input.
  28      *
  29      * @param graph a graph for reading information for constructing a name
  30      * @param editorId the ID of the editor to be named
  31      * @param input the input of the editor to be named
  32      * @return the service-preferred tool tip text for the editor
  33      * @throws DatabaseException on any errors that occur while reading the
  34      *         graph
  35      */
  36     String getToolTipText(ReadGraph graph, String editorId, IEditorInput input) throws DatabaseException;
  37
  38 }