org.dominokit.domino.ui.datatable.plugins

Class SelectionPlugin<T>

java.lang.Object

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

Type Parameters:

T - the type of the data table records

All Implemented Interfaces:

TableEventListener, DataTablePlugin<T>

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

This plugin allow selecting/deselecting single or multiple rows based on the TableConfig.isMultiSelect() and fires table selection change events when the user changes the selection.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SelectionPlugin.CheckBoxCreator<T>

Constructor Summary

Constructors

Constructor and Description
SelectionPlugin() creates an instance with default configurations
SelectionPlugin(ColorScheme colorScheme) create an instance that changes the selected row background color
SelectionPlugin(ColorScheme colorScheme, elemental2.dom.HTMLElement singleSelectIndicator) create an instance that changes the selected row background color and use a custom selection indicator icon
SelectionPlugin(ColorScheme colorScheme, org.jboss.elemento.IsElement<?> singleSelectIndicator) create an instance that changes the selected row background color and use a custom selection indicator icon

Method Summary

Modifier and Type	Method and Description
Optional<List<elemental2.dom.HTMLElement>>	getUtilityElements(DataTable<T> dataTable, CellRenderer.CellInfo<T> cellInfo)
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()
SelectionPlugin<T>	setCheckBoxCreator(SelectionPlugin.CheckBoxCreator<T> checkBoxCreator) A setter to give the user the ability to customize the selection checkbox
SelectionPlugin<T>	setSelectionCondition(SelectionCondition<T> selectionCondition) Set a condition to use to determine if a row should be selectable or not
SelectionPlugin<T>	setSingleSelectIcon(BaseIcon<?> singleSelectIcon) Change the single selection indicator 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

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

Constructor Detail

SelectionPlugin

public SelectionPlugin()

creates an instance with default configurations

SelectionPlugin

public SelectionPlugin(ColorScheme colorScheme)

create an instance that changes the selected row background color

Parameters:

colorScheme - ColorScheme the selected row background color

SelectionPlugin

public SelectionPlugin(ColorScheme colorScheme,
                       elemental2.dom.HTMLElement singleSelectIndicator)

create an instance that changes the selected row background color and use a custom selection indicator icon

Parameters:

colorScheme - ColorScheme the selected row background color

singleSelectIndicator - HTMLElement to use a selection indicator

SelectionPlugin

public SelectionPlugin(ColorScheme colorScheme,
                       org.jboss.elemento.IsElement<?> singleSelectIndicator)

create an instance that changes the selected row background color and use a custom selection indicator icon

Parameters:

colorScheme - ColorScheme the selected row background color

singleSelectIndicator - IsElement to use a selection indicator

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

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)

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.

setSingleSelectIcon

public SelectionPlugin<T> setSingleSelectIcon(BaseIcon<?> singleSelectIcon)

Change the single selection indicator icon

Parameters:

singleSelectIcon - BaseIcon

Returns:

same plugin instance

setSelectionCondition

public SelectionPlugin<T> setSelectionCondition(SelectionCondition<T> selectionCondition)

Set a condition to use to determine if a row should be selectable or not

Parameters:

selectionCondition - SelectionCondition

Returns:

Same plugin instance

setCheckBoxCreator

public SelectionPlugin<T> setCheckBoxCreator(SelectionPlugin.CheckBoxCreator<T> checkBoxCreator)

A setter to give the user the ability to customize the selection checkbox

Parameters:

checkBoxCreator - Supplier of CheckBox

Returns:

same plugin instance