Package org.eclipse.ui.texteditor.spelling

Class SpellingProblem

java.lang.Object
org.eclipse.ui.texteditor.spelling.SpellingProblem
public abstract class SpellingProblem extends Object
A spelling problem as reported by the SpellingService service to the ISpellingProblemCollector.

This class is intended to be subclassed by clients.

Since:
3.1
See Also:

  • Constructor Details

    • SpellingProblem

      public SpellingProblem()

  • Method Details

    • removeAllInActiveEditor

      @Deprecated public static void removeAllInActiveEditor(ITextEditor editor, String word)
      Deprecated.
      As of 3.4, replaced by removeAll(ISourceViewer, String)
      Removes all spelling problems that are reported for the given word in the active editor.

      This a workaround to fix bug https://bugs.eclipse.org/bugs/show_bug.cgi?id=134338 for 3.2 at the time where spelling still resides in JDT Text. Once we move the spell check engine along with its quick fixes down to Platform Text we need to provide the proposals with a way to access the annotation model.

      Parameters:
      editor - the text editor, if null this method does nothing
      word - the word for which to remove the problems or null to remove all
      Since:
      3.3

    • removeAll

      public static void removeAll(ISourceViewer sourceViewer, String word)
      Removes all spelling problems that are reported for the given word in the active editor.
      Parameters:
      sourceViewer - the source viewer
      word - the word for which to remove the problems or null to remove all
      Since:
      3.4

    • getOffset

      public abstract int getOffset()
      Returns the offset of the incorrectly spelled region.
      Returns:
      the offset of the incorrectly spelled region

    • getLength

      public abstract int getLength()
      Returns the length of the incorrectly spelled region.
      Returns:
      the length of the incorrectly spelled region

    • getMessage

      public abstract String getMessage()
      Returns a localized, human-readable message string which describes the spelling problem.
      Returns:
      a localized, human-readable message string which describes the spelling problem

    • getProposals

      public abstract ICompletionProposal[] getProposals()
      Returns the proposals for the incorrectly spelled region.
      Returns:
      the proposals for the incorrectly spelled region

    • getProposals

      public ICompletionProposal[] getProposals(IQuickAssistInvocationContext context)
      Returns the proposals for the incorrectly spelled region.
      Parameters:
      context - the invocation context or null if none
      Returns:
      the proposals for the incorrectly spelled region
      Since:
      3.4