Package org.teamapps.ux.component.table

Class Table<RECORD>

java.lang.Object

org.teamapps.ux.component.AbstractComponent

org.teamapps.ux.component.infiniteitemview.AbstractInfiniteListComponent<RECORD,TableModel<RECORD>>

org.teamapps.ux.component.table.Table<RECORD>

All Implemented Interfaces:

ClientObject, Component

Direct Known Subclasses:

ListTable

public class Table<RECORD>
extends AbstractInfiniteListComponent<RECORD,TableModel<RECORD>>
implements Component

Field Summary

Fields

Modifier and Type	Field	Description
final Event<CellClickedEvent<RECORD,?>>	onCellClicked
final Event<CellEditingStartedEvent<RECORD,?>>	onCellEditingStarted
final Event<CellEditingStoppedEvent<RECORD,?>>	onCellEditingStopped
final Event<FieldValueChangedEventData<RECORD,?>>	onCellValueChanged
final Event<ColumnOrderChangeEventData<RECORD,?>>	onColumnOrderChange
final Event<ColumnSizeChangeEventData<RECORD,?>>	onColumnSizeChange
final Event<List<RECORD>>	onMultipleRowsSelected	Fired only when multiple rows are selected by the user.
final Event<List<RECORD>>	onRowsSelected	Fired when any number of rows is selected by the user.
final Event<RECORD>	onSingleRowSelected	Fired only when a single row is selected by the user.
final Event<SortingChangedEventData>	onSortingChanged
final Event<TableDataRequestEventData>	onTableDataRequest

Fields inherited from class org.teamapps.ux.component.infiniteitemview.AbstractInfiniteListComponent

customEqualsAndHashCode, onDisplayedRangeChanged, renderedRecords

Fields inherited from class org.teamapps.ux.component.AbstractComponent

DELETED_ATTRIBUTE, onRendered

Constructor Summary

Constructors

Constructor	Description
Table()
Table(List<TableColumn<RECORD,?>> columns)

Method Summary

