Module org.autogui

Package org.autogui.swing.util

Class SearchTextField

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

org.autogui.swing.util.SearchTextField

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable

Direct Known Subclasses:

GuiSwingViewStringField.PropertyStringPane, SearchTextFieldFilePath

public class SearchTextField
extends JComponent

a text-field implementation with supporting background searching.

     [ icon: JButton | textField | popupButton ]
       [ popupMenu:
             model.getCandidates(textField.text,...) ]
 

The popup menus are composition of getMenuItemsSource() -> PopupExtensionText.getEditActions(JTextComponent), and getSearchedItems() whose items are set by setCurrentSearchedItems(List, boolean) or setCurrentSearchedItems(List, PopupCategorized.CategorizedMenuItem), called from SearchTextField.SearchTask's background task via SearchTextField.SearchTextFieldModel.

If a background task calls setCurrentSearchedItems and getSearchedItems() is changed, then SearchTextField.SearchedItemsListener is called. In initPopup(), it registers a listener returned by getPopupUpdateListener(PopupExtensionText, PopupCategorized), which dynamically calls PopupExtension.setupMenu().

If the user edits texts, then it needs to dynamically update the popup. To do this, initField() sets up EditingRunner with updateField(List) and registers it to the field as document listener, action listener and focus listener .

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SearchTextField.DynamicItemAction	an action for searching, filtering and selecting items
static class	SearchTextField.SearchBackgroundPainter	an interface for painting background
static class	SearchTextField.SearchBackgroundPainterBordered	the painter impl.
static interface	SearchTextField.SearchedItemsListener	a listener interface for receiving the searched items
static class	SearchTextField.SearchTask	the background searching task
static interface	SearchTextField.SearchTextFieldModel	the interface for the searching model
static class	SearchTextField.SearchTextFieldModelEmpty	the empty model for searching nothing
static interface	SearchTextField.SearchTextFieldPublisher	the intermediate items submission target
static class	SearchTextField.SearchTextFieldPublisherEmpty	empty impl.

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 SearchTextField.SearchBackgroundPainter	backgroundPainter
protected JComponent	buttonsPane	parent component of popupButton
protected List<PopupCategorized.CategorizedMenuItem>	currentSearchedItems
protected SearchTextField.SearchTask	currentTask
protected EditingRunner	editingRunner
protected static ImageIcon	emptyIcon
protected JTextField	field
protected JButton	icon
protected List<Object>	menuItemsSource
protected SearchTextField.SearchTextFieldModel	model
protected PopupExtensionText	popup
protected JButton	popupButton
protected List<SearchTextField.SearchedItemsListener>	searchedItemsListeners
protected KeyUndoManager	undoManager

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
SearchTextField()
SearchTextField(SearchTextField.SearchTextFieldModel model)

Method Summary

