META-INF.modules.java.desktop.classes.javax.swing.ComboBoxModel Maven / Gradle / Ivy
/*
* Copyright (c) 1997, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code 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
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package javax.swing;
/**
* A data model for a combo box. This interface extends ListModel
* and adds the concept of a selected item. The selected item is generally
* the item which is visible in the combo box display area.
*
* The selected item may not necessarily be managed by the underlying
* ListModel. This disjoint behavior allows for the temporary
* storage and retrieval of a selected item in the model.
*
* @param the type of the elements of this model
*
* @author Arnaud Weber
* @since 1.2
*/
public interface ComboBoxModel extends ListModel {
/**
* Set the selected item. The implementation of this method should notify
* all registered ListDataListeners that the contents
* have changed.
*
* @param anItem the list object to select or null
* to clear the selection
*/
void setSelectedItem(Object anItem);
/**
* Returns the selected item
* @return The selected item or null if there is no selection
*/
Object getSelectedItem();
}