com.codename1.ui.table

Class SortableTableModel

java.lang.Object

com.codename1.ui.table.AbstractTableModel

com.codename1.ui.table.SortableTableModel

All Implemented Interfaces:

TableModel

public class SortableTableModel
extends AbstractTableModel

A proxy that wraps the table model providing sorting API that can be leveraged by the table

Author:

Shai Almog

Constructor Summary

Constructors

Constructor and Description
SortableTableModel(int column, boolean asc, TableModel model, Comparator cmp) Sorts a table based on the given column

Method Summary

Modifier and Type	Method and Description
void	addDataChangeListener(DataChangedListener d) Adds a listener to the data changed event
Class	getCellType(int row, int column) Allows the table to hint the class type of a specific cell
int	getColumnCount() Returns the number of columns in the table
String	getColumnName(int i) Returns the name of the column at the given offset
String[]	getMultipleChoiceOptions(int row, int column) Allows the table cell to feature multiple choice for a specific entry
int	getRowCount() Returns the number of rows in the table
int	getSortedPosition(int row) Returns the position of the row when sorted
TableModel	getUnderlying() Returns the underlying table model
Constraint	getValidationConstraint(int row, int column) If the cell has a validation constraint it's returned here
Validator	getValidator() A validator can be defined here so a validation constraint can bind to a table model cell
Object	getValueAt(int row, int column) Returns the value of the cell at the given location
boolean	isCellEditable(int row, int column) Returns true if the cell at the given location is an editable cell
void	removeDataChangeListener(DataChangedListener d) Removes a listener to the data changed event
void	setValidator(Validator validator) A validator can be defined here so a validation constraint can bind to a table model cell
void	setValueAt(int row, int column, Object o) Sets the value of the cell at the given location

Methods inherited from class java.lang.Object

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

Constructor Detail

SortableTableModel

public SortableTableModel(int column,
                          boolean asc,
                          TableModel model,
                          Comparator cmp)

Sorts a table based on the given column

Parameters:

column - the column to sort

asc - the direction ascending/descending

model - the underlying model that will be sorted

cmp - a comparator used for comparing the cells in the column

Method Detail

getUnderlying

public TableModel getUnderlying()

Returns the underlying table model

Returns:

the model

getSortedPosition

public int getSortedPosition(int row)

Returns the position of the row when sorted

Parameters:

row - the row in the visual table

Returns:

the position in the underlying model

getRowCount

public int getRowCount()

Returns the number of rows in the table

Returns:

the number of rows in the table

getColumnCount

public int getColumnCount()

Returns the number of columns in the table

Returns:

the number of columns in the table

getColumnName

public String getColumnName(int i)

Returns the name of the column at the given offset

Parameters:

i - the offset for the column name

Returns:

name to display at the top of the table

isCellEditable

public boolean isCellEditable(int row,
                              int column)

Returns true if the cell at the given location is an editable cell

Parameters:

row - the cell row

column - the cell column

Returns:

true if the cell at the given location is an editable cell

getValueAt

public Object getValueAt(int row,
                         int column)

Returns the value of the cell at the given location

Parameters:

row - the cell row

column - the cell column

Returns:

the value of the cell at the given location

setValueAt

public void setValueAt(int row,
                       int column,
                       Object o)

Sets the value of the cell at the given location

Parameters:

row - the cell row

column - the cell column

o - the value of the cell at the given location

addDataChangeListener

public void addDataChangeListener(DataChangedListener d)

Adds a listener to the data changed event

Parameters:

d - the new listener

removeDataChangeListener

public void removeDataChangeListener(DataChangedListener d)

Removes a listener to the data changed event

Parameters:

d - the listener to remove

getValidationConstraint

public Constraint getValidationConstraint(int row,
                                          int column)

If the cell has a validation constraint it's returned here

Overrides:

getValidationConstraint in class AbstractTableModel

Parameters:

row - the row

column - the column for the cell

Returns:

null for no constraints

getCellType

public Class getCellType(int row,
                         int column)

Allows the table to hint the class type of a specific cell

Overrides:

getCellType in class AbstractTableModel

Parameters:

row - the row in the table

column - the column

Returns:

the class representing this cell

getMultipleChoiceOptions

public String[] getMultipleChoiceOptions(int row,
                                         int column)

Allows the table cell to feature multiple choice for a specific entry

Overrides:

getMultipleChoiceOptions in class AbstractTableModel

Parameters:

row - the row in the table

column - the column

Returns:

the string values matching the entries or null if this isn't a multiple choice option

setValidator

public void setValidator(Validator validator)

Description copied from class: AbstractTableModel

A validator can be defined here so a validation constraint can bind to a table model cell

Overrides:

setValidator in class AbstractTableModel

Parameters:

validator - the validator to set

getValidator

public Validator getValidator()

Description copied from class: AbstractTableModel

A validator can be defined here so a validation constraint can bind to a table model cell

Overrides:

getValidator in class AbstractTableModel

Returns:

the validator