Retro68/gcc/libjava/classpath/javax/swing/ComboBoxEditor.java

/* ComboBoxEditor.java --
   Copyright (C) 2002, 2004 Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */

package javax.swing;

import java.awt.Component;
import java.awt.event.ActionListener;

/**
 * Provides edit capabilities for {@link JComboBox}es.
 *
 * @author Andrew Selkirk
 * @author Olga Rodimina
 */
public interface ComboBoxEditor
{
  /**
   * This method returns component that will be used by the combo box to
   * display/edit currently selected item in the combo box.
   *
   * @return Component that will be used by the combo box to display/edit
   *         currently selected item
   */
  Component getEditorComponent();

  /**
   * Sets item that should be editted when any editting operation is performed
   * by the user. The value is always equal to the currently selected value
   * in the combo box. Thus, whenever a different value is selected from the
   * combo box list then this method should be called to change editting item
   * to the new selected item.
   *
   * @param item item that is currently selected in the combo box
   */
  void setItem(Object item);

  /**
   * This method returns item that is currently editable.
   *
   * @return Item in the combo box that is currently editable
   */
  Object getItem();

  /**
   * selectAll
   */
  void selectAll();

  /**
   * This method adds specified ActionListener to this ComboBoxEditor.
   *
   * @param listener
   */
  void addActionListener(ActionListener listener);

  /**
   * This method removes given ActionListener from this ComboBoxEditor.
   *
   * @param listener TODO
   */
  void removeActionListener(ActionListener listener);
} // ComboBoxEditor