Package limn.components

Class SearchField

java.lang.Object

limn.scene.Widget

limn.components.TextField

limn.components.SearchField

public class SearchField
extends TextField

A TextField preset for search: a leading magnifier icon inside the field and a trailing coupled clear button (the ComboBox-caret idiom). Enter fires onSubmit; the clear button empties the field.

Nested Class Summary

Nested classes/interfaces inherited from class limn.components.TextField

TextField.Validation

Field Summary

Fields inherited from class limn.components.TextField

model

Constructor Summary

Constructors

Constructor	Description
SearchField()	A field with a search icon, a clear button and a localized placeholder.

Method Summary

Modifier and Type	Method	Description
void	clear()	Empties the field (and notifies onChange), as the trailing button does.
protected void	onKeyEvent(KeyEvent event)	Key events (focused widget first, then ancestors).
SearchField	onSubmit(Consumer<String> listener)	Fires with the current query when Enter is pressed.

Methods inherited from class limn.components.TextField

acceptsTextInput, allowClipboardCopy, allowsWordJumps, baselineOffset, caretRect, composingText, fireChange, insertText, invalidateDisplayLine, model, onChange, onCharTyped, onFocusGained, onFocusLost, onMeasure, onMouseEvent, onPaint, onPreedit, paintDisplayText, placeholder, setError, setLeadingIcon, setLeadingIcon, setPlaceholder, setPlaceholder, setPreferredWidth, setText, setTrailingButton, setTrailingButton, setValidation, shapeDisplay, showContextMenu, showContextMenuForFocus, text, validation

Methods inherited from class limn.scene.Widget

add, baselineOffsetOf, children, clipboard, clipsChildren, controlSize, cursor, declaredControlSize, declaredLayoutDirection, declaredLocale, focusArrivedByTraversal, height, hitTest, imageCursor, invalidate, invalidate, isEnabled, isFocusable, isFocused, isShowing, isVisible, layoutBox, layoutDirection, locale, localToSceneX, localToSceneY, markNeedsContainedLayout, markNeedsLayout, measure, moveChild, neutralBase, onAttached, onDetached, onFileDrop, onLayout, onPaintOverlay, overlayPassesPointer, paintChildren, paintOutset, paintWidget, parent, remove, requestFocus, revealInView, scene, sceneToLocalX, sceneToLocalY, setControlSize, setCursor, setEnabled, setFocusable, setImageCursor, setInheritanceHost, setLayoutDirection, setLocale, setTooltip, setTooltip, setVisible, shapeText, textRuler, tooltip, width, x, y

Methods inherited from class java.lang.Object

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

Constructor Details

SearchField

public SearchField()

A field with a search icon, a clear button and a localized placeholder.

Method Details

onSubmit

public SearchField onSubmit(Consumer<String> listener)

Fires with the current query when Enter is pressed.

clear

public void clear()

Empties the field (and notifies onChange), as the trailing button does.

onKeyEvent

protected void onKeyEvent(KeyEvent event)

Description copied from class: Widget

Key events (focused widget first, then ancestors).

Overrides:

onKeyEvent in class TextField