MutableComboBoxModel.java   [plain text]


/* MutableComboBoxModel.java --
   Copyright (C) 2002 Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Classpath 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 for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */

package javax.swing;

/**
 * MutableComboBoxModel is interface for data model that keeps track of the
 * components data and provides methods to insert and remove elements from
 * it. The Classes implementing this interface should  fire appropriate
 * events indicating the undergoing change in the data model.
 *
 * @author Andrew Selkirk
 * @author Olga Rodimina
 * @version 1.0
 */
public interface MutableComboBoxModel extends ComboBoxModel
{
  /**
   * This method adds given object to its data model.
   *
   * @param object element to add to the data model.
   */
  void addElement(Object object);

  /**
   * This method removes elements located at the given index in the data
   * model.
   *
   * @param index index specifying location of the element to remove.
   */
  void removeElementAt(int index);

  /**
   * This method inserts givent element to the data model, at the specified
   * index.
   *
   * @param object element to insert
   * @param index index specifying the position in the data model where the
   *        given element should be inserted.
   */
  void insertElementAt(Object object, int index);

  /**
   * This method removes given element from the data model
   *
   * @param element to remove.
   */
  void removeElement(Object object);
} // MutableComboBoxModel