org.eclipse.fx.ui.controls.table

Class TableViewUtil

java.lang.Object

org.eclipse.fx.ui.controls.table.TableViewUtil

public class TableViewUtil
extends java.lang.Object

Helper APIs when working with TableView

Since:

3.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TableViewUtil.TableView_Properties Properties of a TableView one can capture in an Memento

Constructor Summary

Constructors

Constructor and Description
TableViewUtil()

Method Summary

Modifier and Type	Method and Description
static <S> javafx.scene.control.TableView<S>	captureState(javafx.scene.control.TableView<S> view, Memento m, java.util.function.Function<javafx.scene.control.TableColumn<S,?>,java.lang.String> columnKeyProvider, TableViewUtil.TableView_Properties... properties) Capture the state of the TableView
static <S> javafx.scene.control.TableView<S>	captureState(javafx.scene.control.TableView<S> view, Memento m, TableViewUtil.TableView_Properties... properties) Capture the state of the TableView and use the TableColumnBase.getId() for the lookup
static <S> Subscription	enableAutomaticCaptureing(javafx.scene.control.TableView<S> view, Memento m, java.util.function.Function<javafx.scene.control.TableColumn<S,?>,java.lang.String> columnKeyProvider, TableViewUtil.TableView_Properties... properties) Enabled automatic capturing of property changes
static <S> Subscription	enableAutomaticCaptureing(javafx.scene.control.TableView<S> view, Memento m, TableViewUtil.TableView_Properties... properties) Enabled automatic capturing of property changes and use the TableColumnBase.getId() for the lookup
static <S> javafx.scene.control.TableView<S>	restoreState(javafx.scene.control.TableView<S> view, Memento m, java.util.function.Function<javafx.scene.control.TableColumn<S,?>,java.lang.String> columnKeyProvider, TableViewUtil.TableView_Properties... properties) Restore the state of the TableView
static <S> javafx.scene.control.TableView<S>	restoreState(javafx.scene.control.TableView<S> view, Memento m, TableViewUtil.TableView_Properties... properties) Restore the state of the TableView and use the TableColumnBase.getId() for the lookup

Methods inherited from class java.lang.Object

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

Constructor Detail

TableViewUtil

public TableViewUtil()

Method Detail

restoreState

public static <S> javafx.scene.control.TableView<S> restoreState(javafx.scene.control.TableView<S> view,
                                                                 Memento m,
                                                                 TableViewUtil.TableView_Properties... properties)

Restore the state of the TableView and use the TableColumnBase.getId() for the lookup

Parameters:

view - the view

m - the memento used to retrieve stored data from

properties - list of properties to restore or empty to restore all possible properties

Returns:

the view you passed for fluent API useage

restoreState

public static <S> javafx.scene.control.TableView<S> restoreState(javafx.scene.control.TableView<S> view,
                                                                 Memento m,
                                                                 java.util.function.Function<javafx.scene.control.TableColumn<S,?>,java.lang.String> columnKeyProvider,
                                                                 TableViewUtil.TableView_Properties... properties)

Restore the state of the TableView

Parameters:

view - the view

m - the memento used to retrieve stored data from

columnKeyProvider - function used to compute the id for a column

properties - list of properties to restore or empty to restore all possible properties

Returns:

the view you passed for fluent API useage

captureState

public static <S> javafx.scene.control.TableView<S> captureState(javafx.scene.control.TableView<S> view,
                                                                 Memento m,
                                                                 TableViewUtil.TableView_Properties... properties)

Capture the state of the TableView and use the TableColumnBase.getId() for the lookup

Parameters:

view - the view the state is captured of

m - the memento used to store the state

properties - list of properties to restore or empty to restore all possible properties

Returns:

the view you passed for fluent API useage

captureState

public static <S> javafx.scene.control.TableView<S> captureState(javafx.scene.control.TableView<S> view,
                                                                 Memento m,
                                                                 java.util.function.Function<javafx.scene.control.TableColumn<S,?>,java.lang.String> columnKeyProvider,
                                                                 TableViewUtil.TableView_Properties... properties)

Capture the state of the TableView

Parameters:

view - the view the state is captured of

m - the memento used to store the state

columnKeyProvider - function used to compute the id for a column

properties - list of properties to restore or empty to restore all possible properties

Returns:

the view you passed for fluent API useage

enableAutomaticCaptureing

public static <S> Subscription enableAutomaticCaptureing(javafx.scene.control.TableView<S> view,
                                                         Memento m,
                                                         TableViewUtil.TableView_Properties... properties)

Enabled automatic capturing of property changes and use the TableColumnBase.getId() for the lookup

Parameters:

view - the view

m - the memento

properties - list of properties to restore or empty to restore all possible properties

Returns:

subscription object who can be disposed to end the capturing

enableAutomaticCaptureing

public static <S> Subscription enableAutomaticCaptureing(javafx.scene.control.TableView<S> view,
                                                         Memento m,
                                                         java.util.function.Function<javafx.scene.control.TableColumn<S,?>,java.lang.String> columnKeyProvider,
                                                         TableViewUtil.TableView_Properties... properties)

Enabled automatic capturing of property changes

Parameters:

view - the view

m - the memento

columnKeyProvider - function used to compute the id for a column

properties - list of properties to restore or empty to restore all possible properties

Returns:

subscription object who can be disposed to end the capturing