org.dominokit.domino.ui.datatable

Class DataTable<T>

java.lang.Object

org.dominokit.domino.ui.utils.BaseDominoElement<elemental2.dom.HTMLDivElement,DataTable<T>>

org.dominokit.domino.ui.datatable.DataTable<T>

Type Parameters:

T - the type of the data table records

All Implemented Interfaces:

DominoStyle<elemental2.dom.HTMLDivElement,DataTable<T>,DataTable<T>>, HasChildren<DataTable<T>>, HasSelectionSupport<TableRow<T>>, HasWavesElement, IsCollapsible<DataTable<T>>, IsReadOnly<DataTable<T>>, org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>

public class DataTable<T>
extends BaseDominoElement<elemental2.dom.HTMLDivElement,DataTable<T>>
implements HasSelectionSupport<TableRow<T>>

The data table component

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DataTable.LocalRowFilter<T> Use implement Table row filter
static interface	DataTable.SelectionChangeListener<T> Listens to changes in the table rows selection

Nested classes/interfaces inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

BaseDominoElement.ElementHandler<T>, BaseDominoElement.ResizeHandler<T>, BaseDominoElement.StyleEditor<E extends elemental2.dom.HTMLElement,T extends org.jboss.elemento.IsElement<E>>, BaseDominoElement.WavesStyler

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANY Use this constant to register a table event listener that listen to all events
static String	DATA_TABLE_ROW_FILTERED Use this constant as flag value to check if a row in the data tables have been filtered out

Fields inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

element

Constructor Summary

Constructors

Constructor and Description
DataTable(TableConfig<T> tableConfig, DataStore<T> dataStore) Creates a new data table instance

Method Summary

Modifier and Type	Method and Description
void	addSelectionListener(DataTable.SelectionChangeListener<T> selectionChangeListener) Add a listener to listen to data table selection changes
void	addTableEventListener(String type, TableEventListener listener) Adds a table event listener by event type
void	addTableEventListner(String type, TableEventListener listener) Deprecated. use addTableEventListener(String, TableEventListener)
void	appendData(List<T> newData) Appends more records to the current data list of the table
DominoElement<elemental2.dom.HTMLTableSectionElement>	bodyElement()
DataTable<T>	bordered() Adds borders from the data table rows
DataTable<T>	cancelEditing() Cancel editing of all table rows
void	clearRowFilters() Clear all filtration applied using filterRows(LocalRowFilter)
DataTable<T>	condense() Decreases the height of the data table rows
void	deselectAll() Deselect all table rows
void	deselectAll(SelectionCondition<T> selectionCondition) Deselect all table rows that match a condition
DataTable<T>	edit() Render all table rows in editable mode
elemental2.dom.HTMLDivElement	element()
void	filterRows(DataTable.LocalRowFilter<T> rowFilter) Immediately filter the current table rows using the the specified filter
void	fireTableEvent(TableEvent tableEvent) Manually fire a table event
Collection<T>	getData()
DataStore<T>	getDataStore()
List<T>	getDirtyRecords()
List<TableRow<T>>	getItems() Deprecated.
List<T>	getRecords()
List<TableRow<T>>	getRootRows()
List<TableRow<T>>	getRows()
SearchContext	getSearchContext()
List<TableRow<T>>	getSelectedItems()
List<T>	getSelectedRecords()
TableConfig<T>	getTableConfig()
DominoElement<elemental2.dom.HTMLTableSectionElement>	headerElement()
DataTable<T>	hovered() Adds the hover effect to the data table rows
boolean	isBordered()
boolean	isCondensed()
boolean	isHoverable()
boolean	isSelectable()
boolean	isStriped()
void	load() Force loading the data into the table
DataTable<T>	noBorder() Remove the borders from the data table rows
DataTable<T>	noHover() removes the hover effect from data table rows
DataTable<T>	noStripes() Remove the background alternation from the data table rows
void	onSelectionChange(TableRow<T> source) Called when an item selection is changed, implementation can delegate to a list listeners
void	removeSelectionListener(DataTable.SelectionChangeListener<T> selectionChangeListener)
void	removeTableListener(String type, TableEventListener listener) Removes a table event listener by event type
DataTable<T>	save() Saves all editable table rows changes
void	selectAll() Select all table rows
void	selectAll(SelectionCondition<T> selectionCondition) Select all table rows that match a condition
void	setData(List<T> data) Set the table data
DataTable<T>	striped() Adds background alternation from the data table rows
DominoElement<elemental2.dom.HTMLTableElement>	tableElement()
DataTable<T>	uncondense() Increases the height of the data table rows

Methods inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

