org.jdesktop.swingx.combobox
Class MapComboBoxModel<K,V>

java.lang.Object
  extended by javax.swing.AbstractListModel
      extended by org.jdesktop.swingx.combobox.ListComboBoxModel<K>
          extended by org.jdesktop.swingx.combobox.MapComboBoxModel<K,V>
Type Parameters:
K - the type of keys maintained by the map backing this model
V - the type of mapped values
All Implemented Interfaces:
ActionListener, Serializable, EventListener, ComboBoxModel, ListModel

public class MapComboBoxModel<K,V>
extends ListComboBoxModel<K>

A ComboBoxModel for Maps. The model will always present a Map consistently, once it is instantiated. However, unless the Map is ordered, as a java.util.TreeMap is, the model is not guaranteed to present the maps in a consistent order between instantiations.

See Also:
Serialized Form

Field Summary
protected  Map<K,V> map_data
          The map backing this model.
 
Fields inherited from class org.jdesktop.swingx.combobox.ListComboBoxModel
data, selected, UPDATE
 
Fields inherited from class javax.swing.AbstractListModel
listenerList
 
Constructor Summary
MapComboBoxModel()
          Creates an empty model.
MapComboBoxModel(Map<K,V> map)
          Creates a model backed by the specified map.
 
Method Summary
 void actionPerformed(ActionEvent evt)
          Invoked when an action occurs.
 int getSize()
          Returns the length of the list.
 V getValue(int selectedItem)
          Selects an item from the model and returns that map value.
 V getValue(Object selectedItem)
          Selects an item from the model and returns that map value.
 
Methods inherited from class org.jdesktop.swingx.combobox.ListComboBoxModel
getElementAt, getSelectedItem, setSelectedItem
 
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
 
Methods inherited from interface javax.swing.ListModel
addListDataListener, removeListDataListener
 

Field Detail

map_data

protected Map<K,V> map_data
The map backing this model.

Constructor Detail

MapComboBoxModel

public MapComboBoxModel()
Creates an empty model.


MapComboBoxModel

public MapComboBoxModel(Map<K,V> map)
Creates a model backed by the specified map.

Parameters:
map - the map backing this model
Method Detail

getSize

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

Specified by:
getSize in interface ListModel
Overrides:
getSize in class ListComboBoxModel<K>
Returns:
the length of the list

actionPerformed

public void actionPerformed(ActionEvent evt)
Invoked when an action occurs.

Specified by:
actionPerformed in interface ActionListener
Overrides:
actionPerformed in class ListComboBoxModel<K>

getValue

public V getValue(Object selectedItem)
Selects an item from the model and returns that map value.

Parameters:
selectedItem - the item to select
Returns:
the value for the selected item

getValue

public V getValue(int selectedItem)
Selects an item from the model and returns that map value.

Parameters:
selectedItem - selects the item at the specified index in this model
Returns:
the value for the item at the selected index