Modifier and Type	Method	Description
void	addBottomNonModelRecord(RECORD record)
void	addCellMessage(RECORD record, String propertyName, FieldMessage message)
<VALUE> TableColumn<RECORD,VALUE>	addColumn(String propertyName, String title, AbstractField<VALUE> field)
<VALUE> TableColumn<RECORD,VALUE>	addColumn(String propertyName, Icon<?,?> icon, String title, AbstractField<VALUE> field)
<VALUE> TableColumn<RECORD,VALUE>	addColumn(String propertyName, Icon<?,?> icon, String title, AbstractField<VALUE> field, int defaultWidth)
<VALUE> TableColumn<RECORD,VALUE>	addColumn(String propertyName, Icon<?,?> icon, String title, Template displayTemplate)
void	addColumn(TableColumn<RECORD,?> column)
void	addColumn(TableColumn<RECORD,?> column, int index)
void	addColumns(List<TableColumn<RECORD,?>> newColumns, int index)
void	addNonModelRecord(RECORD record, boolean addToTop)
void	addTopNonModelRecord(RECORD record)
void	applyCellValuesToRecord(RECORD record)
void	cancelEditing()
void	clearAllCellMarkings()
void	clearChangeBuffer()
void	clearRecordMarkings(RECORD record)
void	clearRecordMessages(RECORD record)
void	closeContextMenu()
static <RECORD> Table<RECORD>	create()
protected UiIdentifiableClientRecord	createClientRecord(RECORD record)
UiComponent	createUiComponent()
void	focusCell(RECORD record, String propertyName)
TableCellCoordinates<RECORD>	getActiveEditorCell()
AbstractField<?>	getActiveEditorField()
Map<String,Object>	getAllCellValuesForRecord(RECORD record)
List<RECORD>	getBottomNonModelRecords()
List<FieldMessage>	getCellMessages(RECORD record, String propertyName)
Map<String,Object>	getChangedCellValues(RECORD record)
<VALUE> TableColumn<RECORD,VALUE>	getColumnByPropertyName(String propertyName)
List<String>	getColumnPropertyNames()
List<TableColumn<RECORD,?>>	getColumns()
Function<RECORD,Component>	getContextMenuProvider()
int	getFooterRowHeight()
int	getHeaderRowHeight()
int	getIndentation()
String	getIndentedColumnName()
List<RECORD>	getNonModelRecords(boolean top)
PropertyInjector<RECORD>	getPropertyInjector()
PropertyProvider<RECORD>	getPropertyProvider()
List<RECORD>	getRecordsWithChangedCellValues()
List<RECORD>	getRenderedRecords()
int	getRowHeight()
RECORD	getSelectedRecord()
List<RECORD>	getSelectedRecords()
SelectionFrame	getSelectionFrame()
Sorting	getSorting()
List<RECORD>	getTopNonModelRecords()
protected void	handleModelRecordsChanged(RecordsChangedEvent<RECORD> changeEvent)
protected void	handleModelRecordsRemoved(RecordsRemovedEvent<RECORD> deleteEvent)
void	handleUiEvent(UiEvent event)
boolean	isAllowMultiRowSelection()
boolean	isAutoHeight()
boolean	isDisplayAsList()
boolean	isEditable()
boolean	isEnsureEmptyLastRow()
boolean	isForceFitWidth()
boolean	isHideHeaders()
boolean	isShowFooterRow()
boolean	isShowHeaderRow()
boolean	isShowNumbering()
boolean	isShowRowCheckBoxes()
boolean	isStripedRows()
boolean	isTextSelectionEnabled()
boolean	isTreeMode()
protected void	preRegisteringModel(TableModel<RECORD> model)
void	refreshData()
void	removeAllBottomNonModelRecords()
void	removeAllNonModelRecords()
void	removeAllTopNonModelRecords()
void	removeBottomNonModelRecord(RECORD record)
void	removeCellMessage(RECORD record, String propertyName, FieldMessage message)
void	removeColumn(String propertyName)
void	removeColumn(TableColumn<RECORD,?> column)
void	removeColumns(List<TableColumn<RECORD,?>> obsoleteColumns)
void	removeNonModelRecord(RECORD record)
void	removeNonModelRecord(RECORD record, boolean top)
void	removeTopNonModelRecord(RECORD record)
protected List<RECORD>	retrieveRecords(int startIndex, int length)
void	revertChanges()
protected void	sendUpdateDataCommandToClient(int start, List<Integer> uiRecordIds, List<UiIdentifiableClientRecord> newUiRecords, int totalNumberOfRecords)
void	setAllowMultiRowSelection(boolean allowMultiRowSelection)
void	setAutoHeight(boolean autoHeight)
void	setCellMarked(RECORD record, String propertyName, boolean mark)
void	setCellValue(RECORD record, String propertyName, Object value)
void	setContextMenuProvider(Function<RECORD,Component> contextMenuProvider)
void	setCustomEqualsAndHashCode(EqualsAndHashCode<RECORD> customEqualsAndHashCode)
void	setDisplayAsList(boolean displayAsList)
void	setEditable(boolean editable)
void	setEnsureEmptyLastRow(boolean ensureEmptyLastRow)
void	setFooterRowBackgroundColor(Color footerRowBackgroundColor)
void	setFooterRowBorderColor(Color footerRowBorderColor)
void	setFooterRowBorderWidth(int footerRowBorderWidth)
void	setFooterRowField(String columnName, AbstractField<?> field)	Deprecated.
void	setFooterRowHeight(int footerRowHeight)
void	setForceFitWidth(boolean forceFitWidth)
void	setHeaderRowBackgroundColor(Color headerRowBackgroundColor)
void	setHeaderRowBorderColor(Color headerRowBorderColor)
void	setHeaderRowBorderWidth(int headerRowBorderWidth)
void	setHeaderRowField(String columnName, AbstractField<?> field)	Deprecated.
void	setHeaderRowHeight(int headerRowHeight)
void	setHideHeaders(boolean hideHeaders)
void	setIndentation(int indentation)
void	setIndentedColumnName(String indentedColumnName)
void	setPropertyExtractor(PropertyExtractor<RECORD> propertyExtractor)
void	setPropertyInjector(PropertyInjector<RECORD> propertyInjector)
void	setPropertyProvider(PropertyProvider<RECORD> propertyProvider)
void	setRecordBold(RECORD record, boolean bold)
void	setRowBorderColor(Color rowBorderColor)
void	setRowBorderWidth(int rowBorderWidth)
void	setRowHeight(int rowHeight)
void	setSelectedRecord(RECORD record)
void	setSelectedRecord(RECORD record, boolean scrollToRecordIfAvailable)
void	setSelectedRecords(List<RECORD> records)
void	setSelectedRecords(List<RECORD> records, boolean scrollToFirstIfAvailable)
void	setSelectedRow(int rowIndex)
void	setSelectedRow(int rowIndex, boolean scrollTo)
void	setSelectedRows(List<Integer> rowIndexes)
void	setSelectedRows(List<Integer> rowIndexes, boolean scrollToFirst)
void	setSelectionColor(Color selectionColor)
void	setSelectionFrame(SelectionFrame selectionFrame)
void	setShowFooterRow(boolean showFooterRow)
void	setShowHeaderRow(boolean showHeaderRow)
void	setShowNumbering(boolean showNumbering)
void	setShowRowCheckBoxes(boolean showRowCheckBoxes)
void	setSorting(String sortField, SortDirection sortDirection)
void	setSorting(Sorting sorting)
void	setStripedRowColorEven(Color stripedRowColorEven)
void	setStripedRowColorOdd(Color stripedRowColorOdd)
void	setStripedRows(boolean stripedRows)
void	setTextSelectionEnabled(boolean textSelectionEnabled)
void	setTreeMode(boolean treeMode)
protected void	updateColumnMessages(TableColumn<RECORD,?> tableColumn)
protected void	updateColumnVisibility(TableColumn<RECORD,?> tableColumn)
void	updateRecordMessages(RECORD record, Map<String,List<FieldMessage>> messages)
List<FieldMessage>	validateRecord(RECORD record)
List<FieldMessage>	validateRow(RECORD record)

Methods inherited from class org.teamapps.ux.component.infiniteitemview.AbstractInfiniteListComponent

getCount, getCustomEqualsAndHashCode, getModel, getModelCount, handleModelRecordsAdded, handleScrollOrResize, refresh, rerenderRecord, setModel, updateSingleRecordOnClient

Methods inherited from class org.teamapps.ux.component.AbstractComponent

createUiReference, getDebuggingId, getId, getParent, getSessionContext, isRendered, isVisible, mapAbstractUiComponentProperties, queueCommandIfRendered, render, reRenderIfRendered, setAttribute, setCssStyle, setDebuggingId, setParent, setVisible, toggleCssClass, toString, unrender

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.teamapps.ux.component.ClientObject

createUiReference, getId, handleUiQuery, isRendered, render, unrender

Methods inherited from interface org.teamapps.ux.component.Component

getParent, isVisible, setAriaLabel, setAttribute, setAttribute, setCssStyle, setCssStyle, setHtmlTitle, setMargin, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setParent, setShadow, setVisible, toggleCssClass, toggleCssClass

Field Details

onCellEditingStarted

public final Event<CellEditingStartedEvent<RECORD,?>> onCellEditingStarted

onCellEditingStopped

public final Event<CellEditingStoppedEvent<RECORD,?>> onCellEditingStopped

onCellValueChanged

public final Event<FieldValueChangedEventData<RECORD,?>> onCellValueChanged

onRowsSelected

public final Event<List<RECORD>> onRowsSelected

Fired when any number of rows is selected by the user.

onSingleRowSelected

public final Event<RECORD> onSingleRowSelected

Fired only when a single row is selected by the user.

onMultipleRowsSelected

public final Event<List<RECORD>> onMultipleRowsSelected

Fired only when multiple rows are selected by the user.

onCellClicked

public final Event<CellClickedEvent<RECORD,?>> onCellClicked

onSortingChanged

public final Event<SortingChangedEventData> onSortingChanged

onTableDataRequest

public final Event<TableDataRequestEventData> onTableDataRequest

onColumnOrderChange

public final Event<ColumnOrderChangeEventData<RECORD,?>> onColumnOrderChange

onColumnSizeChange

public final Event<ColumnSizeChangeEventData<RECORD,?>> onColumnSizeChange

Constructor Details

Table

public Table()

Table

public Table(List<TableColumn<RECORD,?>> columns)

Method Details

create

