com.zfqjava.swing
Class JTextSpeller

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              com.zfqjava.swing.JTextSpeller

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class JTextSpeller
extends JComponent
implements Accessible

JTextSpeller provides a text speller component.

See Also:

Serialized Form

Nested Class Summary

static class	JTextSpeller.AbstractSpeller AbstractSpeller handles the spell operation.
protected class	JTextSpeller.AccessibleJTextSpeller This class implements accessibility support for the JTextSpeller class.

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

static int	CANCEL_CONTROL Type used for cancel button on the text speller.
static int	IGNORE_ALL_CONTROL Type used for ingore all button on the text speller.
static int	IGNORE_CONTROL Type used for ignore button on the text speller.
static int	REPLACE_ALL_CONTROL Type used for replace all button on the text speller.
static int	REPLACE_CONTROL Type used for replace button on the text speller.

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

JTextSpeller()

Method Summary

void	cancel() Called by JTextSpeller when the user hits the Cancel button.
protected JDialog	createDialog(Component parent) Creates a dialog for the JTextSpeller.
protected JTextSpeller.AbstractSpeller	createSpeller(Component c) Factory methods to create the AbstractSpeller for specified component.
AccessibleContext	getAccessibleContext() Gets the AccessibleContext associated with this JTextSpeller.
JButton	getControlButton(int controlType) Gets the control button of the type.
String	getErrorText() Returns the error text.
Component	getForComponent() Returns the component that the JTextSpeller attach.
String	getReplaceText() Returns the replace text.
JTextSpeller.AbstractSpeller	getSpeller() Returns the speller for JTextSpeller.
String[]	getSuggestText() Returns the suggest text.
TextSpellerUI	getUI() Returns the look and feel (L&F) object that renders this component.
String	getUIClassID() Returns a string that specifies the name of the L&F class that renders this component.
void	ignore() Called by JTextSpeller when the user hits the Ignore button.
void	ignoreAll() Called by JTextSpeller when the user hits the Ignore All button.
protected String	paramString() Returns a string representation of this JTextSpeller.
void	replace() Called by JTextSpeller when the user hits the Replace button.
void	replaceAll() Called by JTextSpeller when the user hits the Replace All button.
void	setErrorText(String errorText) Sets the error text.
void	setForComponent(Component c) Sets the component that the JTextSpeller attach.
void	setReplaceText(String replaceText) Sets the replace text.
void	setSpeller(JTextSpeller.AbstractSpeller speller) Sets the speller for JTextSpeller.
void	setSuggestText(String[] suggestText) Sets the suggest text.
void	setUI(TextSpellerUI ui) Sets the look and feel (L&F) object that renders this component.
void	showDialog(Component parent) Pops up a dialog contains the JTextSpeller and parented to parent with the dialog having a default title.
void	updateUI() Resets the UI property with a value from the current look and feel.

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

IGNORE_CONTROL

public static final int IGNORE_CONTROL

Type used for ignore button on the text speller.

See Also:

Constant Field Values

IGNORE_ALL_CONTROL

public static final int IGNORE_ALL_CONTROL

Type used for ingore all button on the text speller.

See Also:

Constant Field Values

REPLACE_CONTROL

public static final int REPLACE_CONTROL

Type used for replace button on the text speller.

See Also:

Constant Field Values

REPLACE_ALL_CONTROL

public static final int REPLACE_ALL_CONTROL

Type used for replace all button on the text speller.

See Also:

Constant Field Values

CANCEL_CONTROL

public static final int CANCEL_CONTROL

Type used for cancel button on the text speller.

See Also:

Constant Field Values

Constructor Detail

JTextSpeller

public JTextSpeller()

Method Detail

updateUI

public void updateUI()

Resets the UI property with a value from the current look and feel.

Overrides:

updateUI in class JComponent

See Also:

JComponent.updateUI()

getUI

public TextSpellerUI getUI()

Returns the look and feel (L&F) object that renders this component.

Returns:

the TextSpellerUI object that renders this component

setUI

public void setUI(TextSpellerUI ui)

Sets the look and feel (L&F) object that renders this component.

Parameters:

ui - the TextSpellerUI L&F object

See Also:

UIDefaults.getUI(javax.swing.JComponent)

getUIClassID