Modifier and Type	Method	Description
void	add(Component comp, Object constraints)
void	addSearchItemsListener(SearchTextField.SearchedItemsListener itemsListener)
Icon	convertIcon(Icon icon)
SearchTextField.SearchTask	createSearchTask(String text)
protected void	doActionButtons()	do click to JButton in buttonsPane other than popupButton.
JComponent	getButtonsPane()
SearchTextField.SearchTask	getCurrentTask()
SearchTextField.DynamicItemAction	getDynamicItemAction(String name, KeyStroke key, boolean put)	an action for dynamic created menu items: the returned action searches an action by the specified key.
EditingRunner	getEditingRunner()
protected int	getEditingRunnerDelay()
Icon	getEmptyIcon()
JTextField	getField()
static Color	getFocusColor()
JButton	getIcon()
Supplier<List<PopupCategorized.CategorizedMenuItem>>	getMenuItems()
List<Object>	getMenuItemsSource()
SearchTextField.SearchTextFieldModel	getModel()
PopupExtensionText	getPopup()
JButton	getPopupButton()
SearchTextField.SearchedItemsListener	getPopupUpdateListener(PopupExtensionText popup, PopupCategorized categorized)
List<PopupCategorized.CategorizedMenuItem>	getSearchedItems()
List<SearchTextField.SearchedItemsListener>	getSearchedItemsListeners()
void	init()
void	initAfter()
void	initBackgroundPainter()
void	initField()
void	initIcon()
void	initLayout()
protected List<? extends JComponent>	initLayoutButtons()	popupButton by default
protected void	initLayoutButtonsPane()	setting up buttonsPane
void	initPopup()
PopupCategorized	initPopupCategorized(Supplier<? extends Collection<PopupCategorized.CategorizedMenuItem>> itemSupplier, Consumer<PopupCategorized.CategorizedMenuItem> itemConsumer)
boolean	isSwingEditable()
boolean	isUpdateFieldImmediateEvent(Object e)
boolean	isUpdateFieldImmediateEvent(List<Object> events)
boolean	isUpdateFieldModifiedEvent(Object e)
boolean	isUpdateFieldModifiedEvents(List<Object> events)
protected void	paintComponent(Graphics g)
void	removeSearchItemsListener(SearchTextField.SearchedItemsListener itemsListener)
void	selectSearchedItemFromGui(PopupCategorized.CategorizedMenuItem item)	the user selects the item from the menu.
void	selectSearchedItemFromModel(PopupCategorized.CategorizedMenuItem item)	called when the search is done, and update only the icon
void	setBackground(Color bg)
void	setBackgroundWithoutInit(Color bg)
void	setCurrentSearchedItems(List<PopupCategorized.CategorizedMenuItem> currentSearchedItems, boolean done)	set the searched items from the background task: it might be an intermediate result
void	setCurrentSearchedItems(List<PopupCategorized.CategorizedMenuItem> currentSearchedItems, PopupCategorized.CategorizedMenuItem selection)	called once when the search is done
void	setIconFromSearchedItem(PopupCategorized.CategorizedMenuItem item)
void	setTextFromSearchedItem(PopupCategorized.CategorizedMenuItem item)
void	setTextWithoutUpdateField(String text)
void	setToolTipText(String text)
void	setTransferHandlerWithSettingExportingDragSource(TransferHandler handler)	set the transfer handler to the pane, the field and the icon button.
static void	setupCopyAndPaste(JComponent component)
void	shutdown()
void	updateField(List<Object> events)	After editing text or action performed, this method will be executed under the scheduler thread
void	updateFieldInEvent(boolean modified, boolean immediate)	executed under event thread: start a new search task in background

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, getUI, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, 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, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

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

model

protected SearchTextField.SearchTextFieldModel model

icon

protected JButton icon

field

protected JTextField field

editingRunner

protected volatile EditingRunner editingRunner

popup

protected PopupExtensionText popup

popupButton

protected JButton popupButton

buttonsPane

protected JComponent buttonsPane

parent component of popupButton

Since:

1.5

menuItemsSource

protected List<Object> menuItemsSource

currentSearchedItems

protected List<PopupCategorized.CategorizedMenuItem> currentSearchedItems

currentTask

protected SearchTextField.SearchTask currentTask

searchedItemsListeners

protected List<SearchTextField.SearchedItemsListener> searchedItemsListeners

emptyIcon

protected static ImageIcon emptyIcon

backgroundPainter

protected SearchTextField.SearchBackgroundPainter backgroundPainter

undoManager

protected KeyUndoManager undoManager

Constructor Details

SearchTextField

public SearchTextField()

SearchTextField

public SearchTextField(SearchTextField.SearchTextFieldModel model)

Method Details

init

public void init()

initIcon

public void initIcon()

getEmptyIcon

public Icon getEmptyIcon()

initField

public void initField()

initAfter

public void initAfter()

setTransferHandlerWithSettingExportingDragSource

public void setTransferHandlerWithSettingExportingDragSource(TransferHandler handler)

set the transfer handler to the pane, the field and the icon button. Also, set up the dragging gesture with COPY operation for the field and the icon.

Parameters:

handler - the target handler

setupCopyAndPaste

public static void setupCopyAndPaste(JComponent component)

getEditingRunnerDelay

protected int getEditingRunnerDelay()

initPopup

public void initPopup()

initPopupCategorized

public PopupCategorized initPopupCategorized(Supplier<? extends Collection<PopupCategorized.CategorizedMenuItem>> itemSupplier,
 Consumer<PopupCategorized.CategorizedMenuItem> itemConsumer)

setToolTipText

public void setToolTipText(String text)

Overrides:

setToolTipText in class JComponent

getMenuItems

public Supplier<List<PopupCategorized.CategorizedMenuItem>> getMenuItems()

getMenuItemsSource

public List<Object> getMenuItemsSource()

Returns:

list of menu items including Action or JComponent

getPopupUpdateListener

public SearchTextField.SearchedItemsListener getPopupUpdateListener(PopupExtensionText popup,
 PopupCategorized categorized)

initLayout

public void initLayout()

initLayoutButtonsPane

protected void initLayoutButtonsPane()

setting up buttonsPane

Since:

1.5

initLayoutButtons

