com.ibm.lpex.alef.contentassist
Interface IContentAssistProcessor

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 text viewer 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.

This is the LPEX version of org.eclipse.jface.text.contentassist.IContentAssistProcessor. It refers to LPEX content-assist classes.

Method Summary

ICompletionProposal[]	computeCompletionProposals(ITextViewer viewer, int offset) Return 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) Return 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() Return the characters which, when entered by the user, should automatically trigger the presentation of possible completions.
char[]	getContextInformationAutoActivationCharacters() Return the characters which, when entered by the user, should automatically trigger the presentation of context information.
IContextInformationValidator	getContextInformationValidator() Return a validator used to determine when displayed context information should be dismissed.
String	getErrorMessage() Return the reason why this content assist processor was unable to produce any completion proposals or context information.

Method Detail

computeCompletionProposals

ICompletionProposal[] computeCompletionProposals(ITextViewer viewer,
                                                 int offset)

Return a list of completion proposals based on the specified location within the document that corresponds to the current cursor position within the text viewer. LPEX currently ignores offset, assuming the current cursor position.

Parameters:

viewer - the viewer whose document is used to compute the proposals

offset - an offset within the document for which completions should be computed

Returns:

an array of completion proposals, or
null if no proposals are possible

computeContextInformation

IContextInformation[] computeContextInformation(ITextViewer viewer,
                                                int offset)

Return information about possible contexts, based on the specified location within the document that corresponds to the current cursor position within the text viewer. LPEX currently ignores offset, assuming the current cursor position.

Parameters:

viewer - the viewer whose document is used to compute the possible contexts

offset - an offset within the document for which context information should be computed

Returns:

an array of context information objects, or
null if no context could be found

getCompletionProposalAutoActivationCharacters

char[] getCompletionProposalAutoActivationCharacters()

Return 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
null if no auto activation is desired

getContextInformationAutoActivationCharacters

char[] getContextInformationAutoActivationCharacters()

Return 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
null if no auto activation is desired

getErrorMessage

String getErrorMessage()

Return the reason why this content assist processor was unable to produce any completion proposals or context information.

Returns:

an error message, or
null if no error occurred

getContextInformationValidator

IContextInformationValidator getContextInformationValidator()

Return a validator used to determine when displayed context information should be dismissed. May only return null if the processor is incapable of computing context information.

Returns:

a context information validator, or
null if the processor is incapable of computing context information

See Also:

IContextInformationPresenter