public interface IContentAssistant
IContentAssistant
provides support on interactive content completion.
The content assistant is a ITextViewer
add-on. Its
purpose is to propose, display, and insert completions of the content
of the text viewer's document at the viewer's cursor position. In addition
to handle completions, a content assistant can also be requested to provide
context information. Context information is shown in a tool tip like popup.
As it is not always possible to determine the exact context at a given
document offset, a content assistant displays the possible contexts and requests
the user to choose the one whose information should be displayed.
A content assistant has a list of IContentAssistProcessor
objects each of which is registered for a particular document content
type. The content assistant uses the processors to react on the request
of completing documents or presenting context information.
In order to provide backward compatibility for clients of IContentAssistant
, extension
interfaces are used to provide a means of evolution. The following extension interfaces exist:
IContentAssistantExtension
since version 3.0 introducing
the following functions:
IContentAssistantExtension2
since version 3.2 introducing
the following functions:
IContentAssistantExtension3
since version 3.2 introducing
the following function:
IContentAssistantExtension4
since version 3.4 introducing
the following function:
The interface can be implemented by clients. By default, clients use
ContentAssistant
as the standard
implementer of this interface.
ITextViewer
,
IContentAssistProcessor
Modifier and Type | Field and Description |
---|---|
static int |
CONTEXT_INFO_ABOVE
Context info will be shown above the location it has been requested for without hiding the location.
|
static int |
CONTEXT_INFO_BELOW
Context info will be shown below the location it has been requested for without hiding the location.
|
static int |
PROPOSAL_OVERLAY
The context info list will overlay the list of completion proposals.
|
static int |
PROPOSAL_REMOVE
The completion proposal list will be removed before the context info list will be shown.
|
static int |
PROPOSAL_STACKED
The context info list will be presented without hiding or overlapping the completion proposal list.
|
Modifier and Type | Method and Description |
---|---|
IContentAssistProcessor |
getContentAssistProcessor(String contentType)
Returns the content assist processor to be used for the given content type.
|
void |
install(ITextViewer textViewer)
Installs content assist support on the given text viewer.
|
String |
showContextInformation()
Shows context information for the content at the viewer's cursor position.
|
String |
showPossibleCompletions()
Shows all possible completions of the content at the viewer's cursor position.
|
void |
uninstall()
Uninstalls content assist support from the text viewer it has
previously be installed on.
|
static final int PROPOSAL_OVERLAY
static final int PROPOSAL_REMOVE
static final int PROPOSAL_STACKED
static final int CONTEXT_INFO_ABOVE
static final int CONTEXT_INFO_BELOW
void install(ITextViewer textViewer)
textViewer
- the text viewer on which content assist will workvoid uninstall()
String showPossibleCompletions()
String showContextInformation()
IContentAssistProcessor getContentAssistProcessor(String contentType)
contentType
- the type of the content for which this
content assistant is to be requestednull
if none exists for the specified content type
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.