Package com.github.bordertech.wcomponents

Interface TableDataModel

All Known Subinterfaces:

BeanTableDataModel, ScrollableTableDataModel, TreeTableDataModel

All Known Implementing Classes:

AbstractBeanTableDataModel, AbstractTableDataModel, AbstractTreeTableDataModel, EmptyTableDataModel, SimpleBeanBoundTableDataModel, SimpleBeanListTableDataModel, SimpleBeanTreeTableDataModel, SimpleTableDataModel

@Deprecated
public interface TableDataModel

Deprecated.

Use WTable and WTable.TableModel instead.

TableDataModel provides the data for tables. In a MVC sense, the TableDataModel is the Model, the WDataTable is the controller and the view is comprised of the WDataTable layout and column renderers.

Note that Data may be stored locally or sourced remotely, depending on the particular TableDataModel implementation.

Row and column indices for all methods are zero-based, and TableDataModels are not expected to perform bounds-checking.

Since:

1.0.0

Author:

Yiannis Paschalidis

Method Summary

Modifier and Type	Method	Description
List<String>	getFilterValues(int row)	Deprecated. Retrieves the filter values for this row.
int	getRowCount()	Deprecated. Retrieves the number of rows in the model.
String	getRowHeader(int row)	Deprecated. Retrieves the row heading text for the given row.
Object	getValueAt(int row, int col)	Deprecated. Retrieves the value at the given row and column.
boolean	isCellEditable(int row, int col)	Deprecated. Indicates whether the given cell is editable.
boolean	isDisabled(int row)	Deprecated. Indicates whether the given row is disabled.
boolean	isSelectable(int row)	Deprecated. Indicates whether the given row is selectable.
boolean	isSortable(int col)	Deprecated. Indicates whether the model supports sorting by the given column.
void	setValueAt(Object value, int row, int col)	Deprecated. Sets the value at the given row and column.
int[]	sort(int col, boolean ascending)	Deprecated. Sorts the data by the given column.

Method Detail

getValueAt

Object getValueAt(int row,
                  int col)

Deprecated.

Retrieves the value at the given row and column.

Parameters:

row - - the row index.

col - - the column index.

Returns:

the value at the given row and column.

isCellEditable

boolean isCellEditable(int row,
                       int col)

Deprecated.

Indicates whether the given cell is editable.

Parameters:

row - - the row index.

col - - the column index.

Returns:

true if the given cell is editable, false otherwise.

setValueAt

void setValueAt(Object value,
                int row,
                int col)

Deprecated.

Sets the value at the given row and column.

Parameters:

value - the value to set.

row - - the row index.

col - - the column index.

isSortable

boolean isSortable(int col)

Deprecated.

Indicates whether the model supports sorting by the given column.

Parameters:

col - the column index.

Returns:

true if the model is sortable by the given column, false otherwise.

sort

int[] sort(int col,
           boolean ascending)

Deprecated.

Sorts the data by the given column. Any previous sorting should be disregarded.

Data models must implement sorting in one of two ways.

1. If the data is accessible locally by the data model (ie. a sort won't result in a service call to obtain sorted data), then this method should not sort the actual data, but return a row-index mapping which the table will use to access the data. Row selection and expansion will be updated to use the new row indices.

   For example, if the data for the column is {"a", "b", "d", "c"}, then an ascending sort should return {0, 1, 3, 2}, and a descending sort {2, 3, 1, 0}.

2. If the data is not accessible locally by the data model, or the model is otherwise unable to perform a mapping between old and new row indices, then the model should sort the actual data, and return null. In this case, the table will reset any row selection or expansion.

Parameters:

col - the column to sort on

ascending - true for an ascending sort, false for descending.

Returns:

the row indices in sort order, or null if row mappings can not be determined.

isDisabled

boolean isDisabled(int row)

Deprecated.

Indicates whether the given row is disabled.

Parameters:

row - the row index

Returns:

true if the row is disabled, false otherwise.

isSelectable

boolean isSelectable(int row)

Deprecated.

Indicates whether the given row is selectable.

Parameters:

row - the row index

Returns:

true if the row is disabled, false otherwise.

getFilterValues

List<String> getFilterValues(int row)

Deprecated.

Retrieves the filter values for this row.

Parameters:

row - the row index

Returns:

the filter values for this row.

getRowCount

int getRowCount()

Deprecated.

Retrieves the number of rows in the model.

Returns:

the number of rows in the model.

getRowHeader

String getRowHeader(int row)

Deprecated.

Retrieves the row heading text for the given row.

Parameters:

row - the row index

Returns:

the row heading text for the given row.