001/* ComboBoxEditor.java -- 002 Copyright (C) 2002, 2004 Free Software Foundation, Inc. 003 004This file is part of GNU Classpath. 005 006GNU Classpath is free software; you can redistribute it and/or modify 007it under the terms of the GNU General Public License as published by 008the Free Software Foundation; either version 2, or (at your option) 009any later version. 010 011GNU Classpath is distributed in the hope that it will be useful, but 012WITHOUT ANY WARRANTY; without even the implied warranty of 013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014General Public License for more details. 015 016You should have received a copy of the GNU General Public License 017along with GNU Classpath; see the file COPYING. If not, write to the 018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 01902110-1301 USA. 020 021Linking this library statically or dynamically with other modules is 022making a combined work based on this library. Thus, the terms and 023conditions of the GNU General Public License cover the whole 024combination. 025 026As a special exception, the copyright holders of this library give you 027permission to link this library with independent modules to produce an 028executable, regardless of the license terms of these independent 029modules, and to copy and distribute the resulting executable under 030terms of your choice, provided that you also meet, for each linked 031independent module, the terms and conditions of the license of that 032module. An independent module is a module which is not derived from 033or based on this library. If you modify this library, you may extend 034this exception to your version of the library, but you are not 035obligated to do so. If you do not wish to do so, delete this 036exception statement from your version. */ 037 038package javax.swing; 039 040import java.awt.Component; 041import java.awt.event.ActionListener; 042 043/** 044 * Provides edit capabilities for {@link JComboBox}es. 045 * 046 * @author Andrew Selkirk 047 * @author Olga Rodimina 048 */ 049public interface ComboBoxEditor 050{ 051 /** 052 * This method returns component that will be used by the combo box to 053 * display/edit currently selected item in the combo box. 054 * 055 * @return Component that will be used by the combo box to display/edit 056 * currently selected item 057 */ 058 Component getEditorComponent(); 059 060 /** 061 * Sets item that should be editted when any editting operation is performed 062 * by the user. The value is always equal to the currently selected value 063 * in the combo box. Thus, whenever a different value is selected from the 064 * combo box list then this method should be called to change editting item 065 * to the new selected item. 066 * 067 * @param item item that is currently selected in the combo box 068 */ 069 void setItem(Object item); 070 071 /** 072 * This method returns item that is currently editable. 073 * 074 * @return Item in the combo box that is currently editable 075 */ 076 Object getItem(); 077 078 /** 079 * selectAll 080 */ 081 void selectAll(); 082 083 /** 084 * This method adds specified ActionListener to this ComboBoxEditor. 085 * 086 * @param listener 087 */ 088 void addActionListener(ActionListener listener); 089 090 /** 091 * This method removes given ActionListener from this ComboBoxEditor. 092 * 093 * @param listener TODO 094 */ 095 void removeActionListener(ActionListener listener); 096} // ComboBoxEditor