com.jgoodies.binding.adapter

Class ComboBoxAdapter

Implemented Interfaces:
ComboBoxModel

public final class ComboBoxAdapter
extends AbstractListModel
implements ComboBoxModel

A ComboBoxModel implementation that holds the choice list and a selection. This adapter has two modes that differ primarily in how the selection is kept synchronized with the combo's list. 1) If you construct a ComboBoxAdapter with a SelectionInList, the selection will be guaranteed to be in the list, and the selection will reflect changes in the list. 2) If you construct this adapter with a separate selection holder, the selection won't be affected by any change in the combo's list.

In both cases, the combo's list of element will reflect changes in the list, if it's a ListModel and will ignore content changes, if it's a List.

Example:

 String[] countries = new String[] { "USA", "Germany", "France", ... };
 
 // Using an array and ValueModel
 ValueModel countryModel = new PropertyAdapter(customer, "country", true);
 ComboBoxAdapter adapter = new ComboBoxAdapter(countries, contryModel);
 JComboBox countryBox    = new JComboBox(adapter);
 
 // Using a List and ValueModel
 List countryList = Arrays.asList(countries);
 ValueModel countryModel = new PropertyAdapter(customer, "country", true);
 ComboBoxAdapter adapter = new ComboBoxAdapter(countryList, contryModel);
 JComboBox countryBox    = new JComboBox(adapter);
 
 // Using a ListModel and ValueModel
 ListModel countryListModel = new ArrayListModel(Arrays.asList(countries));
 ValueModel countryModel = new PropertyAdapter(customer, "country", true);
 ComboBoxAdapter adapter = new ComboBoxAdapter(countryListModel, contryModel);
 JComboBox countryBox    = new JComboBox(adapter);
 
 // Using a SelectionInList - allows only selection of contained elements
 ListModel countryListModel = new ArrayListModel(Arrays.asList(countries));
 ValueModel countryModel = new PropertyAdapter(customer, "country", true);
 SelectionInList sil     = new SelectionInList(countryListModel, countryModel);
 ComboBoxAdapter adapter = new ComboBoxAdapter(sil);
 JComboBox countryBox    = new JComboBox(adapter);
  
 // Using ValueModels for the list holder and the selection holder
 class Country extends Model {
     ListModel getLocales();
     Locale getDefaultLocale();
     void setDefaultLocale(Locale locale);
 }
 
 BeanAdapter beanAdapter = new BeanAdapter(null, true);
 ValueModel localesHolder      = beanAdapter.getValueModel("locales");
 ValueModel defaultLocaleModel = beanAdapter.getValueModel("defaultLocale");
 ComboBoxAdapter adapter = new ComboBoxAdapter(
         localesHolder, defaultLocaleModel);
 JComboBox localeBox = new JComboBox(adapter);
  
 beanAdapter.setBean(myCountry);
 
Version:
$Revision: 1.7 $
Author:
Karsten Lentzsch
See Also:
javax.swing.JComboBox

Constructor Summary

ComboBoxAdapter(List items, ValueModel selectionHolder)
Constructs a ComboBoxAdapter for the specified List of items and the given selection holder.
ComboBoxAdapter(ListModel listModel, ValueModel selectionHolder)
Constructs a ComboBoxAdapter for the given ListModel and selection holder.
ComboBoxAdapter(Object[] items, ValueModel selectionHolder)
Constructs a ComboBoxAdapter for the specified List of items and the given selection holder.
ComboBoxAdapter(SelectionInList selectionInList)
Constructs a ComboBoxAdapter for the given SelectionInList.
ComboBoxAdapter(SelectionInListModel selectionInListModel)
Constructs a ComboBoxAdapter for the given SelectionInListModel.

Method Summary

Object
getElementAt(int index)
Returns the value at the specified index.
Object
getSelectedItem()
Returns the selected item by requesting the current value from the either the selection holder or the SelectionInList's selection.
int
getSize()
Returns the length of the item list.
void
setSelectedItem(Object object)
Sets the selected item.

Constructor Details

ComboBoxAdapter

