org.fife.rsta.ui.search

Class ReplaceToolBar

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.fife.rsta.ui.search.FindToolBar

org.fife.rsta.ui.search.ReplaceToolBar

All Implemented Interfaces:

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

public class ReplaceToolBar
extends FindToolBar

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

See Also:

FindToolBar, ReplaceDialog, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	ReplaceToolBar.ReplaceFindFieldListener Listens for the user typing into the search field.

Nested classes/interfaces inherited from class org.fife.rsta.ui.search.FindToolBar

FindToolBar.FindFieldListener

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 SearchListener	searchListener Our search listener, cached so we can grab its selected text easily.

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

findButton, findCombo, findFieldListener, findPrevButton, listener, markAllCheckBox, matchCaseCheckBox, msg, regexCheckBox, replaceCombo, searchMsg, wholeWordCheckBox

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
ReplaceToolBar(SearchListener listener) Creates the tool bar.

Method Summary

Modifier and Type	Method and Description
void	addNotify()
protected java.awt.Container	createButtonPanel()
protected java.awt.Container	createFieldPanel()
protected void	createFindButtons() Creates the buttons 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.
boolean	requestFocusInWindow() Overridden to possibly toggle the enabled state of the replace button.

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

addSearchListener, createCB, createContentAssistablePanel, doMarkAll, fireSearchEvent, getFindText, getMarkAllDelay, getReplaceText, getSearchContext, initUIFromContext, makeEnterActivateButton, removeSearchListener, setFindText, setMarkAllDelay, setReplaceText, setSearchContext

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

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

searchListener

protected SearchListener searchListener

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

Constructor Detail

ReplaceToolBar

public ReplaceToolBar(SearchListener listener)

Creates the tool bar.

Parameters:

listener - An entity listening for search events.

Method Detail

addNotify

public void addNotify()

Overrides:

addNotify in class javax.swing.JComponent

createButtonPanel

protected java.awt.Container createButtonPanel()

Overrides:

createButtonPanel in class FindToolBar

createFieldPanel

protected java.awt.Container createFieldPanel()

Overrides:

createFieldPanel in class FindToolBar

createFindButtons

protected void createFindButtons()

Description copied from class: FindToolBar

Creates the buttons for this tool bar.

Overrides:

createFindButtons in class FindToolBar

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.

Overrides:

handleRegExCheckBoxClicked in class FindToolBar

handleSearchAction

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

Description copied from class: FindToolBar

Creates a search event object and notifies all registered listeners.

Overrides:

handleSearchAction in class FindToolBar

Parameters:

e - The event.

handleToggleButtons

protected FindReplaceButtonsEnableResult handleToggleButtons()

Description copied from class: FindToolBar

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 FindToolBar

Returns:

Whether the buttons should be enabled.

requestFocusInWindow

public boolean requestFocusInWindow()

Overridden to possibly toggle the enabled state of the replace button.

Overrides:

requestFocusInWindow in class FindToolBar