org.dominokit.domino.ui.datatable.plugins

Class SortPlugin<T>

java.lang.Object

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

Type Parameters:

T - the type of the data table records

All Implemented Interfaces:

TableEventListener, DataTablePlugin<T>

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

This plugin adds sort capability to column headers on click

Constructor Summary

Constructors

Constructor and Description
SortPlugin()

Method Summary

Modifier and Type	Method and Description
void	handleEvent(TableEvent event)
void	init(DataTable<T> dataTable) this method is used to initialise the plugin with the datatable instance
void	onHeaderAdded(DataTable<T> dataTable, ColumnConfig<T> column) This method will be called right after adding a column header element to the table
void	sort(SortDirection direction, ColumnConfig<T> column) manually sort the table by the specified column and fires the SortEvent

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, onRowAdded, requiresUtilityColumn

Constructor Detail

SortPlugin

public SortPlugin()

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.

onHeaderAdded

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

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.

sort

public void sort(SortDirection direction,
                 ColumnConfig<T> column)

manually sort the table by the specified column and fires the SortEvent

Parameters:

direction - the SortDirection

column - the sort ColumnConfig

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