com.jspell.domain.net

Class JSpellIFrameValidator

java.lang.Object

com.jspell.domain.net.JSpellV

com.jspell.domain.net.JSpellIFrameValidator

public class JSpellIFrameValidator
extends JSpellV

This is a helper class for the JSpell IFrame Pro spell checker. None of the methods in this class are designed to be used directly by the end user developer.

Field Summary

Fields inherited from class com.jspell.domain.net.JSpellV

dictionaryLocation

Method Summary

Modifier and Type	Method and Description
static JSpellIFrameValidator	getJSpellIFrameValidator() Return an instance of JSpellIFrameValidator.
static JSpellIFrameValidator	getJSpellIFrameValidator(boolean forceUpperCase, boolean ignoreIrregularCaps, boolean ignoreFirstCaps, boolean ignoreNumbers, boolean ignoreUpper, boolean ignoreDouble) Return the JSpellIFrameValidator instance.
java.lang.String	getResults(java.lang.String textToCheck, java.lang.String userLearnedWords, boolean confirmAfterLearn, boolean confirmAfterReplace, java.lang.String supplemental, java.lang.String language) Returns the result of spell checking an IFrame instance.

Methods inherited from class com.jspell.domain.net.JSpellV

getDictionaryLocation, getForceUpperCase, getIgnoreDoubleWords, getIgnoreFirstCaps, getIgnoreIrregularCaps, getIgnoreUpper, getIgnoreWordsWithNumbers, getJSpellDictionaryManager, initManager, setDictionaryLocation, setForceUpperCase, setIgnoreDoubleWords, setIgnoreFirstCaps, setIgnoreIrregularCaps, setIgnoreUpper, setIgnoreWordsWithNumbers

Methods inherited from class java.lang.Object

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

Method Detail

getJSpellIFrameValidator

public static JSpellIFrameValidator getJSpellIFrameValidator()

Return an instance of JSpellIFrameValidator.

Returns:

a JSpellIFrameValidator object.

getJSpellIFrameValidator

public static JSpellIFrameValidator getJSpellIFrameValidator(boolean forceUpperCase,
                                                             boolean ignoreIrregularCaps,
                                                             boolean ignoreFirstCaps,
                                                             boolean ignoreNumbers,
                                                             boolean ignoreUpper,
                                                             boolean ignoreDouble)

Return the JSpellIFrameValidator instance.

Parameters:

forceUpperCase - true or false.

ignoreIrregularCaps - true or false.

ignoreFirstCaps - true or false.

ignoreNumbers - true or false.

ignoreUpper - true or false.

ignoreDouble - true or false.

Returns:

the JSpellIFrameValidator object.

getResults

public java.lang.String getResults(java.lang.String textToCheck,
                                   java.lang.String userLearnedWords,
                                   boolean confirmAfterLearn,
                                   boolean confirmAfterReplace,
                                   java.lang.String supplemental,
                                   java.lang.String language)
                            throws JSpellException

Returns the result of spell checking an IFrame instance.

Parameters:

textToCheck - a String containing the text to check.

userLearnedWords - a String containing words the user has 'learned'.

confirmAfterLearn - true or false.

confirmAfterReplace - true or false.

supplemental - a String specifying the name of the supplemental dictionary.

language - The language in which the spell check is performed, e.g. "English (US)".

Returns:

a String containing dynamic JavaScript which paints the GUI in the HTML client.

Throws:

JSpellException - a JSpellException object containing JSpell errors.