Class SpellingEngineDescriptor
- java.lang.Object
-
- org.eclipse.ui.texteditor.spelling.SpellingEngineDescriptor
-
public class SpellingEngineDescriptor extends Object
Describes an extension to thespellingEngineextension point.This class is not intended to be subclassed by clients.
- Since:
- 3.1
- Restriction:
- This class is not intended to be subclassed by clients.
-
-
Constructor Summary
Constructors Constructor Description SpellingEngineDescriptor(IConfigurationElement element)Creates a new descriptor forelement.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ISpellingEnginecreateEngine()Creates a spelling engine as described in the extension's xml.ISpellingPreferenceBlockcreatePreferences()Creates a spelling preferences block as described in the extension's xml.StringgetId()Reads (if needed) and returns the id of this extension.StringgetLabel()Reads (if needed) and returns the label of this extension.booleanisDefault()Reads (if needed) and returns the default attribute value of this extension.booleanisPluginLoaded()States whether the plug-in declaring this extension has been loaded already.
-
-
-
Constructor Detail
-
SpellingEngineDescriptor
public SpellingEngineDescriptor(IConfigurationElement element)
Creates a new descriptor forelement.This method is for internal use only.
- Parameters:
element- the extension point element to be described.
-
-
Method Detail
-
getLabel
public String getLabel()
Reads (if needed) and returns the label of this extension.- Returns:
- the label for this extension.
-
getId
public String getId()
Reads (if needed) and returns the id of this extension.- Returns:
- the id for this extension.
-
createEngine
public ISpellingEngine createEngine() throws CoreException
Creates a spelling engine as described in the extension's xml.- Returns:
- the created spelling engine
- Throws:
CoreException- if the creation failed
-
createPreferences
public ISpellingPreferenceBlock createPreferences() throws CoreException
Creates a spelling preferences block as described in the extension's xml.- Returns:
- the created spelling preferences block
- Throws:
CoreException- if the creation failed
-
isPluginLoaded
public boolean isPluginLoaded()
States whether the plug-in declaring this extension has been loaded already.- Returns:
trueif the extension point's plug-in has been loaded,falseotherwise.
-
isDefault
public boolean isDefault()
Reads (if needed) and returns the default attribute value of this extension.- Returns:
- the default attribute value for this extension.
-
-