add, add, addClickListener, addCss, addCss, addEventListener, addEventListener, addEventsListener, addHideListener, addShowListener, alignCenter, alignRight, appendChild, appendChild, apply, attr, blur, childNodes, clearElement, contains, contains, contains, containsCss, css, css, cssClassByIndex, cssClassesCount, cssText, disable, elevate, elevate, enable, firstChild, getAttachObserver, getAttribute, getBoundingClientRect, getChildElementCount, getClickableElement, getCollapsible, getCollapsibleElement, getDetachObserver, getDominoId, getElementsCount, getElevation, getFirstChild, getId, getTextContent, getTooltip, getWavesElement, hasAttribute, hasChildNodes, hasDirectChild, hide, hideOn, id, init, insertAfter, insertAfter, insertAfter, insertAfter, insertBefore, insertBefore, insertBefore, insertBefore, insertFirst, insertFirst, insertFirst, isAttached, isCollapsed, isDisabled, isEmptyElement, isEqualNode, isForceHidden, isHidden, isReadOnly, item, lastChild, length, onAttached, onDetached, onResize, pullLeft, pullRight, querySelector, querySelectorAll, remove, removeAttachObserver, removeAttribute, removeChild, removeChild, removeCss, removeCss, removeCssProperty, removeDetachObserver, removeEventListener, removeEventListener, removeHideListener, removeHideOn, removeShowListener, removeShowOn, removeTooltip, removeWaves, replaceCss, setAlignItems, setAttribute, setAttribute, setAttribute, setBackgroundColor, setBackgroundColor, setBorder, setBorderColor, setBottom, setBottom, setBoxShadow, setCollapseStrategy, setColor, setColor, setContent, setContent, setCssProperty, setCssProperty, setCursor, setCursor, setDisabled, setDisplay, setDisplay, setDropMenu, setFlex, setFloat, setFloat, setFontSize, setFontSize, setForceHidden, setHeight, setHeight, setId, setInnerHtml, setLeft, setLeft, setLineHeight, setLineHeight, setMargin, setMargin, setMarginBottom, setMarginBottom, setMarginLeft, setMarginLeft, setMarginRight, setMarginRight, setMarginTop, setMarginTop, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setOpacity, setOpacity, setOverFlow, setOverFlow, setOverFlowY, setPadding, setPadding, setPaddingBottom, setPaddingBottom, setPaddingLeft, setPaddingLeft, setPaddingRight, setPaddingRight, setPaddingTop, setPaddingTop, setPointerEvents, setPosition, setPosition, setReadOnly, setRight, setRight, setTabIndex, setTextAlign, setTextAlign, setTextContent, setTooltip, setTooltip, setTooltip, setTooltip, setTop, setTop, setTransitionDuration, setWidth, setWidth, setZIndex, show, showOn, style, style, styler, textContent, toggleDisplay, toggleDisplay, withWaves, withWaves

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.utils.IsCollapsible

isExpanded

Methods inherited from interface org.dominokit.domino.ui.style.DominoStyle

add, add, remove, remove, removeProperty, replace, setProperty, setProperty

Field Detail

ANY

public static final String ANY

Use this constant to register a table event listener that listen to all events

See Also:

Constant Field Values

DATA_TABLE_ROW_FILTERED

public static final String DATA_TABLE_ROW_FILTERED

Use this constant as flag value to check if a row in the data tables have been filtered out

See Also:

Constant Field Values

Constructor Detail

DataTable

public DataTable(TableConfig<T> tableConfig,
                 DataStore<T> dataStore)

Creates a new data table instance

Parameters:

tableConfig - the TableConfig

dataStore - the DataStore

Method Detail

getDataStore

public DataStore<T> getDataStore()

load

public void load()

Force loading the data into the table

setData

public void setData(List<T> data)

Set the table data

Parameters:

data - List of T

appendData

public void appendData(List<T> newData)

Appends more records to the current data list of the table

Parameters:

newData - List of T

getData

public Collection<T> getData()

Returns:

the Collection of T that is the current data in the table

uncondense

public DataTable<T> uncondense()

Increases the height of the data table rows

Returns:

same DataTable instance

condense

public DataTable<T> condense()

Decreases the height of the data table rows

Returns:

same DataTable instance

noHover

public DataTable<T> noHover()

removes the hover effect from data table rows

Returns:

same DataTable instance

hovered

public DataTable<T> hovered()

Adds the hover effect to the data table rows

Returns:

same DataTable instance

noBorder

public DataTable<T> noBorder()

Remove the borders from the data table rows

Returns:

same DataTable instance

bordered

public DataTable<T> bordered()

Adds borders from the data table rows

Returns:

same DataTable instance

noStripes

public DataTable<T> noStripes()

Remove the background alternation from the data table rows

Returns:

same DataTable instance

striped

public DataTable<T> striped()

Adds background alternation from the data table rows

Returns:

same DataTable instance

edit

public DataTable<T> edit()

Render all table rows in editable mode

