Modifier and Type	Class and Description
public abstract static class	FilterView.Filter< the type of the model objects managed by the filter view T> A filter is a predicate that will be used for filtering the elements of an observable list.
public static class	FilterView.FilterGroup< the type of the model objects managed by the filter view T> A filter group consists of a group of filters and has a name.

Modifier and Type	Field and Description
private final ObjectProperty<Predicate<T>>	additionalFilterPredicate
private final ObjectProperty<Node>	extras
private final ReadOnlyListWrapper<T>	filteredItems
private final ListProperty<FilterView.FilterGroup<T>>	filterGroups
private final ReadOnlyObjectWrapper<Predicate<T>>	filterPredicate
private final ListProperty<FilterView.Filter<T>>	filters
private final StringProperty	filterText
private final ListProperty<T>	items
private final IntegerProperty	scrollThreshold
private final SearchTextField	searchTextField
private final BooleanProperty	showHeader
private final StringProperty	subtitle
private final ObjectProperty<Node>	subtitleGraphic
private final ObjectProperty<Callback<String, Predicate<T>>>	textFilterProvider
private final StringProperty	title
private final ObjectProperty<Node>	titleGraphic
private final StringProperty	titlePostfix
private final ObjectProperty<Node>	titlePostfixGraphic

Access	Constructor and Description
public	FilterView()

Method Summary

Modifier and Type	Method and Description
public final ObjectProperty<Predicate<T>>	additionalFilterPredicateProperty()
protected Skin<?>	createDefaultSkin() Overrides javafx.scene.control.Control.createDefaultSkin. Create a new instance of the default skin for this control.
public final ObjectProperty<Node>	Returns: the extra node extrasProperty() An extra node that can be added to the header of the filter view.
public final ReadOnlyListProperty<T>	filteredItemsProperty()
public final ListProperty<FilterView.FilterGroup<T>>	filterGroupsProperty()
public final ReadOnlyObjectProperty<Predicate<T>>	filterPredicateProperty()
public ListProperty<FilterView.Filter<T>>	filtersProperty()
public final StringProperty	Returns: the filter text filterTextProperty() Stores the filter text entered by the user inside the filter text field.
public final Predicate<T>	getAdditionalFilterPredicate()
public final Node	getExtras()
public final ObservableList<T>	getFilteredItems()
public final ObservableList<FilterView.FilterGroup<T>>	getFilterGroups()
public final Predicate<T>	getFilterPredicate()
public ObservableList<FilterView.Filter<T>>	getFilters()
public final String	getFilterText()
public final ObservableList<T>	getItems()
public int	getScrollThreshold()
public final SearchTextField	Returns: the search text field getSearchTextField() Returns the search text field used for entering filter terms.
public final String	getSubtitle()
public Node	getSubtitleGraphic()
public final Callback<String, Predicate<T>>	getTextFilterProvider()
public final String	getTitle()
public final Node	getTitleGraphic()
public final String	getTitlePostfix()
public final Node	getTitlePostfixGraphic()
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 boolean	isShowHeader()
public final ListProperty<T>	Returns: the model itemsProperty() The list of items that will be managed by the view.
public IntegerProperty	scrollThresholdProperty() The threshold number of filters at which a ScrollPane is introduced to handle large number of elements.
public final void	setAdditionalFilterPredicate(Predicate<T> additionalFilterPredicate)
public final void	setExtras(Node extras)
public final void	setFilterGroups(ObservableList<FilterView.FilterGroup<T>> filterGroups)
public void	setFilters(ObservableList<FilterView.Filter<T>> filters)
public final void	setFilterText(String filterText)
public final void	setItems(ObservableList<T> items)
public void	setScrollThreshold(int scrollThreshold)
public final void	setShowHeader(boolean showHeader)
public final void	setSubtitle(String subtitle)
public void	setSubtitleGraphic(Node subtitleGraphic)
public final void	setTextFilterProvider(Callback<String, Predicate<T>> textFilterProvider)
public final void	setTitle(String title)
public final void	setTitleGraphic(Node titleGraphic)
public final void	setTitlePostfix(String titlePostfix)
public final void	setTitlePostfixGraphic(Node titlePostfixGraphic)
public final BooleanProperty	Returns: true if the header will be shown (default is "true") showHeaderProperty() A flag to control whether the title, subtitle, and the search field will be shown or not.
public ObjectProperty<Node>	subtitleGraphicProperty() The graphic node displayed alongside the subtitle label.
public final StringProperty	Returns: the subtitle text subtitleProperty() The subtitle text for the filter view.
public final ObjectProperty<Callback<String, Predicate<T>>>	Returns: the text filter predicate provider textFilterProviderProperty() Returns a filter predicate for a given text.
public final ObjectProperty<Node>	titleGraphicProperty() The graphic node displayed alongside the title label.
public final ObjectProperty<Node>	titlePostfixGraphicProperty() The graphic node displayed alongside the title postfix label.
public final StringProperty	Returns: the title postfix text titlePostfixProperty() A text that can be added to the title text.
public final StringProperty	Returns: the title text titleProperty() The title for the filter view

