GemsFX 3.10.1 · com.dlsc.gemsfx.SearchField · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
public static class	SearchField.SearchEvent An event type used by the `SearchField` to indicate the start and end of searching operations.
private class	SearchField.SearchEventHandlerProperty
public static class	SearchField.SearchFieldListCell< the type of the cell T> A custom list cell implementation that is capable of underlining the part of the text that matches the user-typed search text.
public static interface	SearchField.SearchFieldSuggestionRequest Represents a suggestion fetch request.
private class	SearchField.SearchService
private class	SearchField.SearchTask

Modifier and Type	Field and Description
private BooleanProperty	addingItemToHistoryOnCommit
private BooleanProperty	addingItemToHistoryOnEnter
private BooleanProperty	addingItemToHistoryOnFocusLost
private BooleanProperty	autoCommitOnFocusLost
private final ReadOnlyStringWrapper	autoCompletedText
private final DoubleProperty	autoCompletionGap
private final ObjectProperty<Node>	busyGraphic
private final ObjectProperty<Callback<ListView<T>, ListCell<T>>>	cellFactory
private boolean	committing
private final ObjectProperty<Comparator<T>>	comparator
private final ObjectProperty<StringConverter<T>>	converter
private static final boolean	DEFAULT_ADDING_ITEM_TO_HISTORY_ON_COMMIT
private static final boolean	DEFAULT_ADDING_ITEM_TO_HISTORY_ON_ENTER
private static final boolean	DEFAULT_ADDING_ITEM_TO_HISTORY_ON_FOCUS_LOST
private static final String	DEFAULT_STYLE_CLASS
private static final PseudoClass	DISABLED_POPUP_PSEUDO_CLASS
private final TextField	editor
private final ReadOnlyStringWrapper	fullText
private final ObjectProperty<Node>	graphic
private final BooleanProperty	hidePopupWithNoChoice
private final BooleanProperty	hidePopupWithSingleChoice
private final HistoryButton<String>	historyButton
private ObjectProperty<HistoryManager<String>>	historyManager
private ObjectProperty<Node>	historyPlaceholder
private final ObjectProperty<Node>	left Hides javafx.scene.Parent.left.
private final ObjectProperty<BiFunction<T, String, Boolean>>	matcher
private final ReadOnlyBooleanWrapper	newItem
private final ObjectProperty<Callback<String, T>>	newItemProducer
private final ObjectProperty<Consumer<T>>	onCommit
private SearchField<T>.SearchEventHandlerProperty	onSearchFinished
private SearchField<T>.SearchEventHandlerProperty	onSearchStarted
private ObjectProperty<Node>	placeholder
private final SearchFieldPopup<T>	popup
private final StringProperty	promptText
private final ObservableList<T>	readOnlySuggestions
private final ObjectProperty<Node>	right Hides javafx.scene.Parent.right.
private final ReadOnlyBooleanWrapper	searching
private final SearchField<T>.SearchService	searchService
private final ObjectProperty<T>	selectedItem
private final BooleanProperty	showSearchIcon
private final ObjectProperty<Callback<SearchField.SearchFieldSuggestionRequest, Collection<T>>>	suggestionProvider
private final ListProperty<T>	suggestions
private final StringProperty	text

Access	Constructor and Description
public	SearchField() Constructs a new spotlight field.

Method Summary

