Eclipse Platform
Release 3.3

org.eclipse.ui.texteditor.spelling
Class SpellingProblem

java.lang.Object
  extended byorg.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:
SpellingService, ISpellingProblemCollector

Constructor Summary
SpellingProblem()
           
 
Method Summary
abstract  int getLength()
          Returns the length of the incorrectly spelled region.
abstract  String getMessage()
          Returns a localized, human-readable message string which describes the spelling problem.
abstract  int getOffset()
          Returns the offset of the incorrectly spelled region.
abstract  ICompletionProposal[] getProposals()
          Returns the proposals for the incorrectly spelled region.
static void removeAllInActiveEditor(ITextEditor editor, String word)
          Removes all spelling problems that are reported for the given word in the active editor.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SpellingProblem

public SpellingProblem()
Method Detail

removeAllInActiveEditor

public static void removeAllInActiveEditor(ITextEditor editor,
                                           String word)
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 is does nothing
word - the word for which to remove the problems or null to remove all
Since:
3.3

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

Eclipse Platform
Release 3.3

Guidelines for using Eclipse APIs.

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