com.jspell.domain.net
Class JSpellValidator

java.lang.Object
  extended by com.jspell.domain.net.JSpellV
      extended by com.jspell.domain.net.JSpellValidator

public class JSpellValidator
extends JSpellV

This is a helper class for the JSpell HTML Pro spell checker. None of these methods are designed for direct use by the end user developer.


Field Summary
 
Fields inherited from class com.jspell.domain.net.JSpellV
dictionaryLocation, validator
 
Method Summary
static JSpellValidator getJSpellValidator()
          Return an instance of the JSpellValidator class.
static JSpellValidator getJSpellValidator(boolean forceUpperCase, boolean ignoreIrregularCaps, boolean ignoreFirstCaps, boolean ignoreNumbers, boolean ignoreUpper, boolean ignoreDouble)
          Return the JSpellValidator object and initialize it.
 java.lang.String getResults(java.lang.String[] checkArray, java.lang.String directEdit, java.lang.String ieMode, java.lang.String userLearnedWords, boolean confirmAfterLearn, boolean confirmAfterReplace, java.lang.String supplemental, java.lang.String language)
          Returns the results of the JSpell HTML spell checker.
 
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

getJSpellValidator

public static JSpellValidator getJSpellValidator()
Return an instance of the JSpellValidator class.

Returns:
a JSpellValidator object.

getJSpellValidator

public static JSpellValidator getJSpellValidator(boolean forceUpperCase,
                                                 boolean ignoreIrregularCaps,
                                                 boolean ignoreFirstCaps,
                                                 boolean ignoreNumbers,
                                                 boolean ignoreUpper,
                                                 boolean ignoreDouble)
Return the JSpellValidator object and initialize it.

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:
a JSpellValidator object.

getResults

public java.lang.String getResults(java.lang.String[] checkArray,
                                   java.lang.String directEdit,
                                   java.lang.String ieMode,
                                   java.lang.String userLearnedWords,
                                   boolean confirmAfterLearn,
                                   boolean confirmAfterReplace,
                                   java.lang.String supplemental,
                                   java.lang.String language)
                            throws JSpellException
Returns the results of the JSpell HTML spell checker.

Parameters:
checkArray - A String array containing the text of each field to spell check.
directEdit - Use text highlighting mode
ieMode - Text Highlighting mode is for IE
userLearnedWords - Words that the user has 'learned'.
confirmAfterLearn - Prompt user for confirmation after learning a word.
confirmAfterReplace - Prompt user for confirmation when replacing a word with a word not in the suggestion list.
supplemental - The name of the file containing the supplemental dictionary.
language - The language in which to perform the spell check, e.g., "English (US)".
Returns:
Return JavaScript for the JSpell HTML GUI.
Throws:
JSpellException - A JSpellException object containing the JSpell intiialization error. Usually an incorrect directory location for the JSpell dictionary fiels has been specified.


JSpell SDK - Spell Checker for the Java ™ Platform
Copyright © 2009 Page Scholar Inc, All Rights Reserved - http://www.jspell.com