libjava/javax/swing/ButtonGroup.java

   1 /* ButtonGroup.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., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 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 java.io.Serializable;
  41 import java.util.Enumeration;
  42 import java.util.Vector;
  43
  44
  45 /**
  46  * DOCUMENT ME!
  47  */
  48 public class ButtonGroup implements Serializable
  49 {
  50   /** DOCUMENT ME! */
  51   private static final long serialVersionUID = 4259076101881721375L;
  52
  53   /** The buttons added to this button group. */
  54   protected Vector buttons = new Vector();
  55
  56   /** The currently selected button model. */
  57   ButtonModel sel;
  58
  59   /**
  60    * Creates a new button group.
  61    */
  62   public ButtonGroup()
  63   {
  64   }
  65
  66   /**
  67    * Adds a button to this group.
  68    *
  69    * @param b the button to add
  70    */
  71   public void add(AbstractButton b)
  72   {
  73     b.getModel().setGroup(this);
  74     buttons.addElement(b);
  75   }
  76
  77   /**
  78    * Removed a given button from this group.
  79    *
  80    * @param b the button to remove
  81    */
  82   public void remove(AbstractButton b)
  83   {
  84     b.getModel().setGroup(null);
  85     buttons.removeElement(b);
  86   }
  87
  88   /**
  89    * Returns the currently added buttons.
  90    *
  91    * @return <code>Enumeration</code> over all added buttons
  92    */
  93   public Enumeration getElements()
  94   {
  95     return buttons.elements();
  96   }
  97
  98   /**
  99    * Returns the currently selected button model.
 100    *
 101    * @return the currently selected button model, null if none was selected
 102    *         yet
 103    */
 104   public ButtonModel getSelection()
 105   {
 106     return sel;
 107   }
 108
 109   /**
 110    * DOCUMENT ME!
 111    *
 112    * @param m DOCUMENT ME!
 113    *
 114    * @return DOCUMENT ME!
 115    */
 116   AbstractButton FindButton(ButtonModel m)
 117   {
 118     for (int i = 0; i < buttons.size(); i++)
 119       {
 120         AbstractButton a = (AbstractButton) buttons.get(i);
 121         if (a.getModel() == m)
 122           return a;
 123       }
 124     return null;
 125   }
 126
 127   /**
 128    * Sets the currently selected button model. Only one button of a group can
 129    * be selected at a time.
 130    *
 131    * @param m the model to select
 132    * @param b true if this button is to be selected, false otherwise
 133    */
 134   public void setSelected(ButtonModel m, boolean b)
 135   {
 136     if ((sel != m || b) && (! b || sel == m))
 137       return;
 138
 139     if (b && sel != m)
 140       {
 141         ButtonModel old = sel;
 142         sel = m;
 143
 144         if (old != null)
 145           old.setSelected(false);
 146         AbstractButton button = FindButton(old);
 147         if (button != null)
 148           button.repaint();
 149       }
 150     else if (! b && sel == m)
 151       m.setSelected(true);
 152   }
 153
 154   /**
 155    * Checks if the given <code>ButtonModel</code> is selected in this button
 156    * group.
 157    *
 158    * @param m DOCUMENT ME!
 159    *
 160    * @return true of given <code>ButtonModel</code> is selected, false
 161    *         otherwise
 162    */
 163   public boolean isSelected(ButtonModel m)
 164   {
 165     return m == sel;
 166   }
 167
 168   /**
 169    * Return the number of buttons in this button group.
 170    *
 171    * @return the number of buttons
 172    *
 173    * @since 1.3
 174    */
 175   public int getButtonCount()
 176   {
 177     return buttons.size();
 178   }
 179 }