public String getUIClassID()

Returns a string that specifies the name of the L&F class that renders this component.

Overrides:

getUIClassID in class JComponent

Returns:

"TextSpellerUI"

See Also:

JComponent.getUIClassID(), UIDefaults.getUI(javax.swing.JComponent)

getControlButton

public JButton getControlButton(int controlType)

Gets the control button of the type.

Parameters:

controlType - the type of the button to be selected:

• JTextSpeller.IGNORE_CONTROL
• JTextSpeller.IGNORE_ALL_CONTROL
• JTextSpeller.REPLACE_CONTROL
• JTextSpeller.REPLACE_ALL_CONTROL
• JTextSpeller.CANCEL_CONTROL

setErrorText

public void setErrorText(String errorText)

Sets the error text.

Parameters:

errorText - the error text

See Also:

getErrorText()

getErrorText

public String getErrorText()

Returns the error text.

Returns:

the error text

See Also:

setErrorText(java.lang.String)

setReplaceText

public void setReplaceText(String replaceText)

Sets the replace text.

Parameters:

replaceText - the replace text

See Also:

getReplaceText()

getReplaceText

public String getReplaceText()

Returns the replace text.

Returns:

the replace text

See Also:

setReplaceText(java.lang.String)

setSuggestText

public void setSuggestText(String[] suggestText)

Sets the suggest text.

Parameters:

suggestText - the suggest text

See Also:

getSuggestText()

getSuggestText

public String[] getSuggestText()

Returns the suggest text.

Returns:

the suggest text

See Also:

setSuggestText(java.lang.String[])

setForComponent

public void setForComponent(Component c)

Sets the component that the JTextSpeller attach.

Parameters:

c - the component to attach

See Also:

getForComponent()

getForComponent

public Component getForComponent()

Returns the component that the JTextSpeller attach.

Returns:

the component to attach

See Also:

setForComponent(java.awt.Component)

ignore

public void ignore()

Called by JTextSpeller when the user hits the Ignore button. This can also be called by the programmer.

ignoreAll

public void ignoreAll()

Called by JTextSpeller when the user hits the Ignore All button. This can also be called by the programmer.

replace

public void replace()

Called by JTextSpeller when the user hits the Replace button. This can also be called by the programmer.

replaceAll

public void replaceAll()

Called by JTextSpeller when the user hits the Replace All button. This can also be called by the programmer.

cancel

public void cancel()

Called by JTextSpeller when the user hits the Cancel button. This can also be called by the programmer.

setSpeller

public void setSpeller(JTextSpeller.AbstractSpeller speller)

Sets the speller for JTextSpeller.

Parameters:

speller - the speller

Since:

JComponentPack 1.4

See Also:

getSpeller()

getSpeller

public JTextSpeller.AbstractSpeller getSpeller()

Returns the speller for JTextSpeller.

Returns:

the speller

Since:

JComponentPack 1.4

See Also:

setSpeller(com.zfqjava.swing.JTextSpeller.AbstractSpeller)

createSpeller

protected JTextSpeller.AbstractSpeller createSpeller(Component c)

Factory methods to create the AbstractSpeller for specified component.

Parameters:

c - the specified component

Returns:

create the AbstractSpeller for specified component

Since:

JComponentPack 1.4

showDialog

public void showDialog(Component parent)

Pops up a dialog contains the JTextSpeller and parented to parent with the dialog having a default title.

Parameters:

parent - the parent of the dialog

createDialog

protected JDialog createDialog(Component parent)

Creates a dialog for the JTextSpeller.

Parameters:

parent - the parent of the dialog

paramString

protected String paramString()

Returns a string representation of this JTextSpeller. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null.

Overrides:

paramString in class JComponent

Returns:

a string representation of this JTextSpeller.

getAccessibleContext

public AccessibleContext getAccessibleContext()

Gets the AccessibleContext associated with this JTextSpeller. For JTextSpellers, the AccessibleContext takes the form of an AccessibleJTextSpeller. A new AccessibleJTextSpeller instance is created if necessary.

Specified by:

getAccessibleContext in interface Accessible

Overrides:

getAccessibleContext in class JComponent

Returns:

an AccessibleJTextSpeller that serves as the AccessibleContext of this JTextSpeller