com.dlsc.preferencesfx.util

Class SearchHandler

java.lang.Object

com.dlsc.preferencesfx.util.SearchHandler

public class SearchHandler
extends Object

Handles everything related to searching in theCategory, Group and Setting.

Author:

François Martin, Marco Sanfratello

Property Summary

Type	Property and Description
javafx.beans.property.ReadOnlyObjectProperty<Category>	categoryMatch Represents the category which is matched by the search and should ultimately be displayed.

Constructor Summary

Constructors

Constructor and Description
SearchHandler()

Method Summary

Modifier and Type	Method and Description
void	bindFilterPredicate(javafx.beans.property.ObjectProperty<org.eclipse.fx.ui.controls.tree.TreeItemPredicate<Category>> predicateProperty) Binds the predicateProperty to ensure filtering according to the searchText.
javafx.beans.property.ReadOnlyObjectProperty<Category>	categoryMatchProperty() Represents the category which is matched by the search and should ultimately be displayed.
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.
Category	getCategoryMatch() Gets the value of the property categoryMatch.
void	init(PreferencesFxModel model, javafx.beans.property.StringProperty searchText, javafx.beans.property.ObjectProperty<org.eclipse.fx.ui.controls.tree.TreeItemPredicate<Category>> predicateProperty) Initializes the SearchHandler by initially creating all necessary lists for filtering and setting up the bindings.
void	initializeSearchText(javafx.beans.property.StringProperty searchText) Initializes the search text by binding it and then adding a listener to react to changes.
void	updateSearch(String searchText) Updates the search based on a new searchText.

Methods inherited from class java.lang.Object

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

Property Detail

categoryMatch

public javafx.beans.property.ReadOnlyObjectProperty<Category> categoryMatchProperty

Represents the category which is matched by the search and should ultimately be displayed.

See Also:

getCategoryMatch()

Constructor Detail

SearchHandler

public SearchHandler()

Method Detail

init

public void init(PreferencesFxModel model,
                 javafx.beans.property.StringProperty searchText,
                 javafx.beans.property.ObjectProperty<org.eclipse.fx.ui.controls.tree.TreeItemPredicate<Category>> predicateProperty)

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

Parameters:

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

predicateProperty - of the rootItem of a FilterableTreeItem

initializeSearchText

public void initializeSearchText(javafx.beans.property.StringProperty searchText)

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

bindFilterPredicate

public void bindFilterPredicate(javafx.beans.property.ObjectProperty<org.eclipse.fx.ui.controls.tree.TreeItemPredicate<Category>> predicateProperty)

Binds the predicateProperty to ensure filtering according to the searchText.

Parameters:

predicateProperty - of the rootItem of a FilterableTreeItem

updateSearch

public void updateSearch(String searchText)

Updates the search based on a new searchText.

Parameters:

searchText - the new text to be searched for

compareMatches

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. reference for further information

Parameters:

setting - category to return, if settingsMatch is chosen

group - category to return, if groupMatch is chosen

category - category to return, if categoryMatch is chosen

settingMatch - amount of settings which match

groupMatch - amount of groups which match

categoryMatch - amount of categories which match

Returns:

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

getCategoryMatch

public Category getCategoryMatch()

Gets the value of the property categoryMatch.

categoryMatchProperty

public javafx.beans.property.ReadOnlyObjectProperty<Category> categoryMatchProperty()

Represents the category which is matched by the search and should ultimately be displayed.

See Also:

getCategoryMatch()