Class DefaultTableContentProvider
java.lang.Object
com.iizix.prop.ui.table.DefaultTableContentProvider
- All Implemented Interfaces:
ITableContentProvider<VSColumnHeader[], VSColumnHeader, VSRow, VSField>
public class DefaultTableContentProvider extends Object implements ITableContentProvider<VSColumnHeader[], VSColumnHeader, VSRow, VSField>
The default grid content provider.
- Author:
- Christopher Mindus
Field Summary
FieldsModifier and TypeFieldDescriptionprotected UITableColumn[]The columns.protected UITableThe UI table instance.protected VSColumnHeader[]The VS columns.protected VSTableThe VS table instance, null for none.Constructor Summary
ConstructorsMethod Summary
Modifier and TypeMethodDescriptionvoiddispose()Called when the content provider is no longer required by the table.Returns the first selected row for single selection table.Gets the header object.getHeaderCells(VSColumnHeader[] header) Gets the header cells.getRowCell(VSField cell, int columnIndex, int rowIndex) Gets the row cell information.VSField[]getRowCells(VSRow row) Gets the cells for a row object.VSRow[]getRows()Gets the row objects.intgetRowStyle(VSRow row, int filteredRowIndex) Gets the row style.protected voidInitializes values for columns and VirtualSpace.booleanisRowCellSelected(VSField cell) Returns if the cell is selected or not.booleanisRowSelected(VSRow row) Returns if the row is selected or not.voidonCellUpdated(VSField cell, TCell value) Cell update event.voidonInitialize(UITable table) Called to initialize the content provider for the UITable instance.voidThis method is called when the table needs re-initialization due to e.g.voidonRowSelection(TableRow tableRow, VSRow row, boolean on) Called when the row selection state is changed.
Field Details
uiTable
The UI table instance. Use only afteronInitialize(UITable)has been called.columns
The columns. Use only afterinitialize()has been called.vsTable
The VS table instance, null for none. Use only afterinitialize()has been called.vsColumns
The VS columns. Use only afterinitialize()has been called.
Constructor Details
DefaultTableContentProvider
public DefaultTableContentProvider()Public constructor.
Method Details
onInitialize
Called to initialize the content provider for the UITable instance.- Specified by:
onInitializein interfaceITableContentProvider<VSColumnHeader[], VSColumnHeader, VSRow, VSField>
onReinitialized
public void onReinitialized()This method is called when the table needs re-initialization due to e.g. a change of the VSTable or one of the columns.- Specified by:
onReinitializedin interfaceITableContentProvider<VSColumnHeader[], VSColumnHeader, VSRow, VSField>
initialize
protected void initialize()Initializes values for columns and VirtualSpace.dispose
public void dispose()Called when the content provider is no longer required by the table.- Specified by:
disposein interfaceITableContentProvider<VSColumnHeader[], VSColumnHeader, VSRow, VSField>
getHeader
Gets the header object.- Specified by:
getHeaderin interfaceITableContentProvider<VSColumnHeader[], VSColumnHeader, VSRow, VSField>- Returns:
- The header object, or null for no header.
getHeaderCells
Gets the header cells.- Specified by:
getHeaderCellsin interfaceITableContentProvider<VSColumnHeader[], VSColumnHeader, VSRow, VSField>- Parameters:
header- The header object, never null.- Returns:
- The cell array.
getRows
Gets the row objects.- Specified by:
getRowsin interfaceITableContentProvider<VSColumnHeader[], VSColumnHeader, VSRow, VSField>- Returns:
- The row object array.
getRowCells
Gets the cells for a row object.- Specified by:
getRowCellsin interfaceITableContentProvider<VSColumnHeader[], VSColumnHeader, VSRow, VSField>- Parameters:
row- The row object.- Returns:
- The cells. Note: the array of cells may very well be shorter or longer than the actual number of columns in table.
isRowSelected
Returns if the row is selected or not. This method is only called if the table has row selection enabled and has multiple selection.- Specified by:
isRowSelectedin interfaceITableContentProvider<VSColumnHeader[], VSColumnHeader, VSRow, VSField>- Returns:
- true if selected, false otherwise.
getFirstSelectedRow
Returns the first selected row for single selection table. This method is only called if the row selection is enabled and set to single selection.- Specified by:
getFirstSelectedRowin interfaceITableContentProvider<VSColumnHeader[], VSColumnHeader, VSRow, VSField>- Returns:
- The selected row.
getRowStyle
Gets the row style.- Specified by:
getRowStylein interfaceITableContentProvider<VSColumnHeader[], VSColumnHeader, VSRow, VSField>- Parameters:
row- The row index.filteredRowIndex- The filtered row index, not necessarily the same at the real row index.- Returns:
- The row style index registered with the table, or zero for none.
onRowSelection
Called when the row selection state is changed.- Specified by:
onRowSelectionin interfaceITableContentProvider<VSColumnHeader[], VSColumnHeader, VSRow, VSField>- Parameters:
tableRow- The table row affected.row- The row whose selection state changed.on- The new selection state.
isRowCellSelected
Returns if the cell is selected or not. This method is called only when the table has cell selection enabled.- Specified by:
isRowCellSelectedin interfaceITableContentProvider<VSColumnHeader[], VSColumnHeader, VSRow, VSField>- Parameters:
cell- The cell.- Returns:
- true if cell is selected, false otherwise.
getRowCell
Gets the row cell information.- Specified by:
getRowCellin interfaceITableContentProvider<VSColumnHeader[], VSColumnHeader, VSRow, VSField>- Parameters:
cell- The cell object.columnIndex- The column index.rowIndex- The row index before filtering.- Returns:
- The cell contents.
onCellUpdated
Cell update event.- Specified by:
onCellUpdatedin interfaceITableContentProvider<VSColumnHeader[], VSColumnHeader, VSRow, VSField>- Parameters:
cell- The cell object.value- The new value.