org.fife.rsta.ui.search

Class AbstractFindReplaceDialog

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

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

Direct Known Subclasses:

FindDialog, ReplaceDialog

public abstract class AbstractFindReplaceDialog
extends AbstractSearchDialog

This is the base class for FindDialog and ReplaceDialog. It is basically all of the features common to the two dialogs that weren't taken care of in AbstractSearchDialog.

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 javax.swing.JPanel	dirPanel
protected javax.swing.JRadioButton	downButton
protected javax.swing.JLabel	findFieldLabel
protected javax.swing.JButton	findNextButton
protected javax.swing.JCheckBox	markAllCheckBox The "mark all" check box.
static java.lang.String	SEARCH_DOWNWARD_PROPERTY Property fired when the user toggles the search direction radio buttons.
protected javax.swing.JRadioButton	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
AbstractFindReplaceDialog(java.awt.Dialog owner) Constructor.
AbstractFindReplaceDialog(java.awt.Frame owner) Constructor.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e) Listens for action events in this dialog.
void	addSearchListener(SearchListener l) Adds a SearchListener to this dialog.
protected void	fireSearchEvent(SearchEvent.Type type, org.fife.ui.rtextarea.SearchContext context) Notifies all listeners that have registered interest for notification on this event type.
java.lang.String	getDownRadioButtonText() Returns the text for the "Down" radio button.
java.lang.String	getFindButtonText() Returns the text on the "Find" button.
java.lang.String	getFindWhatLabelText() Returns the label on the "Find what" text field.
java.lang.String	getSearchButtonsBorderText() Returns the text for the search direction's radio buttons' border.
java.lang.String	getUpRadioButtonText() Returns the text for the "Up" radio button.
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.
protected void	refreshUIFromContext() Overridden to initialize UI elements specific to this subclass.
void	removeSearchListener(SearchListener l) Removes a SearchListener from this dialog.
void	setDownRadioButtonText(java.lang.String text) Sets the text label for the "Down" radio button.
void	setFindButtonText(java.lang.String text) Sets the text on the "Find" button.
void	setFindWhatLabelText(java.lang.String text) Sets the label on the "Find what" text field.
void	setSearchButtonsBorderText(java.lang.String text) Sets the text for the search direction's radio buttons' border.
void	setUpRadioButtonText(java.lang.String text) Sets the text label for the "Up" radio button.

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

createDefaultSearchContext, createTitledBorder, escapePressed, focusFindTextField, getBundle, getCancelButtonText, getContentAssistImage, getMatchCaseCheckboxText, getRegularExpressionCheckboxText, getSearchContext, getSearchString, getString, getWholeWordCheckboxText, getWrapCheckboxText, handleRegExCheckBoxClicked, isPreJava6JRE, isWholeWord, matchesSearchFor, requestFocus, setCancelButtonText, setContentAssistImage, 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, setVisible, 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

SEARCH_DOWNWARD_PROPERTY

public static final java.lang.String SEARCH_DOWNWARD_PROPERTY

Property fired when the user toggles the search direction radio buttons.

See Also:

Constant Field Values

upButton

protected javax.swing.JRadioButton upButton

downButton

protected javax.swing.JRadioButton downButton

dirPanel

protected javax.swing.JPanel dirPanel

findFieldLabel

protected javax.swing.JLabel findFieldLabel

findNextButton

protected javax.swing.JButton findNextButton

markAllCheckBox

protected javax.swing.JCheckBox markAllCheckBox

The "mark all" check box.

Constructor Detail

AbstractFindReplaceDialog

public AbstractFindReplaceDialog(java.awt.Dialog owner)

Constructor.

Parameters:

owner - The dialog that owns this search dialog.

AbstractFindReplaceDialog

public AbstractFindReplaceDialog(java.awt.Frame owner)

Constructor. Does initializing for parts common to FindDialog and ReplaceDialog that isn't taken care of in AbstractSearchDialog's constructor.

Parameters:

owner - The window that owns this search dialog.

Method Detail

actionPerformed

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

Listens for action events in this dialog.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Overrides:

actionPerformed in class AbstractSearchDialog

Parameters:

e - The event that occurred.

addSearchListener

public void addSearchListener(SearchListener l)

Adds a SearchListener to this dialog. This listener will be notified when find or replace operations are triggered. For example, for a Replace dialog, a listener will receive notification when the user clicks "Find", "Replace", or "Replace All".

Parameters:

l - The listener to add.

See Also:

removeSearchListener(SearchListener)

fireSearchEvent

protected void fireSearchEvent(SearchEvent.Type type,
                               org.fife.ui.rtextarea.SearchContext context)

Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created using the event parameter.

Parameters:

type - The type of search.

context - The search context to fire. If this is null, this dialog's current context (e.g. its current state) is used. This parameter allows for scenarios where we want to search differently than what our UI displays; for example, binding a keyboard shortcut to "search backwards" no matter what.

getDownRadioButtonText

public final java.lang.String getDownRadioButtonText()

Returns the text for the "Down" radio button.

Returns:

The text for the "Down" radio button.

See Also:

setDownRadioButtonText(java.lang.String)

getFindButtonText

public final java.lang.String getFindButtonText()

Returns the text on the "Find" button.

Returns:

The text on the Find button.

See Also:

setFindButtonText(java.lang.String)

getFindWhatLabelText

public final java.lang.String getFindWhatLabelText()

Returns the label on the "Find what" text field.

Returns:

The text on the "Find what" text field.

See Also:

setFindWhatLabelText(java.lang.String)

getSearchButtonsBorderText

public final java.lang.String getSearchButtonsBorderText()

Returns the text for the search direction's radio buttons' border.

Returns:

The text for the search radio buttons' border.

See Also:

setSearchButtonsBorderText(java.lang.String)

getUpRadioButtonText

public final java.lang.String getUpRadioButtonText()

Returns the text for the "Up" radio button.

Returns:

The text for the "Up" radio button.

See Also:

setUpRadioButtonText(java.lang.String)

handleSearchContextPropertyChanged

protected void handleSearchContextPropertyChanged(java.beans.PropertyChangeEvent e)

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

Overrides:

handleSearchContextPropertyChanged in class AbstractSearchDialog

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 AbstractSearchDialog

Returns:

Whether the buttons should be enabled.

refreshUIFromContext

protected void refreshUIFromContext()

Overridden to initialize UI elements specific to this subclass.

Overrides:

refreshUIFromContext in class AbstractSearchDialog

removeSearchListener

public void removeSearchListener(SearchListener l)

Removes a SearchListener from this dialog.

Parameters:

l - The listener to remove

See Also:

addSearchListener(SearchListener)

setDownRadioButtonText

public void setDownRadioButtonText(java.lang.String text)

Sets the text label for the "Down" radio button.

Parameters:

text - The new text label for the "Down" radio button.

See Also:

getDownRadioButtonText()

setFindButtonText

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

Sets the text on the "Find" button.

Parameters:

text - The text for the Find button.

See Also:

getFindButtonText()

setFindWhatLabelText

public void setFindWhatLabelText(java.lang.String text)

Sets the label on the "Find what" text field.

Parameters:

text - The text for the "Find what" text field's label.

See Also:

getFindWhatLabelText()

setSearchButtonsBorderText

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

Sets the text for the search direction's radio buttons' border.

Parameters:

text - The text for the search radio buttons' border.

See Also:

getSearchButtonsBorderText()

setUpRadioButtonText

public void setUpRadioButtonText(java.lang.String text)

Sets the text label for the "Up" radio button.

Parameters:

text - The new text label for the "Up" radio button.

See Also:

getUpRadioButtonText()