org.languagetool.openoffice

Class Main

java.lang.Object

com.sun.star.lib.uno.helper.WeakBase

org.languagetool.openoffice.Main

All Implemented Interfaces:

com.sun.star.lang.XEventListener, com.sun.star.lang.XServiceDisplayName, com.sun.star.lang.XServiceInfo, com.sun.star.lang.XTypeProvider, com.sun.star.linguistic2.XLinguServiceEventBroadcaster, com.sun.star.linguistic2.XProofreader, com.sun.star.linguistic2.XSupportedLocales, com.sun.star.task.XJobExecutor, com.sun.star.uno.XInterface, com.sun.star.uno.XWeak, EventListener

public class Main
extends com.sun.star.lib.uno.helper.WeakBase
implements com.sun.star.task.XJobExecutor, com.sun.star.lang.XServiceDisplayName, com.sun.star.lang.XServiceInfo, com.sun.star.linguistic2.XProofreader, com.sun.star.linguistic2.XLinguServiceEventBroadcaster, com.sun.star.lang.XEventListener

LibreOffice/OpenOffice integration.

Author:

Marcin Miłkowski, Fred Kruse

Field Summary

Fields inherited from class com.sun.star.lib.uno.helper.WeakBase

_mapImplementationIds, _mapTypes

Fields inherited from interface com.sun.star.task.XJobExecutor

UNOTYPEINFO

Fields inherited from interface com.sun.star.lang.XServiceDisplayName

UNOTYPEINFO

Fields inherited from interface com.sun.star.lang.XServiceInfo

UNOTYPEINFO

Fields inherited from interface com.sun.star.linguistic2.XProofreader

UNOTYPEINFO

Fields inherited from interface com.sun.star.linguistic2.XLinguServiceEventBroadcaster

UNOTYPEINFO

Fields inherited from interface com.sun.star.lang.XEventListener

UNOTYPEINFO

Fields inherited from interface com.sun.star.uno.XWeak

UNOTYPEINFO

Fields inherited from interface com.sun.star.lang.XTypeProvider

UNOTYPEINFO

Constructor Summary

Constructors

Constructor and Description
Main(com.sun.star.uno.XComponentContext xCompContext)

Method Summary

Modifier and Type	Method and Description
static com.sun.star.lang.XSingleComponentFactory	__getComponentFactory(String sImplName) Get XSingleComponentFactory Default method called by LO/OO extensions
static boolean	__writeRegistryServiceInfo(com.sun.star.registry.XRegistryKey regKey) Write keys to registry Default method called by LO/OO extensions
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	disposing(com.sun.star.lang.EventObject source) Remove internal stored text if document disposes Interface: XEventListener
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.
String	getImplementationName() Get the implementation name of the LT service interface: XServiceInfo
com.sun.star.lang.Locale[]	getLocales()
String	getServiceDisplayName(com.sun.star.lang.Locale locale) Get the display name of the LT service Interface: XServiceDisplayName
String[]	getSupportedServiceNames() Get the names of supported services interface: XServiceInfo
boolean	hasLocale(com.sun.star.lang.Locale locale)
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	isSpellChecker() We leave spell checking to OpenOffice/LibreOffice.
boolean	removeLinguServiceEventListener(com.sun.star.linguistic2.XLinguServiceEventListener eventListener) Remove a listener from the event listeners list.
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.
boolean	supportsService(String sServiceName) Test if the service is supported by LT interface: XServiceInfo
void	trigger(String sEvent) Triggers a registered event interface: XJobExecutor

Methods inherited from class com.sun.star.lib.uno.helper.WeakBase

finalize, getImplementationId, getTypes, queryAdapter

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Main

public Main(com.sun.star.uno.XComponentContext xCompContext)

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. interface: XProofreader

Specified by:

doProofreading in interface com.sun.star.linguistic2.XProofreader

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.

isSpellChecker

public final boolean isSpellChecker()

We leave spell checking to OpenOffice/LibreOffice. interface: XProofreader

Specified by:

isSpellChecker in interface com.sun.star.linguistic2.XProofreader

Returns:

false

getLocales

public final com.sun.star.lang.Locale[] getLocales()

Specified by:

getLocales in interface com.sun.star.linguistic2.XSupportedLocales

Returns:

An array of Locales supported by LT interface: XProofreader

hasLocale

public final boolean hasLocale(com.sun.star.lang.Locale locale)

Specified by:

hasLocale in interface com.sun.star.linguistic2.XSupportedLocales

Parameters:

locale - The Locale to check interface: XProofreader

Returns:

true if LT supports the language of a given locale

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. interface: XLinguServiceEventBroadcaster

Specified by:

addLinguServiceEventListener in interface com.sun.star.linguistic2.XLinguServiceEventBroadcaster

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. interface: XLinguServiceEventBroadcaster

Specified by:

removeLinguServiceEventListener in interface com.sun.star.linguistic2.XLinguServiceEventBroadcaster

Parameters:

eventListener - the listener to be removed

Returns:

true if listener is non-null and has been removed, false otherwise

getSupportedServiceNames

public String[] getSupportedServiceNames()

Get the names of supported services interface: XServiceInfo

Specified by:

getSupportedServiceNames in interface com.sun.star.lang.XServiceInfo

supportsService

public boolean supportsService(String sServiceName)

Test if the service is supported by LT interface: XServiceInfo

Specified by:

supportsService in interface com.sun.star.lang.XServiceInfo

getImplementationName

public String getImplementationName()

Get the implementation name of the LT service interface: XServiceInfo

Specified by:

getImplementationName in interface com.sun.star.lang.XServiceInfo

__getComponentFactory

public static com.sun.star.lang.XSingleComponentFactory __getComponentFactory(String sImplName)

Get XSingleComponentFactory Default method called by LO/OO extensions

__writeRegistryServiceInfo

public static boolean __writeRegistryServiceInfo(com.sun.star.registry.XRegistryKey regKey)

Write keys to registry Default method called by LO/OO extensions

trigger

public void trigger(String sEvent)

Triggers a registered event interface: XJobExecutor

Specified by:

trigger in interface com.sun.star.task.XJobExecutor

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. interface: XProofreader

Specified by:

ignoreRule in interface com.sun.star.linguistic2.XProofreader

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. interface: XProofreader

Specified by:

resetIgnoreRules in interface com.sun.star.linguistic2.XProofreader

getServiceDisplayName

public String getServiceDisplayName(com.sun.star.lang.Locale locale)

Get the display name of the LT service Interface: XServiceDisplayName

Specified by:

getServiceDisplayName in interface com.sun.star.lang.XServiceDisplayName

disposing

public void disposing(com.sun.star.lang.EventObject source)

Remove internal stored text if document disposes Interface: XEventListener

Specified by:

disposing in interface com.sun.star.lang.XEventListener