org.fife.rsta.ui.search

Class AbstractSearchDialog

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

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:

AbstractFindReplaceDialog

public class AbstractSearchDialog
extends EscapableDialog
implements java.awt.event.ActionListener

Base class for all search dialogs (find, replace, find in files, etc.). This class is not useful on its own; you should use either FindDialog or ReplaceDialog, or extend this class to create your own search dialog.

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.JButton	cancelButton
protected javax.swing.JCheckBox	caseCheckBox
protected org.fife.ui.rtextarea.SearchContext	context
protected SearchComboBox	findTextCombo The combo box where the user enters the text for which to search.
protected javax.swing.JCheckBox	regexCheckBox
protected javax.swing.JPanel	searchConditionsPanel
protected javax.swing.JCheckBox	wholeWordCheckBox
protected javax.swing.JCheckBox	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
AbstractSearchDialog(java.awt.Dialog owner) Constructor.
AbstractSearchDialog(java.awt.Frame owner) Constructor.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e) Listens for actions in this search dialog.
protected org.fife.ui.rtextarea.SearchContext	createDefaultSearchContext() Returns the default search context to use for this dialog.
protected javax.swing.border.Border	createTitledBorder(java.lang.String title) Returns a titled border for panels on search dialogs.
protected void	escapePressed() Called when the Escape key is pressed in this dialog.
protected void	focusFindTextField() Makes the "Find text" field active.
protected java.util.ResourceBundle	getBundle()
java.lang.String	getCancelButtonText() Returns the text on the Cancel button.
static java.awt.Image	getContentAssistImage() Returns the image to display beside text components when content assist is available.
java.lang.String	getMatchCaseCheckboxText() Returns the text for the "Match Case" check box.
java.lang.String	getRegularExpressionCheckboxText() Returns the text for the "Regular Expression" check box.
org.fife.ui.rtextarea.SearchContext	getSearchContext() Returns the search context used by this dialog.
java.lang.String	getSearchString() Returns the text to search for.
static java.lang.String	getString(java.lang.String key)
java.lang.String	getWholeWordCheckboxText() Returns the text for the "Whole Word" check box.
java.lang.String	getWrapCheckboxText() Returns the text for the "Wrap" check box.
protected void	handleRegExCheckBoxClicked() Called when the regex checkbox is clicked (or its value is modified via a change to the search context).
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 static boolean	isPreJava6JRE() Deprecated. This library no longer supports Java versions earlier than Java 8. This method is deprecated instead of removed to avoid a major version bump.
static boolean	isWholeWord(java.lang.CharSequence searchIn, int offset, int len) Returns whether the characters on either side of substr(searchIn,startPos,startPos+searchStringLength) are whitespace.
protected boolean	matchesSearchFor(java.lang.String text)
protected void	refreshUIFromContext() Initializes the UI in this tool bar from a search context.
void	requestFocus() Overridden to ensure the "Find text" field gets focused.
void	setCancelButtonText(java.lang.String text) Sets the text on the Cancel button.
void	setContentAssistImage(java.awt.Image image) Sets the image to display by this dialog's text fields when content assistance is available.
void	setMatchCaseCheckboxText(java.lang.String text) Sets the text for the "Match Case" check box.
void	setRegularExpressionCheckboxText(java.lang.String text) Sets the text for the "Regular Expression" check box.
void	setSearchContext(org.fife.ui.rtextarea.SearchContext context) Sets the search context for this dialog.
void	setSearchString(java.lang.String newSearchString) Sets the java.lang.String to search for.
void	setWholeWordCheckboxText(java.lang.String text) Sets the text for the "Whole Word" check box.
void	setWrapCheckboxText(java.lang.String text) Sets the text for the "Wrap" check box.

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

context

protected org.fife.ui.rtextarea.SearchContext context

caseCheckBox

protected javax.swing.JCheckBox caseCheckBox

wholeWordCheckBox

protected javax.swing.JCheckBox wholeWordCheckBox

regexCheckBox

protected javax.swing.JCheckBox regexCheckBox

wrapCheckBox

protected javax.swing.JCheckBox wrapCheckBox

searchConditionsPanel

protected javax.swing.JPanel searchConditionsPanel

findTextCombo

protected SearchComboBox findTextCombo

The combo box where the user enters the text for which to search.

cancelButton

protected javax.swing.JButton cancelButton

Constructor Detail

AbstractSearchDialog

public AbstractSearchDialog(java.awt.Dialog owner)

Constructor. Does initializing for parts common to all search dialogs.

Parameters:

owner - The dialog that owns this search dialog.

AbstractSearchDialog

public AbstractSearchDialog(java.awt.Frame owner)

Constructor. Does initializing for parts common to all search dialogs.

Parameters:

owner - The window that owns this search dialog.

Method Detail

actionPerformed

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

Listens for actions in this search dialog.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

createDefaultSearchContext

protected org.fife.ui.rtextarea.SearchContext createDefaultSearchContext()

Returns the default search context to use for this dialog. Applications that create new subclasses of this class can provide customized search contexts here.

Returns:

The default search context.

createTitledBorder

protected javax.swing.border.Border createTitledBorder(java.lang.String title)

Returns a titled border for panels on search dialogs.

Parameters:

title - The title for the border.

Returns:

