Overview

Package

Class

Use

Tree

Serialized

Deprecated

Index

Help

SWT LPEX
v3.0.0

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.ibm.lpex.alef.contentassist
Interface ICompletionProposalExtension

public interface ICompletionProposalExtension

Extension interface to ICompletionProposal. It adds the following functions:

• handling of trigger characters other then ENTER
• completion proposal validation for a given offset
• freely positionable context information.

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

Method Summary

void	apply(org.eclipse.jface.text.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(org.eclipse.jface.text.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(org.eclipse.jface.text.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(org.eclipse.jface.text.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