org.fife.rsta.ui.search

Class ReplaceDialog

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

org.fife.rsta.ui.EscapableDialog

org.fife.rsta.ui.search.AbstractSearchDialog

org.fife.rsta.ui.search.AbstractFindReplaceDialog

org.fife.rsta.ui.search.ReplaceDialog

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class ReplaceDialog
extends AbstractFindReplaceDialog

A "Replace" dialog similar to those found in most Windows text editing applications. Contains many search options, including:

• Match Case
• Match Whole Word
• Use Regular Expressions
• Search Forwards or Backwards

The dialog also remembers your previous several selections in a combo box.

An application can use a ReplaceDialog as follows. It is suggested that you create an Action or something similar to facilitate "bringing up" the Replace dialog. Have the main application contain an object that implements ActionListener. This object will receive the following action events from the Replace dialog:

• SearchEvent.Type.FIND action when the user clicks the "Find" button.
• SearchEvent.Type.REPLACE action when the user clicks the "Replace" button.
• SearchEvent.Type.REPLACE_ALL action when the user clicks the "Replace All" button.

The application can then call i.e. SearchEngine.find() or SearchEngine.replace() to actually execute the search.

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, java.awt.Dialog.ModalExclusionType, java.awt.Dialog.ModalityType

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

java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

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.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected SearchListener	searchListener Our search listener, cached so we can grab its selected text easily.

Fields inherited from class org.fife.rsta.ui.search.AbstractFindReplaceDialog

dirPanel, downButton, findFieldLabel, findNextButton, markAllCheckBox, SEARCH_DOWNWARD_PROPERTY, upButton

Fields inherited from class org.fife.rsta.ui.search.AbstractSearchDialog

cancelButton, caseCheckBox, context, findTextCombo, regexCheckBox, searchConditionsPanel, wholeWordCheckBox, wrapCheckBox

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Dialog

DEFAULT_MODALITY_TYPE

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

Constructors

Constructor and Description
ReplaceDialog(java.awt.Dialog owner, SearchListener listener) Creates a new ReplaceDialog.
ReplaceDialog(java.awt.Frame owner, SearchListener listener) Creates a new ReplaceDialog.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e) Listens for action events in this dialog.
protected void	escapePressed() Called when the Escape key is pressed in this dialog.
java.lang.String	getReplaceAllButtonText() Returns the text on the "Replace All" button.
java.lang.String	getReplaceButtonText() Returns the text on the "Replace" button.
java.lang.String	getReplaceString() Returns the java.lang.String to replace with.
java.lang.String	getReplaceWithLabelText() Returns the label on the "Replace with" text field.
protected void	handleRegExCheckBoxClicked() Called when the regex checkbox is clicked.
protected void	handleSearchContextPropertyChanged(java.beans.PropertyChangeEvent e) Called whenever a property in the search context is modified.
protected FindReplaceButtonsEnableResult	handleToggleButtons() Returns whether any action-related buttons (Find Next, Replace, etc.) should be enabled.
void	setContentAssistImage(java.awt.Image image) Sets the image to display by this dialog's text fields when content assistance is available.
void	setReplaceAllButtonText(java.lang.String text) Sets the text on the "Replace All" button.
void	setReplaceButtonText(java.lang.String text) Sets the text on the "Replace" button.
void	setReplaceString(java.lang.String newReplaceString) Sets the java.lang.String to replace with.
void	setReplaceWithLabelText(java.lang.String text) Sets the label on the "Replace with" text field.
void	setVisible(boolean visible) Overrides JDialog's setVisible method; decides whether or not buttons are enabled.
void	updateUI() This method should be called whenever the LookAndFeel of the application changes.

Methods inherited from class org.fife.rsta.ui.search.AbstractFindReplaceDialog

addSearchListener, fireSearchEvent, getDownRadioButtonText, getFindButtonText, getFindWhatLabelText, getSearchButtonsBorderText, getUpRadioButtonText, refreshUIFromContext, removeSearchListener, setDownRadioButtonText, setFindButtonText, setFindWhatLabelText, setSearchButtonsBorderText, setUpRadioButtonText

Methods inherited from class org.fife.rsta.ui.search.AbstractSearchDialog

createDefaultSearchContext, createTitledBorder, focusFindTextField, getBundle, getCancelButtonText, getContentAssistImage, getMatchCaseCheckboxText, getRegularExpressionCheckboxText, getSearchContext, getSearchString, getString, getWholeWordCheckboxText, getWrapCheckboxText, isPreJava6JRE, isWholeWord, matchesSearchFor, requestFocus, setCancelButtonText, setMatchCaseCheckboxText, setRegularExpressionCheckboxText, setSearchContext, setSearchString, setWholeWordCheckboxText, setWrapCheckboxText

Methods inherited from class org.fife.rsta.ui.EscapableDialog

