net.sf.cuf.model.ui

Class ListModelAdapter

java.lang.Object

net.sf.cuf.model.ui.ListModelAdapter

All Implemented Interfaces:

ComboBoxModel, ListModel, ListSelectionModel

public class ListModelAdapter
extends Object
implements ComboBoxModel, ListSelectionModel

A ListModelAdapter connects a model of a JList or a JComboBox to a SelectionInList ValueModel, the index for the selected list item is the index in the list/combobox. The data in the list/combobox is taken from the SelectionInList, too, and a DelegateAccess object may be used to convert from the "raw" object to a display object. Whenever either the selection of the list or the index of the ValueModel changes, the other model is adjusted accordingly. A ListModelAdapter is not a ValueModel itself, but connects a SelectionInList ValueModel to a ListSelectionModel and a ListModel/ComboBoxModel.

Field Summary

Fields

Modifier and Type	Field and Description
protected SelectionInList<?>	mSelectionInList value model holding the list, never null

Fields inherited from interface javax.swing.ListSelectionModel

MULTIPLE_INTERVAL_SELECTION, SINGLE_INTERVAL_SELECTION, SINGLE_SELECTION

Constructor Summary

Constructors

Constructor and Description
ListModelAdapter(JComboBox pComboBox, SelectionInList<?> pListValueModel, DelegateAccess pAccessValueModel) Creates a new adapter between a SelectionInList ValueModel and a JComboBox.
ListModelAdapter(JList pList, SelectionInList<?> pListValueModel, DelegateAccess pAccessValueModel) Creates a new adapter between a SelectionInList ValueModel and a JList.

Method Summary

Methods

Modifier and Type	Method and Description
void	addElement(Object pObj) Add the item to the list.
void	addListDataListener(ListDataListener pListener)
void	addListSelectionListener(ListSelectionListener pListener)
void	addSelectionInterval(int pIndex0, int pIndex1)
void	clearSelection()
protected void	fireListChanged(ListDataEvent pEvent) Notifies all listeners that something changed in our list model.
int	getAnchorSelectionIndex()
Object	getElementAt(int pIndex)
int	getIndexByObject(Object pItem) Small helper to find a item in our list.
int	getLeadSelectionIndex()
int	getMaxSelectionIndex()
int	getMinSelectionIndex()
Object	getSelectedItem()
int	getSelectionMode()
int	getSize()
boolean	getValueIsAdjusting()
void	insertIndexInterval(int pIndex, int pLength, boolean pBefore)
boolean	isSelectedIndex(int pIndex)
boolean	isSelectionEmpty()
void	removeElement(Object pObj) Removes the item from the list.
void	removeIndexInterval(int pIndex0, int pIndex1)
void	removeListDataListener(ListDataListener pListener)
void	removeListSelectionListener(ListSelectionListener pListener)
void	removeSelectionInterval(int pIndex0, int pIndex1)
void	setAnchorSelectionIndex(int pIndex)
void	setLeadSelectionIndex(int pIndex)
void	setSelectedItem(Object pItem)
void	setSelectionInterval(int pIndex0, int pIndex1)
void	setSelectionMode(int pSelectionMode)
void	setValueIsAdjusting(boolean pValueIsAdjusting)
void	vmDataChanged(ChangeEvent pEvent) Callback from our VM
void	vmSelectionChanged(ChangeEvent pEvent) Callback from our VM

Methods inherited from class java.lang.Object

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

Field Detail

mSelectionInList

protected SelectionInList<?> mSelectionInList

value model holding the list, never null

Constructor Detail

ListModelAdapter

public ListModelAdapter(JList pList,
                SelectionInList<?> pListValueModel,
                DelegateAccess pAccessValueModel)

Creates a new adapter between a SelectionInList ValueModel and a JList.

Parameters:

pList - the list for which we adapt to

pListValueModel - the value model (SelectionInList) that drives the list (data, selection) and gets updated by the list (selection only)

pAccessValueModel - null or the converter we use to map between the SelectionInList list objects and the display objects

Throws:

IllegalArgumentException - if pList or pValueModel is null

ListModelAdapter

public ListModelAdapter(JComboBox pComboBox,
                SelectionInList<?> pListValueModel,
                DelegateAccess pAccessValueModel)

Creates a new adapter between a SelectionInList ValueModel and a JComboBox.

Parameters:

pComboBox - the combobox for which we adapt to

pListValueModel - the value model (SelectionInList) that drives the combobox (data, selection) and gets updated by the combobox (selection only)

pAccessValueModel - null or the converter we use to map between the SelectionInList list objects and the display objects

Throws:

IllegalArgumentException - if pComboBox or pValueModel is null

Method Detail

fireListChanged

protected void fireListChanged(ListDataEvent pEvent)

Notifies all listeners that something changed in our list model.

Parameters:

pEvent - the ListDataEvent to fire

vmDataChanged

public void vmDataChanged(ChangeEvent pEvent)

Callback from our VM

Parameters:

pEvent - not used

vmSelectionChanged

public void vmSelectionChanged(ChangeEvent pEvent)

Callback from our VM

Parameters:

pEvent - not used

setSelectionInterval

public void setSelectionInterval(int pIndex0,
                        int pIndex1)

Specified by:

setSelectionInterval in interface ListSelectionModel

addSelectionInterval

public void addSelectionInterval(int pIndex0,
                        int pIndex1)

Specified by:

addSelectionInterval in interface ListSelectionModel

removeSelectionInterval

public void removeSelectionInterval(int pIndex0,
                           int pIndex1)

Specified by:

removeSelectionInterval in interface ListSelectionModel

insertIndexInterval

public void insertIndexInterval(int pIndex,
                       int pLength,
                       boolean pBefore)

Specified by:

insertIndexInterval in interface ListSelectionModel

removeIndexInterval

public void removeIndexInterval(int pIndex0,
                       int pIndex1)

Specified by:

removeIndexInterval in interface ListSelectionModel

clearSelection

public void clearSelection()

Specified by:

clearSelection in interface ListSelectionModel

getMinSelectionIndex

public int getMinSelectionIndex()

Specified by:

getMinSelectionIndex in interface ListSelectionModel

getMaxSelectionIndex

public int getMaxSelectionIndex()

Specified by:

getMaxSelectionIndex in interface ListSelectionModel

isSelectedIndex

public boolean isSelectedIndex(int pIndex)

Specified by:

isSelectedIndex in interface ListSelectionModel

getAnchorSelectionIndex

public int getAnchorSelectionIndex()

Specified by:

getAnchorSelectionIndex in interface ListSelectionModel

setAnchorSelectionIndex

public void setAnchorSelectionIndex(int pIndex)

Specified by:

setAnchorSelectionIndex in interface ListSelectionModel

getLeadSelectionIndex

public int getLeadSelectionIndex()

Specified by:

getLeadSelectionIndex in interface ListSelectionModel

setLeadSelectionIndex

public void setLeadSelectionIndex(int pIndex)

Specified by:

setLeadSelectionIndex in interface ListSelectionModel

isSelectionEmpty

public boolean isSelectionEmpty()

Specified by:

isSelectionEmpty in interface ListSelectionModel

setValueIsAdjusting

public void setValueIsAdjusting(boolean pValueIsAdjusting)

Specified by:

setValueIsAdjusting in interface ListSelectionModel

getValueIsAdjusting

public boolean getValueIsAdjusting()

Specified by:

getValueIsAdjusting in interface ListSelectionModel

setSelectionMode

public void setSelectionMode(int pSelectionMode)

Specified by:

setSelectionMode in interface ListSelectionModel

getSelectionMode

public int getSelectionMode()

Specified by:

getSelectionMode in interface ListSelectionModel

addListSelectionListener

public void addListSelectionListener(ListSelectionListener pListener)

Specified by:

addListSelectionListener in interface ListSelectionModel

removeListSelectionListener

public void removeListSelectionListener(ListSelectionListener pListener)

Specified by:

removeListSelectionListener in interface ListSelectionModel

getSelectedItem

public Object getSelectedItem()

Specified by:

getSelectedItem in interface ComboBoxModel

setSelectedItem

public void setSelectedItem(Object pItem)

Specified by:

setSelectedItem in interface ComboBoxModel

getElementAt

public Object getElementAt(int pIndex)

Specified by:

getElementAt in interface ListModel

getSize

public int getSize()

Specified by:

getSize in interface ListModel

addListDataListener

public void addListDataListener(ListDataListener pListener)

Specified by:

addListDataListener in interface ListModel

removeListDataListener

public void removeListDataListener(ListDataListener pListener)

Specified by:

removeListDataListener in interface ListModel

addElement

public void addElement(Object pObj)

Add the item to the list.

Parameters:

pObj - the component to be added

See Also:

SelectionInList.addItem(Object)

removeElement

public void removeElement(Object pObj)

Removes the item from the list.

Parameters:

pObj - the component to be removed

See Also:

SelectionInList.removeItem(int)

getIndexByObject

public int getIndexByObject(Object pItem)

Small helper to find a item in our list. The item may be of a different type than the entries in our list, if a DelegateAccess object is used for display conversion.

Parameters:

pItem - the (display) object we are searching

Returns:

-1 or the index of the item