com.jivesoftware.spark.component.spelling
Class JSpellCheckDlg

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      com.jivesoftware.spark.component.spelling.JSpellCheckDlg

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable, javax.swing.WindowConstants

public class JSpellCheckDlg

extends javax.swing.JDialog

Check the spelling of some text and interact with the user to correct any spelling errors encountered using a Swing dialog. This class is part of the Sentry Java SDK examples.

The basic steps involved in using the JSpellCheckDlg class to check text are:

1. Create a MemTextLexicon object to hold ignore-all and change-all words.
2. Create one or more FileTextLexicon objects representing user lexicons.
3. Create a FileTextLexicon and CompressedLexicon object for the main lexicon.
4. Create a SpellingSession object.
5. Add the lexicon objects to an array, and pass the array to the SpellingSession objects's setLexicons method.
6. Create a TypographicalComparator or EnglishPhoneticComparator object.
7. If your application can display help information about the spelling- checker dialog, create an object derived from the HelpViewer class.
8. If the text being checked is contained by a TextArea component, create a TextAreaWordParser object.
9. Create an array to hold the set of user lexicons.
10. Create a JSpellCheckDlg object.
11. Call JSpellCheckDlg's show method.
12. When the dialog closes, call the userCanceled method to determine if the changes made by the user should be kept.
13. If the JSpellCheckDlg object was constructed to check a String, call the getText method to obtain the corrected text.

Version:

$Id: JSpellCheckDlg.java 18715 2005-04-05 17:10:46 -0700 (Tue, 05 Apr 2005) bill $

See Also:

CompressedLexicon, EnglishPhoneticComparator, FileTextLexicon, MemTextLexicon, SpellingSession, TypographicalComparator, Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JDialog

javax.swing.JDialog.AccessibleJDialog

Nested classes inherited from class java.awt.Dialog

java.awt.Dialog.AccessibleAWTDialog

Nested classes inherited from class java.awt.Window

java.awt.Window.AccessibleAWTWindow

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

int	minSuggestDepth Initial depth used to obtain suggestions.

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

JSpellCheckDlg(java.awt.Frame parent, javax.swing.JTextPane pane)
Create new Spell Check Dialog.

JSpellCheckDlg(java.awt.Frame parent, com.wintertree.ssce.SpellingSession speller, java.lang.String text, com.wintertree.ssce.WordComparator comparator, com.wintertree.ssce.FileTextLexicon[] userLexicons)
Check the spelling of a String and interact with the user to correct spelling errors found in it using a Swing dialog.

Method Summary

void	addNotify()
java.lang.String	getText() Obtain the (possibly updated) text.
void	invoke(java.awt.Frame parent, com.wintertree.ssce.SpellingSession speller, com.wintertree.ssce.WordParser parser, com.wintertree.ssce.WordComparator comparator, com.wintertree.ssce.FileTextLexicon[] userLexicons) Invokes dialog.
void	setVisible(boolean b)
void	undo() Undo the last change made to the tex.
boolean	userCanceled() Determine if the user canceled the spelling check.

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update

Methods inherited from class java.awt.Dialog

dispose, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setResizable, setTitle, setUndecorated, show

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isOpaque, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

minSuggestDepth

public int minSuggestDepth

Initial depth used to obtain suggestions.

Constructor Detail

JSpellCheckDlg

public JSpellCheckDlg(java.awt.Frame parent,
                      javax.swing.JTextPane pane)

Create new Spell Check Dialog.

Parameters:

parent - the parent.

pane - the pane.

JSpellCheckDlg

public JSpellCheckDlg(java.awt.Frame parent,
                      com.wintertree.ssce.SpellingSession speller,
                      java.lang.String text,
                      com.wintertree.ssce.WordComparator comparator,
                      com.wintertree.ssce.FileTextLexicon[] userLexicons)

Check the spelling of a String and interact with the user to correct spelling errors found in it using a Swing dialog.

Parameters:

parent - The parent frame

speller - The spelling session used to check spelling

text - The text to spell-check. When the dialog closes, call the getText method to get the updated text.

comparator - Used to assess suggestions for misspelled words. If null, a TypographicalComparator will be used.

userLexicons - Array of user lexicon files which appear in the "Add words to" choice. If null or empty, the "Add words to" choice will not be displayed.

See Also:

getText()

Method Detail

invoke

public void invoke(java.awt.Frame parent,
                   com.wintertree.ssce.SpellingSession speller,
                   com.wintertree.ssce.WordParser parser,
                   com.wintertree.ssce.WordComparator comparator,
                   com.wintertree.ssce.FileTextLexicon[] userLexicons)

Invokes dialog.

Parameters:

parent - the parent

speller - the spell session.

parser - the word parser.

comparator - the comparator.

userLexicons - the userlexicons

setVisible

public void setVisible(boolean b)

getText

public java.lang.String getText()

Obtain the (possibly updated) text. This method should be called only if the SpellingDialog was constructed to check a String.

Returns:

The updated text

userCanceled

public boolean userCanceled()

Determine if the user canceled the spelling check.

Returns:

true if the user canceled; false if the spelling check ran to completion.

addNotify

public void addNotify()

undo

public void undo()

Undo the last change made to the tex. If no changes can be undone, this method does nothing. Subsequent calls to this method will undo successive changes, starting with the most recent change.