MultiDocumentsHandler (LanguageTool 6.4-SNAPSHOT API)

java.lang.Object
- org.languagetool.openoffice.MultiDocumentsHandler

```
public class MultiDocumentsHandler
extends Object
```
Class to handle multiple LO documents for checking

Since:

4.3

Author:

Fred Kruse, Marcin Miłkowski

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`activateRule(String ruleId)` Activate a rule by rule iD
`void`	`activateRule(String langcode, String ruleId)`
`void`	`activateTextRulesByIndex(int index, SwJLanguageTool lt)` activate all rules stored under a given index related to the list of getNumMinToCheckParas deactivate all other text level rules
`boolean`	`addLinguServiceEventListener(com.sun.star.linguistic2.XLinguServiceEventListener eventListener)` Add a listener that allow re-checking the document after changing the options in the configuration dialog box.
`void`	`deactivateRule()` Deactivate a rule as requested by the context menu
`void`	`deactivateRule(String ruleId, String langcode, boolean reactivate)` Deactivate a rule by rule iD
`void`	`disposing(com.sun.star.lang.EventObject source)` remove internal stored text if document disposes
`com.sun.star.linguistic2.ProofreadingResult`	`doProofreading(String docID, String paraText, com.sun.star.lang.Locale locale, int startOfSentencePos, int nSuggestedBehindEndOfSentencePosition, com.sun.star.beans.PropertyValue[] propertyValues)` Runs the grammar checker on paragraph text.
`com.sun.star.uno.XComponentContext`	`getContext()` Returns xContext
`SingleDocument`	`getCurrentDocument()` Get the current used document
`com.sun.star.lang.Locale`	`getDocumentLocale()` Checks the language under the cursor.
`List<SingleDocument>`	`getDocuments()` Get list of single documents
`Language`	`getLanguage()` Checks the language under the cursor.
`static Language`	`getLanguage(com.sun.star.lang.Locale locale)` Get language from locale
`SwJLanguageTool`	`getLanguageTool()` get LanguageTool
`LinguisticServices`	`getLinguisticServices()` get LinguisticServices
`com.sun.star.lang.Locale`	`getLocale()` Get current locale language
`static com.sun.star.lang.Locale[]`	`getLocales()`
`List<Integer>`	`getNumMinToCheckParas()` Returns a list of different numbers of paragraphs to check for text level rules
`static String`	`getServiceDisplayName(com.sun.star.lang.Locale locale)` Get the displayed service name for LT
`TextLevelCheckQueue`	`getTextLevelCheckQueue()` Get text level queue
`boolean`	`heapLimitIsReached()` heap limit is reached
`String`	`ignoreOnce()` Call method ignoreOnce for concerned document
`String`	`ignorePermanent()` Call method ignorePermanent for concerned document
`void`	`ignoreRule(String ruleId, com.sun.star.lang.Locale locale)` Called when "Ignore" is selected e.g. in the context menu for an error.
`boolean`	`isBackgroundCheckOff()` true, if LanguageTool is switched off
`boolean`	`isEnoughHeapSpace()` Test if enough heap space is left Change to single paragraph mode if not return false if heap space is to small
`boolean`	`isJavaLookAndFeelSet()` true, if Java look and feel is set
`boolean`	`isSortedRuleForIndex(int index)` Test if sorted rules for index exist
`boolean`	`isSpellChecker()` We leave spell checking to OpenOffice/LibreOffice.
`boolean`	`javaVersionOkay()` Test if the needed java version is installed
`void`	`reactivateTextRules(SwJLanguageTool lt)` reactivate all text level rules
`boolean`	`removeLinguServiceEventListener(com.sun.star.linguistic2.XLinguServiceEventListener eventListener)` Remove a listener from the event listeners list.
`void`	`removeMenuListener(com.sun.star.lang.XComponent xComponent)` Delete the menu listener of a document
`void`	`renewMarkups()` Call method renewMarkups for concerned document
`boolean`	`resetCheck()` Inform listener that the document should be rechecked for grammar and style check.
`boolean`	`resetCheck(short eventFlag)` Inform listener that the doc should be rechecked for a special event flag.
`void`	`resetIgnoreOnce()` reset ignoreOnce information in all documents
`void`	`resetIgnoreRules()` Called on rechecking the document - resets the ignore status for rules that was set in the spelling dialog box or in the context menu.
`void`	`resetSortedTextRules(SwJLanguageTool lt)` reset sorted text level rules
`void`	`runOptionsDialog()` Runs LT options dialog box.
`void`	`runShapeCheck(boolean hasShapes, int where)` Start or stop the shape check loop
`void`	`setConfigFileName(String name)` Set Information LT spell and grammar check dialog was started
`void`	`setConfigurationDialog(ConfigurationDialog dialog)` Set pointer to configuration dialog
`void`	`setJavaLookAndFeel()` Set Look and Feel for Java Swing Components
`void`	`setLtDialog(SpellAndGrammarCheckDialog.LtCheckDialog dialog)` Set pointer to LT spell and grammar check dialog
`void`	`setLtDialogIsRunning(boolean running)` Set Information LT spell and grammar check dialog was started
`void`	`setMenuDocId(String docId)` Set docID used within menu
`void`	`setUseOriginalCheckDialog()` Set use original spell und grammar dialog (for OO and old LO)
`boolean`	`toggleNoBackgroundCheck()` Toggle Switch Off / On of LT return true if toggle was done
`void`	`trigger(String sEvent)` Triggers the events from LT menu
`boolean`	`useOriginalCheckDialog()` Set use original spell und grammar dialog (for OO and old LO)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - doProofreading
```
public final com.sun.star.linguistic2.ProofreadingResult doProofreading(String docID,
                                                                        String paraText,
                                                                        com.sun.star.lang.Locale locale,
                                                                        int startOfSentencePos,
                                                                        int nSuggestedBehindEndOfSentencePosition,
                                                                        com.sun.star.beans.PropertyValue[] propertyValues)
```
    Runs the grammar checker on paragraph text.
    
    Parameters:
    
    docID - document ID
    
    paraText - paragraph text
    
    locale - Locale the text Locale
    
    startOfSentencePos - start of sentence position
    
    nSuggestedBehindEndOfSentencePosition - end of sentence position
    
    Returns:
    
    ProofreadingResult containing the results of the check.
  - getCurrentDocument
