Package sc.fiji.snt.gui

Class SNTSearchableBar

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JToolBar

com.jidesoft.swing.SearchableBar

sc.fiji.snt.gui.SNTSearchableBar

All Implemented Interfaces:

com.jidesoft.swing.SearchableProvider, ImageObserver, MenuContainer, Serializable, Accessible, SwingConstants

Direct Known Subclasses:

PathManagerUISearchableBar

public class SNTSearchableBar
extends com.jidesoft.swing.SearchableBar

Implements a SearchableBar following SNT's UI.

Author:

Tiago Ferreira

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.jidesoft.swing.SearchableBar

com.jidesoft.swing.SearchableBar.Installer

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

JToolBar.AccessibleJToolBar, JToolBar.Separator

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
protected List<AbstractButton>	_extraButtons
protected boolean	subFilteringEnabled

Fields inherited from class com.jidesoft.swing.SearchableBar

_closeButton, _comboBox, _findNextButton, _findPrevButton, _highlightsButton, _leadingLabel, _matchCaseCheckBox, _repeatCheckBox, _statusLabel, _textField, _wholeWordsCheckBox, PROPERTY_MAX_HISTORY_LENGTH, SHOW_ALL, SHOW_CLOSE, SHOW_HIGHLIGHTS, SHOW_MATCHCASE, SHOW_NAVIGATION, SHOW_REPEATS, SHOW_STATUS, SHOW_WHOLE_WORDS

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

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Constructor Summary

Constructors

Constructor	Description
SNTSearchableBar(com.jidesoft.swing.Searchable searchable)
SNTSearchableBar(com.jidesoft.swing.Searchable searchable, String placeholder)

Method Summary

Modifier and Type	Method	Description
void	addOptionsMenuItem(JMenuItem item)	Adds a menu item to the search bar's options (gear) menu.
protected void	appendToOptionsMenu(Collection<JMenuItem> menuItems)
protected AbstractButton	createCloseButton(AbstractAction closeAction)
protected AbstractButton	createFindNextButton(AbstractAction findNextAction)
protected AbstractButton	createFindPrevButton(AbstractAction findPrevAction)
protected AbstractButton	createHighlightButton()
protected void	formatButton(AbstractButton button, IconFactory.GLYPH glyph)
protected ImageIcon	getImageIcon(String name)
int	getMaxHistoryLength()
SearchField	getSearchField()
protected void	installComponents()
void	setBorderless()
void	setGuiUtils(GuiUtils guiUtils)
protected void	setSearchableObjectDescription(String objectDescription)
void	setStatus(String text)
void	setStatusLabelPlaceholder(String placeholder)
void	setSubFilteringEnabled(boolean enable)

Methods inherited from class com.jidesoft.swing.SearchableBar

createComboBox, createMatchCaseButton, createRepeatsButton, createTextField, createWholeWordsButton, focusSearchField, getInstaller, getMismatchBackground, getResourceString, getSearchable, getSearchHistory, getSearchingText, getVisibleButtons, install, isCompact, isHighlightAll, isPassive, isShowMatchCount, processKeyEvent, select, setCompact, setHighlightAll, setInstaller, setMaxHistoryLength, setMismatchForeground, setSearchHistory, setSearchingText, setShowMatchCount, setVisibleButtons

Methods inherited from class javax.swing.JToolBar

add, addImpl, addSeparator, addSeparator, createActionChangeListener, createActionComponent, getAccessibleContext, getComponentAtIndex, getComponentIndex, getMargin, getOrientation, getUI, getUIClassID, isBorderPainted, isFloatable, isRollover, paintBorder, paramString, setBorderPainted, setFloatable, setLayout, setMargin, setOrientation, setRollover, 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, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, 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, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, 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, 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

_extraButtons

protected List<AbstractButton> _extraButtons

subFilteringEnabled

protected boolean subFilteringEnabled

Constructor Details

SNTSearchableBar

public SNTSearchableBar(com.jidesoft.swing.Searchable searchable)

SNTSearchableBar

public SNTSearchableBar(com.jidesoft.swing.Searchable searchable,
 String placeholder)

Method Details

getMaxHistoryLength

public int getMaxHistoryLength()

Overrides:

getMaxHistoryLength in class com.jidesoft.swing.SearchableBar

getSearchField

public SearchField getSearchField()

setStatusLabelPlaceholder

public void setStatusLabelPlaceholder(String placeholder)

installComponents

protected void installComponents()

Overrides:

installComponents in class com.jidesoft.swing.SearchableBar

setSearchableObjectDescription

protected void setSearchableObjectDescription(String objectDescription)

setGuiUtils

public void setGuiUtils(GuiUtils guiUtils)

appendToOptionsMenu

protected void appendToOptionsMenu(Collection<JMenuItem> menuItems)

setSubFilteringEnabled

public void setSubFilteringEnabled(boolean enable)

addOptionsMenuItem

public void addOptionsMenuItem(JMenuItem item)

Adds a menu item to the search bar's options (gear) menu. The item is appended before the "Tips & Shortcuts" entry.

Parameters:

item - the menu item to add

setStatus

public void setStatus(String text)

setBorderless

public void setBorderless()

createFindPrevButton

protected AbstractButton createFindPrevButton(AbstractAction findPrevAction)

Overrides:

createFindPrevButton in class com.jidesoft.swing.SearchableBar

createFindNextButton

protected AbstractButton createFindNextButton(AbstractAction findNextAction)

Overrides:

createFindNextButton in class com.jidesoft.swing.SearchableBar

getImageIcon

protected ImageIcon getImageIcon(String name)

Overrides:

getImageIcon in class com.jidesoft.swing.SearchableBar

createCloseButton

protected AbstractButton createCloseButton(AbstractAction closeAction)

Overrides:

createCloseButton in class com.jidesoft.swing.SearchableBar

createHighlightButton

protected AbstractButton createHighlightButton()

Overrides:

createHighlightButton in class com.jidesoft.swing.SearchableBar

formatButton

protected void formatButton(AbstractButton button,
 IconFactory.GLYPH glyph)