|
129
|
1 /*******************************************************************************
|
|
|
2 * Copyright (c) 2000, 2008 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 * Port to the D programming language:
|
|
|
11 * Frank Benoit <benoit@tionex.de>
|
|
|
12 *******************************************************************************/
|
|
|
13 module dwtx.jface.text.source.IAnnotationHover;
|
|
|
14
|
|
|
15 import dwt.dwthelper.utils;
|
|
|
16
|
|
|
17
|
|
|
18
|
|
|
19 /**
|
|
|
20 * Provides the information to be displayed in a hover popup window which
|
|
|
21 * appears over the presentation area of annotations.
|
|
|
22 * <p>
|
|
|
23 * In order to provide backward compatibility for clients of
|
|
|
24 * <code>IAnnotationHover</code>, extension interfaces are used as a means of
|
|
|
25 * evolution. The following extension interfaces exist:
|
|
|
26 * <ul>
|
|
|
27 * <li>{@link dwtx.jface.text.source.IAnnotationHoverExtension} since
|
|
|
28 * version 3.0 allowing a text hover to provide a creator for the hover control.
|
|
|
29 * This allows for sophisticated hovers in a way that information computed by
|
|
|
30 * the hover can be displayed in the best possible form.</li>
|
|
|
31 * <li>{@link dwtx.jface.text.source.IAnnotationHoverExtension2} since
|
|
|
32 * version 3.2 allowing a text hover to specify whether it handles mouse-wheel
|
|
|
33 * events itself.</li>
|
|
|
34 * </ul></p>
|
|
|
35 * <p>
|
|
|
36 * Clients may implement this interface.</p>
|
|
|
37 *
|
|
|
38 * @see dwtx.jface.text.source.IAnnotationHoverExtension
|
|
|
39 * @see dwtx.jface.text.source.IAnnotationHoverExtension2
|
|
|
40 */
|
|
|
41 public interface IAnnotationHover {
|
|
|
42
|
|
|
43 /**
|
|
|
44 * Returns the text which should be presented in the a
|
|
|
45 * hover popup window. This information is requested based on
|
|
|
46 * the specified line number.
|
|
|
47 *
|
|
|
48 * @param sourceViewer the source viewer this hover is registered with
|
|
|
49 * @param lineNumber the line number for which information is requested
|
|
|
50 * @return the requested information or <code>null</code> if no such information exists
|
|
|
51 */
|
|
|
52 String getHoverInfo(ISourceViewer sourceViewer, int lineNumber);
|
|
|
53 }
|
