337a481687b4ac84fe25fed5cc6623fe2286231a
[phpeclipse.git] / net.sourceforge.phpeclipse / 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
15 import org.eclipse.ui.IEditorPart;
16
17 /**
18  * Provides a hover popup which appears on top of an editor with relevant
19  * display information. If the text hover does not provide information no
20  * hover popup is shown.
21  * <p>
22  * Clients may implement this interface.</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 the editor on which the hover popup should be shown
35          */
36         void setEditor(IEditorPart editor);
37
38 }
39