libjava/classpath/javax/swing/ComboBoxModel.java

   1 /* ComboBoxModel.java --
   2    Copyright (C) 2002, 2006, Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19 02110-1301 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38 package javax.swing;
  39
  40 import javax.swing.event.ListDataEvent;
  41 import javax.swing.event.ListDataListener;
  42
  43 /**
  44  * The data model for a {@link JComboBox}. This model keeps track of elements
  45  * contained in the <code>JComboBox</code> as well as the current
  46  * combo box selection. Whenever the selection in the <code>JComboBox</code>
  47  * changes, the <code>ComboBoxModel</code> should fire a {@link ListDataEvent}
  48  * to the model's {@link ListDataListener}s.
  49  *
  50  * @author Andrew Selkirk
  51  */
  52 public interface ComboBoxModel extends ListModel
  53 {
  54   /**
  55    * Sets the selected item in the combo box. Classes implementing this
  56    * interface should fire a {@link ListDataEvent} to all registered
  57    * {@link ListDataListener}s to indicate that the selection has changed.
  58    *
  59    * @param item  the selected item (<code>null</code> permitted).
  60    */
  61   void setSelectedItem(Object item);
  62
  63   /**
  64    * Returns the currently selected item in the combo box.
  65    *
  66    * @return The selected item (possibly <code>null</code>).
  67    */
  68   Object getSelectedItem();
  69 }