The border.

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 EscapableDialog

focusFindTextField

protected void focusFindTextField()

Makes the "Find text" field active.

getBundle

protected java.util.ResourceBundle getBundle()

getCancelButtonText

public final java.lang.String getCancelButtonText()

Returns the text on the Cancel button.

Returns:

The text on the Cancel button.

See Also:

setCancelButtonText(java.lang.String)

getContentAssistImage

public static java.awt.Image getContentAssistImage()

Returns the image to display beside text components when content assist is available.

Returns:

The image to use.

getMatchCaseCheckboxText

public final java.lang.String getMatchCaseCheckboxText()

Returns the text for the "Match Case" check box.

Returns:

The text for the "Match Case" check box.

See Also:

setMatchCaseCheckboxText(java.lang.String)

getRegularExpressionCheckboxText

public final java.lang.String getRegularExpressionCheckboxText()

Returns the text for the "Regular Expression" check box.

Returns:

The text for the "Regular Expression" check box.

See Also:

setRegularExpressionCheckboxText(java.lang.String)

getSearchContext

public org.fife.ui.rtextarea.SearchContext getSearchContext()

Returns the search context used by this dialog.

Returns:

The search context.

See Also:

setSearchContext(SearchContext)

getSearchString

public java.lang.String getSearchString()

Returns the text to search for.

Returns:

The text the user wants to search for.

getString

public static java.lang.String getString(java.lang.String key)

getWholeWordCheckboxText

public final java.lang.String getWholeWordCheckboxText()

Returns the text for the "Whole Word" check box.

Returns:

The text for the "Whole Word" check box.

See Also:

setWholeWordCheckboxText(java.lang.String)

getWrapCheckboxText

public final java.lang.String getWrapCheckboxText()

Returns the text for the "Wrap" check box.

Returns:

The text for the "Wrap" check box.

See Also:

setWrapCheckboxText(java.lang.String)

handleRegExCheckBoxClicked

protected void handleRegExCheckBoxClicked()

Called when the regex checkbox is clicked (or its value is modified via a change to the search context). Subclasses can override to add custom behavior, but should call the super implementation.

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.

Parameters:

e - The property change event fired.

handleToggleButtons

protected FindReplaceButtonsEnableResult handleToggleButtons()

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.

Returns:

Whether the buttons should be enabled.

matchesSearchFor

protected boolean matchesSearchFor(java.lang.String text)

isPreJava6JRE

@Deprecated
protected static boolean isPreJava6JRE()

Deprecated. This library no longer supports Java versions earlier than Java 8. This method is deprecated instead of removed to avoid a major version bump.

This method allows us to check if the current JRE is 1.4 or 1.5. This is used to workaround some Java bugs, for example, pre 1.6, JComboBoxes would "swallow" enter key presses in them when their content changed. This causes the user to have to press Enter twice when entering text to search for in a "Find" dialog, so instead we detect if a JRE is old enough to have this behavior and, if so, programmitcally press the Find button.

Returns:

Whether this is a 1.4 or 1.5 JRE.

isWholeWord

public static boolean isWholeWord(java.lang.CharSequence searchIn,
                                  int offset,
                                  int len)

Returns whether the characters on either side of substr(searchIn,startPos,startPos+searchStringLength) are whitespace. While this isn't the best definition of "whole word", it's the one we're going to use for now.

Parameters:

searchIn - The text to search in.

offset - The offset of the possible word.

len - The length of the possible word.

Returns:

Whether the specified range represents a "whole word".

refreshUIFromContext

protected void refreshUIFromContext()

Initializes the UI in this tool bar from a search context. This is called whenever a new search context is installed on this tool bar (which should practically be never).

requestFocus

public void requestFocus()

Overridden to ensure the "Find text" field gets focused.

Overrides:

requestFocus in class java.awt.Component

setCancelButtonText

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

Sets the text on the Cancel button.

Parameters:

text - The text for the Cancel button.

See Also:

getCancelButtonText()

setContentAssistImage

public void setContentAssistImage(java.awt.Image image)

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

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.

setMatchCaseCheckboxText

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

Sets the text for the "Match Case" check box.

Parameters:

text - The text for the "Match Case" check box.

See Also:

getMatchCaseCheckboxText()

setRegularExpressionCheckboxText

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

Sets the text for the "Regular Expression" check box.

Parameters:

text - The text for the "Regular Expression" check box.

See Also:

getRegularExpressionCheckboxText()

setSearchContext

public void setSearchContext(org.fife.ui.rtextarea.SearchContext context)

Sets the search context for this dialog. You'll usually want to call this method for all search dialogs and give them the same search context, so that their options (match case, etc.) stay in sync with one another.

Parameters:

context - The new search context. This cannot be null.

See Also:

getSearchContext()

setSearchString

public void setSearchString(java.lang.String newSearchString)

Sets the java.lang.String to search for.

Parameters:

newSearchString - The string to put into the search field.

setWholeWordCheckboxText

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

Sets the text for the "Whole Word" check box.

Parameters:

text - The text for the "Whole Word" check box.

See Also:

getWholeWordCheckboxText()

setWrapCheckboxText

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

Sets the text for the "Wrap" check box.

Parameters:

text - The text for the "Whole Word" check box.

See Also:

getWholeWordCheckboxText()