org.fife.rsta.ui.search

Class FindToolBar

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.fife.rsta.ui.search.FindToolBar

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

Direct Known Subclasses:

ReplaceToolBar

public class FindToolBar
extends javax.swing.JPanel

A toolbar for search operations in a text editor application. This provides a more seamless experience than using a Find or Replace dialog.

See Also:

FindDialog, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	FindToolBar.FindFieldListener Listens for events in the Find (and Replace, in the subclass) search field.

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

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	findButton
protected SearchComboBox	findCombo
protected FindToolBar.FindFieldListener	findFieldListener
protected javax.swing.JButton	findPrevButton
protected org.fife.rsta.ui.search.FindToolBar.ToolBarListener	listener
protected javax.swing.JCheckBox	markAllCheckBox
protected javax.swing.JCheckBox	matchCaseCheckBox
protected static java.util.ResourceBundle	MSG
protected javax.swing.JCheckBox	regexCheckBox
protected SearchComboBox	replaceCombo
protected static java.util.ResourceBundle	SEARCH_MSG
protected javax.swing.JCheckBox	wholeWordCheckBox
protected javax.swing.JCheckBox	wrapCheckBox

Fields inherited from class javax.swing.JComponent

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

accessibleContext, 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

Constructors

Constructor and Description
FindToolBar(SearchListener listener) Creates the tool bar.

Method Summary

Modifier and Type	Method and Description
void	addSearchListener(SearchListener l) Adds a SearchListener to this tool bar.
protected java.awt.Container	createButtonPanel()
protected javax.swing.JCheckBox	createCB(java.lang.String key)
protected java.awt.Container	createContentAssistablePanel(javax.swing.JComponent comp) Wraps the specified component in a panel with a leading "content assist available" icon in front of it.
protected java.awt.Container	createFieldPanel()
protected void	createFindButtons() Creates the buttons for this tool bar.
protected void	doMarkAll(boolean delay) Forces a "mark all" event to be sent out, if "mark all" is enabled.
protected void	fireSearchEvent(SearchEvent e) Notifies all listeners that have registered interest for notification on this event type.
protected java.lang.String	getFindText()
int	getMarkAllDelay() Returns the delay between when the user types and when a "mark all" event is fired (assuming "mark all" is enabled), in milliseconds.
protected java.lang.String	getReplaceText()
org.fife.ui.rtextarea.SearchContext	getSearchContext() Returns the search context for this tool bar.
protected void	handleRegExCheckBoxClicked() Called when the regex checkbox is clicked (or its value is modified via a change to the search context).
protected void	handleSearchAction(java.awt.event.ActionEvent e) Creates a search event object and notifies all registered listeners.
protected FindReplaceButtonsEnableResult	handleToggleButtons() Returns whether any action-related buttons (Find Next, Replace, etc.) should be enabled.
protected void	makeEnterActivateButton(javax.swing.JButton button) Makes the Enter key activate the button.
void	removeSearchListener(SearchListener l) Removes a SearchListener from this tool bar.
boolean	requestFocusInWindow() Makes the find field on this toolbar request focus.
void	setContentAssistImage(java.awt.Image image) Sets the image to display by this dialog's text fields when content assistance is available.
protected void	setFindText(java.lang.String text)
void	setMarkAllDelay(int millis) Sets the delay between when the user types and when a "mark all" event is fired (assuming "mark all" is enabled), in milliseconds.
protected void	setReplaceText(java.lang.String text)
void	setSearchContext(org.fife.ui.rtextarea.SearchContext context) Sets the search context for this tool bar.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, 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, 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, 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, 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, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

listener

protected org.fife.rsta.ui.search.FindToolBar.ToolBarListener listener

findFieldListener

protected FindToolBar.FindFieldListener findFieldListener

findCombo

protected SearchComboBox findCombo

replaceCombo

protected SearchComboBox replaceCombo

findButton

protected javax.swing.JButton findButton

findPrevButton

