net.sourceforge.phpeclipse.ui/src/net/sourceforge/phpdt/ui/text/java/hover/IJavaEditorTextHover.java

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