|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
Method Summary | |
---|---|
ICompletionProposal[] |
computeCompletionProposals(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. |
IContextInformation[] |
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[] |
getCompletionProposalAutoActivationCharacters()
Returns the characters which when entered by the user should automatically trigger the presentation of possible completions. |
char[] |
getContextInformationAutoActivationCharacters()
Returns the characters which when entered by the user should automatically trigger the presentation of context information. |
IContextInformationValidator |
getContextInformationValidator()
Returns a validator used to determine when displayed context information should be dismissed. |
String |
getErrorMessage()
Returns the reason why this content assist processor was unable to produce any completion proposals or context information. |
Method Detail |
public ICompletionProposal[] computeCompletionProposals(ITextViewer viewer, int offset)
viewer
- the viewer whose document is used to compute the proposalsoffset
- an offset within the document for which completions should be computed
null
if no proposals are possiblepublic IContextInformation[] computeContextInformation(ITextViewer viewer, int offset)
viewer
- the viewer whose document is used to compute the possible contextsoffset
- an offset within the document for which context information should be computed
null
if no context could be foundpublic char[] getCompletionProposalAutoActivationCharacters()
null
if no auto activation is desiredpublic char[] getContextInformationAutoActivationCharacters()
null
if no auto activation is desiredpublic String getErrorMessage()
null
if no error occurredpublic IContextInformationValidator getContextInformationValidator()
null
if the processor is
incapable of computing context information.
null
if the processor
is incapable of computing context information
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.