Field Detail

additionalFilterPredicate	back to summary
private final ObjectProperty<Predicate<T>> additionalFilterPredicate

extras	back to summary
private final ObjectProperty<Node> extras

filteredItems	back to summary
private final ReadOnlyListWrapper<T> filteredItems

filterGroups	back to summary
private final ListProperty<FilterView.FilterGroup<T>> filterGroups

filterPredicate	back to summary
private final ReadOnlyObjectWrapper<Predicate<T>> filterPredicate

filters	back to summary
private final ListProperty<FilterView.Filter<T>> filters

filterText	back to summary
private final StringProperty filterText

items	back to summary
private final ListProperty<T> items

scrollThreshold	back to summary
private final IntegerProperty scrollThreshold

searchTextField	back to summary
private final SearchTextField searchTextField

showHeader	back to summary
private final BooleanProperty showHeader

subtitle	back to summary
private final StringProperty subtitle

subtitleGraphic	back to summary
private final ObjectProperty<Node> subtitleGraphic

textFilterProvider	back to summary
private final ObjectProperty<Callback<String, Predicate<T>>> textFilterProvider

title	back to summary
private final StringProperty title

titleGraphic	back to summary
private final ObjectProperty<Node> titleGraphic

titlePostfix	back to summary
private final StringProperty titlePostfix

titlePostfixGraphic	back to summary
private final ObjectProperty<Node> titlePostfixGraphic

Constructor Detail

FilterView	back to summary
public FilterView()

Method Detail

additionalFilterPredicateProperty	back to summary
public final ObjectProperty<Predicate<T>> additionalFilterPredicateProperty()

createDefaultSkin back to summary

createDefaultSkin	back to summary
protected Skin<?> createDefaultSkin() Overrides javafx.scene.control.Control.createDefaultSkin. Doc from javafx.scene.control.Control.createDefaultSkin. Create a new instance of the default skin for this control. This is called to create a skin for the control if no skin is provided via CSS `-fx-skin` or set explicitly in a sub-class with `setSkin(...)`. Annotations @Override

protected Skin<?> createDefaultSkin()

Overrides javafx.scene.control.Control.createDefaultSkin.

Doc from javafx.scene.control.Control.createDefaultSkin.

Create a new instance of the default skin for this control. This is called to create a skin for the control if no skin is provided via CSS -fx-skin or set explicitly in a sub-class with setSkin(...).

Annotations

@Override

extrasProperty	back to summary
public final ObjectProperty<Node> extrasProperty() An extra node that can be added to the header of the filter view. The node will appear to the right of the (optional) text filter field. Returns:ObjectProperty<Node> the extra node

extrasProperty

back to summary

public final ObjectProperty<Node> extrasProperty()

An extra node that can be added to the header of the filter view. The node will appear to the right of the (optional) text filter field.

Returns:ObjectProperty<Node>: the extra node

filteredItemsProperty	back to summary
public final ReadOnlyListProperty<T> filteredItemsProperty()

filterGroupsProperty	back to summary
public final ListProperty<FilterView.FilterGroup<T>> filterGroupsProperty()

filterPredicateProperty	back to summary
public final ReadOnlyObjectProperty<Predicate<T>> filterPredicateProperty()

filtersProperty	back to summary
public ListProperty<FilterView.Filter<T>> filtersProperty()

filterTextProperty back to summary

filterTextProperty	back to summary
public final StringProperty filterTextProperty() Stores the filter text entered by the user inside the filter text field. Returns:StringProperty the filter text See Also `setTextFilterProvider(Callback)`

public final StringProperty filterTextProperty()

Stores the filter text entered by the user inside the filter text field.

Returns:StringProperty: the filter text
See Also: setTextFilterProvider(Callback)

getAdditionalFilterPredicate	back to summary
public final Predicate<T> getAdditionalFilterPredicate()

getExtras	back to summary
public final Node getExtras()

getFilteredItems	back to summary
public final ObservableList<T> getFilteredItems()

