org.dts.spell.dictionary

Interface DictionaryProvider

All Known Implementing Classes:

AbstractDictionaryProvider, OpenOfficeDictionaryProvider

public interface DictionaryProvider

Author:

dreamtangerine

Method Summary

Modifier and Type	Method and Description
List<Locale>	getAvailableLocales() This function get a list for all locales on internet, ready for installation
SpellDictionary	getDictionary(Locale locale) Get a new dictionary for the locale.
String	getDisplayName() A name for the UI.
List<Locale>	getInstalledLocales()
void	install(File file, ProgressListener listener) Install a local copy form the dictionary
void	install(Locale locale, ProgressListener listener) Install a local copy of the interntet dictionary for that locale
boolean	isForLocale(Locale locale)
void	uninstall(Locale locale, ProgressListener listener) Uninstall the given locale

Method Detail

getDisplayName

String getDisplayName()

A name for the UI.

Returns:

Name for the user

isForLocale

boolean isForLocale(Locale locale)

Parameters:

locale - locale to check for

Returns:

return true if this provider have installed a dictionary for that locale.

getInstalledLocales

List<Locale> getInstalledLocales()

Returns:

the current list of installed dictionaries

getDictionary

SpellDictionary getDictionary(Locale locale)
                       throws IOException

Get a new dictionary for the locale. Dictionary must be installed.

Parameters:

locale - the locale of the dictionary.

Returns:

Throws:

IOException

getAvailableLocales

List<Locale> getAvailableLocales()

This function get a list for all locales on internet, ready for installation

Returns:

list of lacale for installation

install

void install(Locale locale,
             ProgressListener listener)
      throws Exception

Install a local copy of the interntet dictionary for that locale

Parameters:

locale - the local of the dictionary to install

listener - the listener for progress tracking

Throws:

Exception

install

void install(File file,
             ProgressListener listener)
      throws Exception

Install a local copy form the dictionary

Parameters:

file - the file of the dictionary

listener - the listener for progress tracking

Throws:

Exception

uninstall

void uninstall(Locale locale,
               ProgressListener listener)
        throws Exception

Uninstall the given locale

Parameters:

locale - the locale to uninstall

listener - the listener for progress tracking

Throws:

Exception