Summary:

• Packaging: Java applet in a JAR file
• JAR file size: 86K
• Dictionary file size (English): 100,000 words: 320K; 50,000 words: 187K; 25,000 words: 102K
• Dictionary file location: Server; read by Applet when first spelling check starts.

Methods

Methods are the functions called by JavaScript code in your Web forms to perform some action.

check
The check method checks the spelling of text set via the setText method. If a misspelled word is detected, the check method displays a dialog box which the user interacts with to dispose of the misspelled word. The dialog box contains a context display so the user can see the misspelled word in context. Once the dialog box is displayed, it remains visible until all the text has been checked or the user cancels the spelling check. If the text contains no misspelled words, the dialog box is not displayed.

If the correct.tlx dictionary is open, certain misspelled English words will be automatically corrected (without user intervention). If the user disposes of a misspelled word by clicking the "Add" button in the dialog box, the word will be added to the user dictionary, which can later be retrieved via the getUserDictionary method.

getNumMisspelledWords
Obtain the number of misspelled words detected the last time the check method was called. Useful for displaying statistics.

getNumWordsChanged
Obtain the number of words which were replaced in the text the last time the check method was called. Words are replaced in the text when the user clicks the "Change" button in the spelling dialog box, and in some cases are also changed automatically (if the correct.tlx dictionary is open, certain misspelled words will be automatically corrected). Useful for displaying statistics or for determining if the text was changed by the user.

getNumWordsChecked
Obtain the total number of words in the text which were checked for spelling errors the last time the check method was called. Useful for displaying statistics.

getOptions
The getOptions method returns the current option settings. If the setOptions method has not yet been called, the current option settings are defaults. After the setOptions method has been called, the options set by that method are the current options.

getText
Obtain the text which was checked for spelling errors by the check method. After the check method has been called, the text will contain any corrections made by the user.

getUserDictionary
The getUserDictionary method returns the user dictionary represented as a string. Initially, the user dictionary is empty. Words can be added to the user dictionary via the setUserDictionary method. Words are also added if the user clicks the "Add" button in the spelling-checker dialog box.

setOptions
The setOptions method establishes a set of spelling-checker options contained in a bit-mask. The options bit-mask set by the setOptions method will be returned when the getOptions method is next called.

setText
Set the text which will be spell-checked when the check method is called.

setUserDictionary
The setUserDictionary method sets the user dictionary used by the spelling checker. Any words contained in the user dictionary will be ignored (skipped over) by the spelling checker. When the setUserDictionary method is called, any words currently in the user dictionary will be replaced by the specified words. The getUserDictionary method can be used to obtain the current contents of the user dictionary.