EditLive! 9 Documentation : spellCheck (Swing SDK)

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

If this element is omitted, the location of the spellcheck dictionary will be calculated by combining the setDownloadDirectory Method with the current user's locale.

Example: If the DownloadDirectory for an instance of EditLive! is specified as http://yourserver:port/editlivejava and the user's locale is Italian, the generated URL for spellcheck dictionary will be http://yourserver:port/editlivejava/dictionaries/it_4_0.jar.

Configuration Element Tree Structure

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

Required Attributes

A JAR file must be specified for the spell checking in the EditLive! Swing SDK to function. The name of the JAR file for the spell checker dictionary must be in all lower case letters. The URL location of the JAR file can either be an absolute URL or a URL relative to the page where the EditLive! Swing SDK is being loaded from.

jar

The value for this attribute corresponds to the location of the JAR file to be used with EditLive! for spell checking. The URL location of the JAR file can either be an absolute URL or a URL relative to the page where EditLive! is being loaded from.

Optional Attributes

The following attributes are booleans and can have the value of either true or false.

startBackgroundChecking

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

Default Value: true

useNotModified

This attribute defines whether the client running EditLive! will search the server hosting the EditLive! dictionaries for modified files. If this attribute is set to true when a modified dictionary is located on the server then this same file will be cached on the client.

Default Value: true

startAutoCorrect

This attribute defines whether the Auto Correct functionality is enabled on editor startup.

Default Value: false

Example

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

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

Remarks

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=... />