| J. Duke | 319a3b9 | 2007-12-01 00:00:00 +0000 | [diff] [blame^] | 1 | /* |
| 2 | * Copyright 1997-2000 Sun Microsystems, Inc. All Rights Reserved. |
| 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| 4 | * |
| 5 | * This code is free software; you can redistribute it and/or modify it |
| 6 | * under the terms of the GNU General Public License version 2 only, as |
| 7 | * published by the Free Software Foundation. Sun designates this |
| 8 | * particular file as subject to the "Classpath" exception as provided |
| 9 | * by Sun in the LICENSE file that accompanied this code. |
| 10 | * |
| 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| 15 | * accompanied this code). |
| 16 | * |
| 17 | * You should have received a copy of the GNU General Public License version |
| 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| 20 | * |
| 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
| 23 | * have any questions. |
| 24 | */ |
| 25 | package javax.swing; |
| 26 | |
| 27 | /** |
| 28 | * A data model for a combo box. This interface extends <code>ListDataModel</code> |
| 29 | * and adds the concept of a <i>selected item</i>. The selected item is generally |
| 30 | * the item which is visible in the combo box display area. |
| 31 | * <p> |
| 32 | * The selected item may not necessarily be managed by the underlying |
| 33 | * <code>ListModel</code>. This disjoint behavior allows for the temporary |
| 34 | * storage and retrieval of a selected item in the model. |
| 35 | * |
| 36 | * @author Arnaud Weber |
| 37 | */ |
| 38 | public interface ComboBoxModel extends ListModel { |
| 39 | |
| 40 | /** |
| 41 | * Set the selected item. The implementation of this method should notify |
| 42 | * all registered <code>ListDataListener</code>s that the contents |
| 43 | * have changed. |
| 44 | * |
| 45 | * @param anItem the list object to select or <code>null</code> |
| 46 | * to clear the selection |
| 47 | */ |
| 48 | void setSelectedItem(Object anItem); |
| 49 | |
| 50 | /** |
| 51 | * Returns the selected item |
| 52 | * @return The selected item or <code>null</code> if there is no selection |
| 53 | */ |
| 54 | Object getSelectedItem(); |
| 55 | } |