com.jspell.gui
Class JSpellChecker

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by java.awt.Window
              extended by java.awt.Dialog
                  extended by javax.swing.JDialog
                      extended by com.jspell.gui.JSpellChecker
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class JSpellChecker
extends javax.swing.JDialog

The JSpellChecker class is the Java 2 graphic user interface to the JSpell Java SDK Pro Spell Checker. This is a new class as of JSpell 2004. See JSpellAppTestLocal.java in the com.jspell.demo package for a simple example of using this class in a Java application.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JDialog
javax.swing.JDialog.AccessibleJDialog
 
Nested classes/interfaces inherited from class java.awt.Dialog
java.awt.Dialog.AccessibleAWTDialog
 
Nested classes/interfaces inherited from class java.awt.Window
java.awt.Window.AccessibleAWTWindow
 
Nested classes/interfaces inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
 
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
JSpellChecker()
          Creates a new JSpellChecker.
JSpellChecker(java.awt.Frame f)
          When called with a Frame parameter, will cause the spell checker to center itself within the frame.
JSpellChecker(java.awt.Frame f, JSpellTextComponent textComponent)
          Initializes the JSpellChecker with a Frame and a JSpellTextComponent.
JSpellChecker(java.awt.Frame f, javax.swing.text.JTextComponent textComponent)
          Initializes the JSpellChecker with a Frame and a JTextComponent.
JSpellChecker(javax.swing.JDialog d)
          Used to initialize the JSpellChecker with a JDialog as a parent.
JSpellChecker(JSpellTextComponent textComponent)
          Constructs a JSpellChecker and initializes it to spell check the JSpellTextComponent passed in as an argument.
JSpellChecker(javax.swing.text.JTextComponent textComponent)
          Constructs a JSpellChecker and initializes it to spell check the JTextComponent passed in as an argument.
 
Method Summary
 void addComponent(JSpellTextComponent jtext)
          Adds a JSpellTextComponent object to be spell checked.
 void addComponent(javax.swing.text.JTextComponent textComponent)
          Adds a JTextComponent object to be spell checked.
 void addComponent(java.awt.TextComponent textComponent)
          Adds an AWT TextComponent object to be spell checked.
 void cancel()
          Cancel the spell check.
protected  void centerDialog()
          Centers the dialog within the Frame.
 void check()
          Accepts a previously constructed JSpellParser, a Frame, and the JTextComponent to check.
protected  void closeDialog()
          Closes the dialog
 JSpellParser getParser()
          Returns the JSpellParser object.
 boolean isShowComplete()
          Getter for property showComplete.
 void setParser(JSpellParser parser)
          Initialize the JSpellChecker object with the JSpellParser that will perform the spell checks.
 void setShowComplete(boolean showComplete)
          Setter for property showComplete.
protected  void spellCheckComplete()
          Displays the 'Spell Check Complete' message when the JSpell spell checker has completed processing.
 
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
addNotify, 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, dispose, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isAlwaysOnTop, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationByPlatform, 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, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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, firePropertyChange, firePropertyChange, firePropertyChange, 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, getMousePosition, 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, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, 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, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

JSpellChecker

public JSpellChecker()
Creates a new JSpellChecker. After creating the dialog you must use the addComponent method to add JTextComponent elements to spell check. Alternatively, you may use the JSpellDialog(JTextComponent) constructor to initialize the JSpellDialog with a JTextComponent to spell check.


JSpellChecker

public JSpellChecker(javax.swing.JDialog d)
Used to initialize the JSpellChecker with a JDialog as a parent. This allows the parent JDialog to be modal.


JSpellChecker

public JSpellChecker(java.awt.Frame f)
When called with a Frame parameter, will cause the spell checker to center itself within the frame.

Parameters:
f - a Frame object.

JSpellChecker

public JSpellChecker(javax.swing.text.JTextComponent textComponent)
Constructs a JSpellChecker and initializes it to spell check the JTextComponent passed in as an argument.

Parameters:
textComponent - a JTextComponent.

JSpellChecker

public JSpellChecker(java.awt.Frame f,
                     javax.swing.text.JTextComponent textComponent)
Initializes the JSpellChecker with a Frame and a JTextComponent. The dialog is centered within the Frame.

Parameters:
f - a Frame object.
textComponent - a JTextComponent object.

JSpellChecker

public JSpellChecker(JSpellTextComponent textComponent)
Constructs a JSpellChecker and initializes it to spell check the JSpellTextComponent passed in as an argument.

Parameters:
textComponent - a JSpellTextComponent.

JSpellChecker

public JSpellChecker(java.awt.Frame f,
                     JSpellTextComponent textComponent)
Initializes the JSpellChecker with a Frame and a JSpellTextComponent. The dialog is centered within the Frame.

Parameters:
f - a Frame object.
textComponent - a JSpellTextComponent object.
Method Detail

addComponent

public void addComponent(javax.swing.text.JTextComponent textComponent)
Adds a JTextComponent object to be spell checked. Multiple JTextComponents may be spell checked by simply adding them using this method.

Parameters:
textComponent - a JTextComponent object.

addComponent

public void addComponent(java.awt.TextComponent textComponent)
Adds an AWT TextComponent object to be spell checked. Multiple objects may be spell checked by simply adding them using this method.

Parameters:
textComponent - an AWT TextComponent object.

addComponent

public void addComponent(JSpellTextComponent jtext)
Adds a JSpellTextComponent object to be spell checked. Multiple objects may be spell checked by simply adding them using this method.

Parameters:
jtext - An object that implements the JSpellTextComponent interface.

cancel

public final void cancel()
Cancel the spell check.


setParser

public void setParser(JSpellParser parser)
Initialize the JSpellChecker object with the JSpellParser that will perform the spell checks. This method call is required in order to use the JSpellChecker.

Parameters:
parser - a JSpellParser object.

getParser

public JSpellParser getParser()
Returns the JSpellParser object.

Returns:
a JSpellParser object.

centerDialog

protected void centerDialog()
Centers the dialog within the Frame.


check

public void check()
Accepts a previously constructed JSpellParser, a Frame, and the JTextComponent to check. Passes contents of JTextComponent to JSpellParser and manages updating contents of the JTextComponent based on user interaction.


spellCheckComplete

protected void spellCheckComplete()
Displays the 'Spell Check Complete' message when the JSpell spell checker has completed processing. You can prevent the display of this panel by calling the setShowComplete method with the parameter false.


closeDialog

protected void closeDialog()
Closes the dialog


isShowComplete

public boolean isShowComplete()
Getter for property showComplete.

Returns:
Value of property showComplete.

setShowComplete

public void setShowComplete(boolean showComplete)
Setter for property showComplete. Defaults to true. If set to false prevents the display of the "Spell Check Complete" panel.

Parameters:
showComplete - New value of property showComplete.


JSpell SDK - Spell Checker for the Java ™ Platform
Copyright © 2009 Page Scholar Inc, All Rights Reserved - http://www.jspell.com