001 /* ComboBoxEditor.java -- 002 Copyright (C) 2002, 2004 Free Software Foundation, Inc. 003 004 This file is part of GNU Classpath. 005 006 GNU Classpath is free software; you can redistribute it and/or modify 007 it under the terms of the GNU General Public License as published by 008 the Free Software Foundation; either version 2, or (at your option) 009 any later version. 010 011 GNU Classpath is distributed in the hope that it will be useful, but 012 WITHOUT ANY WARRANTY; without even the implied warranty of 013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014 General Public License for more details. 015 016 You should have received a copy of the GNU General Public License 017 along with GNU Classpath; see the file COPYING. If not, write to the 018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 019 02110-1301 USA. 020 021 Linking this library statically or dynamically with other modules is 022 making a combined work based on this library. Thus, the terms and 023 conditions of the GNU General Public License cover the whole 024 combination. 025 026 As a special exception, the copyright holders of this library give you 027 permission to link this library with independent modules to produce an 028 executable, regardless of the license terms of these independent 029 modules, and to copy and distribute the resulting executable under 030 terms of your choice, provided that you also meet, for each linked 031 independent module, the terms and conditions of the license of that 032 module. An independent module is a module which is not derived from 033 or based on this library. If you modify this library, you may extend 034 this exception to your version of the library, but you are not 035 obligated to do so. If you do not wish to do so, delete this 036 exception statement from your version. */ 037 038 package javax.swing; 039 040 import java.awt.Component; 041 import java.awt.event.ActionListener; 042 043 /** 044 * Provides edit capabilities for {@link JComboBox}es. 045 * 046 * @author Andrew Selkirk 047 * @author Olga Rodimina 048 */ 049 public 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