Modifier and Type	Method and Description
public final BooleanProperty	Returns: true if the text should be added to the history on commit, false otherwise addingItemToHistoryOnCommitProperty() Determines whether the text of the text field should be added to the history when the user commits to a value.
public final BooleanProperty	Returns: true if the text should be added to the history on Enter, false otherwise addingItemToHistoryOnEnterProperty() Determines whether the text of the text field should be added to the history when the user presses the Enter key.
public final BooleanProperty	Returns: true if the text should be added to the history on focus lost, false otherwise addingItemToHistoryOnFocusLostProperty() Determines whether the text of the text field should be added to the history when the field losses its focus.
private void	addToHistory(String text)
public final BooleanProperty	Returns: the BooleanProperty for autoCommitOnFocusLost. autoCommitOnFocusLostProperty() Returns the BooleanProperty that indicates if text should auto-commit when the field loses focus.
public final ReadOnlyStringProperty	Returns: the auto-completed text (e.g. "ates" after the user entered "United St" in a country search field). autoCompletedTextProperty() A read-only property containing the automatically completed text.
public final DoubleProperty	Returns: the gap (in pixels) between the user typed text and the autocompleted text autoCompletionGapProperty() Defines the gap (in pixels) between the user typed text and the autocompleted text.
public final ObjectProperty<Node>	Returns: the busy graphic busyGraphicProperty() Stores a node that will be shown on the field's right side whenever a search is ongoing.
public final void	cancel() Cancels the current search in progress.
public final ObjectProperty<Callback<ListView<T>, ListCell<T>>>	Returns: the cell factory used by the suggestion list view cellFactoryProperty() A cell factory that can be used by a list view to visualize the list of suggestions.
public void	clear() Convenience method to invoke clear() on the text field.
public void	commit() Makes the field commit to the currently selected item and updates the field to show the full text provided by the converter for the item.
public final ObjectProperty<Comparator<T>>	Returns: the sorting comparator used for the suggestions list comparatorProperty() A comparator used to sort the list of suggestions.
public final ObjectProperty<StringConverter<T>>	Returns: the converter for turning the objects returned by the suggestion provider into text converterProperty() A converter for turning the objects returned by the suggestion provider into text.
protected Skin<?>	createDefaultSkin() Overrides javafx.scene.control.Control.createDefaultSkin. Create a new instance of the default skin for this control.
private HistoryButton<String>	createHistoryButton()
public final ReadOnlyStringProperty	Returns: the full text shown by the text field fullTextProperty() A read-only property containing the concatenation of the regular text of the text field and the autocompleted text.
public final String	getAutoCompletedText()
public final double	getAutoCompletionGap()
public final Node	getBusyGraphic()
public final Callback<ListView<T>, ListCell<T>>	getCellFactory()
public final Comparator<T>	getComparator()
public final StringConverter<T>	getConverter()
public final TextField	Returns: the text field editor control getEditor() Returns the text field control used for editing the text.
public final String	getFullText()
public final Node	getGraphic()
public final HistoryManager<String>	getHistoryManager()
public final Node	getHistoryPlaceholder()
public final Node	getLeft()
public final BiFunction<T, String, Boolean>	getMatcher()
public final Callback<String, T>	getNewItemProducer()
public final Consumer<T>	getOnCommit()
public final EventHandler<SearchField.SearchEvent>	getOnSearchFinished()
public final EventHandler<SearchField.SearchEvent>	getOnSearchStarted()
public final Node	getPlaceholder()
public final SearchFieldPopup<T>	getPopup()
public final String	getPromptText()
public final Node	getRight()
public final T	getSelectedItem()
public final Callback<SearchField.SearchFieldSuggestionRequest, Collection<T>>	getSuggestionProvider()
public final ObservableList<T>	Returns: the list of suggestions getSuggestions() Returns a read-only (unmodifiable) list of the current suggestions.
public final String	getText()
public String	getUserAgentStylesheet() Overrides javafx.scene.layout.Region.getUserAgentStylesheet. An implementation may specify its own user-agent styles for this Region, and its children, by overriding this method.
public final ObjectProperty<Node>	Returns: the field's graphic graphicProperty() Stores a node that will be shown on the field's right-hand side whenever the field is idle.
public final BooleanProperty	Returns: true if the popup should not be shown when there are no suggestions to display. hidePopupWithNoChoiceProperty() Determines whether to hide the popup window when there are no choices available in the suggestion list.
public final BooleanProperty	Returns: true if the popup showing the list of suggestions will not appear if only a single choice is available hidePopupWithSingleChoiceProperty() Hides the popup window with the suggestion list if the list only contains a single elements.
public final ObjectProperty<HistoryManager<String>>	Returns: the property representing the history manager historyManagerProperty() The history manager that is used to manage the history of the SearchField.
public final ObjectProperty<Node>	Returns: the property representing the history placeholder node historyPlaceholderProperty() Returns the property representing the history placeholder node.
private void	invokeCommitHandler()
public final boolean	isAddingItemToHistoryOnCommit()
public final boolean	isAddingItemToHistoryOnEnter()
public final boolean	isAddingItemToHistoryOnFocusLost()
public final boolean	Returns: true if auto-commit on focus lost is enabled, false otherwise. isAutoCommitOnFocusLost() Checks if the auto-commit on focus lost feature is enabled.
public final boolean	isHidePopupWithNoChoice()
public final boolean	isHidePopupWithSingleChoice()
public final boolean	isNewItem()
public final boolean	isSearching()
public final boolean	isShowSearchIcon()
public final ObjectProperty<Node>	Returns: a custom node for the left-hand side (e.g. "clear" button) leftProperty() A custom node that can be shown on the left-hand side of the field.
public final ObjectProperty<BiFunction<T, String, Boolean>>	Returns: the function used for determining the best match in the suggestion list matcherProperty() The function that is used to determine the first item in the suggestion list that is a good match for auto selection.
public final ObjectProperty<Callback<String, T>>	Returns: the callback for producing a new object of the field supported object type newItemProducerProperty() A callback used for creating a new object on-the-fly if no item matches the search text.
public final ReadOnlyBooleanProperty	Returns: true if the selected item was not part of the suggestion list and has been created on-the-fly newItemProperty() Determines if the selected item has been created on-the-fly via the `newItemProducer`.
public final ObjectProperty<Consumer<T>>	Returns: the commit handler onCommitProperty() A callback that gets invoked when the user has committed to the selected value.
private void	onHistoryItemConfirmed(String historyItem)
public final ObjectProperty<EventHandler<SearchField.SearchEvent>>	Returns: the "search finished" event handler onSearchFinishedProperty() An event handler that can be used to get informed whenever the field finishes a search.
public final ObjectProperty<EventHandler<SearchField.SearchEvent>>	Returns: the "search started" event handler onSearchStartedProperty() An event handler that can be used to get informed whenever the field starts a search.
public final ObjectProperty<Node>	Returns: the placeholder property for the list view of the auto suggest popup placeholderProperty() The placeholder UI when no suggestions have been returned by the suggestion provider.
public final StringProperty	Returns: the prompt text promptTextProperty() A convenience property to set the prompt text shown by the text field when no text has been entered yet (e.g. "Search ...").
public final ObjectProperty<Node>	Returns: a custom node for the right-hand side (e.g. "clear" button) rightProperty() A custom node that can be shown on the right-hand side of the field.
public final ReadOnlyBooleanProperty	Returns: true if the search is currently in progress searchingProperty() A flag indicating whether the asynchronous search is currently in progress.
public void	select(T the selected item item) Selects the given item and sets the editor's text to the string provided by the converter for the item.
public final ObjectProperty<T>	Returns: the selected item selectedItemProperty() Contains the currently selected item.
public final void	setAddingItemToHistoryOnCommit(boolean addingItemToHistoryOnCommit)
public final void	setAddingItemToHistoryOnEnter(boolean addingItemToHistoryOnEnter)
public final void	setAddingItemToHistoryOnFocusLost(boolean addingItemToHistoryOnFocusLost)
public final void	setAutoCommitOnFocusLost(boolean if true, enables auto-commit on focus lost; if false, disables it. value) Sets the value of the autoCommitOnFocusLost property.
public final void	setAutoCompletionGap(double autoCompletionGap)
public final void	setBusyGraphic(Node busyGraphic)
public final void	setCellFactory(Callback<ListView<T>, ListCell<T>> cellFactory)
public final void	setComparator(Comparator<T> comparator)
public final void	setConverter(StringConverter<T> converter)
public final void	setGraphic(Node graphic)
public final void	setHidePopupWithNoChoice(boolean hidePopupWithNoChoice)
public final void	setHidePopupWithSingleChoice(boolean hidePopupWithSingleChoice)
public final void	setHistoryManager(HistoryManager<String> historyManager)
public final void	setHistoryPlaceholder(Node historyPlaceholder)
public final void	setLeft(Node left)
public final void	setMatcher(BiFunction<T, String, Boolean> matcher)
public final void	setNewItemProducer(Callback<String, T> newItemProducer)
public void	setOnCommit(Consumer<T> onCommit)
public final void	setOnSearchFinished(EventHandler<SearchField.SearchEvent> value)
public final void	setOnSearchStarted(EventHandler<SearchField.SearchEvent> value)
public final void	setPlaceholder(Node value)
public final void	setPromptText(String promptText)
public final void	setRight(Node right)
public final void	setSelectedItem(T selectedItem)
public final void	setShowSearchIcon(boolean showSearchIcon)
public final void	setSuggestionProvider(Callback<SearchField.SearchFieldSuggestionRequest, Collection<T>> suggestionProvider)
public final void	setText(String text)
public final BooleanProperty	Returns: true if a search icon will be shown showSearchIconProperty() Determines if the field will show an icon on the right-hand side which indicates that the field is a search field.
public final ObjectProperty<Callback<SearchField.SearchFieldSuggestionRequest, Collection<T>>>	Returns: #getSuggestions suggestionProviderProperty() A callback used for looking up a list of suggestions for the current search text.
public final StringProperty	Returns: the text shown by the field textProperty() A convenience property bound to the editor's text property.
protected void	update(Collection<T> the new suggestions to use for the field newSuggestions) Updates the control with the newly found list of suggestions.

public Class SearchField<T>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary