Package org.teamapps.ux.component.table

Class Table<RECORD>

java.lang.Object

org.teamapps.ux.component.AbstractComponent

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

All Implemented Interfaces:

Component, Container

public class Table<RECORD>
extends AbstractComponent
implements Container

Field Summary

Fields

Modifier and Type	Field	Description
Event<CellEditingStartedEvent<RECORD,java.lang.Object>>	onCellEditingStarted
Event<CellEditingStoppedEvent<RECORD>>	onCellEditingStopped
Event<FieldValueChangedEventData<RECORD,java.lang.Object>>	onCellValueChanged
Event<ColumnSizeChangeEventData>	onColumnSizeChange
Event<FieldOrderChangeEventData>	onFieldOrderChange
Event<java.util.List<RECORD>>	onMultipleRowsSelected
Event<RECORD>	onRowSelected
Event<SortingChangedEventData>	onSortingChanged
Event<TableDataRequestEventData>	onTableDataRequest

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

onDestroyed, onRendered

Constructor Summary

Constructors

Constructor	Description
Table()
Table(java.util.List<TableColumn> columns)

Method Summary

Modifier and Type	Method	Description
void	addCellMessage(RECORD record, java.lang.String propertyName, FieldMessage message)
void	addColumn(TableColumn column)
void	addColumn(TableColumn column, int index)
void	addColumns(java.util.List<TableColumn> newColumns, int index)
void	addNonModelRecord(RECORD record, boolean addToTop)
void	applyCellValuesToRecord(RECORD record)
void	cancelEditing()
void	clearAllCellMarkings()
void	clearChangeBuffer()
void	clearRecordMarkings(RECORD record)
void	clearRecordMessages(RECORD record)
static <RECORD> Table<RECORD>	create()
org.teamapps.dto.UiComponent	createUiComponent()
protected void	doDestroy()	Override this method to release resources whenever this component gets destroyed
void	focusCell(RECORD record, java.lang.String propertyName)
TableCellCoordinates<RECORD>	getActiveEditorCell()
AbstractField	getActiveEditorField()
java.util.Map<java.lang.String,java.lang.Object>	getAllCellValues(RECORD record)
java.util.List<FieldMessage>	getCellMessages(RECORD record, java.lang.String propertyName)
java.util.Map<java.lang.String,java.lang.Object>	getChangedCellValues(RECORD record)
TableColumn	getColumnByPropertyName(java.lang.String propertyName)
java.util.List<java.lang.String>	getColumnNames()
java.util.List<TableColumn>	getColumns()
AbstractField	getFooterRowFieldByName(java.lang.String propertyName)
java.util.Map<java.lang.String,AbstractField>	getFooterRowFields()
int	getFooterRowHeight()
AbstractField	getHeaderRowFieldByName(java.lang.String propertyName)
java.util.Map<java.lang.String,AbstractField>	getHeaderRowFields()
int	getHeaderRowHeight()
int	getIndentation()
java.lang.String	getIndentedColumnName()
int	getMaxCacheCapacity()
TableModel	getModel()
PropertyExtractor<RECORD>	getPropertyExtractor()
PropertyInjector<RECORD>	getPropertyInjector()
java.util.List<RECORD>	getRecordsWithChangedCellValues()
int	getRowHeight()
RECORD	getSelectedRecord()
java.util.List<RECORD>	getSelectedRecords()
SelectionFrame	getSelectionFrame()
SortDirection	getSortDirection()
java.lang.String	getSortField()
Sorting	getSorting()
void	handleUiEvent(org.teamapps.dto.UiEvent event)
boolean	isAllowMultiRowSelection()
boolean	isDisplayAsList()
boolean	isEditable()
boolean	isEnsureEmptyLastRow()
boolean	isForceFitWidth()
boolean	isHideHeaders()
boolean	isShowFooterRow()
boolean	isShowHeaderRow()
boolean	isShowNumbering()
boolean	isShowRowCheckBoxes()
boolean	isStripedRows()
boolean	isTreeMode()
void	refreshData()
void	removeAllNonModelRecords()
void	removeCellMessage(RECORD record, java.lang.String propertyName, FieldMessage message)
void	removeColumn(java.lang.String propertyName)
void	removeColumn(TableColumn column)
void	removeColumns(java.util.List<TableColumn> obsoleteColumns)
void	removeNonModelRecord(RECORD record)
void	revertChanges()
void	selectSingleRow(RECORD record, boolean scrollToRecord)
void	setAllowMultiRowSelection(boolean allowMultiRowSelection)
void	setCellMarked(RECORD record, java.lang.String propertyName, boolean mark)
void	setCellValue(RECORD record, java.lang.String propertyName, java.lang.Object value)
void	setDisplayAsList(boolean displayAsList)
void	setEditable(boolean editable)
void	setEnsureEmptyLastRow(boolean ensureEmptyLastRow)
void	setFooterRowBackgroundColor(org.teamapps.common.format.Color footerRowBackgroundColor)
void	setFooterRowBorderColor(org.teamapps.common.format.Color footerRowBorderColor)
void	setFooterRowBorderWidth(int footerRowBorderWidth)
void	setFooterRowField(java.lang.String columnName, AbstractField field)
void	setFooterRowFields(java.util.Map<java.lang.String,AbstractField> footerRowFields)
void	setFooterRowHeight(int footerRowHeight)
void	setForceFitWidth(boolean forceFitWidth)
void	setHeaderRowBackgroundColor(org.teamapps.common.format.Color headerRowBackgroundColor)
void	setHeaderRowBorderColor(org.teamapps.common.format.Color headerRowBorderColor)
void	setHeaderRowBorderWidth(int headerRowBorderWidth)
void	setHeaderRowField(java.lang.String columnName, AbstractField field)
void	setHeaderRowFields(java.util.Map<java.lang.String,AbstractField> headerRowFields)
void	setHeaderRowHeight(int headerRowHeight)
void	setHideHeaders(boolean hideHeaders)
void	setIndentation(int indentation)
void	setIndentedColumnName(java.lang.String indentedColumnName)
void	setMaxCacheCapacity(int maxCapacity)
void	setModel(TableModel<RECORD> model)
void	setPageSize(int pageSize)
void	setPropertyExtractor(PropertyExtractor<RECORD> propertyExtractor)
void	setPropertyInjector(PropertyInjector<RECORD> propertyInjector)
void	setRecordBold(RECORD record, boolean bold)
void	setRowBorderColor(org.teamapps.common.format.Color rowBorderColor)
void	setRowBorderWidth(int rowBorderWidth)
void	setRowHeight(int rowHeight)
void	setSelectionColor(org.teamapps.common.format.Color selectionColor)
void	setSelectionFrame(SelectionFrame selectionFrame)
void	setShowFooterRow(boolean showFooterRow)
void	setShowHeaderRow(boolean showHeaderRow)
void	setShowNumbering(boolean showNumbering)
void	setShowRowCheckBoxes(boolean showRowCheckBoxes)
void	setSortDirection(SortDirection sortDirection)
void	setSortField(java.lang.String sortField)
void	setStripedRowColorEven(org.teamapps.common.format.Color stripedRowColorEven)
void	setStripedRowColorOdd(org.teamapps.common.format.Color stripedRowColorOdd)
void	setStripedRows(boolean stripedRows)
void	setTreeMode(boolean treeMode)
void	updateRecordMessages(RECORD record, java.util.Map<java.lang.String,java.util.List<FieldMessage>> messages)

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

