org.dts.spell.swing

Class JTextComponentSpellChecker

java.lang.Object

org.dts.spell.swing.JTextComponentSpellChecker

public class JTextComponentSpellChecker
extends Object

Author:

DreamTangerine

Constructor Summary

Constructors

Constructor and Description
JTextComponentSpellChecker(org.dts.spell.SpellChecker checker)

Method Summary

Modifier and Type	Method and Description
void	addListener(TextComponentSpellCheckerListener listener)
void	addWordToDictionary(JTextComponent textComponent, String badWord, org.dts.spell.dictionary.SpellDictionary dictionary)
void	deleteBadWord(JTextComponent textComponent, org.dts.spell.finder.Word badWord)
ActionManager	getActionManager()
AddWordAction	getAddWordAction()
DeleteWordAction	getDeleteWordAction()
ErrorMarker	getErrorMarker(JTextComponent textComponent)
ErrorPopUpMenu	getErrorPopUpMenu()
ErrorToolTips	getErrorToolTips()
IgnoreWordAction	getIgnoreWordAction()
RealTimeSpellCheckAction	getRealTimeSpellCheckAction()
ReplaceAllWordsAction	getReplaceAllWordsAction()
ReplaceWordAction	getReplaceWordAction()
ReplaceWordAction	getReplaceWordAction(String sugestion)
SpellCheckAction	getSpellCheckAction()
org.dts.spell.SpellChecker	getSpellChecker()
void	ignoreWord(JTextComponent textComponent, String badWord)
boolean	isRealtimeMarkErrors(JTextComponent textComponent)
void	markErrors(JTextComponent textComponent)
void	markErrors(JTextComponent textComponent, DocumentWordFinder wordFinder) Mark current errors (not while you are typing) of the JTextComponent.
protected void	markInManagers(ErrorMarker errorMarker)
void	recheckAll(JTextComponent textComponent)
void	recheckErrors(JTextComponent textComponent)
void	removeListener(TextComponentSpellCheckerListener listener)
void	replaceAllBadWords(JTextComponent textComponent, String badWord, String newWord)
void	replaceBadWord(JTextComponent textComponent, org.dts.spell.finder.Word badWord, String suggestion)
void	setActionManager(ActionManager actionManager)
void	setErrorPopUpMenu(ErrorPopUpMenu errorPopUpMenu) Change the popupmenu to show when mouse is over an error.
void	setErrorToolTips(ErrorToolTips errorToolTips) Change the tooltip to show when mouse is over an error.
boolean	spellCheck(JTextComponent textComponent)
boolean	spellCheck(JTextComponent textComponent, DocumentWordFinder documentWordFinder) Chek the current component showing a Graphical Dialog.
void	startRealtimeMarkErrors(JTextComponent textComponent)
void	startRealtimeMarkErrors(JTextComponent textComponent, DocumentWordFinder wordFinder) Mark current errors (not while you are typing) of the JTextComponent.
void	stopRealtimeMarkErrors()
void	stopRealtimeMarkErrors(JTextComponent textComponent)
void	unMarkErrors(JTextComponent textComponent) Allow quit all marked error of the textComponent.
protected void	unMarkInManagers(ErrorMarker errorMarker)

Methods inherited from class java.lang.Object

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

Constructor Detail

JTextComponentSpellChecker

public JTextComponentSpellChecker(org.dts.spell.SpellChecker checker)

Method Detail

addListener

public void addListener(TextComponentSpellCheckerListener listener)

removeListener

public void removeListener(TextComponentSpellCheckerListener listener)

getSpellChecker

public org.dts.spell.SpellChecker getSpellChecker()

markErrors

public void markErrors(JTextComponent textComponent)

markErrors

public void markErrors(JTextComponent textComponent,
                       DocumentWordFinder wordFinder)

Mark current errors (not while you are typing) of the JTextComponent. You must call unMarkErrors to free resources when you don't need the marks.

Parameters:

textComponent -

wordFinder -

unMarkErrors

