Package org.jdesktop.swingx.combobox

Class 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:
    java.awt.event.ActionListener, java.io.Serializable, java.util.EventListener, javax.swing.ComboBoxModel, javax.swing.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

      Fields 
      Modifier and Type Field Description
      protected java.util.Map<K,​V> map_data
      The map backing this model.

      • Fields inherited from class javax.swing.AbstractListModel

        listenerList

    • Constructor Summary

      Constructors 
      Constructor Description
      MapComboBoxModel()
      Creates an empty model.
      MapComboBoxModel​(java.util.Map<K,​V> map)
      Creates a model backed by the specified map.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void actionPerformed​(java.awt.event.ActionEvent evt)
      private static <E> java.util.List<E> buildIndex​(java.util.Map<E,​?> map)
      Builds an index for this model.
      int getSize()
      V getValue​(int selectedItem)
      Selects an item from the model and returns that map value.
      V getValue​(java.lang.Object selectedItem)
      Selects an item from the model and returns that map value.

      • 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 java.util.Map<K,​V> map_data
        The map backing this model.

    • Constructor Detail

      • MapComboBoxModel

        public MapComboBoxModel()
        Creates an empty model.

      • MapComboBoxModel

        public MapComboBoxModel​(java.util.Map<K,​V> map)
        Creates a model backed by the specified map.
        Parameters:
        map - the map backing this model

    • Method Detail

      • buildIndex

        private static <E> java.util.List<E> buildIndex​(java.util.Map<E,​?> map)
        Builds an index for this model. This method ensures that the map is always presented in a consistent order.

        This method is called by the constructor and the List is passed to super.

        Type Parameters:
        E - the type of keys for the map
        Parameters:
        map - the map to build an index for
        Returns:
        a list containing the map keys

      • getSize

        public int getSize()
        Specified by:
        getSize in interface javax.swing.ListModel<K>
        Overrides:
        getSize in class ListComboBoxModel<K>

      • actionPerformed

        public void actionPerformed​(java.awt.event.ActionEvent evt)
        Specified by:
        actionPerformed in interface java.awt.event.ActionListener
        Overrides:
        actionPerformed in class ListComboBoxModel<K>

      • getValue

        public V getValue​(java.lang.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