createUiComponentReference, destroy, getId, getParent, getSessionContext, isDestroyed, isEffectivelyVisible, isRendered, isVisible, mapAbstractUiComponentProperties, queueCommandIfRendered, render, reRenderIfRendered, setCssStyle, setMargin, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setParent, setShadow, setVisible, 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.Component

createUiComponentReference, destroy, getId, getParent, getSessionContext, isDestroyed, isEffectivelyVisible, isRendered, isVisible, render, setCssStyle, setCssStyle, setMargin, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setParent, setShadow, setVisible, unrender

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

isChildVisible

Field Detail

onCellEditingStarted

public final Event<CellEditingStartedEvent<RECORD,java.lang.Object>> onCellEditingStarted

onCellEditingStopped

public final Event<CellEditingStoppedEvent<RECORD>> onCellEditingStopped

onCellValueChanged

public final Event<FieldValueChangedEventData<RECORD,java.lang.Object>> onCellValueChanged

onRowSelected

public final Event<RECORD> onRowSelected

onMultipleRowsSelected

public final Event<java.util.List<RECORD>> onMultipleRowsSelected

onSortingChanged

public final Event<SortingChangedEventData> onSortingChanged

onTableDataRequest

public final Event<TableDataRequestEventData> onTableDataRequest

onFieldOrderChange