public void unMarkErrors(JTextComponent textComponent)

Allow quit all marked error of the textComponent. You must call it when you don't want the errors marks. You must first call markErrors or a IllegalArgumentException will be throw.

Parameters:

textComponent -

spellCheck

public boolean spellCheck(JTextComponent textComponent)

spellCheck

public boolean spellCheck(JTextComponent textComponent,
                          DocumentWordFinder documentWordFinder)

Chek the current component showing a Graphical Dialog. If the realtime spell check is activated for textComponent, the realtime spell checking is stoped and started when the spellcheck is started and finished respectively.

isRealtimeMarkErrors

public boolean isRealtimeMarkErrors(JTextComponent textComponent)

getErrorMarker

public ErrorMarker getErrorMarker(JTextComponent textComponent)

startRealtimeMarkErrors

public void startRealtimeMarkErrors(JTextComponent textComponent)

startRealtimeMarkErrors

public void startRealtimeMarkErrors(JTextComponent textComponent,
                                    DocumentWordFinder wordFinder)

Mark current errors (not while you are typing) of the JTextComponent. You must call unMarkErrors to free resources when you don't need the marks.

Parameters:

textComponent -

wordFinder -

stopRealtimeMarkErrors

public void stopRealtimeMarkErrors(JTextComponent textComponent)

stopRealtimeMarkErrors

public void stopRealtimeMarkErrors()

markInManagers

protected void markInManagers(ErrorMarker errorMarker)

unMarkInManagers

protected void unMarkInManagers(ErrorMarker errorMarker)

getErrorToolTips

public ErrorToolTips getErrorToolTips()

setErrorToolTips

public void setErrorToolTips(ErrorToolTips errorToolTips)

Change the tooltip to show when mouse is over an error. It try to preserve original ones.

Parameters:

errorToolTips - It can be null, in that case no tooltip is show.

getErrorPopUpMenu

public ErrorPopUpMenu getErrorPopUpMenu()

setErrorPopUpMenu

public void setErrorPopUpMenu(ErrorPopUpMenu errorPopUpMenu)

Change the popupmenu to show when mouse is over an error. It try to preserve original ones.

Parameters:

errorToolTips - It can be null, in that case no popupmenu is show.

getActionManager

public ActionManager getActionManager()

setActionManager

public void setActionManager(ActionManager actionManager)

recheckAll

public void recheckAll(JTextComponent textComponent)

recheckErrors

public void recheckErrors(JTextComponent textComponent)

addWordToDictionary

public void addWordToDictionary(JTextComponent textComponent,
                                String badWord,
                                org.dts.spell.dictionary.SpellDictionary dictionary)

ignoreWord

public void ignoreWord(JTextComponent textComponent,
                       String badWord)

replaceAllBadWords

public void replaceAllBadWords(JTextComponent textComponent,
                               String badWord,
                               String newWord)

replaceBadWord

public void replaceBadWord(JTextComponent textComponent,
                           org.dts.spell.finder.Word badWord,
                           String suggestion)

deleteBadWord

public void deleteBadWord(JTextComponent textComponent,
                          org.dts.spell.finder.Word badWord)

getAddWordAction

public AddWordAction getAddWordAction()

Returns:

the addWordAction

getIgnoreWordAction

public IgnoreWordAction getIgnoreWordAction()

Returns:

the ignoreWordAction

getDeleteWordAction

public DeleteWordAction getDeleteWordAction()

Returns:

the deleteWordAction

getSpellCheckAction

public SpellCheckAction getSpellCheckAction()

Returns:

the spellCheckAction

getRealTimeSpellCheckAction

public RealTimeSpellCheckAction getRealTimeSpellCheckAction()

Returns:

the realTimeSpellCheckAction

getReplaceWordAction

public ReplaceWordAction getReplaceWordAction()

getReplaceAllWordsAction

public ReplaceAllWordsAction getReplaceAllWordsAction()

getReplaceWordAction

public ReplaceWordAction getReplaceWordAction(String sugestion)