home *** CD-ROM | disk | FTP | other *** search
/ Java 1.2 How-To / JavaHowTo.iso / 3rdParty / jbuilder / unsupported / JDK1.2beta3 / SOURCE / SRC.ZIP / java / awt / CheckboxGroup.java < prev    next >
Encoding:
Java Source  |  1998-03-20  |  4.0 KB  |  133 lines
  1. /*
  2.  * @(#)CheckboxGroup.java    1.20 98/03/18
  3.  *
  4.  * Copyright 1995-1997 by Sun Microsystems, Inc.,
  5.  * 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
  6.  * All rights reserved.
  7.  *
  8.  * This software is the confidential and proprietary information
  9.  * of Sun Microsystems, Inc. ("Confidential Information").  You
  10.  * shall not disclose such Confidential Information and shall use
  11.  * it only in accordance with the terms of the license agreement
  12.  * you entered into with Sun.
  13.  */
  14. package java.awt;
  15.  
  16. /**
  17.  * The <code>CheckboxGroup</code> class is used to group together 
  18.  * a set of <code>Checkbox</code> buttons. 
  19.  * <p>
  20.  * Exactly one check box button in a <code>CheckboxGroup</code> can 
  21.  * be in the "on" state at any given time. Pushing any 
  22.  * button sets its state to "on" and forces any other button that 
  23.  * is in the "on" state into the "off" state. 
  24.  * <p>
  25.  * The following code example produces a new check box group,
  26.  * with three check boxes: 
  27.  * <p>
  28.  * <hr><blockquote><pre>
  29.  * setLayout(new GridLayout(3, 1));
  30.  * CheckboxGroup cbg = new CheckboxGroup();
  31.  * add(new Checkbox("one", cbg, true));
  32.  * add(new Checkbox("two", cbg, false));
  33.  * add(new Checkbox("three", cbg, false));
  34.  * </pre></blockquote><hr>
  35.  * <p>
  36.  * This image depicts the check box group created by this example:
  37.  * <p>
  38.  * <img src="images-awt/CheckboxGroup-1.gif"
  39.  * ALIGN=center HSPACE=10 VSPACE=7> 
  40.  * <p>
  41.  * @version     1.20 03/18/98
  42.  * @author     Sami Shaio
  43.  * @see         java.awt.Checkbox
  44.  * @since       JDK1.0
  45.  */
  46. public class CheckboxGroup implements java.io.Serializable {
  47.     /**
  48.      * The current choice.
  49.      */
  50.     Checkbox selectedCheckbox = null;
  51.  
  52.     /*
  53.      * JDK 1.1 serialVersionUID 
  54.      */
  55.     private static final long serialVersionUID = 3729780091441768983L;
  56.  
  57.     /**
  58.      * Creates a new instance of <code>CheckboxGroup</code>. 
  59.      */
  60.     public CheckboxGroup() {
  61.     }
  62.  
  63.     /**
  64.      * Gets the current choice from this check box group.
  65.      * The current choice is the check box in this  
  66.      * group that is currently in the "on" state, 
  67.      * or <code>null</code> if all check boxes in the
  68.      * group are off.
  69.      * @return   the check box that is currently in the
  70.      *                 "on" state, or <code>null</code>.
  71.      * @see      java.awt.Checkbox
  72.      * @see      java.awt.CheckboxGroup#setSelectedCheckbox
  73.      * @since    JDK1.1
  74.      */
  75.     public Checkbox getSelectedCheckbox() {
  76.     return getCurrent();
  77.     }
  78.  
  79.     /**
  80.      * @deprecated As of JDK version 1.1,
  81.      * replaced by <code>getSelectedCheckbox()</code>.
  82.      */
  83.     public Checkbox getCurrent() {
  84.     return selectedCheckbox;
  85.     }
  86.  
  87.     /**
  88.      * Sets the currently selected check box in this group
  89.      * to be the specified check box.
  90.      * This method sets the state of that check box to "on" and 
  91.      * sets all other check boxes in the group to be off.
  92.      * <p>
  93.      * If the check box argument is <code>null</code> or belongs to a 
  94.      * different check box group, then this method does nothing. 
  95.      * @param     box   the <code>Checkbox</code> to set as the
  96.      *                      current selection.
  97.      * @see      java.awt.Checkbox
  98.      * @see      java.awt.CheckboxGroup#getSelectedCheckbox
  99.      * @since    JDK1.1
  100.      */
  101.     public synchronized void setSelectedCheckbox(Checkbox box) {
  102.         setCurrent(box);
  103.     }
  104.  
  105.     /**
  106.      * @deprecated As of JDK version 1.1,
  107.      * replaced by <code>setSelectedCheckbox(Checkbox)</code>.
  108.      */
  109.     public synchronized void setCurrent(Checkbox box) {
  110.     if (box != null && box.group != this) {
  111.         return;
  112.     }
  113.     Checkbox oldChoice = this.selectedCheckbox;
  114.     this.selectedCheckbox = box;
  115.     if ((oldChoice != null) && (oldChoice != box)) {
  116.         oldChoice.setState(false);
  117.     }
  118.     if (box != null && oldChoice != box && !box.getState()) {
  119.         box.setStateInternal(true);
  120.     }
  121.     }
  122.  
  123.     /**
  124.      * Returns a string representation of this check box group,
  125.      * including the value of its current selection.
  126.      * @return    a string representation of this check box group.
  127.      */
  128.     public String toString() {
  129.     return getClass().getName() + "[selectedCheckbox=" + selectedCheckbox + "]";
  130.     }
  131.  
  132. }
  133.