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