SWT LPEX
v3.0.5

com.ibm.lpex.alef.contentassist
Interface ICompletionProposalExtension


public interface ICompletionProposalExtension

Extension interface to ICompletionProposal. It adds the following functions:

This is the LPEX version of org.eclipse.jface.text.contentassist.ICompletionProposalExtension.


Method Summary
 void apply(ITextViewer textViewer, char trigger, int offset)
          Apply the proposed completion to the document of the specified LpexTextViewer.
 int getContextInformationPosition()
          Return the position to which the computed context information refers to, or -1 if no context information can be provided by this completion proposal.
 char[] getTriggerCharacters()
          Return the characters which trigger the application of this completion proposal.
 boolean isValidFor(ITextViewer textViewer, LpexDocumentLocation location)
          Return whether this completion proposal is valid for the given position in the given document.
 

Method Detail

apply

public void apply(ITextViewer textViewer,
                  char trigger,
                  int offset)
Apply the proposed completion to the document of the specified LpexTextViewer. The insertion has been triggered by entering the given character at the given document location. This method assumes that isValidFor() returns true if called for location.

Parameters:
textViewer - the LpexTextViewer into whose document to insert the proposed completion
trigger - the trigger to apply the completion
offset - document offset at which the trigger has been activated

isValidFor

public boolean isValidFor(ITextViewer textViewer,
                          LpexDocumentLocation location)
Return whether this completion proposal is valid for the given position in the given document.

Parameters:
textViewer - the LpexTextViewer whose document the proposal is tested for
location - document location at which the trigger has been activated
Returns:
true iff valid

getTriggerCharacters

public char[] getTriggerCharacters()
Return the characters which trigger the application of this completion proposal.

Returns:
the completion characters for this completion proposal, or
null if no completion other than via Enter is possible

getContextInformationPosition

public int getContextInformationPosition()
Return the position to which the computed context information refers to, or -1 if no context information can be provided by this completion proposal.

Returns:
the position to which the context information refers to, or
-1 for no information

SWT LPEX
v3.0.5

(C) Copyright IBM Corporation 1998, 2005.  All Rights Reserved.