Package org.eclipse.jface.text.contentassist

Interface ICompletionProposalExtension7

public interface ICompletionProposalExtension7
Extends the functionality of ICompletionProposal with the following function:
  • Emphasize ranges in the styled display string of the proposal that match the token at the current caret offset.

Note: ICompletionProposal.getDisplayString() still needs to be correctly implemented as this method might be ignored in case of uninstalled owner draw support.

Since:
3.11

  • Method Summary

    Modifier and Type
    Method
    Description
    StyledString
    getStyledDisplayString(IDocument document, int offset, BoldStylerProvider boldStylerProvider)
    Returns the styled display string for this proposal with emphasized ranges that match the token at the current caret offset.

  • Method Details

    • getStyledDisplayString

      StyledString getStyledDisplayString(IDocument document, int offset, BoldStylerProvider boldStylerProvider)
      Returns the styled display string for this proposal with emphasized ranges that match the token at the current caret offset. This can for example be used to emphasize prefix, camel case or substring matches in the display string. Clients can emphasize the matches using any font style. It is encouraged to use the bold font as the style.
      Parameters:
      document - the document where content assist is invoked
      offset - the offset in the document at current caret location
      boldStylerProvider - to provide a StyledString.Styler that applies bold style
      Returns:
      the styled display string for this proposal with emphasized ranges matching the token at the given offset