org.dominokit.domino.ui.datatable.plugins

Class HeaderBarPlugin<T>

java.lang.Object

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

Type Parameters:

T - the type of the data table records

All Implemented Interfaces:

TableEventListener, DataTablePlugin<T>

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

This plugin attach an action bar to the table and adds HeaderActionElement(s) to it

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HeaderBarPlugin.BordersTableAction<T> A predefined action to toggle borders on data table rows
static class	HeaderBarPlugin.ClearSearch<T> A predefined action to clear data table search
static class	HeaderBarPlugin.CondenseTableAction<T> a Predefined HeaderActionElement that condense/expand the data table rows
static class	HeaderBarPlugin.HoverTableAction<T> A predefined action to toggle hover on data table rows
static class	HeaderBarPlugin.SearchTableAction<T> A predefined action to add a search box the data table
static class	HeaderBarPlugin.ShowHideColumnsAction<T> A predefined action to add a drop down to the data table that allow selecting which columns be shown/hidden
static class	HeaderBarPlugin.StripesTableAction<T> A predefined action to toggle stripes on data table rows

Constructor Summary

Constructors

Constructor and Description
HeaderBarPlugin(String title) creates an instance with a custom title
HeaderBarPlugin(String title, String description) creates an instance with a custom and description

Method Summary

Modifier and Type	Method and Description
HeaderBarPlugin<T>	addActionElement(HeaderActionElement<T> headerActionElement) Adds a new header action to this header bar
void	onBeforeAddTable(DataTable<T> dataTable) This well be called once the table is initialized and before it is appended to the dom

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

Constructor Detail

HeaderBarPlugin

public HeaderBarPlugin(String title)

creates an instance with a custom title

Parameters:

title - String title of the header bar

HeaderBarPlugin

public HeaderBarPlugin(String title,
                       String description)

creates an instance with a custom and description

Parameters:

title - String title of the header bar

description - String description of the header bar

Method Detail

onBeforeAddTable

public void onBeforeAddTable(DataTable<T> dataTable)

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

Specified by:

onBeforeAddTable in interface DataTablePlugin<T>

Parameters:

dataTable - the DataTable we are attaching this plugin to.

addActionElement

public HeaderBarPlugin<T> addActionElement(HeaderActionElement<T> headerActionElement)

Adds a new header action to this header bar

Parameters:

headerActionElement - the HeaderActionElement

Returns:

same plugin instance