public interface ICompletionProposal
In order to provide backward compatibility for clients of
interfaces are used to provide a means of evolution. The following extension interfaces exist:
ICompletionProposalExtensionsince version 2.0 introducing the following functions:
ICompletionProposalExtension2since version 2.1 introducing the following functions:
ICompletionProposalExtension3since version 3.0 introducing the following functions:
ICompletionProposalExtension4since version 3.1 introducing the following functions:
ICompletionProposalExtension5since version 3.2 introducing the following function:
ICompletionProposalExtension6since version 3.4 introducing the following function:
ICompletionProposalExtension7since 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.
|Modifier and Type||Method and Description|
Inserts the proposed completion into the given document.
Returns optional additional information about the proposal.
Returns optional context information associated with this proposal.
Returns the string to be displayed in the list of completion proposals.
Returns the image to be displayed in the list of completion proposals.
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 completion
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
document- the document into which the proposed completion has been inserted
ICompletionProposalExtension5 is implemented, this method should not be called any
longer. This method may be deprecated in a future release.
ICompletionProposalExtension7.getStyledDisplayString(IDocument, int, BoldStylerProvider)
nullif no image is desired
Copyright (c) 2000, 2017 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.