org.fife.ui.search
Class AbstractFindReplaceDialog

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      org.fife.ui.EscapableDialog
                          org.fife.ui.search.AbstractSearchDialog
                              org.fife.ui.search.AbstractFindReplaceDialog

All Implemented Interfaces:

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

Direct Known Subclasses:

FindDialog, ReplaceDialog

public abstract class AbstractFindReplaceDialog

extends AbstractSearchDialog

implements java.awt.event.ActionListener

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.

Version:

0.1

Author:

Robert Futrell

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class org.fife.ui.search.AbstractSearchDialog

AbstractSearchDialog.EnableResult

Nested classes inherited from class javax.swing.JDialog

javax.swing.JDialog.AccessibleJDialog

Nested classes inherited from class java.awt.Dialog

java.awt.Dialog.AccessibleAWTDialog

Nested classes inherited from class java.awt.Window

java.awt.Window.AccessibleAWTWindow

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

protected javax.swing.JPanel	dirPanel
protected javax.swing.JRadioButton	downButton
protected javax.swing.JLabel	findFieldLabel
protected javax.swing.JButton	findNextButton
static java.lang.String	MARK_ALL_PROPERTY
protected javax.swing.JCheckBox	markAllCheckBox The "mark all" check box.
static java.lang.String	SEARCH_DOWNWARD_PROPERTY
protected javax.swing.JRadioButton	upButton

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

cancelButton, caseCheckBox, findTextCombo, MATCH_CASE_PROPERTY, MATCH_WHOLE_WORD_PROPERTY, regExpCheckBox, searchConditionsPanel, USE_REG_EX_PROPERTY, wholeWordCheckBox

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

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

AbstractFindReplaceDialog(java.awt.Frame owner, java.util.ResourceBundle msg, boolean useRButtons)
Constructor.

Method Summary

void	actionPerformed(java.awt.event.ActionEvent e) Listens for action events in this dialog.
abstract void	addActionListener(java.awt.event.ActionListener l) Adds an ActionListener to this dialog.
void	changeActionListener(java.awt.event.ActionListener fromPanel, java.awt.event.ActionListener toPanel) Changes the action listener from one component to another.
protected javax.swing.JLabel	createLabel(java.util.ResourceBundle msg, java.lang.String key, javax.swing.JComponent comp) Returns a label for a component.
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 AbstractSearchDialog.EnableResult	handleToggleButtons() Returns whether any action-related buttons (Find Next, Replace, etc.)
abstract void	removeActionListener(java.awt.event.ActionListener l) Removes an ActionListener 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	setSearchParameters(java.lang.String searchString, boolean matchCase, boolean wholeWord, boolean regExp, boolean searchUp, boolean markAll) This function should be called to update match case, whole word, etc.
void	setSearchParameters(java.util.Vector findComboBoxStrings, boolean matchCase, boolean wholeWord, boolean regExp, boolean searchUp, boolean markAll) This function should be called to update match case, whole word, etc.
void	setUpRadioButtonText(java.lang.String text) Sets the text label for the "Up" radio button.

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

createSearchComboBox, createTitledBorder, escapePressed, getCancelButtonText, getContentAssistImage, getMatchCaseCheckboxText, getRegularExpressionCheckboxText, getSearchString, getSearchStrings, getTextComponent, getWholeWordCheckboxText, handleRegExCheckBoxClicked, isPreJava6JRE, isWholeWord, setCancelButtonText, setMatchCaseCheckboxText, setRegularExpressionCheckboxText, setSearchString, setVisible, setWholeWordCheckboxText

Methods inherited from class org.fife.ui.EscapableDialog

setEscapeClosesDialog

Methods inherited from class javax.swing.JDialog

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

Methods inherited from class java.awt.Dialog

addNotify, dispose, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setResizable, setTitle, setUndecorated, show

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, toBack, 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, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, 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, isOpaque, 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, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

MARK_ALL_PROPERTY

public static final java.lang.String MARK_ALL_PROPERTY

See Also:

Constant Field Values

SEARCH_DOWNWARD_PROPERTY

public static final java.lang.String SEARCH_DOWNWARD_PROPERTY

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.Frame owner,
                                 java.util.ResourceBundle msg,
                                 boolean useRButtons)

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.

msg - The resource bundle to use for labels, etc.

useRButtons - If true, then org.fife.ui.RButtons will be used for all buttons defined here (currently just the Cancel button). Otherwise, regular JButtons are used.

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.

addActionListener

public abstract void addActionListener(java.awt.event.ActionListener l)

Adds an ActionListener to this dialog. This method should be overridden so that search actions are sent to listeners. For example, for a Replace dialog, all listeners should receive notification when the user clicks "Find", "Replace", or "Replace All".

Parameters:

l - The listener to add.

See Also:

removeActionListener(java.awt.event.ActionListener)

changeActionListener

public void changeActionListener(java.awt.event.ActionListener fromPanel,
                                 java.awt.event.ActionListener toPanel)

Changes the action listener from one component to another.

Parameters:

fromPanel - The old ActionListener to remove.

toPanel - The new ActionListener to add as an action listener.

createLabel

protected javax.swing.JLabel createLabel(java.util.ResourceBundle msg,
                                         java.lang.String key,
                                         javax.swing.JComponent comp)

Returns a label for a component.

Parameters:

msg - The resource bundle to use for localizations.

key - The root key into the resource bundle.

comp - The component this will be a label for.

Returns:

The label.

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)

handleToggleButtons

protected AbstractSearchDialog.EnableResult 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.

removeActionListener

public abstract void removeActionListener(java.awt.event.ActionListener l)

Removes an ActionListener from this dialog.

Parameters:

l - The listener to remove

See Also:

addActionListener(java.awt.event.ActionListener)

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

setSearchParameters

public void setSearchParameters(java.lang.String searchString,
                                boolean matchCase,
                                boolean wholeWord,
                                boolean regExp,
                                boolean searchUp,
                                boolean markAll)

This function should be called to update match case, whole word, etc.

Parameters:

searchString - The string to be at the top of the combo box of strings to search for.

matchCase - Whether or not to match case in the search.

wholeWord - Whether or not to look for searchString as a separate word when searching.

regExp - Whether or not to treat searchString as a regular expression when searching.

searchUp - Whether to search up or down.

markAll - Whether to mark all occurrences.

setSearchParameters

public void setSearchParameters(java.util.Vector findComboBoxStrings,
                                boolean matchCase,
                                boolean wholeWord,
                                boolean regExp,
                                boolean searchUp,
                                boolean markAll)

This function should be called to update match case, whole word, etc.

Parameters:

findComboBoxStrings - The strings that the "Find" combo box should contain.

matchCase - Whether or not to match case in the search.

wholeWord - Whether or not to look for searchString as a separate word when searching.

regExp - Whether or not to treat searchString as a regular expression when searching.

searchUp - Whether to search up or down.

markAll - Whether to mark all occurrences.

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