net.sf.cuf.ui.table

Class TableSortInfo

java.lang.Object

net.sf.cuf.ui.table.TableSortInfo

public class TableSortInfo
extends Object

TableSortInfo holds all information about current sorting order and sorting direction. The order of the entries is important, because this is the prio in which compares of multiple columns will be performed.

Author:

Jörg Eichhorn, sd&m AG

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TableSortInfo.Entry Immutable sorting information entry.

Constructor Summary

Constructors

Constructor and Description
TableSortInfo() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clear the current sorting.
TableSortInfo	cloneImmutable() Create an immutable clone of this object.
int	find(int pColumnIndex) Find a sorting entry for a column.
int	getColumn(int pEntryIndex) Get colum information from a sorting entry.
boolean	isAscending(int pEntryIndex) Get ascending/descending information from a sorting entry.
boolean	isSorted(int pColumnIndex) Check if there is a sorting defined for a column.
int	size() Get the number of sorting information entries.
void	sortByColumn(int pColumn, boolean pAscending) Append sorting information entry.

Methods inherited from class java.lang.Object

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

Constructor Detail

TableSortInfo

public TableSortInfo()

Constructor.

Method Detail

cloneImmutable

public TableSortInfo cloneImmutable()

Create an immutable clone of this object. The clone will see all changes applied to the original object.

Returns:

cloned object

clear

public void clear()

Clear the current sorting.

size

public int size()

Get the number of sorting information entries.

Returns:

number of entries

isSorted

public boolean isSorted(int pColumnIndex)

Check if there is a sorting defined for a column.

Parameters:

pColumnIndex - model index of a column

Returns:

true if there is a sorting entry for the column

find

public int find(int pColumnIndex)

Find a sorting entry for a column.

Parameters:

pColumnIndex - model index of a column

Returns:

entry index of the sorting info or -1 if the column is not sorted

getColumn

public int getColumn(int pEntryIndex)

Get colum information from a sorting entry.

Parameters:

pEntryIndex - index of sorting entry

Returns:

model column index

isAscending

public boolean isAscending(int pEntryIndex)

Get ascending/descending information from a sorting entry.

Parameters:

pEntryIndex - index of sorting entry

Returns:

true if sorting is to be done ascending

sortByColumn

public void sortByColumn(int pColumn,
                boolean pAscending)

Append sorting information entry. The sorting information is appended to the currently defined sorting. For a new sorting use clear() first.

Parameters:

pColumn - model index of column to be sorted

pAscending - true if sorting is to be done ascending