public ComboBoxAdapter(List items,
                       ValueModel selectionHolder)
Constructs a ComboBoxAdapter for the specified List of items and the given selection holder. Structural changes in the list will be ignored.

Example:

 String[] countries = new String[] { "USA", "Germany", "France", ... };
 List countryList = Arrays.asList(countries);
 ValueModel countryModel = new PropertyAdapter(customer, "country", true);
 ComboBoxAdapter adapter = new ComboBoxAdapter(countryList, contryModel);
 JComboBox countryBox    = new JComboBox(adapter);
 
Parameters:
items - the list of items
selectionHolder - holds the selection of the combo

ComboBoxAdapter

public ComboBoxAdapter(ListModel listModel,
                       ValueModel selectionHolder)
Constructs a ComboBoxAdapter for the given ListModel and selection holder. Structural changes in the ListModel will be reflected by this adapter, but won't affect the selection.

Example:

 String[] countries = new String[] { "USA", "Germany", "France", ... };
 ListModel countryList = new ArrayListModel(Arrays.asList(countries));
 ValueModel countryModel = new PropertyAdapter(customer, "country", true);
 ComboBoxAdapter adapter = new ComboBoxAdapter(countryList, contryModel);
 JComboBox countryBox    = new JComboBox(adapter);
 
Parameters:
listModel - the initial list model
selectionHolder - holds the selection of the combo

ComboBoxAdapter

public ComboBoxAdapter(Object[] items,
                       ValueModel selectionHolder)
Constructs a ComboBoxAdapter for the specified List of items and the given selection holder. Structural changes in the list will be ignored.

Example:

 String[] countries = new String[] { "USA", "Germany", "France", ... };
 ValueModel countryModel = new PropertyAdapter(customer, "country", true);
 ComboBoxAdapter adapter = new ComboBoxAdapter(countries, contryModel);
 JComboBox countryBox    = new JComboBox(adapter);
 
Parameters:
items - the list of items
selectionHolder - holds the selection of the combo

ComboBoxAdapter

public ComboBoxAdapter(SelectionInList selectionInList)
Constructs a ComboBoxAdapter for the given SelectionInList. Note that selections which are not elements of the list will be rejected.

Example:

 String[] countries = new String[] { "USA", "Germany", "France", ... };
 List countryList = Arrays.asList(countries);
 ValueModel countryModel = new PropertyAdapter(customer, "country", true);
 SelectionInList sil     = new SelectionInList(countryList, countryModel);
 ComboBoxAdapter adapter = new ComboBoxAdapter(sil);
 JComboBox countryBox    = new JComboBox(adapter);
 
Parameters:
selectionInList - provides the list and selection

ComboBoxAdapter

public ComboBoxAdapter(SelectionInListModel selectionInListModel)
Constructs a ComboBoxAdapter for the given SelectionInListModel. Note that selections which are not elements of the list will be rejected.

Example:

 String[] countries = new String[] { "USA", "Germany", "France", ... };
 ListModel countryList = new ArrayListModel(countries);
 ValueModel countryModel = new PropertyAdapter(customer, "country", true);
 SelectionInListModel silm = new SelectionInListModel(countryList, countryModel);
 ComboBoxAdapter adapter = new ComboBoxAdapter(sil);
 JComboBox countryBox    = new JComboBox(adapter);
 
Parameters:
selectionInListModel - provides the list and selection
Since:
1.5

Method Details

getElementAt

public Object getElementAt(int index)
Returns the value at the specified index.
Parameters:
index - the requested index
Returns:
the value at index

getSelectedItem

public Object getSelectedItem()
Returns the selected item by requesting the current value from the either the selection holder or the SelectionInList's selection.
Returns:
The selected item or null if there is no selection

getSize

public int getSize()
Returns the length of the item list.
Returns:
the length of the list

setSelectedItem

public void setSelectedItem(Object object)
Sets the selected item. The implementation of this method should notify all registered ListDataListeners that the contents has changed.
Parameters:
object - the list object to select or null to clear the selection

Copyright © 2002-2007 JGoodies Karsten Lentzsch. All Rights Reserved.