setEscapeClosesDialog

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Dialog

addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, 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, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, 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, 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, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

searchListener

protected SearchListener searchListener

Our search listener, cached so we can grab its selected text easily.

Constructor Detail

ReplaceDialog

public ReplaceDialog(java.awt.Dialog owner,
                     SearchListener listener)

Creates a new ReplaceDialog.

Parameters:

owner - The main window that owns this dialog.

listener - The component that listens for SearchEvents.

ReplaceDialog

public ReplaceDialog(java.awt.Frame owner,
                     SearchListener listener)

Creates a new ReplaceDialog.

Parameters:

owner - The main window that owns this dialog.

listener - The component that listens for SearchEvents.

Method Detail

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Description copied from class: AbstractFindReplaceDialog

Listens for action events in this dialog.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Overrides:

actionPerformed in class AbstractFindReplaceDialog

Parameters:

e - The event that occurred.

escapePressed

protected void escapePressed()

Description copied from class: EscapableDialog

Called when the Escape key is pressed in this dialog. Subclasses can override to handle any custom "Cancel" logic. The default implementation hides the dialog (via setVisible(false);).

Overrides:

escapePressed in class AbstractSearchDialog

getReplaceButtonText

public final java.lang.String getReplaceButtonText()

Returns the text on the "Replace" button.

Returns:

The text on the Replace button.

See Also:

setReplaceButtonText(java.lang.String)

getReplaceAllButtonText

public final java.lang.String getReplaceAllButtonText()

Returns the text on the "Replace All" button.

Returns:

The text on the Replace All button.

See Also:

setReplaceAllButtonText(java.lang.String)

getReplaceString

public java.lang.String getReplaceString()

Returns the java.lang.String to replace with.

Returns:

The String the user wants to replace the text to find with.

getReplaceWithLabelText

public final java.lang.String getReplaceWithLabelText()

Returns the label on the "Replace with" text field.

Returns:

The text on the "Replace with" text field.

See Also:

setReplaceWithLabelText(java.lang.String)

handleRegExCheckBoxClicked

protected void handleRegExCheckBoxClicked()

Called when the regex checkbox is clicked. Subclasses can override to add custom behavior, but should call the super implementation.

Overrides:

handleRegExCheckBoxClicked in class AbstractSearchDialog

handleSearchContextPropertyChanged

protected void handleSearchContextPropertyChanged(java.beans.PropertyChangeEvent e)

Description copied from class: AbstractFindReplaceDialog

Called whenever a property in the search context is modified. Subclasses should override if they listen for additional properties.

Overrides:

handleSearchContextPropertyChanged in class AbstractFindReplaceDialog

Parameters:

e - The property change event fired.

handleToggleButtons

protected FindReplaceButtonsEnableResult handleToggleButtons()

Description copied from class: AbstractSearchDialog

Returns whether any action-related buttons (Find Next, Replace, etc.) should be enabled. Subclasses can call this method when the "Find What" or "Replace With" text fields are modified. They can then enable/disable any components as appropriate.

Overrides:

handleToggleButtons in class AbstractFindReplaceDialog

Returns:

Whether the buttons should be enabled.

setContentAssistImage

public void setContentAssistImage(java.awt.Image image)

Description copied from class: AbstractSearchDialog

Sets the image to display by this dialog's text fields when content assistance is available.

Overrides:

setContentAssistImage in class AbstractSearchDialog

Parameters:

image - The image. If this is null, a default image (a light bulb) is used). This should be kept small, around 8x8 for standard resolution monitors.

setReplaceButtonText

public final void setReplaceButtonText(java.lang.String text)

Sets the text on the "Replace" button.

Parameters:

text - The text for the Replace button.

See Also:

getReplaceButtonText()

setReplaceAllButtonText

public final void setReplaceAllButtonText(java.lang.String text)

Sets the text on the "Replace All" button.

Parameters:

text - The text for the Replace All button.

See Also:

getReplaceAllButtonText()

setReplaceWithLabelText

public final void setReplaceWithLabelText(java.lang.String text)

Sets the label on the "Replace with" text field.

Parameters:

text - The text for the "Replace with" text field's label.

See Also:

getReplaceWithLabelText()

setReplaceString

public void setReplaceString(java.lang.String newReplaceString)

Sets the java.lang.String to replace with.

Parameters:

newReplaceString - The String to put into the replace field.

setVisible

public void setVisible(boolean visible)

Overrides JDialog's setVisible method; decides whether or not buttons are enabled.

Overrides:

setVisible in class java.awt.Dialog

Parameters:

visible - Whether or not the dialog should be visible.

updateUI

public void updateUI()

This method should be called whenever the LookAndFeel of the application changes. This calls SwingUtilities.updateComponentTreeUI(this) and does other necessary things.

Note that this is not an override, as JDialogs don't have an updateUI() method.