public final Event<FieldOrderChangeEventData> onFieldOrderChange

onColumnSizeChange

public final Event<ColumnSizeChangeEventData> onColumnSizeChange

Constructor Detail

Table

public Table()

Table

public Table(java.util.List<TableColumn> columns)

Method Detail

create

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

doDestroy

protected void doDestroy()

Description copied from class: AbstractComponent

Override this method to release resources whenever this component gets destroyed

Overrides:

doDestroy in class AbstractComponent

addColumn

public void addColumn(TableColumn column)

addColumn

public void addColumn(TableColumn column,
                      int index)

addColumns

public void addColumns(java.util.List<TableColumn> newColumns,
                       int index)

removeColumn

public void removeColumn(java.lang.String propertyName)

removeColumn

public void removeColumn(TableColumn column)

removeColumns

public void removeColumns(java.util.List<TableColumn> obsoleteColumns)

createUiComponent

public org.teamapps.dto.UiComponent createUiComponent()

Specified by:

createUiComponent in class AbstractComponent

handleUiEvent

public void handleUiEvent(org.teamapps.dto.UiEvent event)

Specified by:

handleUiEvent in interface Component

getColumnNames

public java.util.List<java.lang.String> getColumnNames()

getActiveEditorCell

public TableCellCoordinates<RECORD> getActiveEditorCell()

getActiveEditorField

public AbstractField getActiveEditorField()

setCellValue

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

focusCell

public void focusCell(RECORD record,
                      java.lang.String propertyName)

setCellMarked

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

clearRecordMarkings

public void clearRecordMarkings(RECORD record)

clearAllCellMarkings

public void clearAllCellMarkings()

setRecordBold

public void setRecordBold(RECORD record,
                          boolean bold)

selectSingleRow

public void selectSingleRow(RECORD record,
                            boolean scrollToRecord)

getCellMessages

public java.util.List<FieldMessage> getCellMessages(RECORD record,
                                                    java.lang.String propertyName)

addCellMessage

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

removeCellMessage

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

addNonModelRecord

public void addNonModelRecord(RECORD record,
                              boolean addToTop)

removeNonModelRecord

public void removeNonModelRecord(RECORD record)

removeAllNonModelRecords

public void removeAllNonModelRecords()

getModel

public TableModel getModel()

setModel

public void setModel(TableModel<RECORD> model)

clearRecordMessages

public void clearRecordMessages(RECORD record)

updateRecordMessages

public void updateRecordMessages(RECORD record,
                                 java.util.Map<java.lang.String,java.util.List<FieldMessage>> messages)

refreshData

public void refreshData()

cancelEditing

public void cancelEditing()

getColumns

public java.util.List<TableColumn> 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(org.teamapps.common.format.Color stripedRowColorEven)

setStripedRowColorOdd

