PreferencesFX 11.17.0 · com.dlsc.preferencesfx.util.SearchHandler

Field Summary

Modifier and Type	Field and Description
private ObjectProperty<Category>	categoryMatch Represents the category which is matched by the search and should ultimately be displayed.
private int	categoryMatches
private List<Category>	filteredCategoriesLst
private List<Group>	filteredGroupsLst
private List<Setting<E extends Element<E extends Element<E>>, P extends Property<T>>>	filteredSettingsLst
private TreeItemPredicate<Category>	filterPredicate Decides whether a `TreeItem` should be shown in the `TreeView` or not.
private List<Category>	flatCategoriesLst
private List<Group>	flatGroupsLst
private List<Setting<E extends Element<E extends Element<E>>, P extends Property<T>>>	flatSettingsLst
private HashMap<Group, Category>	groupCategoryMap
private int	groupMatches
private static final Logger	LOGGER
private PreferencesFxModel	model
private StringProperty	searchText
private HashMap<Setting<E extends Element<E extends Element<E>>, P extends Property<T>>, Category>	settingCategoryMap
private int	settingMatches

Constructor Summary

Access	Constructor and Description
public	SearchHandler()

Method Summary

Modifier and Type	Method and Description
public void	bindFilterPredicate(ObjectProperty<TreeItemPredicate<Category>> of the rootItem of a `FilterableTreeItem` predicateProperty) Binds the predicateProperty to ensure filtering according to the searchText.
private void	bindSearchText(StringProperty textProperty of a TextField where the search string is being input searchText) Makes sure this class is aware of the current text which is being searched for.
public ReadOnlyObjectProperty<Category>	categoryMatchProperty()
public Category	Returns: the category with the least amount of matches, taking into account the priority compareMatches(Category category to return, if settingsMatch is chosen setting, Category category to return, if groupMatch is chosen group, Category category to return, if categoryMatch is chosen category, int amount of settings which match settingMatch, int amount of groups which match groupMatch, int amount of categories which match categoryMatch) Compares three categories with decreasing priority from the first to the last category.
public Category	getCategoryMatch()
private Category	getSelectedCategoryByMatch()
public void	init(PreferencesFxModel the model of PreferencesFx model, StringProperty textProperty of a TextField where the search string is being input searchText, ObjectProperty<TreeItemPredicate<Category>> of the rootItem of a `FilterableTreeItem` predicateProperty) Initializes the SearchHandler by initially creating all necessary lists for filtering and setting up the bindings.
private void	initializeSearch()
public void	initializeSearchText(StringProperty the property of the search text UI element searchText) Initializes the search text by binding it and then adding a listener to react to changes.
private void	initializeSearchTextListener() Reacts upon changes in the search text.
private void	markMatches()
private void	resetSearch()
private void	setCategoryMatch(Category categoryMatch)
private void	unmarkEverything()
private void	updateFilteredLists(String searchText)
public void	updateSearch(String the new text to be searched for searchText) Updates the search based on a new `searchText`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

categoryMatch	back to summary
private ObjectProperty<Category> categoryMatch Represents the category which is matched by the search and should ultimately be displayed.

categoryMatches	back to summary
private int categoryMatches

filteredCategoriesLst	back to summary
private List<Category> filteredCategoriesLst

filteredGroupsLst	back to summary
private List<Group> filteredGroupsLst

filteredSettingsLst	back to summary
private List<Setting<E extends Element<E extends Element<E>>, P extends Property<T>>> filteredSettingsLst

filterPredicate	back to summary
private TreeItemPredicate<Category> filterPredicate Decides whether a `TreeItem` should be shown in the `TreeView` or not. If result is true, it will be shown, if the result is false, it will be hidden.

flatCategoriesLst	back to summary
private List<Category> flatCategoriesLst

flatGroupsLst	back to summary
private List<Group> flatGroupsLst

flatSettingsLst	back to summary
private List<Setting<E extends Element<E extends Element<E>>, P extends Property<T>>> flatSettingsLst

groupCategoryMap	back to summary
private HashMap<Group, Category> groupCategoryMap

groupMatches	back to summary
private int groupMatches

LOGGER	back to summary
private static final Logger LOGGER

model	back to summary
private PreferencesFxModel model

searchText	back to summary
private StringProperty searchText

settingCategoryMap	back to summary
private HashMap<Setting<E extends Element<E extends Element<E>>, P extends Property<T>>, Category> settingCategoryMap

settingMatches	back to summary
private int settingMatches

Constructor Detail

SearchHandler	back to summary
public SearchHandler()

Method Detail

bindFilterPredicate back to summary

bindFilterPredicate	back to summary
public void bindFilterPredicate(ObjectProperty<TreeItemPredicate<Category>> predicateProperty) Binds the predicateProperty to ensure filtering according to the searchText. Parameters predicateProperty:ObjectProperty<TreeItemPredicate<Category>> of the rootItem of a `FilterableTreeItem`

