libjava/javax/swing/ComboBoxEditor.java

   1 /* ComboBoxEditor.java --
   2    Copyright (C) 2002, 2004 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., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 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 java.awt.Component;
  41 import java.awt.event.ActionListener;
  42
  43 /**
  44  * ComboBoxEditor
  45  *
  46  * @author Andrew Selkirk
  47  * @author Olga Rodimina
  48  * @version 1.0
  49  */
  50 public interface ComboBoxEditor
  51 {
  52   /**
  53    * This method returns component that will be used by the combo box to
  54    * display/edit currently selected item in the combo box.
  55    *
  56    * @return Component that will be used by the combo box to display/edit
  57    *         currently selected item
  58    */
  59   Component getEditorComponent();
  60
  61   /**
  62    * Sets item that should be editted when any editting operation is performed
  63    * by the user. The value is always equal to the currently selected value
  64    * in the combo box. Thus, whenever a different value is selected from the
  65    * combo box list then this method should be called to change editting item
  66    * to the new selected item.
  67    *
  68    * @param selectedItem item that is currently selected in the combo box
  69    */
  70   void setItem(Object item);
  71
  72   /**
  73    * This method returns item that is currently editable.
  74    *
  75    * @return Item in the combo box that is currently editable
  76    */
  77   Object getItem();
  78
  79   /**
  80    * selectAll
  81    */
  82   void selectAll();
  83
  84   /**
  85    * This method adds specified ActionListener to this ComboBoxEditor.
  86    *
  87    * @param listener
  88    */
  89   void addActionListener(ActionListener listener);
  90
  91   /**
  92    * This method removes given ActionListener from this ComboBoxEditor.
  93    *
  94    * @param listener TODO
  95    */
  96   void removeActionListener(ActionListener listener);
  97 } // ComboBoxEditor