blob: dfd64da66059b6aef4736bf12fccbff232c441df (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
|
/*******************************************************************************
* Copyright (c) 2000, 2008 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.jface.text.source;
/**
* Provides the information to be displayed in a hover popup window which appears over the
* presentation area of annotations.
* <p>
* In order to provide backward compatibility for clients of <code>IAnnotationHover</code>,
* extension interfaces are used as a means of evolution. The following extension interfaces exist:
* </p>
* <ul>
* <li>{@link org.eclipse.jface.text.source.IAnnotationHoverExtension} since version 3.0 allowing a
* text hover to provide a creator for the hover control. This allows for sophisticated hovers in a
* way that information computed by the hover can be displayed in the best possible form.</li>
* <li>{@link org.eclipse.jface.text.source.IAnnotationHoverExtension2} since version 3.2 allowing a
* text hover to specify whether it handles mouse-wheel events itself.</li>
* </ul>
* <p>
* Clients may implement this interface.
* </p>
*
* @see org.eclipse.jface.text.source.IAnnotationHoverExtension
* @see org.eclipse.jface.text.source.IAnnotationHoverExtension2
*/
public interface IAnnotationHover {
/**
* Returns the text which should be presented in the a
* hover popup window. This information is requested based on
* the specified line number.
*
* @param sourceViewer the source viewer this hover is registered with
* @param lineNumber the line number for which information is requested
* @return the requested information or <code>null</code> if no such information exists
*/
String getHoverInfo(ISourceViewer sourceViewer, int lineNumber);
}
|
