|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.ui.texteditor.spelling.SpellingService
public class SpellingService
System wide spelling service.
This class is not intended to be subclassed by clients.
| Field Summary | |
|---|---|
static java.lang.String |
PREFERENCE_SPELLING_ENABLED
A named preference that controls if spelling is enabled or disabled. |
static java.lang.String |
PREFERENCE_SPELLING_ENGINE
A named preference that controls which spelling engine is used. |
| Constructor Summary | |
|---|---|
SpellingService(IPreferenceStore preferences)
Initializes the spelling service with the given preferences. |
|
| Method Summary | |
|---|---|
void |
check(IDocument document,
IRegion[] regions,
SpellingContext context,
ISpellingProblemCollector collector,
IProgressMonitor monitor)
Checks the given regions in the given document. |
void |
check(IDocument document,
SpellingContext context,
ISpellingProblemCollector collector,
IProgressMonitor monitor)
Checks the given document. |
SpellingEngineDescriptor |
getActiveSpellingEngineDescriptor(IPreferenceStore preferences)
Returns the descriptor of the active spelling engine based on the value of the PREFERENCE_SPELLING_ENGINE preference
in the given preferences. |
SpellingEngineDescriptor |
getDefaultSpellingEngineDescriptor()
Returns the default spelling engine descriptor from extensions to the spelling engine extension point. |
SpellingEngineDescriptor[] |
getSpellingEngineDescriptors()
Returns all spelling engine descriptors from extensions to the spelling engine extension point. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final java.lang.String PREFERENCE_SPELLING_ENABLED
Value is of type Boolean.
public static final java.lang.String PREFERENCE_SPELLING_ENGINE
Value is of type String.
| Constructor Detail |
|---|
public SpellingService(IPreferenceStore preferences)
preferences - the preferencesPREFERENCE_SPELLING_ENABLED,
PREFERENCE_SPELLING_ENGINE| Method Detail |
|---|
public void check(IDocument document,
SpellingContext context,
ISpellingProblemCollector collector,
IProgressMonitor monitor)
document - the document to checkcontext - the contextcollector - the problem collectormonitor - the progress monitor, can be null
public void check(IDocument document,
IRegion[] regions,
SpellingContext context,
ISpellingProblemCollector collector,
IProgressMonitor monitor)
document - the document to checkregions - the regions to checkcontext - the contextcollector - the problem collectormonitor - the progress monitor, can be nullpublic SpellingEngineDescriptor[] getSpellingEngineDescriptors()
public SpellingEngineDescriptor getDefaultSpellingEngineDescriptor()
null if none could be foundpublic SpellingEngineDescriptor getActiveSpellingEngineDescriptor(IPreferenceStore preferences)
PREFERENCE_SPELLING_ENGINE preference
in the given preferences.
preferences - the preferences
null if none could be foundPREFERENCE_SPELLING_ENGINE
|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.