Package org.languagetool.gui

Class LanguageToolSupport

java.lang.Object

org.languagetool.gui.LanguageToolSupport

class LanguageToolSupport
extends java.lang.Object

Support for associating a LanguageTool instance and a JTextComponent

Since:

2.3

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	LanguageToolSupport.ReplaceMenuItem
private class	LanguageToolSupport.RunnableImpl
private static class	LanguageToolSupport.Span

Field Summary

Fields

Modifier and Type	Field	Description
private java.awt.event.ActionListener	actionListener
private boolean	backgroundCheckEnabled
private java.util.concurrent.atomic.AtomicInteger	check
private java.util.concurrent.ScheduledExecutorService	checkExecutor
private Configuration	config
(package private) static java.lang.String	CONFIG_FILE
private java.util.List<LanguageToolSupport.Span>	documentSpans
private javax.swing.JFrame	frame
private org.languagetool.language.LanguageIdentifier	langIdentifier
private org.languagetool.MultiThreadedJLanguageTool	languageTool
private javax.swing.event.EventListenerList	listenerList
private static int	MAX_CATEGORIES_PER_MENU
private static int	MAX_RULES_NO_CATEGORY_MENU
private static int	MAX_RULES_PER_MENU
private java.util.ResourceBundle	messages
private int	millisecondDelay
private java.awt.event.MouseListener	mouseListener
private boolean	mustDetectLanguage
private boolean	popupMenuEnabled
private java.util.List<org.languagetool.rules.RuleMatch>	ruleMatches
private javax.swing.text.JTextComponent	textComponent
private UndoRedoSupport	undo

Constructor Summary

Constructors

Constructor	Description
LanguageToolSupport(javax.swing.JFrame frame, javax.swing.text.JTextComponent textComponent)	LanguageTool support for a JTextComponent
LanguageToolSupport(javax.swing.JFrame frame, javax.swing.text.JTextComponent textComponent, UndoRedoSupport support)	LanguageTool support for a JTextComponent

Method Summary

Modifier and Type	Method	Description
private void	_actionPerformed(java.awt.event.ActionEvent e)
private void	activateLanguageModelRules(org.languagetool.Language language)
private void	activateWord2VecModelRules(org.languagetool.Language language)
private void	addDisabledRulesToMenu(java.util.List<org.languagetool.rules.Rule> disabledRules, javax.swing.JMenu menu)
(package private) void	addLanguageToolListener(LanguageToolListener ltListener)
private void	applySuggestion(java.lang.String str, int start, int end)
(package private) org.languagetool.Language	autoDetectLanguage(java.lang.String text)
void	checkDelayed()
void	checkDelayed(java.lang.Object caller)
void	checkImmediately()
void	checkImmediately(java.lang.Object caller)
private java.util.List<org.languagetool.rules.RuleMatch>	checkText(java.lang.Object caller)
private void	createRulesMenu(javax.swing.JMenu parent, java.util.List<org.languagetool.rules.Rule> rules)
(package private) void	disableRule(java.lang.String ruleId)
(package private) void	enableRule(java.lang.String ruleId)
private void	fireEvent(LanguageToolEvent event)
private void	fireEvent(LanguageToolEvent.Type type, java.lang.Object caller)
private void	fireEvent(LanguageToolEvent.Type type, java.lang.Object caller, long elapsedTime)
Configuration	getConfig()
private java.util.List<org.languagetool.rules.Rule>	getDisabledRules()
(package private) org.languagetool.Language	getLanguage()
(package private) org.languagetool.JLanguageTool	getLanguageTool()
(package private) java.util.List<org.languagetool.rules.RuleMatch>	getMatches()
int	getMillisecondDelay()
(package private) @Nullable org.languagetool.rules.Rule	getRuleForId(java.lang.String ruleId)
private @Nullable LanguageToolSupport.Span	getSpan(int offset)
(package private) javax.swing.text.JTextComponent	getTextComponent()
private void	init()
boolean	isBackgroundCheckEnabled()
boolean	isPopupMenuEnabled()
private void	prepareUpdateHighlights(java.util.List<org.languagetool.rules.RuleMatch> matches, java.util.List<LanguageToolSupport.Span> spans)
private void	recalculateSpans(int offset, int length, boolean remove)
(package private) void	reloadConfig()
private void	reloadLanguageTool(org.languagetool.Language language)
private void	removeHighlights()
(package private) void	removeLanguageToolListener(LanguageToolListener ltListener)
void	setBackgroundCheckEnabled(boolean backgroundCheckEnabled)
void	setLanguage(org.languagetool.Language language)
void	setMillisecondDelay(int millisecondDelay)	The text checking delay in milliseconds.
void	setPopupMenuEnabled(boolean popupMenuEnabled)
private void	showDialog(java.awt.Component parent, java.lang.String title, java.lang.String message, org.languagetool.rules.Rule rule, java.net.URL url)
private void	showPopup(java.awt.event.MouseEvent event)
private void	updateHighlights()
private void	updateHighlights(java.lang.String disabledRule)
private void	updateHighlights(java.util.List<org.languagetool.rules.RuleMatch> matches)

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_FILE

static final java.lang.String CONFIG_FILE

See Also:

Constant Field Values

MAX_RULES_NO_CATEGORY_MENU

private static final int MAX_RULES_NO_CATEGORY_MENU

See Also:

Constant Field Values

MAX_RULES_PER_MENU

private static final int MAX_RULES_PER_MENU

See Also:

Constant Field Values

MAX_CATEGORIES_PER_MENU

private static final int MAX_CATEGORIES_PER_MENU

See Also:

Constant Field Values

undo

private final UndoRedoSupport undo

langIdentifier

private final org.languagetool.language.LanguageIdentifier langIdentifier

frame

private final javax.swing.JFrame frame

textComponent

private final javax.swing.text.JTextComponent textComponent

listenerList

private final javax.swing.event.EventListenerList listenerList

messages

private final java.util.ResourceBundle messages

ruleMatches

private final java.util.List<org.languagetool.rules.RuleMatch> ruleMatches

documentSpans

private final java.util.List<LanguageToolSupport.Span> documentSpans

languageTool

private org.languagetool.MultiThreadedJLanguageTool languageTool

checkExecutor

private java.util.concurrent.ScheduledExecutorService checkExecutor

mouseListener

private java.awt.event.MouseListener mouseListener

actionListener

private java.awt.event.ActionListener actionListener

millisecondDelay

private int millisecondDelay

check

private java.util.concurrent.atomic.AtomicInteger check

popupMenuEnabled

private boolean popupMenuEnabled

backgroundCheckEnabled

private boolean backgroundCheckEnabled

config

private Configuration config

mustDetectLanguage

private boolean mustDetectLanguage

Constructor Detail

LanguageToolSupport

LanguageToolSupport(javax.swing.JFrame frame,
                    javax.swing.text.JTextComponent textComponent)

LanguageTool support for a JTextComponent

LanguageToolSupport

LanguageToolSupport(javax.swing.JFrame frame,
                    javax.swing.text.JTextComponent textComponent,
                    UndoRedoSupport support)

LanguageTool support for a JTextComponent

Since:

2.7

Method Detail

addLanguageToolListener

void addLanguageToolListener(LanguageToolListener ltListener)

removeLanguageToolListener

void removeLanguageToolListener(LanguageToolListener ltListener)

fireEvent

private void fireEvent(LanguageToolEvent.Type type,
                       java.lang.Object caller,
                       long elapsedTime)

fireEvent

private void fireEvent(LanguageToolEvent.Type type,
                       java.lang.Object caller)

fireEvent

private void fireEvent(LanguageToolEvent event)

getTextComponent

javax.swing.text.JTextComponent getTextComponent()

getMatches

java.util.List<org.languagetool.rules.RuleMatch> getMatches()

reloadConfig

void reloadConfig()

reloadLanguageTool

private void reloadLanguageTool(org.languagetool.Language language)

activateLanguageModelRules

private void activateLanguageModelRules(org.languagetool.Language language)

activateWord2VecModelRules

private void activateWord2VecModelRules(org.languagetool.Language language)

init

private void init()

getMillisecondDelay

public int getMillisecondDelay()

setMillisecondDelay

public void setMillisecondDelay(int millisecondDelay)

The text checking delay in milliseconds.

isPopupMenuEnabled

public boolean isPopupMenuEnabled()

setPopupMenuEnabled

public void setPopupMenuEnabled(boolean popupMenuEnabled)

isBackgroundCheckEnabled

public boolean isBackgroundCheckEnabled()

setBackgroundCheckEnabled

public void setBackgroundCheckEnabled(boolean backgroundCheckEnabled)

setLanguage

public void setLanguage(org.languagetool.Language language)

getLanguage

org.languagetool.Language getLanguage()

getConfig

public Configuration getConfig()

getLanguageTool

org.languagetool.JLanguageTool getLanguageTool()

disableRule

void disableRule(java.lang.String ruleId)

enableRule

void enableRule(java.lang.String ruleId)

getSpan

@Nullable
private @Nullable LanguageToolSupport.Span getSpan(int offset)

showPopup

private void showPopup(java.awt.event.MouseEvent event)

getDisabledRules

private java.util.List<org.languagetool.rules.Rule> getDisabledRules()

addDisabledRulesToMenu

private void addDisabledRulesToMenu(java.util.List<org.languagetool.rules.Rule> disabledRules,
                                    javax.swing.JMenu menu)

createRulesMenu

private void createRulesMenu(javax.swing.JMenu parent,
                             java.util.List<org.languagetool.rules.Rule> rules)

getRuleForId

@Nullable
@Nullable org.languagetool.rules.Rule getRuleForId(java.lang.String ruleId)

_actionPerformed

private void _actionPerformed(java.awt.event.ActionEvent e)

applySuggestion

private void applySuggestion(java.lang.String str,
                             int start,
                             int end)

checkDelayed

public void checkDelayed()

checkDelayed

public void checkDelayed(java.lang.Object caller)

checkImmediately

public void checkImmediately()

checkImmediately

public void checkImmediately(java.lang.Object caller)

autoDetectLanguage

org.languagetool.Language autoDetectLanguage(java.lang.String text)

checkText

private java.util.List<org.languagetool.rules.RuleMatch> checkText(java.lang.Object caller)
                                                            throws java.io.IOException

Throws:

java.io.IOException

removeHighlights

private void removeHighlights()

recalculateSpans

private void recalculateSpans(int offset,
                              int length,
                              boolean remove)

updateHighlights

private void updateHighlights(java.lang.String disabledRule)

updateHighlights

private void updateHighlights(java.util.List<org.languagetool.rules.RuleMatch> matches)

prepareUpdateHighlights

private void prepareUpdateHighlights(java.util.List<org.languagetool.rules.RuleMatch> matches,
                                     java.util.List<LanguageToolSupport.Span> spans)

updateHighlights

private void updateHighlights()

showDialog

private void showDialog(java.awt.Component parent,
                        java.lang.String title,
                        java.lang.String message,
                        org.languagetool.rules.Rule rule,
                        java.net.URL url)