Source for javax.swing.SingleSelectionModel

   1: /* SingleSelectionModel.java --
   2:    Copyright (C) 2002, 2004 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: import javax.swing.event.ChangeEvent;
  41: import javax.swing.event.ChangeListener;
  42: 
  43: /**
  44:  * A data model that is used in components that support at most one
  45:  * selected element, like {@link JTabbedPane}, {@link JMenu} and
  46:  * {@link JPopupMenu}.
  47:  *
  48:  * @author Andrew Selkirk
  49:  */
  50: public interface SingleSelectionModel
  51: {
  52:   /**
  53:    * Returns the selected index or <code>-1</code> if there is no selection.
  54:    * 
  55:    * @return The selected index.
  56:    * 
  57:    * @see #setSelectedIndex(int)
  58:    */
  59:   int getSelectedIndex();
  60: 
  61:   /**
  62:    * Sets the selected index and, if this is different to the previous 
  63:    * selection, sends a {@link ChangeEvent} to all registered listeners.
  64:    * 
  65:    * @param index  the index (use <code>-1</code> to represent no selection).
  66:    * 
  67:    * @see #getSelectedIndex()
  68:    * @see #clearSelection
  69:    */
  70:   void setSelectedIndex(int index);
  71: 
  72:   /**
  73:    * Clears the selection by setting the selected index to <code>-1</code> and
  74:    * sends a {@link ChangeEvent} to all registered listeners.  If the selected
  75:    * index is already <code>-1</code>, this method does nothing.  
  76:    */
  77:   void clearSelection();
  78: 
  79:   /**
  80:    * Returns <code>true</code> if there is a selection, and <code>false</code>
  81:    * otherwise.  
  82:    * 
  83:    * @return A boolean.
  84:    */
  85:   boolean isSelected();
  86: 
  87:   /**
  88:    * Registers a listener to receive {@link ChangeEvent} notifications from
  89:    * this model whenever the selected index changes.
  90:    *
  91:    * @param listener the listener to add.
  92:    */
  93:   void addChangeListener(ChangeListener listener);
  94: 
  95:   /**
  96:    * Deregisters a listener so that it no longer receives {@link ChangeEvent}
  97:    * notifications from this model.
  98:    *
  99:    * @param listener the listener to remove.
 100:    */
 101:   void removeChangeListener(ChangeListener listener);
 102: 
 103: }