```
public SingleDocument getCurrentDocument()
```
    Get the current used document
  - setConfigurationDialog
```
public void setConfigurationDialog(ConfigurationDialog dialog)
```
    Set pointer to configuration dialog
  - setLtDialog
```
public void setLtDialog(SpellAndGrammarCheckDialog.LtCheckDialog dialog)
```
    Set pointer to LT spell and grammar check dialog
  - setLtDialogIsRunning
```
public void setLtDialogIsRunning(boolean running)
```
    Set Information LT spell and grammar check dialog was started
  - setConfigFileName
```
public void setConfigFileName(String name)
```
    Set Information LT spell and grammar check dialog was started
  - getLanguageTool
```
public SwJLanguageTool getLanguageTool()
```
    get LanguageTool
  - getLinguisticServices
```
public LinguisticServices getLinguisticServices()
```
    get LinguisticServices
  - getLanguage
```
public Language getLanguage()
```
    Checks the language under the cursor. Used for opening the configuration dialog.
    
    Returns:
    
    the language under the visible cursor
  - getDocumentLocale
```
@Nullable
public com.sun.star.lang.Locale getDocumentLocale()
```
    Checks the language under the cursor. Used for opening the configuration dialog.
    
    Returns:
    
    the locale under the visible cursor
  - getLanguage
```
public static Language getLanguage(com.sun.star.lang.Locale locale)
```
    Get language from locale
  - removeMenuListener
```
public void removeMenuListener(com.sun.star.lang.XComponent xComponent)
```
    Delete the menu listener of a document
  - getLocale
```
public com.sun.star.lang.Locale getLocale()
```
    Get current locale language
  - getDocuments
```
public List<SingleDocument> getDocuments()
```
    Get list of single documents
  - getTextLevelCheckQueue
```
public TextLevelCheckQueue getTextLevelCheckQueue()
```
    Get text level queue
  - isBackgroundCheckOff
```
public boolean isBackgroundCheckOff()
```
    true, if LanguageTool is switched off
  - isJavaLookAndFeelSet
```
public boolean isJavaLookAndFeelSet()
```
    true, if Java look and feel is set
  - toggleNoBackgroundCheck
```
public boolean toggleNoBackgroundCheck()
                                throws IOException
```
    Toggle Switch Off / On of LT return true if toggle was done
    
    Throws:
    
    IOException
  - setMenuDocId
```
public void setMenuDocId(String docId)
```
    Set docID used within menu
  - setUseOriginalCheckDialog
```
public void setUseOriginalCheckDialog()
```
    Set use original spell und grammar dialog (for OO and old LO)
  - useOriginalCheckDialog
```
public boolean useOriginalCheckDialog()
```
    Set use original spell und grammar dialog (for OO and old LO)
  - ignoreOnce
```
public String ignoreOnce()
```
    Call method ignoreOnce for concerned document
  - ignorePermanent
```
public String ignorePermanent()
```
    Call method ignorePermanent for concerned document
  - renewMarkups
```
public void renewMarkups()
```
    Call method renewMarkups for concerned document
  - resetIgnoreOnce
```
public void resetIgnoreOnce()
```
    reset ignoreOnce information in all documents
  - activateRule
```
public void activateRule(String ruleId)
```
    Activate a rule by rule iD
  - activateRule
```
public void activateRule(String langcode,
                         String ruleId)
```
  - deactivateRule
```
public void deactivateRule()
```
    Deactivate a rule as requested by the context menu
  - deactivateRule
```
public void deactivateRule(String ruleId,
                           String langcode,
                           boolean reactivate)
```
    Deactivate a rule by rule iD
  - resetSortedTextRules
