org.dominokit.domino.ui.datatable.plugins

Class GroupingPlugin<T>

java.lang.Object

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

Type Parameters:

T - the type of the data table records

All Implemented Interfaces:

TableEventListener, DataTablePlugin<T>, TableConfig.RowAppender<T>

public class GroupingPlugin<T>
extends Object
implements DataTablePlugin<T>, TableConfig.RowAppender<T>

This plugin renders the table rows in groups.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GroupingPlugin.DataGroup<T>
static interface	GroupingPlugin.GroupSupplier<T> this interface is to provide an implementation to define each row group

Constructor Summary

Constructors

Constructor and Description
GroupingPlugin(GroupingPlugin.GroupSupplier<T> groupSupplier, CellRenderer<T> groupRenderer) Create an instance with custom group supplier and group cell renderer

Method Summary

Modifier and Type	Method and Description
void	appendRow(DataTable<T> dataTable, TableRow<T> tableRow) Appends a row to the data table
void	collapseAll() Collapse all the current groups in the data table
void	expandAll() Expands all the current groups in the data table
Map<String,GroupingPlugin.DataGroup<T>>	getDataGroups()
void	handleEvent(TableEvent event)
void	init(DataTable<T> dataTable) this method is used to initialise the plugin with the datatable instance
GroupingPlugin<T>	setGroupCollapsedIcon(Supplier<BaseIcon<?>> groupCollapsedIconSupplier) Changes the group collapse icon
GroupingPlugin<T>	setGroupExpandedIcon(Supplier<BaseIcon<?>> groupExpandedIconSupplier) Changes the group expand icon

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

getUtilityElements, onAfterAddHeaders, onAfterAddTable, onAllRowsAdded, onBeforeAddHeaders, onBeforeAddRow, onBeforeAddTable, onBodyAdded, onHeaderAdded, onRowAdded, requiresUtilityColumn

Constructor Detail

GroupingPlugin

public GroupingPlugin(GroupingPlugin.GroupSupplier<T> groupSupplier,
                      CellRenderer<T> groupRenderer)

Create an instance with custom group supplier and group cell renderer

Parameters:

groupSupplier - the GroupingPlugin.GroupSupplier

groupRenderer - the CellRenderer

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.

setGroupExpandedIcon

public GroupingPlugin<T> setGroupExpandedIcon(Supplier<BaseIcon<?>> groupExpandedIconSupplier)

Changes the group expand icon

Parameters:

groupExpandedIconSupplier - Supplier of BaseIcon to change the icon

Returns:

same plugin instance

setGroupCollapsedIcon

public GroupingPlugin<T> setGroupCollapsedIcon(Supplier<BaseIcon<?>> groupCollapsedIconSupplier)

Changes the group collapse icon

Parameters:

groupCollapsedIconSupplier - Supplier of BaseIcon to change the icon

Returns:

same plugin instance

appendRow

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

Appends a row to the data table

the plugin will create a group based on the GroupSupplier and will append rows to the first group matching the criteria

Specified by:

appendRow in interface TableConfig.RowAppender<T>

Parameters:

dataTable - the DataTable

tableRow - the TableRow being appended

expandAll

public void expandAll()

Expands all the current groups in the data table

collapseAll

public void collapseAll()

Collapse all the current groups in the data table

getDataGroups

public Map<String,GroupingPlugin.DataGroup<T>> getDataGroups()

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