getFilterGroups	back to summary
public final ObservableList<FilterView.FilterGroup<T>> getFilterGroups()

getFilterPredicate	back to summary
public final Predicate<T> getFilterPredicate()

getFilters	back to summary
public ObservableList<FilterView.Filter<T>> getFilters()

getFilterText	back to summary
public final String getFilterText()

getItems	back to summary
public final ObservableList<T> getItems()

getScrollThreshold	back to summary
public int getScrollThreshold()

getSearchTextField	back to summary
public final SearchTextField getSearchTextField() Returns the search text field used for entering filter terms. Returns:SearchTextField the search text field

getSearchTextField

back to summary

public final SearchTextField getSearchTextField()

Returns the search text field used for entering filter terms.

Returns:SearchTextField: the search text field

getSubtitle	back to summary
public final String getSubtitle()

getSubtitleGraphic	back to summary
public Node getSubtitleGraphic()

getTextFilterProvider	back to summary
public final Callback<String, Predicate<T>> getTextFilterProvider()

getTitle	back to summary
public final String getTitle()

getTitleGraphic	back to summary
public final Node getTitleGraphic()

getTitlePostfix	back to summary
public final String getTitlePostfix()

getTitlePostfixGraphic	back to summary
public final Node getTitlePostfixGraphic()

getUserAgentStylesheet back to summary

