de.cismet.cids.custom.wrrl_db_mv.util

Class SortedListModel

java.lang.Object

javax.swing.AbstractListModel

de.cismet.cids.custom.wrrl_db_mv.util.SortedListModel

All Implemented Interfaces:

Serializable, ListModel

public class SortedListModel
extends AbstractListModel

SortedListModel decorates an unsorted ListModel to provide a sorted model. You can create a SortedListModel from models you already have. Place the SortedListModel into a JList, for example, to provide a sorted view of your underlying model.

Version:

$Revision$, $Date$

Author:

John O'Conner

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SortedListModel.SortOrder DOCUMENT ME!

Field Summary

Fields inherited from class javax.swing.AbstractListModel

listenerList

Constructor Summary

Constructors

Constructor and Description
SortedListModel(ListModel model) Create a SortedListModel from an existing model using a default text comparator for the default Locale.
SortedListModel(ListModel model, SortedListModel.SortOrder sortOrder) Create a SortedListModel from an existing model using a specific comparator and sort order.
SortedListModel(ListModel model, SortedListModel.SortOrder sortOrder, Comparator comp) Create a SortedListModel from an existing model.

Method Summary

Modifier and Type	Method and Description
Object	getElementAt(int index) Retrieve the sorted entry from the original model.
int	getSize() Retrieve the size of the underlying model.
void	setComparator(Comparator comp) DOCUMENT ME!
void	setSortOrder(SortedListModel.SortOrder sortOrder) Change the sort order of the model at runtime.
int	toSortedModelIndex(int unsortedIndex) Convert an unsorted model index to a sorted model index.
int[]	toSortedModelIndices(int[] unsortedModelIndices) Convert an array of unsorted model selection indices to indices in the sorted model.
int	toUnsortedModelIndex(int index) Convert sorted model index to an unsorted model index.
int[]	toUnsortedModelIndices(int[] sortedSelectedIndices) Convert an array of sorted model indices to their unsorted model indices.
void	unsortedContentsChanged() Resort the sorted model if there are changes in the original unsorted model.

Methods inherited from class javax.swing.AbstractListModel

addListDataListener, fireContentsChanged, fireIntervalAdded, fireIntervalRemoved, getListDataListeners, getListeners, removeListDataListener

Methods inherited from class java.lang.Object

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

Constructor Detail

SortedListModel

public SortedListModel(ListModel model)

Create a SortedListModel from an existing model using a default text comparator for the default Locale. Sort in ascending order.

Parameters:

model - the underlying, unsorted ListModel

SortedListModel

public SortedListModel(ListModel model,
                       SortedListModel.SortOrder sortOrder)

Create a SortedListModel from an existing model using a specific comparator and sort order. Use a default text comparator.

Parameters:

model - the unsorted list model

sortOrder - that should be used

SortedListModel

public SortedListModel(ListModel model,
                       SortedListModel.SortOrder sortOrder,
                       Comparator comp)

Create a SortedListModel from an existing model. Sort the model in the specified sort order using the given comparator.

Parameters:

model - DOCUMENT ME!

sortOrder - DOCUMENT ME!

comp - DOCUMENT ME!

Method Detail

getElementAt

public Object getElementAt(int index)
                    throws IndexOutOfBoundsException

Retrieve the sorted entry from the original model.

Parameters:

index - index of an entry in the sorted model

Returns:

element in the original model to which our entry points

Throws:

IndexOutOfBoundsException - DOCUMENT ME!

getSize

public int getSize()

Retrieve the size of the underlying model.

Returns:

size of the model

toUnsortedModelIndex

public int toUnsortedModelIndex(int index)
                         throws IndexOutOfBoundsException

Convert sorted model index to an unsorted model index.

Parameters:

index - an index in the sorted model

Returns:

modelIndex an index in the unsorted model

Throws:

IndexOutOfBoundsException - DOCUMENT ME!

toUnsortedModelIndices

public int[] toUnsortedModelIndices(int[] sortedSelectedIndices)

Convert an array of sorted model indices to their unsorted model indices. Sort the resulting set of indices.

Parameters:

sortedSelectedIndices - indices of selected elements in the sorted model or sorted view

Returns:

unsortedSelectedIndices selected indices in the unsorted model

toSortedModelIndex

public int toSortedModelIndex(int unsortedIndex)

Convert an unsorted model index to a sorted model index.

Parameters:

unsortedIndex - an element index in the unsorted model

Returns:

sortedIndex an element index in the sorted model

toSortedModelIndices

public int[] toSortedModelIndices(int[] unsortedModelIndices)

Convert an array of unsorted model selection indices to indices in the sorted model. Sort the model indices from low to high to duplicate JList's getSelectedIndices method

Parameters:

unsortedModelIndices - DOCUMENT ME!

Returns:

an array of selected indices in the sorted model

setComparator

public void setComparator(Comparator comp)

DOCUMENT ME!

Parameters:

comp - DOCUMENT ME!

setSortOrder

public void setSortOrder(SortedListModel.SortOrder sortOrder)

Change the sort order of the model at runtime.

Parameters:

sortOrder - DOCUMENT ME!

unsortedContentsChanged

public void unsortedContentsChanged()

Resort the sorted model if there are changes in the original unsorted model. Let any listeners know about changes. Since I don't track specific changes, sort everywhere and redisplay all items.