Package com.illumon.iris.gui.table.dialog

Class SearchAndSortControl

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.illumon.iris.gui.table.dialog.SearchAndSortControl

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class SearchAndSortControl
extends JPanel

A simple search-and-sort control panel. It displays a ascending,descending,reset sort button group, as well as a search text bar. Visibility of each control group depends on the set of provided listeners.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SearchAndSortControl.SearchableListener	A simple SearchAndSortControl.SearchListener for controls that support a Searchable.
static interface	SearchAndSortControl.SearchListener	A listener for changes in the search parameters
static interface	SearchAndSortControl.SortListener	A listener for when the selected sorting changes.

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.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
static Color	INVALID_REGEX_COLOR

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	Description
SearchAndSortControl()	Create a SearchAndSortControl.

Method Summary

Modifier and Type	Method	Description
JComponent	$$$getRootComponent$$$()
void	addSearchListener(SearchAndSortControl.SearchListener listener)	Add a search listener.
void	addSortListener(SearchAndSortControl.SortListener listener)	Add a sort listener.
void	connectSearchAction(Object key, KeyStroke stroke, int inputMapCondition, Action action)	Connect an Action to a specific KeyStroke when the 'Search' box has focus.
void	findNext()	Tell all listeners to find the next matching item.
void	findPrev()	Tell all listeners to find the previous matching item.
void	focusSearch()	Make the 'Search' text box the focused control.
SortOrder	getSortDirective()	Get the current sort directive.
void	removeSearchListener(SearchAndSortControl.SearchListener listener)	Remove a search listener.
void	removeSortListener(SearchAndSortControl.SortListener listener)	Remove a sort listener.
void	setAscendingSortIcon(Icon icon)	Set the icon for the ascending sort button.
void	setDescendingSortIcon(Icon icon)	Set the icon for the descending sort button.
void	setPreferredSize(Dimension dimension)
void	setSearchText(String newText)	Set the search text value
void	setSortDirective(SortOrder directive)
void	setSortFocusable(boolean isFocusable)	Sets focusability of sortAscending/sortDescending buttons

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, 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, 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, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, 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 Details

INVALID_REGEX_COLOR

public static final Color INVALID_REGEX_COLOR

Constructor Details

SearchAndSortControl

public SearchAndSortControl()

Create a SearchAndSortControl.

Method Details

findNext

public void findNext()

Tell all listeners to find the next matching item.

findPrev

public void findPrev()

Tell all listeners to find the previous matching item.

focusSearch

public void focusSearch()

Make the 'Search' text box the focused control.

setSearchText

public void setSearchText(@NotNull String newText)

Set the search text value

Parameters:

newText - the new search text value

connectSearchAction

public void connectSearchAction(Object key, KeyStroke stroke, int inputMapCondition, Action action)

Connect an Action to a specific KeyStroke when the 'Search' box has focus.

Parameters:

key - the acton key

stroke - they KeyStroke that triggers the action

inputMapCondition - the condition the action is valid

action - the action to take

addSortListener

public void addSortListener(@NotNull SearchAndSortControl.SortListener listener)

Add a sort listener.

Parameters:

listener - the listener

removeSortListener

public void removeSortListener(@NotNull SearchAndSortControl.SortListener listener)

Remove a sort listener.

Parameters:

listener - the listener

addSearchListener

public void addSearchListener(@NotNull SearchAndSortControl.SearchListener listener)

Add a search listener.

Parameters:

listener - the listener

removeSearchListener

public void removeSearchListener(@NotNull SearchAndSortControl.SearchListener listener)

Remove a search listener.

Parameters:

listener - the listener

setAscendingSortIcon

public void setAscendingSortIcon(Icon icon)

Set the icon for the ascending sort button.

Parameters:

icon - the icon

setDescendingSortIcon

public void setDescendingSortIcon(Icon icon)

Set the icon for the descending sort button.

Parameters:

icon - the icon

setSortFocusable

public void setSortFocusable(boolean isFocusable)

Sets focusability of sortAscending/sortDescending buttons

Parameters:

isFocusable - if the buttons should be focusable

getSortDirective

public SortOrder getSortDirective()

Get the current sort directive.

Returns:

the sort directive

setSortDirective

public void setSortDirective(SortOrder directive)

setPreferredSize

public void setPreferredSize(Dimension dimension)

Overrides:

setPreferredSize in class JComponent

$$$getRootComponent$$$

public JComponent $$$getRootComponent$$$()

Noinspection:

ALL