org.dominokit.domino.ui.datatable.plugins

Class ColumnHeaderFilterPlugin<T>

java.lang.Object

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

Type Parameters:

T - the type of the data table records

All Implemented Interfaces:

TableEventListener, DataTablePlugin<T>

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

This plugin adds header filters to table columns headers

 tableConfig
         .addPlugin(ColumnHeaderFilterPlugin.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ColumnHeaderFilterPlugin.HeaderFilter<T> An interface for implementing HeaderFilters

Constructor Summary

Constructors

Constructor and Description
ColumnHeaderFilterPlugin()

Method Summary

Modifier and Type	Method and Description
ColumnHeaderFilterPlugin<T>	addHeaderFilter(String columnName, ColumnHeaderFilterPlugin.HeaderFilter headerFilter) Adds a new header filter to the plugin
static <T> ColumnHeaderFilterPlugin<T>	create() Create a new instance
DominoElement<elemental2.dom.HTMLTableRowElement>	getFiltersRowElement()
void	handleEvent(TableEvent event)
void	onAfterAddHeaders(DataTable<T> dataTable) This method will be called right after adding all columns headers elements to the table

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, init, onAfterAddTable, onAllRowsAdded, onBeforeAddHeaders, onBeforeAddRow, onBeforeAddTable, onBodyAdded, onHeaderAdded, onRowAdded, requiresUtilityColumn

Constructor Detail

ColumnHeaderFilterPlugin

public ColumnHeaderFilterPlugin()

Method Detail

create

public static <T> ColumnHeaderFilterPlugin<T> create()

Create a new instance

Type Parameters:

T - the type of the data table records

Returns:

new instance

onAfterAddHeaders

public void onAfterAddHeaders(DataTable<T> dataTable)

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

Specified by:

onAfterAddHeaders in interface DataTablePlugin<T>

Parameters:

dataTable - the DataTable we are attaching this plugin to.

addHeaderFilter

public ColumnHeaderFilterPlugin<T> addHeaderFilter(String columnName,
                                                   ColumnHeaderFilterPlugin.HeaderFilter headerFilter)

Adds a new header filter to the plugin

Parameters:

columnName - String, the name of the column we are adding the header filter to.

headerFilter - the ColumnHeaderFilterPlugin.HeaderFilter

Returns:

same instance

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

getFiltersRowElement

public DominoElement<elemental2.dom.HTMLTableRowElement> getFiltersRowElement()

Returns:

The table row element that contains the header filters components