org.dominokit.domino.ui.datatable.plugins

Interface DataTablePlugin<T>

Type Parameters:

T - the type of the datatable records

All Superinterfaces:

TableEventListener

All Known Implementing Classes:

AdvancedPaginationPlugin, BodyScrollPlugin, ColumnHeaderFilterPlugin, DoubleClickPlugin, EmptyStatePlugin, GroupingPlugin, HeaderBarPlugin, RecordDetailsPlugin, RowClickPlugin, RowMarkerPlugin, ScrollingPaginationPlugin, SelectionPlugin, SimplePaginationPlugin, SortPlugin, TopPanelPlugin, TreeGridPlugin

public interface DataTablePlugin<T>
extends TableEventListener

An interface for implementing datatable plugins

the methods in this interface are all hood methods that will be called on specific places while building the data table

Method Summary

Modifier and Type	Method and Description
default Optional<List<elemental2.dom.HTMLElement>>	getUtilityElements(DataTable<T> dataTable, CellRenderer.CellInfo<T> cellInfo)
default void	handleEvent(TableEvent event)
default void	init(DataTable<T> dataTable) this method is used to initialise the plugin with the datatable instance
default void	onAfterAddHeaders(DataTable<T> dataTable) This method will be called right after adding all columns headers elements to the table
default void	onAfterAddTable(DataTable<T> dataTable) This method will be called right after adding the table element to its root element
default void	onAllRowsAdded(DataTable<T> dataTable) This method will be called right after all rows are added to the table
default void	onBeforeAddHeaders(DataTable<T> dataTable) This method will be called right before adding all columns headers elements to the table
default void	onBeforeAddRow(DataTable<T> dataTable, TableRow<T> tableRow) This method will be called right before adding a row to the table
default void	onBeforeAddTable(DataTable<T> dataTable) This well be called once the table is initialized and before it is appended to the dom
default void	onBodyAdded(DataTable<T> dataTable) This method will be called right after adding body element to the table
default void	onHeaderAdded(DataTable<T> dataTable, ColumnConfig<T> column) This method will be called right after adding a column header element to the table
default void	onRowAdded(DataTable<T> dataTable, TableRow<T> tableRow) This method will be called right after adding a row to the table
default boolean	requiresUtilityColumn()

Method Detail

init

default void init(DataTable<T> dataTable)

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

Parameters:

dataTable - the DataTable we are attaching this plugin to.

onBeforeAddTable

default void onBeforeAddTable(DataTable<T> dataTable)

This well be called once the table is initialized and before it is appended to the dom

Parameters:

dataTable - the DataTable we are attaching this plugin to.

onBeforeAddHeaders

default void onBeforeAddHeaders(DataTable<T> dataTable)

This method will be called right before adding all columns headers elements to the table

Parameters:

dataTable - the DataTable we are attaching this plugin to.

onAfterAddHeaders

default void onAfterAddHeaders(DataTable<T> dataTable)

This method will be called right after adding all columns headers elements to the table

Parameters:

dataTable - the DataTable we are attaching this plugin to.

onHeaderAdded

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

This method will be called right after adding a column header element to the table

Parameters:

dataTable - the DataTable we are attaching this plugin to.

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

onBodyAdded

default void onBodyAdded(DataTable<T> dataTable)

This method will be called right after adding body element to the table

Parameters:

dataTable - the DataTable we are attaching this plugin to.

onBeforeAddRow

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

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

Parameters:

dataTable - the DataTable we are attaching this plugin to.

tableRow - the TableRow we are about to add

onRowAdded

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

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

Parameters:

dataTable - the DataTable we are attaching this plugin to.

tableRow - the TableRow added

onAllRowsAdded

default void onAllRowsAdded(DataTable<T> dataTable)

This method will be called right after all rows are added to the table

Parameters:

dataTable - the DataTable we are attaching this plugin to.

onAfterAddTable

default void onAfterAddTable(DataTable<T> dataTable)

This method will be called right after adding the table element to its root element

Parameters:

dataTable - the DataTable we are attaching this plugin to.

handleEvent

default void handleEvent(TableEvent event)

Specified by:

handleEvent in interface TableEventListener

Parameters:

event - the TableEvent being received

requiresUtilityColumn

default boolean requiresUtilityColumn()

Returns:

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

getUtilityElements

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

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.