org.eclipse.fx.ui.controls.tree

Class TreeTableViewUtil

java.lang.Object

org.eclipse.fx.ui.controls.tree.TreeTableViewUtil

public class TreeTableViewUtil
extends java.lang.Object

Helper APIs when working with TreeTableView

Since:

3.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TreeTableViewUtil.TreeTableView_Properties Properties of a TreeTableView one can capture in an Memento

Constructor Summary

Constructors

Constructor and Description
TreeTableViewUtil()

Method Summary

Modifier and Type	Method and Description
static <S> javafx.scene.control.TreeTableView<S>	captureState(javafx.scene.control.TreeTableView<S> view, Memento m, java.util.function.Function<javafx.scene.control.TreeTableColumn<S,?>,java.lang.String> columnKeyProvider, TreeTableViewUtil.TreeTableView_Properties... properties) Capture the state of the TreeTableView
static <S> javafx.scene.control.TreeTableView<S>	captureState(javafx.scene.control.TreeTableView<S> view, Memento m, TreeTableViewUtil.TreeTableView_Properties... properties) Capture the state of the TreeTableView and use the TableColumnBase.getId() for the lookup
static <S> Subscription	enableAutomaticCaptureing(javafx.scene.control.TreeTableView<S> view, Memento m, java.util.function.Function<javafx.scene.control.TreeTableColumn<S,?>,java.lang.String> columnKeyProvider, TreeTableViewUtil.TreeTableView_Properties... properties) Enabled automatic capturing of property changes
static <S> Subscription	enableAutomaticCaptureing(javafx.scene.control.TreeTableView<S> view, Memento m, TreeTableViewUtil.TreeTableView_Properties... properties) Enabled automatic capturing of property changes and use the TableColumnBase.getId() for the lookup
static <S> javafx.scene.control.TreeTableView<S>	restoreState(javafx.scene.control.TreeTableView<S> view, Memento m, java.util.function.Function<javafx.scene.control.TreeTableColumn<S,?>,java.lang.String> columnKeyProvider, TreeTableViewUtil.TreeTableView_Properties... properties) Restore the state of the TreeTableView
static <S> javafx.scene.control.TreeTableView<S>	restoreState(javafx.scene.control.TreeTableView<S> view, Memento m, TreeTableViewUtil.TreeTableView_Properties... properties) Restore the state of the TreeTableView 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

TreeTableViewUtil

public TreeTableViewUtil()

Method Detail

restoreState

public static <S> javafx.scene.control.TreeTableView<S> restoreState(javafx.scene.control.TreeTableView<S> view,
                                                                     Memento m,
                                                                     TreeTableViewUtil.TreeTableView_Properties... properties)

Restore the state of the TreeTableView 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.TreeTableView<S> restoreState(javafx.scene.control.TreeTableView<S> view,
                                                                     Memento m,
                                                                     java.util.function.Function<javafx.scene.control.TreeTableColumn<S,?>,java.lang.String> columnKeyProvider,
                                                                     TreeTableViewUtil.TreeTableView_Properties... properties)

Restore the state of the TreeTableView

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.TreeTableView<S> captureState(javafx.scene.control.TreeTableView<S> view,
                                                                     Memento m,
                                                                     TreeTableViewUtil.TreeTableView_Properties... properties)

Capture the state of the TreeTableView 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.TreeTableView<S> captureState(javafx.scene.control.TreeTableView<S> view,
                                                                     Memento m,
                                                                     java.util.function.Function<javafx.scene.control.TreeTableColumn<S,?>,java.lang.String> columnKeyProvider,
                                                                     TreeTableViewUtil.TreeTableView_Properties... properties)

Capture the state of the TreeTableView

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.TreeTableView<S> view,
                                                         Memento m,
                                                         TreeTableViewUtil.TreeTableView_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.TreeTableView<S> view,
                                                         Memento m,
                                                         java.util.function.Function<javafx.scene.control.TreeTableColumn<S,?>,java.lang.String> columnKeyProvider,
                                                         TreeTableViewUtil.TreeTableView_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