public void bindFilterPredicate(ObjectProperty<TreeItemPredicate<Category>> predicateProperty)

Binds the predicateProperty to ensure filtering according to the searchText.

Parameters

predicateProperty:ObjectProperty<TreeItemPredicate<Category>>: of the rootItem of a FilterableTreeItem

bindSearchText	back to summary
private void bindSearchText(StringProperty searchText) Makes sure this class is aware of the current text which is being searched for. Parameters searchText:StringProperty textProperty of a TextField where the search string is being input

bindSearchText

back to summary

private void bindSearchText(StringProperty searchText)

Makes sure this class is aware of the current text which is being searched for.

Parameters

searchText:StringProperty: textProperty of a TextField where the search string is being input

categoryMatchProperty	back to summary
public ReadOnlyObjectProperty<Category> categoryMatchProperty()

compareMatches	back to summary
public Category compareMatches(Category setting, Category group, Category category, int settingMatch, int groupMatch, int categoryMatch) Compares three categories with decreasing priority from the first to the last category. See developer reference for further information. Parameters setting:Category category to return, if settingsMatch is chosen group:Category category to return, if groupMatch is chosen category:Category category to return, if categoryMatch is chosen settingMatch:int amount of settings which match groupMatch:int amount of groups which match categoryMatch:int amount of categories which match Returns:Category the category with the least amount of matches, taking into account the priority

compareMatches

back to summary

public Category compareMatches(Category setting, Category group, Category category, int settingMatch, int groupMatch, int categoryMatch)

Compares three categories with decreasing priority from the first to the last category. See developer reference for further information.

Parameters

setting:Category: category to return, if settingsMatch is chosen
group:Category: category to return, if groupMatch is chosen
category:Category: category to return, if categoryMatch is chosen
settingMatch:int: amount of settings which match
groupMatch:int: amount of groups which match
categoryMatch:int: amount of categories which match

Returns:Category

the category with the least amount of matches, taking into account the priority

getCategoryMatch	back to summary
public Category getCategoryMatch()

getSelectedCategoryByMatch	back to summary
private Category getSelectedCategoryByMatch()

init back to summary

init	back to summary
public void init(PreferencesFxModel model, StringProperty searchText, ObjectProperty<TreeItemPredicate<Category>> predicateProperty) Initializes the SearchHandler by initially creating all necessary lists for filtering and setting up the bindings. API Note Must be called to make the filtering work. Parameters model:PreferencesFxModel the model of PreferencesFx searchText:StringProperty textProperty of a TextField where the search string is being input predicateProperty:ObjectProperty<TreeItemPredicate<Category>> of the rootItem of a `FilterableTreeItem`

public void init(PreferencesFxModel model, StringProperty searchText, ObjectProperty<TreeItemPredicate<Category>> predicateProperty)

Initializes the SearchHandler by initially creating all necessary lists for filtering and setting up the bindings.

API Note

Must be called to make the filtering work.

Parameters

model:PreferencesFxModel: the model of PreferencesFx
searchText:StringProperty: textProperty of a TextField where the search string is being input
predicateProperty:ObjectProperty<TreeItemPredicate<Category>>: of the rootItem of a FilterableTreeItem

initializeSearch	back to summary
private void initializeSearch()

initializeSearchText	back to summary
public void initializeSearchText(StringProperty searchText) Initializes the search text by binding it and then adding a listener to react to changes. Parameters searchText:StringProperty the property of the search text UI element

initializeSearchText

back to summary

public void initializeSearchText(StringProperty searchText)

Initializes the search text by binding it and then adding a listener to react to changes.

Parameters

searchText:StringProperty: the property of the search text UI element

initializeSearchTextListener	back to summary
private void initializeSearchTextListener() Reacts upon changes in the search text. If the search text is empty, everything will be unmarked, else the search will be updated.

markMatches	back to summary
private void markMatches()

resetSearch	back to summary
private void resetSearch()

setCategoryMatch	back to summary
private void setCategoryMatch(Category categoryMatch)

unmarkEverything	back to summary
private void unmarkEverything()

updateFilteredLists	back to summary
private void updateFilteredLists(String searchText)

updateSearch back to summary

updateSearch	back to summary
public void updateSearch(String searchText) Updates the search based on a new `searchText`. Implementation Note Filters the lists, sets the category match, unmarks everything and marks all matches. Parameters searchText:String the new text to be searched for

public void updateSearch(String searchText)

Updates the search based on a new searchText.

Implementation Note

Filters the lists, sets the category match, unmarks everything and marks all matches.

Parameters

searchText:String: the new text to be searched for

public Class SearchHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail