com.zfqjava.swing
Class JTextFinder

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

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class JTextFinder
extends JComponent
implements Accessible

JTextFinder provides a text finder component.

See Also:

Serialized Form

Nested Class Summary

static class	JTextFinder.AbstractFinder AbstractFinder handles the find and replace operation.
protected class	JTextFinder.AccessibleJTextFinder This class implements accessibility support for the JTextFinder 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 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 JDialog	createDialog(Component parent) Creates a dialog for the JTextFinder.
protected JTextFinder.AbstractFinder	createFinder(Component c) Factory methods to create the AbstractFinder for the specified component.
void	findNext() Called by JTextFinder when the user hits the Find Next button.
AccessibleContext	getAccessibleContext() Gets the AccessibleContext associated with this JTextFinder.
JButton	getControlButton(int controlType) Gets the control button of the type.
int	getDialogType() Returns the current dialog type.
JTextFinder.AbstractFinder	getFinder() Returns the finder for JTextFinder.
String	getFindText() Returns the find text.
Component	getForComponent() Returns the component that the JTextFinder attach.
Component[]	getOptions() Returns the options.
String	getReplaceText() Returns the replace text.
TextFinderUI	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.
protected 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	setFinder(JTextFinder.AbstractFinder finder) Sets the finder for JTextFinder.
void	setFindText(String findText) Sets the find text.
void	setForComponent(Component c) Sets the component that the JTextFinder attach.
void	setOptions(Component[] options) Sets the options.
void	setReplaceText(String replaceText) Sets the replace text.
void	setUI(TextFinderUI ui) Sets the look and feel (L&F) object that renders this component.
void	showDialog(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, 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

FIND_DIALOG

public static final int FIND_DIALOG

Identifies the find dialog type.

See Also:

Constant Field Values

REPLACE_DIALOG

public static final int REPLACE_DIALOG

Identifies the replace dialog type.

See Also:

Constant Field Values

FIND_CONTROL

public static final int FIND_CONTROL

Type used for find button on the text finder.

See Also:

Constant Field Values

REPLACE_CONTROL

public static final int REPLACE_CONTROL

Type used for replace button on the text finder.

See Also:

Constant Field Values

REPLACE_ALL_CONTROL

public static final int REPLACE_ALL_CONTROL

Type used for replace all button on the text finder.

See Also:

Constant Field Values

CANCEL_CONTROL

public static final int CANCEL_CONTROL

Type used for cancel button on the text finder.

See Also:

Constant Field Values

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 JComponent

See Also:

JComponent.updateUI()

getUI

public 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(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 String getUIClassID()

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

Overrides:

getUIClassID in class JComponent

Returns:

"TextFinderUI"

See Also:

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

setFindText

public void setFindText(String findText)

Sets the find text.

Parameters:

findText - the find text

See Also:

getFindText()

getFindText

public String getFindText()

Returns the find text.

Returns:

the find text

See Also:

setFindText(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)

setOptions

public void setOptions(Component[] options)

Sets the options.

Parameters:

options - the options

See Also:

getOptions()

getOptions

public Component[] getOptions()

Returns the options.

Returns:

the options

See Also:

setOptions(java.awt.Component[])

setForComponent

public void setForComponent(Component c)

Sets the component that the JTextFinder attach.

Parameters:

c - the component to attach

See Also:

getForComponent()

getForComponent

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

setFinder

public void setFinder(JTextFinder.AbstractFinder finder)

Sets the finder for JTextFinder.

Parameters:

finder - the finder

Since:

JComponentPack 1.4

See Also:

getFinder()

getFinder

public JTextFinder.AbstractFinder getFinder()

Returns the finder for JTextFinder.

Returns:

the finder

Since:

JComponentPack 1.4

See Also:

setFinder(com.zfqjava.swing.JTextFinder.AbstractFinder)

createFinder

protected JTextFinder.AbstractFinder createFinder(Component c)

Factory methods to create the AbstractFinder for the specified component.

Parameters:

c - the specified component

Returns:

create the AbstractFinder for the specified component

Since:

JComponentPack 1.4

getControlButton

public 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:

• JTextFinder.FIND_DIALOG
• JTextFinder.REPLACE_DIALOG

Returns:

the dialog type

See Also:

setDialogType(int)

setDialogType

public void setDialogType(int type)

Sets the dialog type.

One of 2 legal values:

• JTextFinder.FIND_DIALOG
• JTextFinder.REPLACE_DIALOG

Parameters:

type - the dialog type

See Also:

getDialogType()

showDialog

public void showDialog(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 JDialog createDialog(Component parent)

Creates a dialog for the JTextFinder.

Parameters:

parent - the parent of the dialog

paramString

protected 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 JComponent

Returns:

a string representation of this JTextFinder.

getAccessibleContext

public 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 Accessible

Overrides:

getAccessibleContext in class JComponent

Returns:

an AccessibleJTextFinder that serves as the AccessibleContext of this JTextFinder