Eclipse Platform
Release 3.1

org.eclipse.jface.contentassist
Interface ISubjectControlContentAssistProcessor

All Superinterfaces:
IContentAssistProcessor

public interface ISubjectControlContentAssistProcessor
extends IContentAssistProcessor

Extension interface for IContentAssistProcessor which provides the context for the subject control content assistant.

Since:
3.0

Method Summary
 ICompletionProposal[] computeCompletionProposals(IContentAssistSubjectControl contentAssistSubjectControl, int documentOffset)
          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(IContentAssistSubjectControl contentAssistSubjectControl, int documentOffset)
          Returns information about possible contexts based on the specified location within the document that corresponds to the current cursor position within the content assist subject control.
 
Methods inherited from interface org.eclipse.jface.text.contentassist.IContentAssistProcessor
computeCompletionProposals, computeContextInformation, getCompletionProposalAutoActivationCharacters, getContextInformationAutoActivationCharacters, getContextInformationValidator, getErrorMessage
 

Method Detail

computeCompletionProposals

public ICompletionProposal[] computeCompletionProposals(IContentAssistSubjectControl contentAssistSubjectControl,
                                                        int documentOffset)
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:
contentAssistSubjectControl - the content assist subject control whose document is used to compute the proposals
documentOffset - 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

public IContextInformation[] computeContextInformation(IContentAssistSubjectControl contentAssistSubjectControl,
                                                       int documentOffset)
Returns information about possible contexts based on the specified location within the document that corresponds to the current cursor position within the content assist subject control.

Parameters:
contentAssistSubjectControl - the content assist subject control whose document is used to compute the possible contexts
documentOffset - 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

Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.