net.sf.cuf.model.ui

Class LOVAdapter

java.lang.Object

net.sf.cuf.model.ui.LOVAdapter

All Implemented Interfaces:

ActionListener, EventListener, ComboBoxModel, ListModel, ListSelectionModel

public class LOVAdapter
extends Object
implements ListSelectionModel, ComboBoxModel, ActionListener

A LOVAdapter connects a model of a JList, a JComboBox or a JRadioBox ButtonGroup to various ValueModels holding the display, the data and the selection value(s). The displayed data in the list/combobox is taken from a List of Objects, this List may be inside a ValueModel. The "keys" or "ids" for the displayed data is taken from an other List, again this list may be inside a value model. The selected key/id is taken from another ValueModel. The value of that ValueModel is kept in sync (both ways) with the selected list/combobox entry. The mapping of "nothing selected" (aka -1) to a "magic" key/id is also supported. TODO: provide a "inSync" ValueModel, that contains true if the index is valid (!=-1) and false if it the index is -1. TODO: provide a "DelegateAccess" attribute, so that the mDisplayedItems are created on the fly from the mKeys

Field Summary

Fields inherited from interface javax.swing.ListSelectionModel

MULTIPLE_INTERVAL_SELECTION, SINGLE_INTERVAL_SELECTION, SINGLE_SELECTION

Constructor Summary

Constructors

Constructor and Description
LOVAdapter(ButtonGroup pButtonGroup, List<?> pDisplayedItems, List<?> pKeys, ValueModel<?> pSelectedKeyVM, Object pUnselectedKey) Create a new adapter between the buttong group, the keys and the selected key.
LOVAdapter(ButtonGroup pButtonGroup, ValueModel<List<?>> pDisplayedItemsVM, ValueModel<List<?>> pKeysVM, ValueModel<?> pSelectedKeyVM, Object pUnselectedKey) Create a new adapter between the buttong group, the keys and the selected key.
LOVAdapter(JComboBox pComboBox, List<?> pDisplayedItems, List<?> pKeys, ValueModel<?> pSelectedKeyVM) Create a new adapter between the displayed itams and the keys.
LOVAdapter(JComboBox pComboBox, List<?> pDisplayedItems, List<?> pKeys, ValueModel<?> pSelectedKeyVM, Object pUnselectedKey) Create a new adapter between the displayed itams, the keys and a magic "null" key value.
LOVAdapter(JComboBox pComboBox, ValueModel<List<?>> pDisplayedItemsVM, ValueModel<List<?>> pKeysVM, ValueModel<?> pSelectedKeyVM) Create a new adapter between the displayed itams and the keys.
LOVAdapter(JComboBox pComboBox, ValueModel<List<?>> pDisplayedItemsVM, ValueModel<List<?>> pKeysVM, ValueModel<?> pSelectedKeyVM, Object pUnselectedKey) Create a new adapter between the displayed itams, the keys and a magic "null" key value.
LOVAdapter(JList pList, List<?> pDisplayedItems, List<?> pKeys, ValueModel<?> pSelectedKeyVM) Create a new adapter between the displayed itams and the keys.
LOVAdapter(JList pList, List<?> pDisplayedItems, List<?> pKeys, ValueModel<?> pSelectedKeyVM, Object pUnselectedKey) Create a new adapter between the displayed itams, the keys and a magic "null" key value.
LOVAdapter(JList pList, ValueModel<List<?>> pDisplayedItemsVM, ValueModel<List<?>> pKeysVM, ValueModel<?> pSelectedKeyVM) Create a new adapter between the displayed itams and the keys.
LOVAdapter(JList pList, ValueModel<List<?>> pDisplayedItemsVM, ValueModel<List<?>> pKeysVM, ValueModel<?> pSelectedKeyVM, Object pUnselectedKey) Create a new adapter between the displayed itams, the keys and a magic "null" key value.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent pEvent)
void	addListDataListener(ListDataListener pListDataListener)
void	addListSelectionListener(ListSelectionListener pListener)
void	addSelectionInterval(int pIndex0, int pIndex1)
void	clearSelection()
protected void	fireListChanged(ListDataEvent pListDataEvent) Helper method to notify all listeners that something changed in our list model.
int	getAnchorSelectionIndex()
Object	getElementAt(int pIndex)
int	getIndexByKey(Object pKey) Small helper to find the index for a key in the key list.
int	getLeadSelectionIndex()
int	getMaxSelectionIndex()
int	getMinSelectionIndex()
int	getSelectedIndex() Return the selected index or -1 if there is no valid selection.
Object	getSelectedItem()
int	getSelectionMode()
int	getSize()
boolean	getValueIsAdjusting()
void	insertIndexInterval(int pIndex, int pLength, boolean pBefore)
boolean	isSelectedIndex(int pIndex)
boolean	isSelectionEmpty()
void	removeIndexInterval(int pIndex0, int pIndex1)
void	removeListDataListener(ListDataListener pListDataListener)
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	vmItemsChanged(ChangeEvent pEvent) Callback from our ValueModel holding the displayed items.
void	vmKeysChanged(ChangeEvent pEvent) Callback from our ValueModel holding the possible keys.
void	vmSelectedKeyChanged(ChangeEvent pEvent) Callback from our ValueModel holding the selected key.

Methods inherited from class java.lang.Object

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

Constructor Detail

LOVAdapter

public LOVAdapter(JComboBox pComboBox,
          ValueModel<List<?>> pDisplayedItemsVM,
          ValueModel<List<?>> pKeysVM,
          ValueModel<?> pSelectedKeyVM)

Create a new adapter between the displayed itams and the keys.

Parameters:

pComboBox - the combobox widget, must not be null

pDisplayedItemsVM - the value model holding the displayed items, must not be null

pKeysVM - the value model holding the matching keys, must not be null

pSelectedKeyVM - the value model holding the key matching the selection keys, must not be null

LOVAdapter

public LOVAdapter(JComboBox pComboBox,
          ValueModel<List<?>> pDisplayedItemsVM,
          ValueModel<List<?>> pKeysVM,
          ValueModel<?> pSelectedKeyVM,
          Object pUnselectedKey)

Create a new adapter between the displayed itams, the keys and a magic "null" key value.

Parameters:

pComboBox - the combobox widget, must not be null

pDisplayedItemsVM - the value model holding the displayed items, must not be null

pKeysVM - the value model holding the matching keys, must not be null

pSelectedKeyVM - the value model holding the key matching the selection keys, must not be null

pUnselectedKey - the magic key, may be nulll

LOVAdapter

public LOVAdapter(JComboBox pComboBox,
          List<?> pDisplayedItems,
          List<?> pKeys,
          ValueModel<?> pSelectedKeyVM)

Create a new adapter between the displayed itams and the keys.

Parameters:

pComboBox - the combobox widget, must not be null

pDisplayedItems - the list containing the displayed items, must not be null

pKeys - the list containing the matching keys, must not be null

pSelectedKeyVM - the value model holding the key matching the selection keys, must not be null

LOVAdapter

public LOVAdapter(JComboBox pComboBox,
          List<?> pDisplayedItems,
          List<?> pKeys,
          ValueModel<?> pSelectedKeyVM,
          Object pUnselectedKey)

Create a new adapter between the displayed itams, the keys and a magic "null" key value.

Parameters:

pComboBox - the combobox widget, must not be null

pDisplayedItems - the list containing the displayed items, must not be null

pKeys - the list containing the matching keys, must not be null

pSelectedKeyVM - the value model holding the key matching the selection keys, must not be null

pUnselectedKey - the magic key, may be nulll

LOVAdapter

public LOVAdapter(JList pList,
          ValueModel<List<?>> pDisplayedItemsVM,
          ValueModel<List<?>> pKeysVM,
          ValueModel<?> pSelectedKeyVM)

Create a new adapter between the displayed itams and the keys.

Parameters:

pList - the list widget, must not be null

pDisplayedItemsVM - the value model holding the displayed items, must not be null

pKeysVM - the value model holding the matching keys, must not be null

pSelectedKeyVM - the value model holding the key matching the selection keys, must not be null

LOVAdapter

public LOVAdapter(JList pList,
          ValueModel<List<?>> pDisplayedItemsVM,
          ValueModel<List<?>> pKeysVM,
          ValueModel<?> pSelectedKeyVM,
          Object pUnselectedKey)

Create a new adapter between the displayed itams, the keys and a magic "null" key value.

Parameters:

pList - the list widget, must not be null

pDisplayedItemsVM - the value model holding the displayed items, must not be null

pKeysVM - the value model holding the matching keys, must not be null

pSelectedKeyVM - the value model holding the key matching the selection keys, must not be null

pUnselectedKey - the magic key, may be nulll

LOVAdapter

public LOVAdapter(JList pList,
          List<?> pDisplayedItems,
          List<?> pKeys,
          ValueModel<?> pSelectedKeyVM)

Create a new adapter between the displayed itams and the keys.

Parameters:

pList - the list widget, must not be null

pDisplayedItems - the list containing the displayed items, must not be null

pKeys - the list containing the matching keys, must not be null

pSelectedKeyVM - the value model holding the key matching the selection keys, must not be null

LOVAdapter

public LOVAdapter(JList pList,
          List<?> pDisplayedItems,
          List<?> pKeys,
          ValueModel<?> pSelectedKeyVM,
          Object pUnselectedKey)

Create a new adapter between the displayed itams, the keys and a magic "null" key value.

Parameters:

pList - the list widget, must not be null

pDisplayedItems - the list containing the displayed items, must not be null

pKeys - the list containing the matching keys, must not be null

pSelectedKeyVM - the value model holding the key matching the selection keys, must not be null

pUnselectedKey - the magic key, may be nulll

LOVAdapter

public LOVAdapter(ButtonGroup pButtonGroup,
          ValueModel<List<?>> pDisplayedItemsVM,
          ValueModel<List<?>> pKeysVM,
          ValueModel<?> pSelectedKeyVM,
          Object pUnselectedKey)

Create a new adapter between the buttong group, the keys and the selected key.

Parameters:

pButtonGroup - the list widget, must not be null

pDisplayedItemsVM - the value model holding the displayed items, must not be null

pKeysVM - the value model holding the matching keys, must not be null

pSelectedKeyVM - the value model holding the key matching the selection keys, must not be null

pUnselectedKey - the magic key, may be nulll

LOVAdapter

public LOVAdapter(ButtonGroup pButtonGroup,
          List<?> pDisplayedItems,
          List<?> pKeys,
          ValueModel<?> pSelectedKeyVM,
          Object pUnselectedKey)

Create a new adapter between the buttong group, the keys and the selected key.

Parameters:

pButtonGroup - the button group, must not be null

pDisplayedItems - the list containing the displayed items, must not be null, but not really used

pKeys - the list containing the matching keys, must not be null

pSelectedKeyVM - the value model holding the key matching the selection keys, must not be null

pUnselectedKey - the magic key, may be nulll

Method Detail

fireListChanged

protected void fireListChanged(ListDataEvent pListDataEvent)

Helper method to notify all listeners that something changed in our list model.

Parameters:

pListDataEvent - the list data event to dispatch

getSelectedIndex

public int getSelectedIndex()

Return the selected index or -1 if there is no valid selection.

Returns:

-1 or the selected index

getIndexByKey

public int getIndexByKey(Object pKey)

Small helper to find the index for a key in the key list.

Parameters:

pKey - the key we are searching the index for

Returns:

-1 or the index of the key

vmItemsChanged

public void vmItemsChanged(ChangeEvent pEvent)

Callback from our ValueModel holding the displayed items.

Parameters:

pEvent - not used

vmSelectedKeyChanged

public void vmSelectedKeyChanged(ChangeEvent pEvent)

Callback from our ValueModel holding the selected key.

Parameters:

pEvent - not used

vmKeysChanged

public void vmKeysChanged(ChangeEvent pEvent)

Callback from our ValueModel holding the possible keys.

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

getSize

public int getSize()

Specified by:

getSize in interface ListModel

getElementAt

public Object getElementAt(int pIndex)

Specified by:

getElementAt in interface ListModel

addListDataListener

public void addListDataListener(ListDataListener pListDataListener)

Specified by:

addListDataListener in interface ListModel

removeListDataListener

public void removeListDataListener(ListDataListener pListDataListener)

Specified by:

removeListDataListener in interface ListModel

actionPerformed

public void actionPerformed(ActionEvent pEvent)

Specified by:

actionPerformed in interface ActionListener