public static <RECORD> Table<RECORD> create()

addColumn

public void addColumn(TableColumn<RECORD,?> column)

addColumn

public void addColumn(TableColumn<RECORD,?> column,
 int index)

addColumn

public <VALUE> TableColumn<RECORD,VALUE> addColumn(String propertyName,
 String title,
 AbstractField<VALUE> field)

addColumn

public <VALUE> TableColumn<RECORD,VALUE> addColumn(String propertyName,
 Icon<?,?> icon,
 String title,
 AbstractField<VALUE> field)

addColumn

public <VALUE> TableColumn<RECORD,VALUE> addColumn(String propertyName,
 Icon<?,?> icon,
 String title,
 AbstractField<VALUE> field,
 int defaultWidth)

addColumn

public <VALUE> TableColumn<RECORD,VALUE> addColumn(String propertyName,
 Icon<?,?> icon,
 String title,
 Template displayTemplate)

addColumns

public void addColumns(List<TableColumn<RECORD,?>> newColumns,
 int index)

removeColumn

public void removeColumn(String propertyName)

removeColumn

public void removeColumn(TableColumn<RECORD,?> column)

removeColumns

public void removeColumns(List<TableColumn<RECORD,?>> obsoleteColumns)

preRegisteringModel

protected void preRegisteringModel(TableModel<RECORD> model)

Overrides:

preRegisteringModel in class AbstractInfiniteListComponent<RECORD,TableModel<RECORD>>

createUiComponent

public UiComponent createUiComponent()

Specified by:

createUiComponent in class AbstractComponent

handleUiEvent

public void handleUiEvent(UiEvent event)

Specified by:

handleUiEvent in interface ClientObject

getColumnPropertyNames

public List<String> getColumnPropertyNames()

getActiveEditorCell

public TableCellCoordinates<RECORD> getActiveEditorCell()

getActiveEditorField

public AbstractField<?> getActiveEditorField()

setCellValue

public void setCellValue(RECORD record,
 String propertyName,
 Object value)

focusCell

public void focusCell(RECORD record,
 String propertyName)

setCellMarked

public void setCellMarked(RECORD record,
 String propertyName,
 boolean mark)

clearRecordMarkings

public void clearRecordMarkings(RECORD record)

clearAllCellMarkings

public void clearAllCellMarkings()

setRecordBold

public void setRecordBold(RECORD record,
 boolean bold)

setSelectedRecord

public void setSelectedRecord(RECORD record)

setSelectedRecord

public void setSelectedRecord(RECORD record,
 boolean scrollToRecordIfAvailable)

setSelectedRecords

public void setSelectedRecords(List<RECORD> records)

setSelectedRecords

public void setSelectedRecords(List<RECORD> records,
 boolean scrollToFirstIfAvailable)

setSelectedRow

public void setSelectedRow(int rowIndex)

setSelectedRow

public void setSelectedRow(int rowIndex,
 boolean scrollTo)

setSelectedRows

public void setSelectedRows(List<Integer> rowIndexes)

setSelectedRows

public void setSelectedRows(List<Integer> rowIndexes,
 boolean scrollToFirst)

updateColumnMessages

protected void updateColumnMessages(TableColumn<RECORD,?> tableColumn)

getCellMessages

public List<FieldMessage> getCellMessages(RECORD record,
 String propertyName)

addCellMessage

public void addCellMessage(RECORD record,
 String propertyName,
 FieldMessage message)

removeCellMessage

public void removeCellMessage(RECORD record,
 String propertyName,
 FieldMessage message)

validateRecord

public List<FieldMessage> validateRecord(RECORD record)

validateRow

public List<FieldMessage> validateRow(RECORD record)

updateColumnVisibility

protected void updateColumnVisibility(TableColumn<RECORD,?> tableColumn)

getTopNonModelRecords

public List<RECORD> getTopNonModelRecords()

getBottomNonModelRecords

public List<RECORD> getBottomNonModelRecords()

getNonModelRecords

public List<RECORD> getNonModelRecords(boolean top)

addTopNonModelRecord

public void addTopNonModelRecord(RECORD record)

addBottomNonModelRecord

public void addBottomNonModelRecord(RECORD record)

addNonModelRecord

