to.etc.domui.component.tbl

Class SortableListModel<T>

java.lang.Object

to.etc.domui.component.tbl.TableModelBase<T>

to.etc.domui.component.tbl.TableListModelBase<T>

to.etc.domui.component.tbl.SimpleListModel<T>

to.etc.domui.component.tbl.SortableListModel<T>

All Implemented Interfaces:

IModifyableTableModel<T>, ISortableTableModel, ITableModel<T>, ITruncateableDataModel

public class SortableListModel<T>
extends SimpleListModel<T>
implements ISortableTableModel, ITruncateableDataModel

This is a list model where the list instance will be maintained by the model, and where the values can be sorted using property based sorting.

Author:

Frits Jalvingh Created on Aug 8, 2011

Field Summary

Fields inherited from interface to.etc.domui.component.tbl.ITableModel

DEFAULT_MAX_SIZE, IN_MEMORY_FILTER_OR_SORT_MAX_SIZE

Constructor Summary

Constructors

Constructor and Description
SortableListModel(Class<T> clz, List<T> list)

Method Summary

Modifier and Type	Method and Description
Class<T>	getDataClass() Returns the type of the record contained in the list.
String	getSortKey() DO NOT USE: Whomever uses the model should define sorting and remember it.
boolean	isSortDescending() DO NOT USE: Whomever uses the model should define sorting and remember it.
boolean	isTruncated() Return true if the result is truncated.
void	setComparator(Comparator<T> comparator) Sets a new comparator to use.
void	setTruncated(boolean tr)
void	sortOn(String key, boolean descending)

Methods inherited from class to.etc.domui.component.tbl.SimpleListModel

getList

Methods inherited from class to.etc.domui.component.tbl.TableListModelBase

add, add, delete, delete, getComparator, getItem, getItems, getRows, indexOf, modified, modified, move

Methods inherited from class to.etc.domui.component.tbl.TableModelBase

addChangeListener, fireAdded, fireDeleted, fireModelChanged, fireModified, getListeners, refresh, removeChangeListener

Methods inherited from class java.lang.Object

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

Constructor Detail

SortableListModel

public SortableListModel(Class<T> clz,
                         List<T> list)

Method Detail

getDataClass

public Class<T> getDataClass()

Returns the type of the record contained in the list.

Returns:

sortOn

public void sortOn(String key,
                   boolean descending)
            throws Exception

Specified by:

sortOn in interface ISortableTableModel

Throws:

Exception

setComparator

public void setComparator(Comparator<T> comparator)
                   throws Exception

Description copied from class: TableListModelBase

Sets a new comparator to use. This resorts the model, if needed, causing a full model update.

Overrides:

setComparator in class TableListModelBase<T>

Throws:

Exception

getSortKey

public String getSortKey()

Description copied from interface: ISortableTableModel

DO NOT USE: Whomever uses the model should define sorting and remember it. If this model is currently sorted, this returns an identifier (usually a property reference) indicating on which column the thingy is sorted. If the model is unsorted this returns null.

Specified by:

getSortKey in interface ISortableTableModel

Returns:

isSortDescending

public boolean isSortDescending()

Description copied from interface: ISortableTableModel

DO NOT USE: Whomever uses the model should define sorting and remember it. If the set is a sorted set, this returns TRUE if the sort order is descending. The return value is undefined for an unsorted model.

Specified by:

isSortDescending in interface ISortableTableModel

Returns:

isTruncated

public boolean isTruncated()

Description copied from interface: ITruncateableDataModel

Return true if the result is truncated.

Specified by:

isTruncated in interface ITruncateableDataModel

Returns:

setTruncated

public void setTruncated(boolean tr)