org.gwt.advanced.client.datamodel

Interface Editable

All Superinterfaces:

GridDataModel, Pageable

All Known Subinterfaces:

Composite, Hierarchical

All Known Implementing Classes:

EditableGridDataModel, HierarchicalGridDataModel, LazyGridDataModel, LazyHierarchicalGridDataModel, LazyTreeGridDataModel, LazyTreeGridDataModel.DelegateLazyGridDataModel, TreeGridDataModel, TreeGridDataModel.DelegateEditableGridDataModel

public interface Editable
extends GridDataModel

This is interface describing an editable table.

Since:

1.0.0

Author:

Sergey Skladchikov

Method Summary

Methods

Modifier and Type	Method and Description
void	addColumn(int beforeColumn, Object[] column) This method adds a column into the model.
void	addColumn(int beforeColumn, String name, Object[] column) This method adds a column into the model.
void	addListener(EditableModelListener listener) This method registers the specified listener to receive model events.
void	addRow(int beforeRow, Object[] row) This method adds a row into the model.
void	clearRemovedRows() This method clears removed rows from the model history
String[]	getColumnNames() This method gets a list of column names.
GridColumn[]	getColumns() Gets an array of all model columns.
GridColumn	getGridColumn(int index) Gets a grid column by index.
DataModelCallbackHandler<Editable>	getHandler() This method returns a callback handler instance.
Object[][]	getRemovedRows() This method returns removed rows.
GridRow	getRow(int index) Gets a grid row by index.
GridRow[]	getRows() This method returns all rows of the model.
int	getTotalColumnCount() This method returns a total row count.
void	removeAll() This method removes all rows from the model.
void	removeColumn(int columnNumber) This method removes a column from the model.
void	removeColumn(String name) This method removes a column from the model.
void	removeListener(EditableModelListener listener) This method unregisters the specified listener to stop model events receiving.
void	removeRow(int rowNumber) This method removes a row from the model.
void	setColumNames(String[] names) This method sets a list of column names This list must be in the same order like the data array columns (see update(Object[][]) for details.
void	setHandler(DataModelCallbackHandler<Editable> handler) This method sets a callback handler.
void	setSortColumn(int sortColumn, Comparator<Object> comparator) This method sets a sort column and uses the specified comparator.
void	update(int row, int column, Object data) This method updates the specified cell with the value.
void	update(Object[][] data) This method updates data in the model using the specified value.
void	updateColumn(int columnNumber, Object[] column) This method updates a column with the specified data set.
void	updateColumn(String name, Object[] column) This method updates a column with the specified data set.
void	updateRow(int rowNumber, Object[] row) This method updates a row with the specified data set.

Methods inherited from interface org.gwt.advanced.client.datamodel.GridDataModel

getData, getEndRow, getRowData, getSortColumn, getStartRow, getTotalRowCount, isAscending, isEmpty, setAscending, setSortColumn

Methods inherited from interface org.gwt.advanced.client.datamodel.Pageable

getCurrentPageNumber, getDisplayedPages, getEndPage, getPageSize, getStartPage, getTotalPagesNumber, setCurrentPageNumber, setDisplayedPages, setPageSize

Method Detail

addRow

void addRow(int beforeRow,
          Object[] row)
            throws IllegalArgumentException

This method adds a row into the model.

Parameters:

beforeRow - is a row number.

row - is row data.

Throws:

IllegalArgumentException - if the row number is invalid.

updateRow

void updateRow(int rowNumber,
             Object[] row)
               throws IllegalArgumentException

This method updates a row with the specified data set.

Parameters:

rowNumber - is a row number.

row - is row data.

Throws:

IllegalArgumentException - if the row number is invalid.

removeRow

void removeRow(int rowNumber)
               throws IllegalArgumentException

This method removes a row from the model.

Parameters:

rowNumber - is a row number.

Throws:

IllegalArgumentException - if the row number is invalid.

addColumn

void addColumn(int beforeColumn,
             Object[] column)
               throws IllegalArgumentException

This method adds a column into the model.

Parameters:

beforeColumn - a column number.

column - a column data set.

Throws:

IllegalArgumentException - if the column number is invalid.

addColumn

void addColumn(int beforeColumn,
             String name,
             Object[] column)
               throws IllegalArgumentException

This method adds a column into the model.

Parameters:

beforeColumn - a column number.

name - a column name.

column - a column data set.

Throws:

IllegalArgumentException - if the column number is invalid.

updateColumn

void updateColumn(int columnNumber,
                Object[] column)
                  throws IllegalArgumentException

This method updates a column with the specified data set.

Parameters:

columnNumber - a column number.

column - a column data set.

Throws:

IllegalArgumentException - if the column number is invalid.

updateColumn

void updateColumn(String name,
                Object[] column)

This method updates a column with the specified data set.

Parameters:

name - a column name.

column - a column data set.

removeColumn

void removeColumn(int columnNumber)
                  throws IllegalArgumentException

This method removes a column from the model.

Parameters:

columnNumber - a column number.

Throws:

IllegalArgumentException - if the column number is invalid.

removeColumn

void removeColumn(String name)

This method removes a column from the model.

Parameters:

name - a column name.

removeAll

void removeAll()

This method removes all rows from the model.

update

void update(int row,
          int column,
          Object data)
            throws IllegalArgumentException

This method updates the specified cell with the value.

Parameters:

row - is a row number.

column - is a column number.

data - is a data to be applied.

Throws:

IllegalArgumentException - if row and / or column number is invalid.

setSortColumn

void setSortColumn(int sortColumn,
                 Comparator<Object> comparator)

This method sets a sort column and uses the specified comparator.

Parameters:

sortColumn - is a sort column.

comparator - is a column comparator.

getHandler

DataModelCallbackHandler<Editable> getHandler()

This method returns a callback handler instance.

Returns:

a callback handler.

update

void update(Object[][] data)

This method updates data in the model using the specified value.

Parameters:

data - is a data to be placed.

setHandler

void setHandler(DataModelCallbackHandler<Editable> handler)

This method sets a callback handler.

Parameters:

handler - a callback handler.

getTotalColumnCount

int getTotalColumnCount()

This method returns a total row count.

Returns:

a total row count.

getRemovedRows

Object[][] getRemovedRows()

This method returns removed rows.

Returns:

a list of removed rows.

clearRemovedRows

void clearRemovedRows()

This method clears removed rows from the model history

getRows

GridRow[] getRows()

This method returns all rows of the model.

Returns:

a grid row array.

getColumns

GridColumn[] getColumns()

Gets an array of all model columns.

Returns:

a columns array.

getRow

GridRow getRow(int index)

Gets a grid row by index.

Parameters:

index - is an index value.

Returns:

a grid row.

getGridColumn

GridColumn getGridColumn(int index)

Gets a grid column by index.

Parameters:

index - is an index value.

Returns:

a grid column.

getColumnNames

String[] getColumnNames()

This method gets a list of column names.

Size of this list must be equal to the size of the model data array.

Returns:

is a list of column names.

setColumNames

void setColumNames(String[] names)

This method sets a list of column names

This list must be in the same order like the data array columns (see update(Object[][]) for details.

Parameters:

names - is a list of column names.

addListener

void addListener(EditableModelListener listener)

This method registers the specified listener to receive model events.

Parameters:

listener - is a model listener to register.

removeListener

void removeListener(EditableModelListener listener)

This method unregisters the specified listener to stop model events receiving.

Parameters:

listener - is a model listener to be removed.