```
public void resetSortedTextRules(SwJLanguageTool lt)
```
    reset sorted text level rules
  - getNumMinToCheckParas
```
public List<Integer> getNumMinToCheckParas()
```
    Returns a list of different numbers of paragraphs to check for text level rules
  - isSortedRuleForIndex
```
public boolean isSortedRuleForIndex(int index)
```
    Test if sorted rules for index exist
  - activateTextRulesByIndex
```
public void activateTextRulesByIndex(int index,
                                     SwJLanguageTool lt)
```
    activate all rules stored under a given index related to the list of getNumMinToCheckParas deactivate all other text level rules
  - reactivateTextRules
```
public void reactivateTextRules(SwJLanguageTool lt)
```
    reactivate all text level rules
  - isSpellChecker
```
public final boolean isSpellChecker()
```
    We leave spell checking to OpenOffice/LibreOffice.
    
    Returns:
    
    false
  - getContext
```
public com.sun.star.uno.XComponentContext getContext()
```
    Returns xContext
  - runOptionsDialog
```
public void runOptionsDialog()
```
    Runs LT options dialog box.
  - getLocales
```
public static final com.sun.star.lang.Locale[] getLocales()
```
    Returns:
    
    An array of Locales supported by LT
  - addLinguServiceEventListener
```
public final boolean addLinguServiceEventListener(com.sun.star.linguistic2.XLinguServiceEventListener eventListener)
```
    Add a listener that allow re-checking the document after changing the options in the configuration dialog box.
    
    Parameters:
    
    eventListener - the listener to be added
    
    Returns:
    
    true if listener is non-null and has been added, false otherwise
  - removeLinguServiceEventListener
```
public final boolean removeLinguServiceEventListener(com.sun.star.linguistic2.XLinguServiceEventListener eventListener)
```
    Remove a listener from the event listeners list.
    
    Parameters:
    
    eventListener - the listener to be removed
    
    Returns:
    
    true if listener is non-null and has been removed, false otherwise
  - resetCheck
```
public boolean resetCheck()
```
    Inform listener that the document should be rechecked for grammar and style check.
  - resetCheck
```
public boolean resetCheck(short eventFlag)
```
    Inform listener that the doc should be rechecked for a special event flag.
  - trigger
```
public void trigger(String sEvent)
```
    Triggers the events from LT menu
  - javaVersionOkay
```
public boolean javaVersionOkay()
```
    Test if the needed java version is installed
  - setJavaLookAndFeel
```
public void setJavaLookAndFeel()
```
    Set Look and Feel for Java Swing Components
  - heapLimitIsReached
```
public boolean heapLimitIsReached()
```
    heap limit is reached
  - isEnoughHeapSpace
```
public boolean isEnoughHeapSpace()
```
    Test if enough heap space is left Change to single paragraph mode if not return false if heap space is to small
  - ignoreRule
```
public void ignoreRule(String ruleId,
                       com.sun.star.lang.Locale locale)
```
    Called when "Ignore" is selected e.g. in the context menu for an error.
  - resetIgnoreRules
```
public void resetIgnoreRules()
```
    Called on rechecking the document - resets the ignore status for rules that was set in the spelling dialog box or in the context menu. The rules disabled in the config dialog box are left as intact.
  - getServiceDisplayName
```
public static String getServiceDisplayName(com.sun.star.lang.Locale locale)
```
    Get the displayed service name for LT
  - disposing
```
public void disposing(com.sun.star.lang.EventObject source)
```
    remove internal stored text if document disposes
  - runShapeCheck
```
public void runShapeCheck(boolean hasShapes,
                          int where)
```
    Start or stop the shape check loop

Class MultiDocumentsHandler

Method Summary

Methods inherited from class java.lang.Object

Method Detail

doProofreading

getCurrentDocument

setConfigurationDialog

setLtDialog

setLtDialogIsRunning

setConfigFileName

getLanguageTool

getLinguisticServices

getLanguage

getDocumentLocale

getLanguage

removeMenuListener

getLocale

getDocuments

getTextLevelCheckQueue

isBackgroundCheckOff

isJavaLookAndFeelSet

toggleNoBackgroundCheck

setMenuDocId

setUseOriginalCheckDialog

useOriginalCheckDialog

ignoreOnce

ignorePermanent

renewMarkups

resetIgnoreOnce

activateRule

activateRule

deactivateRule

deactivateRule

resetSortedTextRules

getNumMinToCheckParas

isSortedRuleForIndex

activateTextRulesByIndex

reactivateTextRules

isSpellChecker

getContext

runOptionsDialog

getLocales

addLinguServiceEventListener

removeLinguServiceEventListener

resetCheck

resetCheck

trigger

javaVersionOkay

setJavaLookAndFeel

heapLimitIsReached

isEnoughHeapSpace

ignoreRule

resetIgnoreRules

getServiceDisplayName

disposing

runShapeCheck