protected javax.swing.JButton findPrevButton

matchCaseCheckBox

protected javax.swing.JCheckBox matchCaseCheckBox

wholeWordCheckBox

protected javax.swing.JCheckBox wholeWordCheckBox

regexCheckBox

protected javax.swing.JCheckBox regexCheckBox

markAllCheckBox

protected javax.swing.JCheckBox markAllCheckBox

wrapCheckBox

protected javax.swing.JCheckBox wrapCheckBox

SEARCH_MSG

protected static final java.util.ResourceBundle SEARCH_MSG

MSG

protected static final java.util.ResourceBundle MSG

Constructor Detail

FindToolBar

public FindToolBar(SearchListener listener)

Creates the tool bar.

Parameters:

listener - An entity listening for search events.

Method Detail

addSearchListener

public void addSearchListener(SearchListener l)

Adds a SearchListener to this tool bar. This listener will be notified when find or replace operations are triggered.

Parameters:

l - The listener to add.

See Also:

removeSearchListener(SearchListener)

createButtonPanel

protected java.awt.Container createButtonPanel()

createCB

protected javax.swing.JCheckBox createCB(java.lang.String key)

createContentAssistablePanel

protected java.awt.Container createContentAssistablePanel(javax.swing.JComponent comp)

Wraps the specified component in a panel with a leading "content assist available" icon in front of it.

Parameters:

comp - The component with content assist.

Returns:

The wrapper panel.

createFieldPanel

protected java.awt.Container createFieldPanel()

createFindButtons

protected void createFindButtons()

Creates the buttons for this tool bar.

doMarkAll

protected void doMarkAll(boolean delay)

Forces a "mark all" event to be sent out, if "mark all" is enabled.

Parameters:

delay - If the delay should be honored.

fireSearchEvent

protected void fireSearchEvent(SearchEvent e)

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

Parameters:

e - The ActionEvent object coming from a child component.

getFindText

protected java.lang.String getFindText()

getMarkAllDelay

public int getMarkAllDelay()

Returns the delay between when the user types and when a "mark all" event is fired (assuming "mark all" is enabled), in milliseconds.

Returns:

The delay.

See Also:

setMarkAllDelay(int)

getReplaceText

protected java.lang.String getReplaceText()

getSearchContext

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

Returns the search context for this tool bar.

Returns:

The search context.

See Also:

setSearchContext(SearchContext)

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.

handleSearchAction

protected void handleSearchAction(java.awt.event.ActionEvent e)

Creates a search event object and notifies all registered listeners.

Parameters:

e - The event.

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.

makeEnterActivateButton

protected void makeEnterActivateButton(javax.swing.JButton button)

Makes the Enter key activate the button. In Swing, this is a complicated thing. It's LAF-dependent whether or not this works automatically; on most LAFs, it doesn't happen. In WindowsLookAndFeel it does, but *only* if the current window has a "default" button specified. Since these tool bars will typically be used in "main" application windows, which don't have default buttons, we'll just enable this property here and now.

Parameters:

button - The button that should respond to the Enter key.

removeSearchListener

public void removeSearchListener(SearchListener l)

Removes a SearchListener from this tool bar.

Parameters:

l - The listener to remove

See Also:

addSearchListener(SearchListener)

requestFocusInWindow

public boolean requestFocusInWindow()

Makes the find field on this toolbar request focus. If it is already focused, its text is selected.

Overrides:

requestFocusInWindow in class javax.swing.JComponent

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.

setFindText

protected void setFindText(java.lang.String text)

setMarkAllDelay

public void setMarkAllDelay(int millis)

Sets the delay between when the user types and when a "mark all" event is fired (assuming "mark all" is enabled), in milliseconds.

Parameters:

millis - The new delay. This should be >= zero.

See Also:

getMarkAllDelay()

setReplaceText

protected void setReplaceText(java.lang.String text)

setSearchContext

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

Sets the search context for this tool bar. You'll usually want to call this method for all tool bars 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()