Class SearchField

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

ca.phon.ui.text.SearchField

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

IpaMapSearchField, TableSearchField

public class SearchField
extends JPanel

A search field with optional context button. The field displays a prompt when the text field text is empty.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SearchField.SearchFieldMenuHandler

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
protected ca.phon.ui.text.SearchField.SearchFieldButton	ctxButton	Search context button
protected ca.phon.ui.text.SearchField.SearchFieldButton	endButton
protected SearchField.SearchFieldMenuHandler	menuHandler	Custom menu handler for adding custom options to the context menu.
protected final PromptedTextField	queryField

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
SearchField()	Search icon
SearchField(String prompt)
SearchField(String historyProperty, int maxHistory, String prompt)

Method Summary

Modifier and Type	Method	Description
void	addToSearchHistory(SearchHistoryEntry entry)	Add given entry to search history, requires that a history property was specified at construction time.
BufferedImage	createClearIcon()
BufferedImage	createSearchIcon()
Action	getAction()
int	getColumns()
JButton	getContextButton()
Document	getDocument()
JButton	getEndButton()
SearchField.SearchFieldMenuHandler	getMenuHandler()	Get the custom menu handler for the search field.
String	getPrompt()
String	getQuery()	Get the query text
PromptedTextField.FieldState	getState()
String	getText()
PromptedTextField	getTextField()
void	onClearText(PhonActionEvent<Void> pae)
void	onShowContextMenu(PhonActionEvent<Void> pae)	Displays the context menu for the component.
void	setAction(Action action)
void	setColumns(int columns)
void	setFocusable(boolean b)
void	setMenuHandler(SearchField.SearchFieldMenuHandler menuHandler)	Set a custom menu handler for the search field.
void	setPrompt(String prompt)
void	setSearchHistorySelectionCallback(Consumer<SearchHistoryEntry> callback)
void	setState(String state)
void	setText(String s)
protected void	setupPopupMenu(JPopupMenu menu)	Setup popup menu.

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

ctxButton

protected ca.phon.ui.text.SearchField.SearchFieldButton ctxButton

Search context button

endButton

protected ca.phon.ui.text.SearchField.SearchFieldButton endButton

queryField

protected final PromptedTextField queryField

menuHandler

protected SearchField.SearchFieldMenuHandler menuHandler

Custom menu handler for adding custom options to the context menu.

Constructor Details

SearchField

public SearchField()

Search icon

SearchField

public SearchField(String prompt)

SearchField

public SearchField(String historyProperty,
 int maxHistory,
 String prompt)

Method Details

createClearIcon

public BufferedImage createClearIcon()

createSearchIcon

public BufferedImage createSearchIcon()

setFocusable

public void setFocusable(boolean b)

Overrides:

setFocusable in class Component

getQuery

public String getQuery()

Get the query text

Returns:

query text

getAction

public Action getAction()

setAction

public void setAction(Action action)

onShowContextMenu

public void onShowContextMenu(PhonActionEvent<Void> pae)

Displays the context menu for the component. By default, this displays a single option for clearing the text field. Subclasses should override to define custom options.

Parameters:

pae -

getContextButton

public JButton getContextButton()

getEndButton

public JButton getEndButton()

getPrompt

public String getPrompt()

setPrompt

public void setPrompt(String prompt)

getColumns

public int getColumns()

setColumns

public void setColumns(int columns)

getDocument

public Document getDocument()

getTextField

public PromptedTextField getTextField()

setupPopupMenu

protected void setupPopupMenu(JPopupMenu menu)

Setup popup menu. Override this method to completely customize the context menu for the search field. Most implementations will only need to add custom options to the menu and should use the SearchField.SearchFieldMenuHandler interface to do so.

Parameters:

menu - popup menu to setup

setMenuHandler

public void setMenuHandler(SearchField.SearchFieldMenuHandler menuHandler)

Set a custom menu handler for the search field. May be used to add custom options to the context menu.

Parameters:

menuHandler - custom menu handler or null to remove

getMenuHandler

public SearchField.SearchFieldMenuHandler getMenuHandler()

Get the custom menu handler for the search field.

Returns:

custom menu handler or null if none is set

setState

public void setState(String state)

getState

public PromptedTextField.FieldState getState()

getText

public String getText()

setText

public void setText(String s)

onClearText

public void onClearText(PhonActionEvent<Void> pae)

addToSearchHistory

public void addToSearchHistory(SearchHistoryEntry entry)

Add given entry to search history, requires that a history property was specified at construction time.

Parameters:

entry - the entry to add

setSearchHistorySelectionCallback

public void setSearchHistorySelectionCallback(Consumer<SearchHistoryEntry> callback)