org.dominokit.domino.ui.datatable.plugins

Class TreeGridPlugin<T>

java.lang.Object

org.dominokit.domino.ui.datatable.plugins.TreeGridPlugin<T>

All Implemented Interfaces:

TableEventListener, DataTablePlugin<T>

public class TreeGridPlugin<T>
extends Object
implements DataTablePlugin<T>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TreeGridPlugin.ParentRowCellsSupplier<T> Functional interface to provide the cells to be rendered in a parent row
static interface	TreeGridPlugin.SubItemsProvider<T> A functional interface to supply record children

Field Summary

Fields

Modifier and Type	Field and Description
static int	BASE_PADDING
static int	DEFAULT_INDENT
static String	ICON_ORDER
static String	TREE_GRID_EXPAND_COLLAPSE
static String	TREE_GRID_ROW_LEVEL
static String	TREE_GRID_ROW_SUBITEMS
static String	TREE_GRID_ROW_TOGGLE_ICON

Constructor Summary

Constructors

Constructor and Description
TreeGridPlugin(TreeGridPlugin.SubItemsProvider<T> subItemsProvider)

Method Summary

Modifier and Type	Method and Description
void	collapseAllRows() Collapse all table row
void	collapseRow(TableRow<T> row) If the row has children it will collapse the row.
void	expandAllRows(boolean recursive) Expand all table rows, and based on recursive value it might also recursively expand all children
void	expandRow(TableRow<T> row) If the row has children it will expand the row and recursively expand the row children
void	expandRow(TableRow<T> row, boolean recursive) If the row has children it will expand the row, and based on recursive value it might also expand its children sub-children
Optional<List<elemental2.dom.HTMLElement>>	getUtilityElements(DataTable<T> dataTable, CellRenderer.CellInfo<T> cellInfo) Adds the expand/collapse/leaf icons to the plugins utility columns cells
void	handleEvent(TableEvent event)
void	init(DataTable<T> dataTable) this method is used to initialise the plugin with the datatable instance
void	onBeforeAddRow(DataTable<T> dataTable, TableRow<T> tableRow) This method will be called right before adding a row to the table
void	onHeaderAdded(DataTable<T> dataTable, ColumnConfig<T> column) Adds the Expand all/collpase all to the plugins utility column header This method will be called right after adding a column header element to the table
void	onRowAdded(DataTable<T> dataTable, TableRow<T> tableRow) This method will be called right after adding a row to the table
boolean	requiresUtilityColumn()
TreeGridPlugin<T>	setCollapseIconSupplier(Supplier<BaseIcon<?>> collapseIconSupplier) Sets a supplier for a custom collapse icon instead of the default one
TreeGridPlugin<T>	setExpandIconSupplier(Supplier<BaseIcon<?>> expandIconSupplier) Sets a supplier for a custom expand icon instead of the default one
TreeGridPlugin<T>	setIndent(int indent) Sets indent value to be added for each tree gird level
TreeGridPlugin<T>	setIndentColumnElementSupplier(Function<TableRow<T>,elemental2.dom.Node> indentColumnElementSupplier) Sets a supplier of elements to be appended to the tree grid indent column as part of the utility columns cells
TreeGridPlugin<T>	setLeafIconSupplier(Supplier<BaseIcon<?>> leafIconSupplier) Sets a supplier for a custom leaf row icon instead of the default one
TreeGridPlugin<T>	setParentRowCellsSupplier(TreeGridPlugin.ParentRowCellsSupplier<T> parentRowCellsSupplier) Set a supplier that provides cells to be rendered in a parent row cells, this can be used to provide a custom UI for parent rows

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dominokit.domino.ui.datatable.plugins.DataTablePlugin

onAfterAddHeaders, onAfterAddTable, onAllRowsAdded, onBeforeAddHeaders, onBeforeAddTable, onBodyAdded

Field Detail

TREE_GRID_ROW_LEVEL

public static final String TREE_GRID_ROW_LEVEL

See Also:

Constant Field Values

TREE_GRID_ROW_SUBITEMS

public static final String TREE_GRID_ROW_SUBITEMS

See Also:

Constant Field Values

TREE_GRID_ROW_TOGGLE_ICON

public static final String TREE_GRID_ROW_TOGGLE_ICON

See Also:

Constant Field Values

TREE_GRID_EXPAND_COLLAPSE

public static final String TREE_GRID_EXPAND_COLLAPSE

See Also:

Constant Field Values

DEFAULT_INDENT

public static final int DEFAULT_INDENT

See Also:

Constant Field Values

BASE_PADDING

public static final int BASE_PADDING

See Also:

Constant Field Values

ICON_ORDER

public static final String ICON_ORDER

See Also:

Constant Field Values

Constructor Detail

TreeGridPlugin

public TreeGridPlugin(TreeGridPlugin.SubItemsProvider<T> subItemsProvider)

Method Detail

init

public void init(DataTable<T> dataTable)

this method is used to initialise the plugin with the datatable instance

