org.jdesktop.swingx
Class JXFindBar

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.jdesktop.swingx.JXPanel
                      org.jdesktop.swingx.AbstractPatternPanel
                          org.jdesktop.swingx.JXFindPanel
                              org.jdesktop.swingx.JXFindBar

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, Scrollable

public class JXFindBar
extends JXFindPanel

A simple low-intrusion default widget for incremental search. Actions registered (in addition to super):

• JXDialog.CLOSE_ACTION_COMMAND - an action bound to this component's cancel method. The method itself is an empty implementation: Subclassing clients can override the method, all clients can register a custom action.

Key bindings:

• ESCAPE - calls action registered for JXDialog.CLOSE_ACTION_COMMAND

This implementation uses textfield coloring as not-found visualization.

PENDING: the coloring needs to be read from the UIManager instead of hardcoding.

PENDING: the state transition of found/non-found coloring needs clean-up - there are spurious problems when re-using the same instance (as SearchFactory does).

See Also:

Serialized Form

Nested Class Summary

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

JPanel.AccessibleJPanel

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

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

protected JButton	findNext
protected JButton	findPrevious
protected Color	notFoundBackgroundColor
protected Color	notFoundForegroundColor
protected Color	previousBackgroundColor
protected Color	previousForegroundColor

Fields inherited from class org.jdesktop.swingx.JXFindPanel

backCheck, FIND_NEXT_ACTION_COMMAND, FIND_PREVIOUS_ACTION_COMMAND, searchable, wrapCheck

Fields inherited from class org.jdesktop.swingx.AbstractPatternPanel

MATCH_ACTION_COMMAND, matchCheck, patternModel, SEARCH_FIELD_LABEL, SEARCH_FIELD_MNEMONIC, SEARCH_TITLE, searchField, searchLabel

Fields inherited from class javax.swing.JComponent

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

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

JXFindBar()

JXFindBar(Searchable searchable)

Method Summary

void	addNotify() Notifies this component that it now has a parent component.
protected void	bind() Configure and bind components to/from PatternModel.
protected void	build() Compose and layout all the subcomponents.
void	cancel() Action callback method for bound action JXDialog.CLOSE_ACTION_COMMAND.
protected void	initComponents() Create and initialize components.
protected void	initExecutables() creates and registers all "executable" actions.
void	setSearchable(Searchable searchable) Sets the Searchable targeted of this find widget.
protected void	showFoundMessage() here: set textfield colors to normal.
protected void	showNotFoundMessage() here: set textfield colors to not-found colors.

Methods inherited from class org.jdesktop.swingx.JXFindPanel

doFind, doSearch, findNext, findPrevious, init, match, refreshEmptyFromModel, updateLocaleState

Methods inherited from class org.jdesktop.swingx.AbstractPatternPanel

bindSearchLabel, createBoundAction, createModelStateAction, createPatternModel, getAction, getActionContainerFactory, getPatternModel, getPatternModelListener, getSearchFieldListener, getSearchFieldWidth, getUIString, getUIString, initActions, initPatternActions, refreshDocumentFromModel, refreshModelFromDocument, refreshPatternFromModel, setLocale

Methods inherited from class org.jdesktop.swingx.JXPanel

getAlpha, getBackgroundPainter, getEffectiveAlpha, getPreferredScrollableViewportSize, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, isInheritAlpha, isPaintBorderInsets, paint, paintComponent, setAlpha, setBackground, setBackgroundPainter, setInheritAlpha, setPaintBorderInsets, setScrollableTracksViewportHeight, setScrollableTracksViewportWidth

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, 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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, 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, 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, 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, hide, 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, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

previousBackgroundColor

protected Color previousBackgroundColor

previousForegroundColor

protected Color previousForegroundColor

notFoundBackgroundColor

protected Color notFoundBackgroundColor

notFoundForegroundColor

protected Color notFoundForegroundColor

findNext

protected JButton findNext

findPrevious

protected JButton findPrevious

Constructor Detail

JXFindBar

public JXFindBar()

JXFindBar

public JXFindBar(Searchable searchable)

Method Detail

setSearchable

public void setSearchable(Searchable searchable)

Description copied from class: JXFindPanel

Sets the Searchable targeted of this find widget. Triggers a search with null pattern to release the old searchable, if any.

Overrides:

setSearchable in class JXFindPanel

Parameters:

searchable - Component where search widget will try to locate and select information using methods of the Searchable interface.

showNotFoundMessage

protected void showNotFoundMessage()

here: set textfield colors to not-found colors.

Overrides:

showNotFoundMessage in class JXFindPanel

showFoundMessage

protected void showFoundMessage()

here: set textfield colors to normal.

Overrides:

showFoundMessage in class JXFindPanel

addNotify

public void addNotify()

Description copied from class: JXFindPanel

Notifies this component that it now has a parent component. When this method is invoked, the chain of parent components is set up with KeyboardAction event listeners.

Overrides:

addNotify in class JXFindPanel

See Also:

JComponent.registerKeyboardAction(java.awt.event.ActionListener, java.lang.String, javax.swing.KeyStroke, int)

cancel

public void cancel()

Action callback method for bound action JXDialog.CLOSE_ACTION_COMMAND. Here: does nothing. Subclasses can override to define custom "closing" behaviour. Alternatively, any client can register a custom action with the actionMap.

initExecutables

protected void initExecutables()

Description copied from class: JXFindPanel

creates and registers all "executable" actions. Meaning: the actions bound to a callback method on this.

Overrides:

initExecutables in class JXFindPanel

bind

protected void bind()

Description copied from class: JXFindPanel

Configure and bind components to/from PatternModel.

Overrides:

bind in class JXFindPanel

build

protected void build()

Description copied from class: JXFindPanel

Compose and layout all the subcomponents.

Overrides:

build in class JXFindPanel

initComponents

protected void initComponents()

Description copied from class: JXFindPanel

Create and initialize components.

Overrides:

initComponents in class JXFindPanel