Interface IContentAssistProcessor
- All Known Subinterfaces:
IContentAssistProcessorExtension,ISubjectControlContentAssistProcessor
- All Known Implementing Classes:
HippieProposalProcessor,TemplateCompletionProcessor
public interface IContentAssistProcessor
A content assist processor proposes completions and computes context information for a particular
content type. A content assist processor is a
IContentAssistant plug-in.
This interface must be implemented by clients. Implementers should be registered with a content assistant in order to get involved in the assisting process.
In order to provide backward compatibility for clients of IContentAssistProcessor,
extension interfaces are used to provide a means of evolution. The following extension interfaces
exist:
IContentAssistProcessorExtensionsince version 3.17 introducing the following functions:- isCompletionProposalAutoActivation(char, ITextViewer, int) providing context information when calculating auto activation
- isContextInformationAutoActivation(char, ITextViewer, int) providing context information when calculating auto activation
-
Method Summary
Modifier and TypeMethodDescriptioncomputeCompletionProposals(ITextViewer viewer, int offset) Returns a list of completion proposals based on the specified location within the document that corresponds to the current cursor position within the text viewer.computeContextInformation(ITextViewer viewer, int offset) Returns information about possible contexts based on the specified location within the document that corresponds to the current cursor position within the text viewer.char[]Returns the characters which when entered by the user should automatically trigger the presentation of possible completions.char[]Returns the characters which when entered by the user should automatically trigger the presentation of context information.Returns a validator used to determine when displayed context information should be dismissed.Returns the reason why this content assist processor was unable to produce any completion proposals or context information.
-
Method Details
-
computeCompletionProposals
Returns a list of completion proposals based on the specified location within the document that corresponds to the current cursor position within the text viewer.- Parameters:
viewer- the viewer whose document is used to compute the proposalsoffset- an offset within the document for which completions should be computed- Returns:
- an array of completion proposals or
nullif no proposals are possible
-
computeContextInformation
Returns information about possible contexts based on the specified location within the document that corresponds to the current cursor position within the text viewer.- Parameters:
viewer- the viewer whose document is used to compute the possible contextsoffset- an offset within the document for which context information should be computed- Returns:
- an array of context information objects or
nullif no context could be found
-
getCompletionProposalAutoActivationCharacters
char[] getCompletionProposalAutoActivationCharacters()Returns the characters which when entered by the user should automatically trigger the presentation of possible completions.- Returns:
- the auto activation characters for completion proposal or
nullif no auto activation is desired
-
getContextInformationAutoActivationCharacters
char[] getContextInformationAutoActivationCharacters()Returns the characters which when entered by the user should automatically trigger the presentation of context information.- Returns:
- the auto activation characters for presenting context information
or
nullif no auto activation is desired
-
getErrorMessage
String getErrorMessage()Returns the reason why this content assist processor was unable to produce any completion proposals or context information.- Returns:
- an error message or
nullif no error occurred
-
getContextInformationValidator
IContextInformationValidator getContextInformationValidator()Returns a validator used to determine when displayed context information should be dismissed. May only returnnullif the processor is incapable of computing context information.- Returns:
- a context information validator, or
nullif the processor is incapable of computing context information
-