Documentation/DevGuide/OfficeDev/Using Spellchecker

OpenOffice.org Developer's Guide

Office Development

< Previous Section

Next Section >

• OpenOffice.org Application Environment

• Desktop Environment
• Framework API

• Frame-Controller-Model Paradigm in OpenOffice.org
• Frames
• Controllers
• Windows
• Dispatch Framework

• Using the Desktop
• Using the Component Framework

• Getting Frames, Controllers and Models from Each Other
• Frames
• Controllers
• Models
• Window Interfaces

• Creating Frames Manually
• Handling Documents

• Closing Documents
• Storing Documents

• Using the Dispatch Framework

• Command URL
• Processing Chain
• Dispatch Process
• Dispatch Results
• Dispatch Interception

• Java Window Integration

• Common Application Features

• Internationalization

• Overview and Using the API
• Implementing a New Locale

• Linguistics

• Using Spellchecker
• Using Hyphenator
• Using Thesaurus
• Events
• Implementing a Spell Checker
• Implementing a Hyphenator
• Implementing a Thesaurus

• Integrating Import and Export Filters

• Filtering Process
• Filters
• Type Detection and its Configuration
• Properties of a Type
• Properties of a Filter
• Filter Options
• Properties of a FrameLoader
• Document API Filter Development

• XML Based Filter Development

• Writing the Filtering Component
• The Importer
• The Exporter
• XML Filter Detection

• Number Formats

• Managing Number Formats
• Applying Number Formats

• Document Events
• Path Organization

• Path Settings
• Path Variables

• Predefined Variables
• Custom Path Variables
• Resolving Path Variables

• OpenOffice.org Single Sign-On API
• RDF metadata

< Previous Page

Next Page >

The interface used for spell checking is com.sun.star.linguistic2.XSpellChecker. Accessing the spellchecker through the LinguServiceManager and initializing the mxSpell object is done by:

  /** Get the SpellChecker to be used.
   */
  public boolean GetSpell()
      throws com.sun.star.uno.Exception,
      com.sun.star.uno.RuntimeException
  {
      if (mxLinguSvcMgr != null)
          mxSpell = mxLinguSvcMgr.getSpellChecker();
      return mxSpell != null;
  }

Relevant properties

The properties of the LinguProperties service evaluated by the spell checker are:

Spell-checking Properties of com.sun.star.linguistic2.LinguProperties Description
IsIgnoreControlCharacters	Defines if control characters should be ignored or not.
IsUseDictionaryList	Defines if the dictionary-list should be used or not.
IsGermanPreReform	Defines if the new German spelling rules should be used for German language text or not.
IsSpellUpperCase	Defines if words with only uppercase letters should be subject to spellchecking or not.
IsSpellWithDigits	Defines if words containing digits or numbers should be subject to spellchecking or not.
IsSpellCapitalization	Defines if the capitalization of words should be checked or not.

Changing the values of these properties in the LinguProperties affect all subsequent calls to the spell checker. Instantiate a com.sun.star.linguistic2.LinguProperties instance and change it by calling setPropertyValue(). The changes affect the whole office unless another modifies the properties again. This is done implicitly when changing the linguistic settings through Tools → Options → Language Settings → Writing Aids.

The following example shows verifying single words:

  // test with correct word
  String aWord = "horseback";
  boolean bIsCorrect = mxSpell.isValid( aWord, aLocale, aEmptyProps );
  System.out.println( aWord + ": " + bIsCorrect );
  
  // test with incorrect word
  aWord = "course";
  bIsCorrect = mxSpell.isValid( aWord, aLocale , aEmptyProps );
  System.out.println( aWord + ": " + bIsCorrect );

The following example shows spelling a single word and retrieving possible corrections:

  aWord = "house";
  XSpellAlternatives xAlt = mxSpell.spell( aWord, aLocale, aEmptyProps );
  if (xAlt == null)
      System.out.println( aWord + " is correct." );
  else
  {
      System.out.println( aWord + " is not correct. A list of proposals follows." );
      String[] aAlternatives = xAlt.getAlternatives();
      if (aAlternatives.length == 0)
          System.out.println( "no proposal found." );
      else
      {
          for (int i = 0; i < aAlternatives.length; ++i)
              System.out.println( aAlternatives[i] );
      }
  }

For a description of the return types interface, refer to com.sun.star.linguistic2.XSpellAlternatives.

Content on this page is licensed under the Public Documentation License (PDL).