001/* MutableComboBoxModel.java --
002   Copyright (C) 2002 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
040/**
041 * A data model used in {@link JComboBox}es that keeps track of the
042 * components data and provides methods to insert and remove elements from
043 * it. The classes implementing this interface should
044 * fire appropriate events indicating the undergoing change in the data model.
045 *
046 * @author Andrew Selkirk
047 * @author Olga Rodimina
048 */
049public interface MutableComboBoxModel extends ComboBoxModel
050{
051  /**
052   * This method adds given object to its data model.
053   *
054   * @param object element to add to the data model.
055   */
056  void addElement(Object object);
057
058  /**
059   * This method removes elements located at the given index in the data
060   * model.
061   *
062   * @param index index specifying location of the element to remove.
063   */
064  void removeElementAt(int index);
065
066  /**
067   * This method inserts givent element to the data model, at the specified
068   * index.
069   *
070   * @param object element to insert
071   * @param index index specifying the position in the data model where the
072   *        given element should be inserted.
073   */
074  void insertElementAt(Object object, int index);
075
076  /**
077   * This method removes given element from the data model
078   *
079   * @param object element to remove.
080   */
081  void removeElement(Object object);
082}