Returns:

same DataTable instance

save

public DataTable<T> save()

Saves all editable table rows changes

Returns:

same DataTable instance

cancelEditing

public DataTable<T> cancelEditing()

Cancel editing of all table rows

Returns:

same DataTable instance

tableElement

public DominoElement<elemental2.dom.HTMLTableElement> tableElement()

Returns:

the HTMLTableElement wrapped as DominoElement

bodyElement

public DominoElement<elemental2.dom.HTMLTableSectionElement> bodyElement()

Returns:

the HTMLTableSectionElement -tbody- wrapped as DominoElement

headerElement

public DominoElement<elemental2.dom.HTMLTableSectionElement> headerElement()

Returns:

the HTMLTableSectionElement -thead- wrapped as DominoElement

getTableConfig

public TableConfig<T> getTableConfig()

Returns:

the applied TableConfig of this table

isCondensed

public boolean isCondensed()

Returns:

boolean

isHoverable

public boolean isHoverable()

Returns:

boolean

isStriped

public boolean isStriped()

Returns:

boolean

isBordered

public boolean isBordered()

Returns:

boolean

filterRows

public void filterRows(DataTable.LocalRowFilter<T> rowFilter)

Immediately filter the current table rows using the the specified filter

Parameters:

rowFilter - DataTable.LocalRowFilter

clearRowFilters

public void clearRowFilters()

Clear all filtration applied using filterRows(LocalRowFilter)

element

public elemental2.dom.HTMLDivElement element()

Specified by:

element in interface org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>

Specified by:

element in class BaseDominoElement<elemental2.dom.HTMLDivElement,DataTable<T>>

Returns:

the HTML element of type E which is the root element of the component

getSelectedItems

public List<TableRow<T>> getSelectedItems()

Specified by:

getSelectedItems in interface HasSelectionSupport<TableRow<T>>

Returns:

getSelectedRecords

public List<T> getSelectedRecords()

Returns:

a List of the currently selected records including a row selected children

getItems

@Deprecated
public List<TableRow<T>> getItems()

Deprecated.

Specified by:

getItems in interface HasSelectionSupport<TableRow<T>>

Returns:

a List of TableRows including the child rows

getRows

public List<TableRow<T>> getRows()

Specified by:

getRows in interface HasSelectionSupport<TableRow<T>>

Returns:

a List of TableRows including the child rows

getRootRows

public List<TableRow<T>> getRootRows()

getRecords

public List<T> getRecords()

Returns:

a List of TableRows excluding the child rows

getDirtyRecords

public List<T> getDirtyRecords()

Returns:

a List of TableRows that are being edited and still not saved

onSelectionChange

public void onSelectionChange(TableRow<T> source)

Description copied from interface: HasSelectionSupport

Called when an item selection is changed, implementation can delegate to a list listeners

Specified by:

onSelectionChange in interface HasSelectionSupport<TableRow<T>>

Parameters:

source - T item that has its selection changed

selectAll

public void selectAll()

Select all table rows

Specified by:

selectAll in interface HasSelectionSupport<TableRow<T>>

selectAll

public void selectAll(SelectionCondition<T> selectionCondition)

Select all table rows that match a condition

deselectAll

public void deselectAll()

Deselect all table rows

Specified by:

deselectAll in interface HasSelectionSupport<TableRow<T>>

deselectAll

public void deselectAll(SelectionCondition<T> selectionCondition)

Deselect all table rows that match a condition

isSelectable

public boolean isSelectable()

Specified by:

isSelectable in interface HasSelectionSupport<TableRow<T>>

Returns:

boolean, true if the component allows selection otherwise false.

addSelectionListener

public void addSelectionListener(DataTable.SelectionChangeListener<T> selectionChangeListener)

Add a listener to listen to data table selection changes

Parameters:

selectionChangeListener - DataTable.SelectionChangeListener

removeSelectionListener

public void removeSelectionListener(DataTable.SelectionChangeListener<T> selectionChangeListener)

Parameters:

selectionChangeListener - DataTable.SelectionChangeListener

addTableEventListner

@Deprecated
public void addTableEventListner(String type,
                                             TableEventListener listener)

Deprecated. use addTableEventListener(String, TableEventListener)

addTableEventListener

public void addTableEventListener(String type,
                                  TableEventListener listener)

Adds a table event listener by event type

Parameters:

type - String type of the event

listener - TableEventListener

removeTableListener

public void removeTableListener(String type,
                                TableEventListener listener)

Removes a table event listener by event type

Parameters:

type - String type of the event

listener - TableEventListener

fireTableEvent

public void fireTableEvent(TableEvent tableEvent)

Manually fire a table event

Parameters:

tableEvent - TableEvent

getSearchContext

public SearchContext getSearchContext()

Returns:

the current SearchContext of the data table