public void addNonModelRecord(RECORD record,
 boolean addToTop)

removeTopNonModelRecord

public void removeTopNonModelRecord(RECORD record)

removeBottomNonModelRecord

public void removeBottomNonModelRecord(RECORD record)

removeNonModelRecord

public void removeNonModelRecord(RECORD record)

removeNonModelRecord

public void removeNonModelRecord(RECORD record,
 boolean top)

removeAllTopNonModelRecords

public void removeAllTopNonModelRecords()

removeAllBottomNonModelRecords

public void removeAllBottomNonModelRecords()

removeAllNonModelRecords

public void removeAllNonModelRecords()

clearRecordMessages

public void clearRecordMessages(RECORD record)

updateRecordMessages

public void updateRecordMessages(RECORD record,
 Map<String,List<FieldMessage>> messages)

handleModelRecordsRemoved

protected void handleModelRecordsRemoved(RecordsRemovedEvent<RECORD> deleteEvent)

Overrides:

handleModelRecordsRemoved in class AbstractInfiniteListComponent<RECORD,TableModel<RECORD>>

handleModelRecordsChanged

protected void handleModelRecordsChanged(RecordsChangedEvent<RECORD> changeEvent)

Overrides:

handleModelRecordsChanged in class AbstractInfiniteListComponent<RECORD,TableModel<RECORD>>

refreshData

public void refreshData()

sendUpdateDataCommandToClient

protected void sendUpdateDataCommandToClient(int start,
 List<Integer> uiRecordIds,
 List<UiIdentifiableClientRecord> newUiRecords,
 int totalNumberOfRecords)

Specified by:

sendUpdateDataCommandToClient in class AbstractInfiniteListComponent<RECORD,TableModel<RECORD>>

retrieveRecords

protected List<RECORD> retrieveRecords(int startIndex,
 int length)

Specified by:

retrieveRecords in class AbstractInfiniteListComponent<RECORD,TableModel<RECORD>>

cancelEditing

public void cancelEditing()

createClientRecord

protected UiIdentifiableClientRecord createClientRecord(RECORD record)

Specified by:

createClientRecord in class AbstractInfiniteListComponent<RECORD,TableModel<RECORD>>

getColumns

public List<TableColumn<RECORD,?>> getColumns()

isDisplayAsList

public boolean isDisplayAsList()

setDisplayAsList

public void setDisplayAsList(boolean displayAsList)

isForceFitWidth

public boolean isForceFitWidth()

setForceFitWidth

public void setForceFitWidth(boolean forceFitWidth)

getRowHeight

public int getRowHeight()

setRowHeight

public void setRowHeight(int rowHeight)

isStripedRows

public boolean isStripedRows()

setStripedRows

public void setStripedRows(boolean stripedRows)

setStripedRowColorEven

public void setStripedRowColorEven(Color stripedRowColorEven)

setStripedRowColorOdd

public void setStripedRowColorOdd(Color stripedRowColorOdd)

isHideHeaders

public boolean isHideHeaders()

setHideHeaders

public void setHideHeaders(boolean hideHeaders)

isAllowMultiRowSelection

public boolean isAllowMultiRowSelection()

setAllowMultiRowSelection

public void setAllowMultiRowSelection(boolean allowMultiRowSelection)

setSelectionColor

public void setSelectionColor(Color selectionColor)

setRowBorderWidth

public void setRowBorderWidth(int rowBorderWidth)

setRowBorderColor

public void setRowBorderColor(Color rowBorderColor)

isShowRowCheckBoxes

public boolean isShowRowCheckBoxes()

setShowRowCheckBoxes

public void setShowRowCheckBoxes(boolean showRowCheckBoxes)

isShowNumbering

public boolean isShowNumbering()

setShowNumbering

public void setShowNumbering(boolean showNumbering)

isTextSelectionEnabled

public boolean isTextSelectionEnabled()

setTextSelectionEnabled

public void setTextSelectionEnabled(boolean textSelectionEnabled)

getSorting

public Sorting getSorting()

setSorting

public void setSorting(String sortField,
 SortDirection sortDirection)

setSorting

public void setSorting(Sorting sorting)

isEditable

public boolean isEditable()

setEditable

public void setEditable(boolean editable)

