Source for javax.swing.MutableComboBoxModel

   1: /* MutableComboBoxModel.java --
   2:    Copyright (C) 2002 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: /**
  41:  * A data model used in {@link JComboBox}es that keeps track of the
  42:  * components data and provides methods to insert and remove elements from
  43:  * it. The classes implementing this interface should
  44:  * fire appropriate events indicating the undergoing change in the data model.
  45:  *
  46:  * @author Andrew Selkirk
  47:  * @author Olga Rodimina
  48:  */
  49: public interface MutableComboBoxModel extends ComboBoxModel
  50: {
  51:   /**
  52:    * This method adds given object to its data model.
  53:    *
  54:    * @param object element to add to the data model.
  55:    */
  56:   void addElement(Object object);
  57: 
  58:   /**
  59:    * This method removes elements located at the given index in the data
  60:    * model.
  61:    *
  62:    * @param index index specifying location of the element to remove.
  63:    */
  64:   void removeElementAt(int index);
  65: 
  66:   /**
  67:    * This method inserts givent element to the data model, at the specified
  68:    * index.
  69:    *
  70:    * @param object element to insert
  71:    * @param index index specifying the position in the data model where the
  72:    *        given element should be inserted.
  73:    */
  74:   void insertElementAt(Object object, int index);
  75: 
  76:   /**
  77:    * This method removes given element from the data model
  78:    *
  79:    * @param object element to remove.
  80:    */
  81:   void removeElement(Object object);
  82: }