is.codion.swing.common.model.component.table

Interface FilteredTableSortModel<R,C>

Type Parameters:

R - the type representing a row in the table model

C - the type representing the column identifiers in the table model

public interface FilteredTableSortModel<R,C>

Handles the column sorting states for a FilteredTableModel.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FilteredTableSortModel.ColumnSortOrder<C> Specifies a sorting state for a column.

Method Summary

Modifier and Type	Method and Description
void	addSortingChangedListener(EventDataListener<C> listener)
void	addSortOrder(C columnIdentifier, SortOrder sortOrder) Adds the given column sorting order to the currently sorted columns.
void	clear() Clears the sorting states from this sort model.
List<FilteredTableSortModel.ColumnSortOrder<C>>	columnSortOrder() Returns the current column sort order, in order of priority
boolean	isSortingEnabled()
void	setSortOrder(C columnIdentifier, SortOrder sortOrder) Clears the sorting state and adds the given column sorting order.
void	sort(List<R> items) Sorts the given list according to the sort configuration
SortOrder	sortOrder(C columnIdentifier)
int	sortPriority(C columnIdentifier)

Method Detail

sort

void sort(List<R> items)

Sorts the given list according to the sort configuration

Parameters:

items - the items to sort

setSortOrder

void setSortOrder(C columnIdentifier,
                  SortOrder sortOrder)

Clears the sorting state and adds the given column sorting order.

Parameters:

columnIdentifier - the identifier of the column to sort by

sortOrder - the sorting order

See Also:

addSortOrder(Object, SortOrder), sortOrder(Object)

addSortOrder

void addSortOrder(C columnIdentifier,
                  SortOrder sortOrder)

Adds the given column sorting order to the currently sorted columns. If no column sorting is enabled, this call is the equivilent to using setSortOrder(Object, SortOrder).

Parameters:

columnIdentifier - the identifier of the column to sort by

sortOrder - the sorting order

See Also:

setSortOrder(Object, SortOrder), sortOrder(Object)

sortOrder

SortOrder sortOrder(C columnIdentifier)

Parameters:

columnIdentifier - the column identifier

Returns:

the SortOrder associated with the given column

sortPriority

int sortPriority(C columnIdentifier)

Parameters:

columnIdentifier - the column identifier

Returns:

the sort priority for the given column, -1 if not sorted

isSortingEnabled

boolean isSortingEnabled()

Returns:

true if sorting is enabled for one or more columns

columnSortOrder

List<FilteredTableSortModel.ColumnSortOrder<C>> columnSortOrder()

Returns the current column sort order, in order of priority

Returns:

the current column sort order, in order of priority

clear

void clear()

Clears the sorting states from this sort model. Note that only one sorting change event will happen, with the first sort column.

addSortingChangedListener

void addSortingChangedListener(EventDataListener<C> listener)

Parameters:

listener - a listener notified each time the sorting state changes, with the column identifier as event data