getUserAgentStylesheet	back to summary
public String getUserAgentStylesheet() Overrides javafx.scene.layout.Region.getUserAgentStylesheet. Doc from javafx.scene.layout.Region.getUserAgentStylesheet. An implementation may specify its own user-agent styles for this Region, and its children, by overriding this method. These styles are used in addition to whatever user-agent stylesheets are in use. This provides a mechanism for third parties to introduce styles for custom controls. The URL is a hierarchical URI of the form [scheme:][//authority][path]. If the URL does not have a [scheme:] component, the URL is considered to be the [path] component only. Any leading '/' character of the [path] is ignored and the [path] is treated as a path relative to the root of the application's classpath. Subclasses overriding this method should not assume any particular implementation approach as to the number and frequency with which it is called. For this reason, attempting any kind of dynamic implementation (i.e. returning different user agent stylesheet values) based on some state change is highly discouraged, as there is no guarantee when, or even if, this method will be called. Some JavaFX CSS implementations may choose to cache this response for an indefinite period of time, and therefore there should be no expectation around when this method is called. `package com.example.javafx.app; import javafx.application.Application; import javafx.scene.Group; import javafx.scene.Scene; import javafx.stage.Stage; public class MyApp extends Application { @Override public void start(Stage stage) { Scene scene = new Scene(new Group()); scene.getStylesheets().add("/com/example/javafx/app/mystyles.css"); stage.setScene(scene); stage.show(); } public static void main(String[] args) { launch(args); } }` For additional information about using CSS with the scene graph, see the CSS Reference Guide. Annotations @Override

public String getUserAgentStylesheet()

Overrides javafx.scene.layout.Region.getUserAgentStylesheet.

Doc from javafx.scene.layout.Region.getUserAgentStylesheet.

An implementation may specify its own user-agent styles for this Region, and its children, by overriding this method. These styles are used in addition to whatever user-agent stylesheets are in use. This provides a mechanism for third parties to introduce styles for custom controls.

The URL is a hierarchical URI of the form [scheme:][//authority][path]. If the URL does not have a [scheme:] component, the URL is considered to be the [path] component only. Any leading '/' character of the [path] is ignored and the [path] is treated as a path relative to the root of the application's classpath.

Subclasses overriding this method should not assume any particular implementation approach as to the number and frequency with which it is called. For this reason, attempting any kind of dynamic implementation (i.e. returning different user agent stylesheet values) based on some state change is highly discouraged, as there is no guarantee when, or even if, this method will be called. Some JavaFX CSS implementations may choose to cache this response for an indefinite period of time, and therefore there should be no expectation around when this method is called.



package com.example.javafx.app;

import javafx.application.Application;
import javafx.scene.Group;
import javafx.scene.Scene;
import javafx.stage.Stage;

public class MyApp extends Application {

    @Override public void start(Stage stage) {
        Scene scene = new Scene(new Group());
        scene.getStylesheets().add("/com/example/javafx/app/mystyles.css");
        stage.setScene(scene);
        stage.show();
    }

    public static void main(String[] args) {
        launch(args);
    }
}

For additional information about using CSS with the scene graph, see the CSS Reference Guide.

Annotations

@Override

isShowHeader	back to summary
public final boolean isShowHeader()

itemsProperty

back to summary

public final ListProperty<T> itemsProperty()

The list of items that will be managed by the view.

Returns:ListProperty<T>: the model

scrollThresholdProperty	back to summary
public IntegerProperty scrollThresholdProperty() The threshold number of filters at which a ScrollPane is introduced to handle large number of elements. If the number of filters is equal to or exceeds this value, the filters will be displayed within a ScrollPane.

setAdditionalFilterPredicate	back to summary
public final void setAdditionalFilterPredicate(Predicate<T> additionalFilterPredicate)

setExtras	back to summary
public final void setExtras(Node extras)

setFilterGroups	back to summary
public final void setFilterGroups(ObservableList<FilterView.FilterGroup<T>> filterGroups)

setFilters	back to summary
public void setFilters(ObservableList<FilterView.Filter<T>> filters)

setFilterText	back to summary
public final void setFilterText(String filterText)

setItems	back to summary
public final void setItems(ObservableList<T> items)

setScrollThreshold	back to summary
public void setScrollThreshold(int scrollThreshold)

setShowHeader	back to summary
public final void setShowHeader(boolean showHeader)

setSubtitle	back to summary
public final void setSubtitle(String subtitle)

setSubtitleGraphic	back to summary
public void setSubtitleGraphic(Node subtitleGraphic)

setTextFilterProvider	back to summary
public final void setTextFilterProvider(Callback<String, Predicate<T>> textFilterProvider)

setTitle	back to summary
public final void setTitle(String title)

setTitleGraphic	back to summary
public final void setTitleGraphic(Node titleGraphic)

setTitlePostfix	back to summary
public final void setTitlePostfix(String titlePostfix)

setTitlePostfixGraphic	back to summary
public final void setTitlePostfixGraphic(Node titlePostfixGraphic)

showHeaderProperty

back to summary

public final BooleanProperty showHeaderProperty()

A flag to control whether the title, subtitle, and the search field will be shown or not.

Returns:BooleanProperty: true if the header will be shown (default is "true")

subtitleGraphicProperty	back to summary
public ObjectProperty<Node> subtitleGraphicProperty() The graphic node displayed alongside the subtitle label.

subtitleProperty

back to summary

public final StringProperty subtitleProperty()

The subtitle text for the filter view.

Returns:StringProperty: the subtitle text

textFilterProviderProperty

back to summary

public final ObjectProperty<Callback<String, Predicate<T>>> textFilterProviderProperty()

Returns a filter predicate for a given text. This predicate will be added to the list of internally managed predicates. The input field for text will only appear if this predicate has been specified.

Returns:ObjectProperty<Callback<String, Predicate<T>>>: the text filter predicate provider

titleGraphicProperty	back to summary
public final ObjectProperty<Node> titleGraphicProperty() The graphic node displayed alongside the title label.

titlePostfixGraphicProperty	back to summary
public final ObjectProperty<Node> titlePostfixGraphicProperty() The graphic node displayed alongside the title postfix label.

titlePostfixProperty

back to summary

public final StringProperty titlePostfixProperty()

A text that can be added to the title text.

Returns:StringProperty: the title postfix text

titleProperty

back to summary

public final StringProperty titleProperty()

The title for the filter view

Returns:StringProperty: the title text

com.dlsc.gemsfx back to summary

public abstract Class FilterView.Filter<T>

Class Inheritance

extends Object
implements Predicate<T>

java.lang.Object
com.dlsc.gemsfx.FilterView.Filter

All Implemented Interfaces

java.util.function.Predicate

Type Parameters

<T>: the type of the model objects managed by the filter view

A filter is a predicate that will be used for filtering the elements of an observable list. A filter may only be added to one FilterGroup.

See Also: FilterGroup#getFilters(), FilteredList#setPredicate(Predicate)

Field Summary

Modifier and Type	Field and Description
private FilterView.FilterGroup<T>	group
private final StringProperty	id
private final StringProperty	name
private boolean	selected

Constructor Summary

Access	Constructor and Description
public	Filter(String the name of the filter (e.g. "Male") name, String the id of the filter id) Constructs a new filter with the given name.
public	Filter(String the name of the filter (e.g. "Male") name) Constructs a new filter with the given name.
public	Filter(String the name of the filter (e.g., "Male") name, boolean the default selected state of the filter; `true` if the filter should be selected by default, `false` otherwise selected) Constructs a new filter with the given name, setting it to the default selected state.
public	Filter(String the name of the filter (e.g., "Male") name, String the id of the filter id, boolean the default selected state of the filter; `true` if the filter should be selected by default, `false` otherwise selected) Constructs a new filter with the given name and id, setting it to the default selected state.

Method Summary

Modifier and Type	Method and Description
public FilterView.FilterGroup<T>	Returns: the filter's "parent" group getGroup() Returns the group to which the filter belongs.
public final String	getId()
public final String	getName()
public final StringProperty	Returns: the ID of the filter group idProperty() An identifier, useful for persisting session state of the filter view.
public boolean	Returns: `true` if the filter is selected by default, `false` otherwise isSelected() Returns the default selected state of the filter.
public final StringProperty	Returns: the filter's name nameProperty() The name of the filter as shown inside the UI.
pack-priv void	setGroup(FilterView.FilterGroup<T> group)
public final void	setId(String id)
public final void	setName(String name)

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

Field Detail

group	back to summary
private FilterView.FilterGroup<T> group

id	back to summary
private final StringProperty id

name	back to summary
private final StringProperty name

selected	back to summary
private boolean selected

Constructor Detail

Filter

back to summary

public Filter(String name, String id)

Constructs a new filter with the given name.

Parameters

name:String: the name of the filter (e.g. "Male")
id:String: the id of the filter

Filter

back to summary

public Filter(String name)

Constructs a new filter with the given name.

Parameters

name:String: the name of the filter (e.g. "Male")

Filter back to summary

public Filter(String name, boolean selected)

Constructs a new filter with the given name, setting it to the default selected state.

Parameters

name:String: the name of the filter (e.g., "Male")
selected:boolean: the default selected state of the filter; true if the filter should be selected by default, false otherwise

Filter back to summary

public Filter(String name, String id, boolean selected)

Constructs a new filter with the given name and id, setting it to the default selected state.

Parameters

name:String: the name of the filter (e.g., "Male")
id:String: the id of the filter
selected:boolean: the default selected state of the filter; true if the filter should be selected by default, false otherwise

Method Detail

getGroup back to summary

public FilterView.FilterGroup<T> getGroup()

Returns the group to which the filter belongs.

Returns:FilterView.FilterGroup<T>: the filter's "parent" group
See Also: FilterGroup#getFilters()

getId	back to summary
public final String getId()

getName	back to summary
public final String getName()

idProperty

back to summary

public final StringProperty idProperty()

An identifier, useful for persisting session state of the filter view.

Returns:StringProperty: the ID of the filter group

isSelected back to summary

public boolean isSelected()

Returns the default selected state of the filter.

Returns:boolean: true if the filter is selected by default, false otherwise

nameProperty

back to summary

public final StringProperty nameProperty()

The name of the filter as shown inside the UI.

Returns:StringProperty: the filter's name

setId	back to summary
public final void setId(String id)

setName	back to summary
public final void setName(String name)

com.dlsc.gemsfx back to summary

public Class FilterView.FilterGroup<T>

Class Inheritance

extends Object

java.lang.Object
com.dlsc.gemsfx.FilterView.FilterGroup

Type Parameters

<T>: the type of the model objects managed by the filter view

A filter group consists of a group of filters and has a name. The name is displayed in the UI as part of the dropdown list that expostes the available filters.

Field Summary

Modifier and Type	Field and Description
private final ListProperty<FilterView.Filter<T>>	filters
private final StringProperty	id
private final StringProperty	name

Constructor Summary

Access	Constructor and Description
public	FilterGroup(String the name that will be shown in the UI, e.g. "Gender" name, String the id of the group id) Constructs a new group.
public	FilterGroup(String name)

Method Summary

Modifier and Type	Method and Description
public final ListProperty<FilterView.Filter<T>>	filtersProperty()
public final ObservableList<FilterView.Filter<T>>	getFilters()
public final String	getId()
public final String	getName()
public final StringProperty	Returns: the ID of the filter group idProperty() An identifier, useful for persisting session state of the filter view.
public final StringProperty	Returns: the filter name nameProperty() The name of the filter as shown in the filter group's dropdown list.
public final void	setFilters(ObservableList<FilterView.Filter<T>> filters)
public final void	setId(String id)
public final void	setName(String name)

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

Field Detail

Constructor Detail

FilterGroup

back to summary

public FilterGroup(String name, String id)

Constructs a new group.

Parameters

name:String: the name that will be shown in the UI, e.g. "Gender"
id:String: the id of the group

public Class FilterView<T>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public abstract Class FilterView.Filter<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class FilterView.FilterGroup<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail