com.zfqjava.swing
Class JTextFinder

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

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

JTextFinder provides a text finder component.

See Also:
Serialized Form

Inner Class Summary
protected  class JTextFinder.AccessibleJTextFinder
          This class implements accessibility support for the JTextFinder 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 finder.
static int FIND_CONTROL
          Type used for find button on the text finder.
static int FIND_DIALOG
          Identifies the find dialog type.
static int REPLACE_ALL_CONTROL
          Type used for replace all button on the text finder.
static int REPLACE_CONTROL
          Type used for replace button on the text finder.
static int REPLACE_DIALOG
          Identifies the replace dialog type.
 
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
JTextFinder()
           
 
Method Summary
 void cancel()
          Called by JTextFinder when the user hits the Cancel button.
protected  javax.swing.JDialog createDialog(java.awt.Component parent)
          Creates a dialog for the JTextFinder.
 void findNext()
          Called by JTextFinder when the user hits the Find Next button.
 javax.accessibility.AccessibleContext getAccessibleContext()
          Gets the AccessibleContext associated with this JTextFinder.
 javax.swing.JButton getControlButton(int controlType)
          Gets the control button of the type.
 int getDialogType()
          Returns the current dialog type.
 java.lang.String getFindText()
          Returns the find text.
 java.awt.Component getForComponent()
          Returns the component that the JTextFinder attach.
 java.lang.String getReplaceText()
          Returns the replace text.
 com.zfqjava.swing.plaf.TextFinderUI 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.
protected  java.lang.String paramString()
          Returns a string representation of this JTextFinder.
 void replace()
          Called by JTextFinder when the user hits the Replace button.
 void replaceAll()
          Called by JTextFinder when the user hits the Replace All button.
 void setDialogType(int type)
          Sets the dialog type.
 void setFindText(java.lang.String findText)
          Sets the find text.
 void setForComponent(java.awt.Component c)
          Sets the component that the JTextFinder attach.
 void setReplaceText(java.lang.String replaceText)
          Sets the replace text.
 void setUI(com.zfqjava.swing.plaf.TextFinderUI 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 JTextFinder 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

FIND_DIALOG

public static final int FIND_DIALOG
Identifies the find dialog type.

REPLACE_DIALOG

public static final int REPLACE_DIALOG
Identifies the replace dialog type.

FIND_CONTROL

public static final int FIND_CONTROL
Type used for find button on the text finder.

REPLACE_CONTROL

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

REPLACE_ALL_CONTROL

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

CANCEL_CONTROL

public static final int CANCEL_CONTROL
Type used for cancel button on the text finder.
Constructor Detail

JTextFinder

public JTextFinder()
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.TextFinderUI getUI()
Returns the look and feel (L&F) object that renders this component.
Returns:
the TextFinderUI object that renders this component

setUI

public void setUI(com.zfqjava.swing.plaf.TextFinderUI ui)
Sets the look and feel (L&F) object that renders this component.
Parameters:
ui - the TextFinderUI 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:
"TextFinderUI"
See Also:
JComponent.getUIClassID(), UIDefaults.getUI(javax.swing.JComponent)

setFindText

public void setFindText(java.lang.String findText)
Sets the find text.
Parameters:
findText - the find text
See Also:
getFindText()

getFindText

public java.lang.String getFindText()
Returns the find text.
Returns:
the find text
See Also:
setFindText(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)

setForComponent

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

getForComponent

public java.awt.Component getForComponent()
Returns the component that the JTextFinder attach.
Returns:
the component to attach
See Also:
setForComponent(java.awt.Component)

findNext

public void findNext()
Called by JTextFinder when the user hits the Find Next button. This can also be called by the programmer.

replace

public void replace()
Called by JTextFinder when the user hits the Replace button. This can also be called by the programmer.

replaceAll

public void replaceAll()
Called by JTextFinder when the user hits the Replace All button. This can also be called by the programmer.

cancel

public void cancel()
Called by JTextFinder when the user hits the Cancel button. This can also be called by the programmer.

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:
  • JTextFinder.FIND_CONTROL
  • JTextFinder.REPLACE_CONTROL
  • JTextFinder.REPLACE_ALL_CONTROL
  • JTextFinder.CANCEL_CONTROL

getDialogType

public int getDialogType()
Returns the current dialog type.

One of 2 legal values:

Returns:
the dialog type
See Also:
setDialogType(int)

setDialogType

public void setDialogType(int type)
Sets the dialog type.

One of 2 legal values:

Parameters:
type - the dialog type
See Also:
getDialogType()

showDialog

public void showDialog(java.awt.Component parent)
Pops up a dialog contains the JTextFinder 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 JTextFinder.
Parameters:
parent - the parent of the dialog

paramString

protected java.lang.String paramString()
Returns a string representation of this JTextFinder. 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 JTextFinder.

getAccessibleContext

public javax.accessibility.AccessibleContext getAccessibleContext()
Gets the AccessibleContext associated with this JTextFinder. For JTextFinders, the AccessibleContext takes the form of an AccessibleJTextFinder. A new AccessibleJTextFinder instance is created if necessary.
Specified by:
getAccessibleContext in interface javax.accessibility.Accessible
Overrides:
getAccessibleContext in class javax.swing.JComponent
Returns:
an AccessibleJTextFinder that serves as the AccessibleContext of this JTextFinder


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