com.jidesoft.list
Interface GroupableListModel

All Superinterfaces:

ListModel

All Known Implementing Classes:

AbstractGroupableListModel, DefaultGroupableListModel, FilterableGroupableListModel, SortableGroupableListModel

public interface GroupableListModel
extends ListModel

GroupableListModel is the model used by GroupList. It extends ListModel by adding group information to each row. With the information provided by this interface, GroupList knows how to display the rows in groups.

Please note, rows of the same group don't have to be adjacent.

Method Summary

void	addListGroupChangeListener(ListGroupChangeListener listener) Adds a listener to the list which s notified each time a change to the group information occurs.
Object	getGroupAt(int index) Returns the group of the element at the specified index.
Object[]	getGroups() Returns all groups, which control the order of appearance.
void	removeListGroupChangeListener(ListGroupChangeListener listener) Removes a listener from the list which is notified each time a change to the group information occurs.

Methods inherited from interface javax.swing.ListModel

addListDataListener, getElementAt, getSize, removeListDataListener

Method Detail

getGroupAt

Object getGroupAt(int index)

Returns the group of the element at the specified index. Note that the order of groups is controlled by first getGroups() then getGroupAt(int).

Parameters:

index - the index of element

Returns:

the group for the specified index.

See Also:

getGroups()

getGroups

Object[] getGroups()

Returns all groups, which control the order of appearance. Besides, if getGroupAt(int) returns a value that doesn't exist in the groups, the value will be arranged after the array.

Returns:

an array of groups in the order of appearance.

See Also:

getGroupAt(int)

addListGroupChangeListener

void addListGroupChangeListener(ListGroupChangeListener listener)

Adds a listener to the list which s notified each time a change to the group information occurs.

Parameters:

listener - the ListGroupChangeListener to be added

removeListGroupChangeListener

void removeListGroupChangeListener(ListGroupChangeListener listener)

Removes a listener from the list which is notified each time a change to the group information occurs.

Parameters:

listener - the ListGroupChangeListener to be removed