Module com.iamsoft.util.ui

Package com.iamsoft.util.ui.javafx

Class FindTextFieldSupport

java.lang.Object

com.iamsoft.util.ui.javafx.FindTextFieldSupport

public class FindTextFieldSupport
extends Object

Support for clearable auto-complete text field suitable for find text fields. Suggestions are automatically added when the user hits 'Enter' or when the text field looses focus.

Property Summary

Properties

Type	Property	Description
final javafx.beans.property.ObjectProperty<javafx.collections.ObservableList<String>>	findSuggestions
javafx.beans.property.BooleanProperty	searchHistoryButtonVisible
javafx.beans.property.BooleanProperty	suggestionAdditionEnabled

Constructor Summary

Constructors

Constructor	Description
FindTextFieldSupport()
FindTextFieldSupport(boolean pSortSuggestionList)

Method Summary

Modifier and Type	Method	Description
void	addSuggestion(String pSuggestion)	If the suggestion already exists, it is moved to the beginning of the list.
final javafx.beans.property.ObjectProperty<javafx.collections.ObservableList<String>>	findSuggestionsProperty()
final javafx.collections.ObservableList<String>	getFindSuggestions()	Gets the value of the findSuggestions property.
javafx.scene.control.TextField	getFindTextField()
boolean	isSearchHistoryButtonVisible()	Gets the value of the searchHistoryButtonVisible property.
boolean	isSuggestionAdditionEnabled()	Gets the value of the suggestionAdditionEnabled property.
javafx.beans.property.BooleanProperty	searchHistoryButtonVisibleProperty()
final void	setFindSuggestions(javafx.collections.ObservableList<String> pFindSuggestions)	Sets the value of the findSuggestions property.
void	setSearchHistoryButtonVisible(boolean pVisible)	Sets the value of the searchHistoryButtonVisible property.
void	setSuggestionAdditionEnabled(boolean pEnabled)	Sets the value of the suggestionAdditionEnabled property.
javafx.beans.property.BooleanProperty	suggestionAdditionEnabledProperty()

Methods inherited from class java.lang.Object

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

Property Details

findSuggestions

public final javafx.beans.property.ObjectProperty<javafx.collections.ObservableList<String>> findSuggestionsProperty

See Also:

• getFindSuggestions()
• setFindSuggestions(ObservableList)
• findSuggestionsProperty()

suggestionAdditionEnabled

public javafx.beans.property.BooleanProperty suggestionAdditionEnabledProperty

See Also:

• isSuggestionAdditionEnabled()
• setSuggestionAdditionEnabled(boolean)
• suggestionAdditionEnabledProperty()

searchHistoryButtonVisible

public javafx.beans.property.BooleanProperty searchHistoryButtonVisibleProperty

See Also:

• isSearchHistoryButtonVisible()
• setSearchHistoryButtonVisible(boolean)
• searchHistoryButtonVisibleProperty()

Constructor Details

FindTextFieldSupport

public FindTextFieldSupport()

FindTextFieldSupport

public FindTextFieldSupport(boolean pSortSuggestionList)

Parameters:

pSortSuggestionList - determines whether the suggestion list should be sorted

Method Details

getFindTextField

public javafx.scene.control.TextField getFindTextField()

findSuggestionsProperty

public final javafx.beans.property.ObjectProperty<javafx.collections.ObservableList<String>> findSuggestionsProperty()

Returns:

the findSuggestions property

See Also:

• getFindSuggestions()
• setFindSuggestions(ObservableList)

getFindSuggestions

public final javafx.collections.ObservableList<String> getFindSuggestions()

Gets the value of the findSuggestions property.

Property description:

Returns:

the value of the findSuggestions property

See Also:

• setFindSuggestions(ObservableList)
• findSuggestionsProperty()

setFindSuggestions

public final void setFindSuggestions(javafx.collections.ObservableList<String> pFindSuggestions)

Sets the value of the findSuggestions property.

Property description:

Parameters:

pFindSuggestions - the value for the findSuggestions property

See Also:

• getFindSuggestions()
• findSuggestionsProperty()

suggestionAdditionEnabledProperty

public javafx.beans.property.BooleanProperty suggestionAdditionEnabledProperty()

Returns:

the suggestionAdditionEnabled property

See Also:

• isSuggestionAdditionEnabled()
• setSuggestionAdditionEnabled(boolean)

isSuggestionAdditionEnabled

public boolean isSuggestionAdditionEnabled()

Gets the value of the suggestionAdditionEnabled property.

Property description:

Returns:

the value of the suggestionAdditionEnabled property

See Also:

• setSuggestionAdditionEnabled(boolean)
• suggestionAdditionEnabledProperty()

setSuggestionAdditionEnabled

public void setSuggestionAdditionEnabled(boolean pEnabled)

Sets the value of the suggestionAdditionEnabled property.

Property description:

Parameters:

pEnabled - the value for the suggestionAdditionEnabled property

See Also:

• isSuggestionAdditionEnabled()
• suggestionAdditionEnabledProperty()

searchHistoryButtonVisibleProperty

public javafx.beans.property.BooleanProperty searchHistoryButtonVisibleProperty()

Returns:

the searchHistoryButtonVisible property

See Also:

• isSearchHistoryButtonVisible()
• setSearchHistoryButtonVisible(boolean)

isSearchHistoryButtonVisible

public boolean isSearchHistoryButtonVisible()

Gets the value of the searchHistoryButtonVisible property.

Property description:

Returns:

the value of the searchHistoryButtonVisible property

See Also:

• setSearchHistoryButtonVisible(boolean)
• searchHistoryButtonVisibleProperty()

setSearchHistoryButtonVisible

public void setSearchHistoryButtonVisible(boolean pVisible)

Sets the value of the searchHistoryButtonVisible property.

Property description:

Parameters:

pVisible - the value for the searchHistoryButtonVisible property

See Also:

• isSearchHistoryButtonVisible()
• searchHistoryButtonVisibleProperty()

addSuggestion

public void addSuggestion(String pSuggestion)

If the suggestion already exists, it is moved to the beginning of the list.

Parameters:

pSuggestion - the suggestion to add