public interface ICompletionProposal
In order to provide backward compatibility for clients of ICompletionProposal
, extension
interfaces are used to provide a means of evolution. The following extension interfaces exist:
ICompletionProposalExtension
since version 2.0 introducing
the following functions:
ICompletionProposalExtension2
since version 2.1 introducing
the following functions:
ICompletionProposalExtension3
since version 3.0 introducing
the following functions:
ICompletionProposalExtension4
since version 3.1 introducing
the following functions:
ICompletionProposalExtension5
since version 3.2 introducing
the following function:
ICompletionProposalExtension6
since version 3.4 introducing
the following function:
ICompletionProposalExtension7
since version 3.11 introducing
the following function:
This interface can be implemented by clients. By default, clients use
CompletionProposal
as the
standard implementer of this interface.
IContentAssistProcessor
Modifier and Type | Method and Description |
---|---|
void |
apply(IDocument document)
Inserts the proposed completion into the given document.
|
String |
getAdditionalProposalInfo()
Returns optional additional information about the proposal.
|
IContextInformation |
getContextInformation()
Returns optional context information associated with this proposal.
|
String |
getDisplayString()
Returns the string to be displayed in the list of completion proposals.
|
Image |
getImage()
Returns the image to be displayed in the list of completion proposals.
|
Point |
getSelection(IDocument document)
Returns the new selection after the proposal has been applied to
the given document in absolute document coordinates.
|
void apply(IDocument document)
document
- the document into which to insert the proposed completionPoint getSelection(IDocument document)
null
, no new selection is set.
A document change can trigger other document changes, which have
to be taken into account when calculating the new selection. Typically,
this would be done by installing a document listener or by using a
document position during apply(IDocument)
.document
- the document into which the proposed completion has been insertedString getAdditionalProposalInfo()
If ICompletionProposalExtension5
is implemented, this method should not be called any
longer. This method may be deprecated in a future release.
null
String getDisplayString()
ICompletionProposalExtension6.getStyledDisplayString()
,
ICompletionProposalExtension7.getStyledDisplayString(IDocument, int, BoldStylerProvider)
Image getImage()
null
if no image is desiredIContextInformation getContextInformation()
null
Copyright (c) 2000, 2018 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.