<spellCheck> Configuration Element
Prev Chapter 18. XML Configuration API Next

<spellCheck> Configuration Element

This element defines the location of the JAR file to be used with the spell checker. This enables the dictionary to be defined for Ephox EditLive! for Java.

Configuration Element Tree Structure

<editLive>
     ...
     <spellCheck ... />
     ...
</editLive>

Optional Attributes

jar

The value for this attribute corresponds to the location of the JAR file to be used with EditLive! for Java for spell checking.

Note

For the spell checking in EditLive! for Java to function a JAR file must be specified. The name of the JAR file for the spell checker dictionary must be in all lower case letters.

startBackgroundChecking

This attribute defines if spell check as you type is turned on or off as a default.

Default Value: true

Possible Values:

This attribute is boolean and can have the value of either true or false.

useNotModified

This attribute defines if spell checking dictionaries that have been modified will be accepted by EditLive! for Java.

Default Value: true

Possible Values:

This attribute is boolean and can have the value of either true or false.

Example

The following example demonstrates how to define the location of the spell checker JAR file to be used with EditLive! for Java. Spell check as you type is turned on as a default and spell checking dictionaries that have been modified are accepted.

<editLive>
    ...
    <spellCheck 
       jar="../../redistributables/editlivejava/dictionaries/en_us_3_1.jar"
       startBackgroundChecking="true"
       useNotModified="false"
     />
    ...
</editLive>

Remarks

A JAR file must be specified for the spell checker in order for the spell checking functionality of EditLive! for Java to work.

The <spellCheck> element can appear only once within the <editLive> element.

If the <spellCheck> element is to be left blank the element must then be a complete tag, it cannot contain a tag body. Therefore the tag must be closed in the same line. It should appear as below:

<spellCheck jar=... />

Copyright 2001-2005 Ephox Corporation. All Rights Reserved.

Prev Up Next
<webeqLicense> Configuration Element Home <htmlFilter> Configuration Element