| java.lang.Object org.eclipse.ui.texteditor.spelling.SpellingService
SpellingService | public class SpellingService (Code) | | System wide spelling service.
This class is not intended to be subclassed by clients.
since: 3.1 |
Constructor Summary | |
public | SpellingService(IPreferenceStore preferences) Initializes the spelling service with the given preferences. |
PREFERENCE_SPELLING_ENABLED | final public static String PREFERENCE_SPELLING_ENABLED(Code) | | A named preference that controls if spelling is enabled or disabled.
Value is of type Boolean .
|
PREFERENCE_SPELLING_ENGINE | final public static String PREFERENCE_SPELLING_ENGINE(Code) | | A named preference that controls which spelling engine is used.
The value is the spelling engine's extension id.
Value is of type String .
|
check | public void check(IDocument document, SpellingContext context, ISpellingProblemCollector collector, IProgressMonitor monitor)(Code) | | Checks the given document. Reports all found spelling problems to the
collector. The spelling engine is chosen based on the settings
from the given preferences.
Parameters: document - the document to check Parameters: context - the context Parameters: collector - the problem collector Parameters: monitor - the progress monitor, can be null |
check | public void check(IDocument document, IRegion[] regions, SpellingContext context, ISpellingProblemCollector collector, IProgressMonitor monitor)(Code) | | Checks the given regions in the given document. Reports all found
spelling problems to the collector. The spelling engine is chosen
based on the settings from the given preferences.
Parameters: document - the document to check Parameters: regions - the regions to check Parameters: context - the context Parameters: collector - the problem collector Parameters: monitor - the progress monitor, can be null |
getActiveSpellingEngineDescriptor | public SpellingEngineDescriptor getActiveSpellingEngineDescriptor(IPreferenceStore preferences)(Code) | | Returns the descriptor of the active spelling engine based on the
value of the PREFERENCE_SPELLING_ENGINE preference
in the given preferences.
Parameters: preferences - the preferences the descriptor of the active spelling engine ornull if none could be found See Also: SpellingService.PREFERENCE_SPELLING_ENGINE |
getDefaultSpellingEngineDescriptor | public SpellingEngineDescriptor getDefaultSpellingEngineDescriptor()(Code) | | Returns the default spelling engine descriptor from extensions to
the spelling engine extension point.
the default spelling engine descriptor ornull if none could be found |
getSpellingEngineDescriptors | public SpellingEngineDescriptor[] getSpellingEngineDescriptors()(Code) | | Returns all spelling engine descriptors from extensions to the
spelling engine extension point.
all spelling engine descriptors |
|
|