TableConfig (domino-ui 1.0.0-RC13 API)

java.lang.Object
- org.dominokit.domino.ui.datatable.TableConfig<T>

Type Parameters:: T - the type of the data table records

All Implemented Interfaces:: HasMultiSelectionSupport<TableConfig<T>>

public class TableConfig<T>
extends Object
implements HasMultiSelectionSupport<TableConfig<T>>

This class is responsible of configuring the data table

     TableConfig<Contact> tableConfig = new TableConfig<>();
 tableConfig
         .addColumn(ColumnConfig.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`TableConfig.ColumnNofFoundException` This exception is thrown when performing action that looks up a column by its name but the column does not exist in the current `TableConfig`
`static interface`	`TableConfig.RowAppender<T>` An interface to provide an alternative implementation of how rows should be appended to the table
`static interface`	`TableConfig.UtilityColumnHandler<T>`

Constructor Summary

Constructors
Constructor and Description

TableConfig()

Constructors
Constructor and Description
`TableConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TableConfig<T>`	`addColumn(ColumnConfig<T> column)` Adds a configuration for a column in the data table
`TableConfig<T>`	`addPlugin(DataTablePlugin<T> plugin)` Adds a new plugin to the data table
`void`	`drawHeaders(DataTable<T> dataTable, DominoElement<elemental2.dom.HTMLTableSectionElement> thead)` This method will draw the table columns header elements for all columns and append them to the table head element
`void`	`drawRecord(DataTable<T> dataTable, TableRow<T> tableRow)` Draw a record as a row in the data table, row information is obtained from the TableRow
`ColumnConfig<T>`	`getColumnByName(String name)` get a column config by the column name
`List<ColumnConfig<T>>`	`getColumns()`
`DataTable<T>`	`getDataTable()`
`String`	`getFixedBodyHeight()`
`String`	`getFixedDefaultColumnWidth()`
`List<DataTablePlugin<T>>`	`getPlugins()`
`List<ColumnConfig<T>>`	`getVisibleColumns()`
`TableConfig<T>`	`insertColumnFirst(ColumnConfig<T> column)` Adds a configuration for a column in the data table as the first column over the existing columns list
`TableConfig<T>`	`insertColumnLast(ColumnConfig<T> column)` Adds a configuration for a column in the data table as the last column after the existing columns list
`boolean`	`isFixed()`
`boolean`	`isLazyLoad()`
`boolean`	`isMultiSelect()`
`TableConfig<T>`	`onUtilityColumn(TableConfig.UtilityColumnHandler<T> utilityColumnHandler)`
`TableConfig<T>`	`setDirtyRecordHandlers(DirtyRecordProvider<T> dirtyRecordProvider, SaveDirtyRecordHandler<T> saveDirtyRecordHandler)` sets the dirty record handlers for editable tables
`TableConfig<T>`	`setFixed(boolean fixed)`
`TableConfig<T>`	`setFixedBodyHeight(String fixedBodyHeight)`
`TableConfig<T>`	`setFixedDefaultColumnWidth(String fixedDefaultColumnWidth)`
`TableConfig<T>`	`setLazyLoad(boolean lazyLoad)`
`TableConfig<T>`	`setMultiSelect(boolean multiSelect)`
`void`	`setRowAppender(TableConfig.RowAppender<T> rowAppender)` Change the default RowAppender for the data table
`TableConfig<T>`	`setUtilityColumnTitle(String title)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TableConfig
```
public TableConfig()
```
- Method Detail
  - drawHeaders
```
public void drawHeaders(DataTable<T> dataTable,
                        DominoElement<elemental2.dom.HTMLTableSectionElement> thead)
```
    This method will draw the table columns header elements for all columns and append them to the table head element
    
    Parameters:
    
    dataTable - the DataTable initialized with this configuration
    
    thead - the DominoElement of HTMLTableSectionElement that is the table header element
  - drawRecord
```
public void drawRecord(DataTable<T> dataTable,
                       TableRow<T> tableRow)
```
    Draw a record as a row in the data table, row information is obtained from the TableRow
    
    Parameters:
    
    dataTable - the DataTable initialized with this configuration
    
    tableRow - the TableRow we are adding to the table
  - addColumn
```
public TableConfig<T> addColumn(ColumnConfig<T> column)
```
    Adds a configuration for a column in the data table
    
    Parameters:
    
    column - ColumnConfig
    
    Returns:
    
    same TableConfig instance
  - insertColumnFirst
```
public TableConfig<T> insertColumnFirst(ColumnConfig<T> column)
```
    Adds a configuration for a column in the data table as the first column over the existing columns list
    
    Parameters:
    
    column - ColumnConfig
    
    Returns:
    
    same TableConfig instance
  - insertColumnLast
```
public TableConfig<T> insertColumnLast(ColumnConfig<T> column)
```
    Adds a configuration for a column in the data table as the last column after the existing columns list
    
    Parameters:
    
    column - ColumnConfig
    
    Returns:
    
    same TableConfig instance
  - addPlugin
```
public TableConfig<T> addPlugin(DataTablePlugin<T> plugin)
```
    Adds a new plugin to the data table
    
    Parameters:
    
    plugin - DataTablePlugin
    
    Returns:
    
    same TableConfig instance
  - onUtilityColumn
```
public TableConfig<T> onUtilityColumn(TableConfig.UtilityColumnHandler<T> utilityColumnHandler)
```
  - isFixed
```
public boolean isFixed()
```
    Returns:
    
    boolean, if true then this table will have a fixed width and wont change the columns width when resized, otherwise columns will stretch to match the table root element width
  - setFixed
```
public TableConfig<T> setFixed(boolean fixed)
```
    Parameters:
    
    fixed - boolean, if true then this table will have a fixed width and wont change the columns width when resized, otherwise columns will stretch to match the table root element width
    
    Returns:
    
    same TableConfig instance
  - isLazyLoad
```
public boolean isLazyLoad()
```
    Returns:
    
    boolean, if true the table will only start loading the data from the data store if load is called manually, otherwise it will automatically load the data when it is initialized
  - setLazyLoad
```
public TableConfig<T> setLazyLoad(boolean lazyLoad)
```
    Parameters:
    
    lazyLoad - boolean, if true the table will only start loading the data from the data store if load is called manually, otherwise it will automatically load the data when it is initialized
    
    Returns:
    
    same TableConfig instance
  - getFixedBodyHeight
```
public String getFixedBodyHeight()
```
    Returns:
    
    String, the height of the data table body, this is the value we set with setFixedBodyHeight(String) not the actual current table body height
  - setFixedBodyHeight
```
public TableConfig<T> setFixedBodyHeight(String fixedBodyHeight)
```
    Parameters:
    
    fixedBodyHeight - boolean, if true the height of the table body will be fixed to the specified value and while adding records to the table if the total height of rows exceed this height scroll bars will show up, otherwise the table body will not fixed and will grow to match the rows height and wont show scrollbars
    
    Returns:
    
    same TableConfig instance
  - getFixedDefaultColumnWidth
```
public String getFixedDefaultColumnWidth()
```
    Returns:
    
    String default value for a fixed column width
  - setFixedDefaultColumnWidth
```
public TableConfig<T> setFixedDefaultColumnWidth(String fixedDefaultColumnWidth)
```
    Parameters:
    
    fixedDefaultColumnWidth - String default value to be used as width for the fixed width columns
    
    Returns:
    
    same TableConfig instance
  - isMultiSelect
```
public boolean isMultiSelect()
```
    Specified by:
    
    isMultiSelect in interface HasMultiSelectionSupport<TableConfig<T>>
    
    Returns:
    
    boolean, true if the component supports multi-selection, otherwise false
  - setMultiSelect
```
public TableConfig<T> setMultiSelect(boolean multiSelect)
```
    Specified by:
    
    setMultiSelect in interface HasMultiSelectionSupport<TableConfig<T>>
    
    Parameters:
    
    multiSelect - boolean, true if the component should support multi-selection, otherwise false
  - setRowAppender
```
public void setRowAppender(TableConfig.RowAppender<T> rowAppender)
```
    Change the default RowAppender for the data table
    
    Parameters:
    
    rowAppender - TableConfig.RowAppender
  - getPlugins
```
public List<DataTablePlugin<T>> getPlugins()
```
    Returns:
    
    the List of plugins added to the table
  - getColumns
```
public List<ColumnConfig<T>> getColumns()
```
    Returns:
    
    a List of all ColumnConfig added to the table
  - getVisibleColumns
```
public List<ColumnConfig<T>> getVisibleColumns()
```
    Returns:
    
    a List of all currently visible ColumnConfig of the table
  - getColumnByName
```
public ColumnConfig<T> getColumnByName(String name)
```
    get a column config by the column name
    
    Parameters:
    
    name - String name of the column
    
    Returns:
    
    the ColumnConfig if exists otherwise throw TableConfig.ColumnNofFoundException
  - setUtilityColumnTitle
```
public TableConfig<T> setUtilityColumnTitle(String title)
```
  - getDataTable
```
public DataTable<T> getDataTable()
```
    Returns:
    
    the DataTable initialized with this configuration
  - setDirtyRecordHandlers
```
public TableConfig<T> setDirtyRecordHandlers(DirtyRecordProvider<T> dirtyRecordProvider,
                                             SaveDirtyRecordHandler<T> saveDirtyRecordHandler)
```
    sets the dirty record handlers for editable tables
    
    Parameters:
    
    dirtyRecordProvider - DirtyRecordProvider
    
    saveDirtyRecordHandler - SaveDirtyRecordHandler
    
    Returns:
    
    same TableConfig istance

Class TableConfig<T>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TableConfig

Method Detail

drawHeaders

drawRecord

addColumn

insertColumnFirst

insertColumnLast

addPlugin

onUtilityColumn

isFixed

setFixed

isLazyLoad

setLazyLoad

getFixedBodyHeight

setFixedBodyHeight

getFixedDefaultColumnWidth

setFixedDefaultColumnWidth

isMultiSelect

setMultiSelect

setRowAppender

getPlugins

getColumns

getVisibleColumns

getColumnByName

setUtilityColumnTitle

getDataTable

setDirtyRecordHandlers