public void setStripedRowColorOdd(org.teamapps.common.format.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(org.teamapps.common.format.Color selectionColor)

setRowBorderWidth

public void setRowBorderWidth(int rowBorderWidth)

setRowBorderColor

public void setRowBorderColor(org.teamapps.common.format.Color rowBorderColor)

isShowRowCheckBoxes

public boolean isShowRowCheckBoxes()

setShowRowCheckBoxes

public void setShowRowCheckBoxes(boolean showRowCheckBoxes)

isShowNumbering

public boolean isShowNumbering()

setShowNumbering

public void setShowNumbering(boolean showNumbering)

getSorting

public Sorting getSorting()

getSortField

public java.lang.String getSortField()

setSortField

public void setSortField(java.lang.String sortField)

getSortDirection

public SortDirection getSortDirection()

setSortDirection

public void setSortDirection(SortDirection sortDirection)

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 java.lang.String getIndentedColumnName()

setIndentedColumnName

public void setIndentedColumnName(java.lang.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(org.teamapps.common.format.Color headerRowBorderColor)

getHeaderRowHeight

public int getHeaderRowHeight()

setHeaderRowHeight

public void setHeaderRowHeight(int headerRowHeight)

setHeaderRowBackgroundColor

public void setHeaderRowBackgroundColor(org.teamapps.common.format.Color headerRowBackgroundColor)

getHeaderRowFields

public java.util.Map<java.lang.String,AbstractField> getHeaderRowFields()

setHeaderRowFields

public void setHeaderRowFields(java.util.Map<java.lang.String,AbstractField> headerRowFields)

setHeaderRowField

public void setHeaderRowField(java.lang.String columnName,
                              AbstractField field)

isShowFooterRow

public boolean isShowFooterRow()

setShowFooterRow

public void setShowFooterRow(boolean showFooterRow)

setFooterRowBorderWidth

public void setFooterRowBorderWidth(int footerRowBorderWidth)

setFooterRowBorderColor

public void setFooterRowBorderColor(org.teamapps.common.format.Color footerRowBorderColor)

getFooterRowHeight

public int getFooterRowHeight()

setFooterRowHeight

public void setFooterRowHeight(int footerRowHeight)

setFooterRowBackgroundColor

public void setFooterRowBackgroundColor(org.teamapps.common.format.Color footerRowBackgroundColor)

getFooterRowFields

public java.util.Map<java.lang.String,AbstractField> getFooterRowFields()

setFooterRowFields

public void setFooterRowFields(java.util.Map<java.lang.String,AbstractField> footerRowFields)

setFooterRowField

public void setFooterRowField(java.lang.String columnName,
                              AbstractField field)

setPageSize

public void setPageSize(int pageSize)

getColumnByPropertyName

public TableColumn getColumnByPropertyName(java.lang.String propertyName)

getHeaderRowFieldByName

public AbstractField getHeaderRowFieldByName(java.lang.String propertyName)

getFooterRowFieldByName

public AbstractField getFooterRowFieldByName(java.lang.String propertyName)

getRecordsWithChangedCellValues

public java.util.List<RECORD> getRecordsWithChangedCellValues()

getChangedCellValues

public java.util.Map<java.lang.String,java.lang.Object> getChangedCellValues(RECORD record)

getAllCellValues

public java.util.Map<java.lang.String,java.lang.Object> getAllCellValues(RECORD record)

clearChangeBuffer

public void clearChangeBuffer()

applyCellValuesToRecord

public void applyCellValuesToRecord(RECORD record)

revertChanges

public void revertChanges()

getSelectedRecord

public RECORD getSelectedRecord()

getPropertyExtractor

public PropertyExtractor<RECORD> getPropertyExtractor()

setPropertyExtractor

public void setPropertyExtractor(PropertyExtractor<RECORD> propertyExtractor)

getPropertyInjector

public PropertyInjector<RECORD> getPropertyInjector()

setPropertyInjector

public void setPropertyInjector(PropertyInjector<RECORD> propertyInjector)

setMaxCacheCapacity

public void setMaxCacheCapacity(int maxCapacity)

getMaxCacheCapacity

public int getMaxCacheCapacity()

getSelectedRecords

public java.util.List<RECORD> getSelectedRecords()