Interface CustomDictionaryProvider

  • All Known Subinterfaces:
    UserDictionaryProvider
    All Known Implementing Classes:
    FileUserDictionary

    public interface CustomDictionaryProvider
    Interface to be implemented by an additional dictionary. This can be used to add an expert dictionary like a medical dictionary or a chemical dictionary.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.Iterator<java.lang.String> getWords​(java.util.Locale locale)
      Gets the list of custom words for this locale.
    • Method Detail

      • getWords

        java.util.Iterator<java.lang.String> getWords​(java.util.Locale locale)
        Gets the list of custom words for this locale. The implementation can decide if there is a custom dictionary for each available language or only one. This method is called before the language change event is fired if the language is changed and the dictionary is loaded.
        Parameters:
        locale - The locale of the selected language.
        Returns:
        A list of words delimited with line breaks. It can be null.