Module org.controlsfx.controls
Package org.controlsfx.control.tableview2

Class FilteredTableColumn<S,T>

java.lang.Object
javafx.scene.control.TableColumnBase<S,T>
javafx.scene.control.TableColumn<S,T>
org.controlsfx.control.tableview2.TableColumn2<S,T>
org.controlsfx.control.tableview2.FilteredTableColumn<S,T>
Type Parameters:
S - The type of the objects contained within the TableView items list.
T - The type of the content in all cells in this TableColumn
All Implemented Interfaces:
Styleable, EventTarget
public class FilteredTableColumn<S,T> extends TableColumn2<S,T>
An extension of TableColumn2 that allows filtering options. A filter button is displayed in the column header. If no predicate is applied to the column, it is grayed, else it is blue. The developer can select the action that will be performed when this button is clicked.

  • Property Details

  • Constructor Details

    • FilteredTableColumn

      public FilteredTableColumn()
      Creates a FilteredTableColumn control.

    • FilteredTableColumn

      public FilteredTableColumn(String text)

  • Method Details

    • setFilterable

      public final void setFilterable(boolean value)
      Sets the value of the property filterable.
      Property description:
      When the filterable property is set to true, the column can be filtered.

    • isFilterable

      public final boolean isFilterable()
      Gets the value of the property filterable.
      Property description:
      When the filterable property is set to true, the column can be filtered.

    • filterableProperty

      public final BooleanProperty filterableProperty()
      When the filterable property is set to true, the column can be filtered.
      See Also:

    • setPredicate

      public final void setPredicate(Predicate<? super T> value)
      Sets the value of the property predicate.
      Property description:
      This property allows defining a predicate for the column. This predicate can be nullified when the table's predicate is reset, so it is convenient that this property can be set again dynamically via the UI option TableColumn2.southNode.

    • getPredicate

      public final Predicate<? super T> getPredicate()
      Gets the value of the property predicate.
      Property description:
      This property allows defining a predicate for the column. This predicate can be nullified when the table's predicate is reset, so it is convenient that this property can be set again dynamically via the UI option TableColumn2.southNode.

    • predicateProperty

      public final ObservableValue<Predicate<? super T>> predicateProperty()
      This property allows defining a predicate for the column. This predicate can be nullified when the table's predicate is reset, so it is convenient that this property can be set again dynamically via the UI option TableColumn2.southNode.
      See Also:

    • onFilterActionProperty

      public final ObjectProperty<EventHandler<ActionEvent>> onFilterActionProperty()
      The filter button's action, which is invoked whenever the filter button is fired.
      See Also:

    • setOnFilterAction

      public final void setOnFilterAction(EventHandler<ActionEvent> value)
      Sets the value of the property onFilterAction.
      Property description:
      The filter button's action, which is invoked whenever the filter button is fired.

    • getOnFilterAction

      public final EventHandler<ActionEvent> getOnFilterAction()
      Gets the value of the property onFilterAction.
      Property description:
      The filter button's action, which is invoked whenever the filter button is fired.