org.dominokit.domino.ui.datatable.plugins

Class RecordDetailsPlugin<T>

java.lang.Object

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

Type Parameters:

T - the type of the data table records

All Implemented Interfaces:

TableEventListener, DataTablePlugin<T>

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

This plugin add the capability to expand a row in the table to display more information about its record beneath the row itself

Constructor Summary

Constructors

Constructor and Description
RecordDetailsPlugin(CellRenderer<T> cellRenderer) Creates an instance with custom renderer and default expand/collapse icons
RecordDetailsPlugin(CellRenderer<T> cellRenderer, BaseIcon<?> collapseIcon, BaseIcon<?> expandIcon) Creates an instance with custom renderer and expand/collapse icons

Method Summary

Modifier and Type	Method and Description
void	applyStyles(CellRenderer.CellInfo<T> cellInfo)
elemental2.dom.HTMLDivElement	getElement()
elemental2.dom.HTMLTableCellElement	getTd()
elemental2.dom.HTMLTableRowElement	getTr()
Optional<List<elemental2.dom.HTMLElement>>	getUtilityElements(DataTable<T> dataTable, CellRenderer.CellInfo<T> cell)
void	handleEvent(TableEvent event)
void	onBeforeAddHeaders(DataTable<T> dataTable) This method will be called right before adding all columns headers elements to the table
void	onHeaderAdded(DataTable<T> dataTable, ColumnConfig<T> column) This method will be called right after adding a column header element to the table
boolean	requiresUtilityColumn()
void	setupColumn(ColumnConfig<T> column) A hook method to customize the column of the expand/collapse icons

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

init, onAfterAddHeaders, onAfterAddTable, onAllRowsAdded, onBeforeAddRow, onBeforeAddTable, onBodyAdded, onRowAdded

Constructor Detail

RecordDetailsPlugin

public RecordDetailsPlugin(CellRenderer<T> cellRenderer)

Creates an instance with custom renderer and default expand/collapse icons

Parameters:

cellRenderer - the CellRenderer

RecordDetailsPlugin

public RecordDetailsPlugin(CellRenderer<T> cellRenderer,
                           BaseIcon<?> collapseIcon,
                           BaseIcon<?> expandIcon)

Creates an instance with custom renderer and expand/collapse icons

Parameters:

cellRenderer - the CellRenderer

collapseIcon - BaseIcon

expandIcon - BaseIcon

Method Detail

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

getUtilityElements

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

Specified by:

getUtilityElements in interface DataTablePlugin<T>

Parameters:

dataTable - DataTable

cell - 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)

Description copied from interface: DataTablePlugin

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.

onBeforeAddHeaders

public void onBeforeAddHeaders(DataTable<T> dataTable)

Description copied from interface: DataTablePlugin

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

Specified by:

onBeforeAddHeaders in interface DataTablePlugin<T>

Parameters:

dataTable - the DataTable we are attaching this plugin to.

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

getElement

public elemental2.dom.HTMLDivElement getElement()

Returns:

the root HTMLDivElement of this component

getTd

public elemental2.dom.HTMLTableCellElement getTd()

Returns:

the HTMLTableCellElement that contains the records details

getTr

public elemental2.dom.HTMLTableRowElement getTr()

Returns:

the HTMLTableRowElement that contains the records details

applyStyles

public void applyStyles(CellRenderer.CellInfo<T> cellInfo)

setupColumn

public void setupColumn(ColumnConfig<T> column)

A hook method to customize the column of the expand/collapse icons

Parameters:

column - ColumnConfig