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

   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
   8  *\r
   9  * Contributors:\r
  10  *     VTT Technical Research Centre of Finland - initial API and implementation\r
  11  *******************************************************************************/\r
  12 package org.simantics.ui.workbench;\r
  13 \r
  14 import org.eclipse.ui.IEditorInput;\r
  15 import org.simantics.db.ReadGraph;\r
  16 import org.simantics.db.exception.DatabaseException;\r
  17 \r
  18 /**\r
  19  * An IProject service for naming editors while working on a project.\r
  20  * \r
  21  * @author Tuukka Lehtonen\r
  22  */\r
  23 public interface IEditorNamingService2 extends IEditorNamingService {\r
  24 \r
  25     /**\r
  26      * Get the tool tip text that should be shown on an editor with the specified\r
  27      * id and the specified input.\r
  28      * \r
  29      * @param graph a graph for reading information for constructing a name\r
  30      * @param editorId the ID of the editor to be named\r
  31      * @param input the input of the editor to be named\r
  32      * @return the service-preferred tool tip text for the editor\r
  33      * @throws DatabaseException on any errors that occur while reading the\r
  34      *         graph\r
  35      */\r
  36     String getToolTipText(ReadGraph graph, String editorId, IEditorInput input) throws DatabaseException;\r
  37 \r
  38 }\r