KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > jface > text > source > ISourceViewerExtension3


1 /*******************************************************************************
2  * Copyright (c) 2006 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
12 package org.eclipse.jface.text.source;
13
14 import org.eclipse.jface.text.quickassist.IQuickAssistAssistant;
15 import org.eclipse.jface.text.quickassist.IQuickAssistInvocationContext;
16
17 /**
18  * Extension interface for {@link org.eclipse.jface.text.source.ISourceViewer}.<p>
19  * It introduces the concept of a quick assist assistant and provides access
20  * to the quick assist invocation context. It also gives access to any currently
21  * showing annotation hover.</p>
22  *
23  * @see IQuickAssistAssistant
24  * @see IQuickAssistInvocationContext
25  * @since 3.2
26  */
27 public interface ISourceViewerExtension3 {
28
29     /**
30      * Returns this viewers quick assist assistant.
31      *
32      * @return the quick assist assistant or <code>null</code> if none is configured
33      * @since 3.2
34      */
35     public IQuickAssistAssistant getQuickAssistAssistant();
36
37     /**
38      * Returns this viewer's quick assist invocation context.
39      *
40      * @return the quick assist invocation context or <code>null</code> if none is available
41      */
42     IQuickAssistInvocationContext getQuickAssistInvocationContext();
43
44     /**
45      * Returns the currently displayed annotation hover if any, <code>null</code> otherwise.
46      *
47      * @return the currently displayed annotation hover or <code>null</code>
48      */
49     IAnnotationHover getCurrentAnnotationHover();
50
51 }
52
Popular Tags