isEnsureEmptyLastRow

public boolean isEnsureEmptyLastRow()

setEnsureEmptyLastRow

public void setEnsureEmptyLastRow(boolean ensureEmptyLastRow)

isTreeMode

public boolean isTreeMode()

setTreeMode

public void setTreeMode(boolean treeMode)

getIndentedColumnName

public String getIndentedColumnName()

setIndentedColumnName

public void setIndentedColumnName(String indentedColumnName)

getIndentation

public int getIndentation()

setIndentation

public void setIndentation(int indentation)

getSelectionFrame

public SelectionFrame getSelectionFrame()

setSelectionFrame

public void setSelectionFrame(SelectionFrame selectionFrame)

isShowHeaderRow

public boolean isShowHeaderRow()

setShowHeaderRow

public void setShowHeaderRow(boolean showHeaderRow)

setHeaderRowBorderWidth

public void setHeaderRowBorderWidth(int headerRowBorderWidth)

setHeaderRowBorderColor

public void setHeaderRowBorderColor(Color headerRowBorderColor)

getHeaderRowHeight

public int getHeaderRowHeight()

setHeaderRowHeight

public void setHeaderRowHeight(int headerRowHeight)

setHeaderRowBackgroundColor

public void setHeaderRowBackgroundColor(Color headerRowBackgroundColor)

setHeaderRowField

@Deprecated
public void setHeaderRowField(String columnName,
 AbstractField<?> field)

Deprecated.

Use TableColumn.setHeaderRowField(AbstractField) instead!

isShowFooterRow

public boolean isShowFooterRow()

setShowFooterRow

public void setShowFooterRow(boolean showFooterRow)

setFooterRowBorderWidth

public void setFooterRowBorderWidth(int footerRowBorderWidth)

setFooterRowBorderColor

public void setFooterRowBorderColor(Color footerRowBorderColor)

getFooterRowHeight

public int getFooterRowHeight()

setFooterRowHeight

public void setFooterRowHeight(int footerRowHeight)

setFooterRowBackgroundColor

public void setFooterRowBackgroundColor(Color footerRowBackgroundColor)

setFooterRowField

@Deprecated
public void setFooterRowField(String columnName,
 AbstractField<?> field)

Deprecated.

Use TableColumn.setFooterRowField(AbstractField) instead!

getColumnByPropertyName

public <VALUE> TableColumn<RECORD,VALUE> getColumnByPropertyName(String propertyName)

getRecordsWithChangedCellValues

public List<RECORD> getRecordsWithChangedCellValues()

getChangedCellValues

public Map<String,Object> getChangedCellValues(RECORD record)

getAllCellValuesForRecord

public Map<String,Object> getAllCellValuesForRecord(RECORD record)

clearChangeBuffer

public void clearChangeBuffer()

applyCellValuesToRecord

public void applyCellValuesToRecord(RECORD record)

revertChanges

public void revertChanges()

getSelectedRecord

public RECORD getSelectedRecord()

getSelectedRecords

public List<RECORD> getSelectedRecords()

getPropertyProvider

public PropertyProvider<RECORD> getPropertyProvider()

setPropertyProvider

public void setPropertyProvider(PropertyProvider<RECORD> propertyProvider)

setPropertyExtractor

public void setPropertyExtractor(PropertyExtractor<RECORD> propertyExtractor)

getPropertyInjector

public PropertyInjector<RECORD> getPropertyInjector()

setPropertyInjector

public void setPropertyInjector(PropertyInjector<RECORD> propertyInjector)

getContextMenuProvider

public Function<RECORD,Component> getContextMenuProvider()

setContextMenuProvider

public void setContextMenuProvider(Function<RECORD,Component> contextMenuProvider)

closeContextMenu

public void closeContextMenu()

getRenderedRecords

public List<RECORD> getRenderedRecords()

isAutoHeight

public boolean isAutoHeight()

setAutoHeight

public void setAutoHeight(boolean autoHeight)

setCustomEqualsAndHashCode

public void setCustomEqualsAndHashCode(EqualsAndHashCode<RECORD> customEqualsAndHashCode)

Overrides:

setCustomEqualsAndHashCode in class AbstractInfiniteListComponent<RECORD,TableModel<RECORD>>