Specified by:

init in interface DataTablePlugin<T>

Parameters:

dataTable - the DataTable we are attaching this plugin to.

requiresUtilityColumn

public boolean requiresUtilityColumn()

Specified by:

requiresUtilityColumn in interface DataTablePlugin<T>

Returns:

boolean, true if the plugin should use the plugins utility column else false

expandRow

public final void expandRow(TableRow<T> row,
                            boolean recursive)

If the row has children it will expand the row, and based on recursive value it might also expand its children sub-children

Parameters:

row - TableRow to be expanded

recursive - boolean, if true will recursively expand the row children

expandRow

public final void expandRow(TableRow<T> row)

If the row has children it will expand the row and recursively expand the row children

Parameters:

row - TableRow to be expanded

expandAllRows

public final void expandAllRows(boolean recursive)

Expand all table rows, and based on recursive value it might also recursively expand all children

Parameters:

recursive - boolean, if true will recursively expand the row children

collapseRow

public final void collapseRow(TableRow<T> row)

If the row has children it will collapse the row.

Parameters:

row - TableRow to be collapsed

collapseAllRows

public final void collapseAllRows()

Collapse all table row

getUtilityElements

public Optional<List<elemental2.dom.HTMLElement>> getUtilityElements(DataTable<T> dataTable,
                                                                     CellRenderer.CellInfo<T> cellInfo)

Adds the expand/collapse/leaf icons to the plugins utility columns cells

Specified by:

getUtilityElements in interface DataTablePlugin<T>

Parameters:

dataTable - DataTable

cellInfo - CellRenderer.CellInfo

Returns:

return an Optional List of HTMLElements to be used as part of the plugins utility column, elements returned from this method will be rendered as flex items inside the utility cell.

onHeaderAdded

public void onHeaderAdded(DataTable<T> dataTable,
                          ColumnConfig<T> column)

Adds the Expand all/collpase all to the plugins utility column header This method will be called right after adding a column header element to the table

Specified by:

onHeaderAdded in interface DataTablePlugin<T>

Parameters:

dataTable - the DataTable we are attaching this plugin to.

column - the ColumnConfig of the column we added the header for.

onBeforeAddRow

public void onBeforeAddRow(DataTable<T> dataTable,
                           TableRow<T> tableRow)

This method will be called right before adding a row to the table

Specified by:

onBeforeAddRow in interface DataTablePlugin<T>

Parameters:

dataTable - the DataTable we are attaching this plugin to.

tableRow - the TableRow we are about to add

onRowAdded

public void onRowAdded(DataTable<T> dataTable,
                       TableRow<T> tableRow)

This method will be called right after adding a row to the table

Specified by:

onRowAdded in interface DataTablePlugin<T>

Parameters:

dataTable - the DataTable we are attaching this plugin to.

tableRow - the TableRow added

handleEvent

public void handleEvent(TableEvent event)

Specified by:

handleEvent in interface TableEventListener

Specified by:

handleEvent in interface DataTablePlugin<T>

Parameters:

event - the TableEvent being received

setParentRowCellsSupplier

public TreeGridPlugin<T> setParentRowCellsSupplier(TreeGridPlugin.ParentRowCellsSupplier<T> parentRowCellsSupplier)

Set a supplier that provides cells to be rendered in a parent row cells, this can be used to provide a custom UI for parent rows

Parameters:

parentRowCellsSupplier - TreeGridPlugin.ParentRowCellsSupplier

Returns:

Same plugin instance

setExpandIconSupplier

public TreeGridPlugin<T> setExpandIconSupplier(Supplier<BaseIcon<?>> expandIconSupplier)

Sets a supplier for a custom expand icon instead of the default one

Parameters:

expandIconSupplier - Supplier of BaseIcon

Returns:

Same plugin instance

setCollapseIconSupplier

public TreeGridPlugin<T> setCollapseIconSupplier(Supplier<BaseIcon<?>> collapseIconSupplier)

Sets a supplier for a custom collapse icon instead of the default one

Parameters:

collapseIconSupplier - Supplier of BaseIcon

Returns:

Same plugin instance

setLeafIconSupplier

public TreeGridPlugin<T> setLeafIconSupplier(Supplier<BaseIcon<?>> leafIconSupplier)

Sets a supplier for a custom leaf row icon instead of the default one

Parameters:

leafIconSupplier - Supplier of BaseIcon

Returns:

Same plugin instance

setIndent

public TreeGridPlugin<T> setIndent(int indent)

Sets indent value to be added for each tree gird level

Parameters:

indent - int

Returns:

Same plugin instance

setIndentColumnElementSupplier

public TreeGridPlugin<T> setIndentColumnElementSupplier(Function<TableRow<T>,elemental2.dom.Node> indentColumnElementSupplier)

Sets a supplier of elements to be appended to the tree grid indent column as part of the utility columns cells

Parameters:

indentColumnElementSupplier - Function that takes a TableRow and return a Node

Returns:

same plugin instance