case-study/jdt-after/ui/org/eclipse/jdt/ui/text/java/hover/IJavaEditorTextHover.java

   1 /*******************************************************************************
   2  * Copyright (c) 2000, 2005 IBM Corporation and others.
   3  * All rights reserved. This program and the accompanying materials
   4  * are made available under the terms of the Eclipse Public License v1.0
   5  * which accompanies this distribution, and is available at
   6  * http://www.eclipse.org/legal/epl-v10.html
   7  *
   8  * Contributors:
   9  *     IBM Corporation - initial API and implementation
  10  *******************************************************************************/
  11 package org.eclipse.jdt.ui.text.java.hover;
  12
  13 import org.eclipse.jface.text.ITextHover;
  14
  15 import org.eclipse.ui.IEditorPart;
  16
  17
  18 /**
  19  * Provides a hover popup which appears on top of an editor with relevant
  20  * display information. If the text hover does not provide information no
  21  * hover popup is shown.
  22  * <p>
  23  * Clients may implement this interface.
  24  * </p>
  25  *
  26  * @see org.eclipse.ui.IEditorPart
  27  * @see org.eclipse.jface.text.ITextHover
  28  *
  29  * @since 2.0
  30  */
  31 public interface IJavaEditorTextHover extends ITextHover {
  32
  33         /**
  34          * Sets the editor on which the hover is shown.
  35          *
  36          * @param editor the editor on which the hover popup should be shown
  37          */
  38         void setEditor(IEditorPart editor);
  39
  40 }
  41