com.zfqjava.swing
Class JTextSpeller

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--com.zfqjava.swing.JTextSpeller
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class JTextSpeller
extends javax.swing.JComponent
implements javax.accessibility.Accessible

JTextSpeller provides a text speller component.

See Also:
Serialized Form

Inner Class Summary
protected  class JTextSpeller.AccessibleJTextSpeller
          This class implements accessibility support for the JTextSpeller class.
 
Inner classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Inner classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Inner classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent
 
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  javax.swing.JDialog createDialog(java.awt.Component parent)
          Creates a dialog for the JTextSpeller.
 javax.accessibility.AccessibleContext getAccessibleContext()
          Gets the AccessibleContext associated with this JTextSpeller.
 javax.swing.JButton getControlButton(int controlType)
          Gets the control button of the type.
 java.lang.String getErrorText()
          Returns the error text.
 java.awt.Component getForComponent()
          Returns the component that the JTextSpeller attach.
 java.lang.String getReplaceText()
          Returns the replace text.
 java.lang.String[] getSuggestText()
          Returns the suggest text.
 com.zfqjava.swing.plaf.TextSpellerUI getUI()
          Returns the look and feel (L&F) object that renders this component.
 java.lang.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  java.lang.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(java.lang.String errorText)
          Sets the error text.
 void setForComponent(java.awt.Component c)
          Sets the component that the JTextSpeller attach.
 void setReplaceText(java.lang.String replaceText)
          Sets the replace text.
 void setSuggestText(java.lang.String[] suggestText)
          Sets the suggest text.
 void setUI(com.zfqjava.swing.plaf.TextSpellerUI ui)
          Sets the look and feel (L&F) object that renders this component.
 void showDialog(java.awt.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, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVerifyInputWhenFocusTarget, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, hide, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processFocusEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setLayout, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus
 
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.

IGNORE_ALL_CONTROL

public static final int IGNORE_ALL_CONTROL
Type used for ingore all button on the text speller.

REPLACE_CONTROL

public static final int REPLACE_CONTROL
Type used for replace button on the text speller.

REPLACE_ALL_CONTROL

public static final int REPLACE_ALL_CONTROL
Type used for replace all button on the text speller.

CANCEL_CONTROL

public static final int CANCEL_CONTROL
Type used for cancel button on the text speller.
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 javax.swing.JComponent
See Also:
JComponent.updateUI()

getUI

public com.zfqjava.swing.plaf.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(com.zfqjava.swing.plaf.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 java.lang.String getUIClassID()
Returns a string that specifies the name of the L&F class that renders this component.
Overrides:
getUIClassID in class javax.swing.JComponent
Returns:
"TextSpellerUI"
See Also:
JComponent.getUIClassID(), UIDefaults.getUI(javax.swing.JComponent)

getControlButton

public javax.swing.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(java.lang.String errorText)
Sets the error text.
Parameters:
errorText - the error text
See Also:
getErrorText()

getErrorText

public java.lang.String getErrorText()
Returns the error text.
Returns:
the error text
See Also:
setErrorText(java.lang.String)

setReplaceText

public void setReplaceText(java.lang.String replaceText)
Sets the replace text.
Parameters:
replaceText - the replace text
See Also:
getReplaceText()

getReplaceText

public java.lang.String getReplaceText()
Returns the replace text.
Returns:
the replace text
See Also:
setReplaceText(java.lang.String)

setSuggestText

public void setSuggestText(java.lang.String[] suggestText)
Sets the suggest text.
Parameters:
suggestText - the suggest text
See Also:
getSuggestText()

getSuggestText

public java.lang.String[] getSuggestText()
Returns the suggest text.
Returns:
the suggest text
See Also:
setSuggestText(java.lang.String[])

setForComponent

public void setForComponent(java.awt.Component c)
Sets the component that the JTextSpeller attach.
Parameters:
c - the component to attach
See Also:
getForComponent()

getForComponent

public java.awt.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.

showDialog

public void showDialog(java.awt.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 javax.swing.JDialog createDialog(java.awt.Component parent)
Creates a dialog for the JTextSpeller.
Parameters:
parent - the parent of the dialog

paramString

protected java.lang.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 javax.swing.JComponent
Returns:
a string representation of this JTextSpeller.

getAccessibleContext

public javax.accessibility.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 javax.accessibility.Accessible
Overrides:
getAccessibleContext in class javax.swing.JComponent
Returns:
an AccessibleJTextSpeller that serves as the AccessibleContext of this JTextSpeller


Copyright © 2001-2003 Extreme Component, Inc. All rights reserved.