Interface ICompletionProposalExtension3
- All Known Implementing Classes:
TemplateProposal
public interface ICompletionProposalExtension3
Extends
ICompletionProposal
with the following functions:
- provision of a custom information control creator
- provide a custom completion text and offset for prefix completion
- Since:
- 3.0
-
Method Summary
Modifier and TypeMethodDescriptionReturns the information control creator of this completion proposal.intgetPrefixCompletionStart(IDocument document, int completionOffset) Returns the document offset at which the receiver would insert its proposal.getPrefixCompletionText(IDocument document, int completionOffset) Returns the string that would be inserted at the position returned fromgetPrefixCompletionStart(IDocument, int)if this proposal was applied.
-
Method Details
-
getInformationControlCreator
IInformationControlCreator getInformationControlCreator()Returns the information control creator of this completion proposal.- Returns:
- the information control creator, or
nullif no custom control creator is available
-
getPrefixCompletionText
Returns the string that would be inserted at the position returned fromgetPrefixCompletionStart(IDocument, int)if this proposal was applied. If the replacement string cannot be determined,nullmay be returned.- Parameters:
document- the document that the receiver applies tocompletionOffset- the offset intodocumentwhere the completion takes place- Returns:
- the replacement string or
nullif it cannot be determined
-
getPrefixCompletionStart
Returns the document offset at which the receiver would insert its proposal.- Parameters:
document- the document that the receiver applies tocompletionOffset- the offset intodocumentwhere the completion takes place- Returns:
- the offset at which the proposal would insert its proposal
-