com.xmlmind.xmleditapp.spellchecker

Class NoSpellCheckerFactory

java.lang.Object

com.xmlmind.xmleditapp.spellchecker.NoSpellCheckerFactory

All Implemented Interfaces:

SpellCheckerFactory

public final class NoSpellCheckerFactory
extends Object
implements SpellCheckerFactory

No-op implementation of a SpellCheckerFactory. Use it when no real implementation is available.

Field Summary

Fields

Modifier and Type	Field and Description
static NoSpellCheckerFactory	INSTANCE

Constructor Summary

Constructors

Constructor and Description
NoSpellCheckerFactory()

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns a (couple of lines) description of this plug-in.
String	getName() Returns the (couple of words) name of this plug-in.
String	getPersonalDictionaryPath() Returns the path pattern last specified using SpellCheckerFactory.setPersonalDictionaryPath(java.lang.String).
Preferences	getPreferences() Returns the object where to read and write user preferences.
PreferencesSheet	getPreferencesSheet() Returns a newly created preferences sheet which can be used to edit the user preferences related to this plug-in.
LanguageInfo[]	listLanguages() Returns a (possibly empty, never null) list of items describing all the available dictionaries.
SpellChecker	newSpellChecker() Returns a newly created spell checker.
void	resetSpellChecker(SpellChecker spellChecker) Reset the state of specified spell checker.
void	setPersonalDictionaryPath(String path) Defines a path pattern for personal dictionaries.
void	setPreferences(Preferences preferences) Invoked by the environment hosting the factory to specify to this plug-in the object where to read and write user preferences.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INSTANCE

public static final NoSpellCheckerFactory INSTANCE

Constructor Detail

NoSpellCheckerFactory

public NoSpellCheckerFactory()

Method Detail

setPreferences

public void setPreferences(Preferences preferences)

Description copied from interface: SpellCheckerFactory

Invoked by the environment hosting the factory to specify to this plug-in the object where to read and write user preferences.

Specified by:

setPreferences in interface SpellCheckerFactory

getPreferences

public Preferences getPreferences()

Description copied from interface: SpellCheckerFactory

Returns the object where to read and write user preferences. Returns null unless SpellCheckerFactory.setPreferences(com.xmlmind.util.Preferences) has been invoked by the environment hosting the plug-in (that is, XMLmind XML Editor).

Specified by:

getPreferences in interface SpellCheckerFactory

setPersonalDictionaryPath

public void setPersonalDictionaryPath(String path)

Description copied from interface: SpellCheckerFactory

Defines a path pattern for personal dictionaries.

Each language loads or saves a different file.

Specified by:

setPersonalDictionaryPath in interface SpellCheckerFactory

Parameters:

path - a pattern containing the symbol '%L%' which is replaced by the language name.

For example: setPersonalDictionaryPath(".mydict_%L%.txt") would read/save an English dictionary (language "en") from/to file .mydict_en.txt.

If set to null, personal dictionaries are not saved (i.e. they are made temporary).

getPersonalDictionaryPath

public String getPersonalDictionaryPath()

Description copied from interface: SpellCheckerFactory

Returns the path pattern last specified using SpellCheckerFactory.setPersonalDictionaryPath(java.lang.String).

Specified by:

getPersonalDictionaryPath in interface SpellCheckerFactory

getName

public String getName()

Description copied from interface: SpellCheckerFactory

Returns the (couple of words) name of this plug-in.

Specified by:

getName in interface SpellCheckerFactory

getDescription

public String getDescription()

Description copied from interface: SpellCheckerFactory

Returns a (couple of lines) description of this plug-in. May return null.

Specified by:

getDescription in interface SpellCheckerFactory

getPreferencesSheet

public PreferencesSheet getPreferencesSheet()

Description copied from interface: SpellCheckerFactory

Returns a newly created preferences sheet which can be used to edit the user preferences related to this plug-in. May return null.

Changing the preferences using the returned sheet has no effect on existing instances of SpellChecker.

Specified by:

getPreferencesSheet in interface SpellCheckerFactory

listLanguages

public LanguageInfo[] listLanguages()

Description copied from interface: SpellCheckerFactory

Returns a (possibly empty, never null) list of items describing all the available dictionaries.

The items of the returned array must be sorted by language code.

Specified by:

listLanguages in interface SpellCheckerFactory

newSpellChecker

public SpellChecker newSpellChecker()

Description copied from interface: SpellCheckerFactory

Returns a newly created spell checker. Returns null if, for any reason, a spell checker cannot be created.

All the users preferences have been applied to this spell checker. A language is preselected.

Specified by:

newSpellChecker in interface SpellCheckerFactory

See Also:

SpellCheckerFactory.resetSpellChecker(com.xmlmind.xmleditapp.spellchecker.SpellChecker)

resetSpellChecker

public void resetSpellChecker(SpellChecker spellChecker)

Description copied from interface: SpellCheckerFactory

Reset the state of specified spell checker. The state must the same as those of spell checkers returned by SpellCheckerFactory.newSpellChecker().

Specified by:

resetSpellChecker in interface SpellCheckerFactory