com.teamdev.jxbrowser.spellcheck

Interface SpellChecker

All Superinterfaces:

EngineService

public interface SpellChecker
extends EngineService

Represents an engine service that provides functionality for configuring spell checking.

Method Summary

Modifier and Type	Method and Description
Dictionary	customDictionary() Returns the custom dictionary.
java.util.List<java.lang.String>	dictionaryNames() Returns an immutable list of the dictionary names used for spell checking.
void	dictionaryNames(java.lang.String... dictionaryNames) Updates the dictionary names used for spell checking.
void	disable() Disables spell checking on the web pages loaded in the browser instances of the engine.
void	enable() Enables spell checking on the web pages loaded in the browser instances of the engine.
boolean	isEnabled() Indicates whether spell checking is enabled or not.

Method Detail

isEnabled

boolean isEnabled()

Indicates whether spell checking is enabled or not. By default, it is enabled.

Throws:

java.lang.IllegalStateException - when the engine is closed and its spell check service isn't available anymore

enable

void enable()

Enables spell checking on the web pages loaded in the browser instances of the engine.

disable

void disable()

Disables spell checking on the web pages loaded in the browser instances of the engine.

Throws:

java.lang.IllegalStateException - when the engine is closed and its spell check service isn't available anymore

dictionaryNames

java.util.List<java.lang.String> dictionaryNames()

Returns an immutable list of the dictionary names used for spell checking. The dictionaries are downloaded programmatically and stored in the directory where the Chromium binaries are located.

Throws:

java.lang.IllegalStateException - when the engine is closed and its spell check service isn't available anymore

dictionaryNames

void dictionaryNames(java.lang.String... dictionaryNames)

Updates the dictionary names used for spell checking.

Important: on macOS this method updates the dictionary names, but these dictionaries will not be downloaded and used for spell checking. On macOS the platform spell checker is used instead. This platform spell checker automatically detects the language of the text.

Parameters:

dictionaryNames - the list of strings that represent the dictionary names. For example, "en-us", "ru", etc.

Throws:

java.lang.IllegalArgumentException - when one or more elements of the dictionaryNames are empty or blank

java.lang.IllegalStateException - when the engine is closed and its spell check service isn't available anymore

customDictionary

Dictionary customDictionary()

Returns the custom dictionary.