protected List<? extends JComponent> initLayoutButtons()

popupButton by default

Returns:

components added to buttonsPane

Since:

1.5

initBackgroundPainter

public void initBackgroundPainter()

add

public void add(Component comp,
 Object constraints)

Overrides:

add in class Container

paintComponent

protected void paintComponent(Graphics g)

Overrides:

paintComponent in class JComponent

setBackground

public void setBackground(Color bg)

Overrides:

setBackground in class JComponent

setBackgroundWithoutInit

public void setBackgroundWithoutInit(Color bg)

getModel

public SearchTextField.SearchTextFieldModel getModel()

getPopup

public PopupExtensionText getPopup()

getPopupButton

public JButton getPopupButton()

getEditingRunner

public EditingRunner getEditingRunner()

getIcon

public JButton getIcon()

getField

public JTextField getField()

getButtonsPane

public JComponent getButtonsPane()

Returns:

the pane at west

Since:

1.5

getCurrentTask

public SearchTextField.SearchTask getCurrentTask()

addSearchItemsListener

public void addSearchItemsListener(SearchTextField.SearchedItemsListener itemsListener)

removeSearchItemsListener

public void removeSearchItemsListener(SearchTextField.SearchedItemsListener itemsListener)

getSearchedItemsListeners

public List<SearchTextField.SearchedItemsListener> getSearchedItemsListeners()

isSwingEditable

public boolean isSwingEditable()

updateField

public void updateField(List<Object> events)

After editing text or action performed, this method will be executed under the scheduler thread

Parameters:

events - the accumulated events

isUpdateFieldModifiedEvents

public boolean isUpdateFieldModifiedEvents(List<Object> events)

isUpdateFieldModifiedEvent

public boolean isUpdateFieldModifiedEvent(Object e)

isUpdateFieldImmediateEvent

public boolean isUpdateFieldImmediateEvent(List<Object> events)

isUpdateFieldImmediateEvent

public boolean isUpdateFieldImmediateEvent(Object e)

updateFieldInEvent

public void updateFieldInEvent(boolean modified,
 boolean immediate)

executed under event thread: start a new search task in background

Parameters:

modified - true if the field is actually edited

immediate - if true, a background task will not be created even if the model supports it

doActionButtons

protected void doActionButtons()

do click to JButton in buttonsPane other than popupButton.

Since:

1.5

createSearchTask

public SearchTextField.SearchTask createSearchTask(String text)

setCurrentSearchedItems

public void setCurrentSearchedItems(List<PopupCategorized.CategorizedMenuItem> currentSearchedItems,
 boolean done)

set the searched items from the background task: it might be an intermediate result

Parameters:

currentSearchedItems - the intermediate searched items

done - true if the search is done

setCurrentSearchedItems

public void setCurrentSearchedItems(List<PopupCategorized.CategorizedMenuItem> currentSearchedItems,
 PopupCategorized.CategorizedMenuItem selection)

called once when the search is done

Parameters:

currentSearchedItems - the final result of the search

selection - the selected item by the model

getSearchedItems

public List<PopupCategorized.CategorizedMenuItem> getSearchedItems()

selectSearchedItemFromGui

public void selectSearchedItemFromGui(PopupCategorized.CategorizedMenuItem item)

the user selects the item from the menu. update selection in the model and also GUI display. It will stop the current running task if exists, and starts a new task.

Parameters:

item - the selected item

selectSearchedItemFromModel

public void selectSearchedItemFromModel(PopupCategorized.CategorizedMenuItem item)

called when the search is done, and update only the icon

Parameters:

item - the selected item by the model

setIconFromSearchedItem

public void setIconFromSearchedItem(PopupCategorized.CategorizedMenuItem item)

convertIcon

public Icon convertIcon(Icon icon)

setTextFromSearchedItem

public void setTextFromSearchedItem(PopupCategorized.CategorizedMenuItem item)

setTextWithoutUpdateField

public void setTextWithoutUpdateField(String text)

shutdown

public void shutdown()

getFocusColor

public static Color getFocusColor()

getDynamicItemAction

public SearchTextField.DynamicItemAction getDynamicItemAction(String name,
 KeyStroke key,
 boolean put)

an action for dynamic created menu items: the returned action searches an action by the specified key. So getSearchedItems() will contain an item with the key (PopupCategorized.CategorizedMenuItem.getKeyStroke()).

Parameters:

name - the name of the action, used for ActionMap and InputMap binding

key - the keystroke of the action

put - if true, it binds to the component and also the field and the icon button

Returns:

the created item