libjava/javax/swing/JRadioButtonMenuItem.java

   1 /* JRadioButtonMenuItem.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., 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.IOException;
  41 import java.io.ObjectOutputStream;
  42 import javax.accessibility.Accessible;
  43 import javax.accessibility.AccessibleContext;
  44 import javax.accessibility.AccessibleRole;
  45 import javax.swing.event.ChangeEvent;
  46 import javax.swing.event.ChangeListener;
  47
  48
  49 /**
  50  * This class represents JRadioButtonMenuItem. Its behaviour is very similar
  51  * to JRadioButton. Just like JRadioButton, user can check and uncheck this
  52  * menu item by clicking on it. JRadioButtonMenuItem uses ToggleButtonModel
  53  * to keep track of its selection. If the JRadioButtonMenuItem is included in
  54  * the button group, then only one JRadioButtonMenuItem can be selected at
  55  * one time.
  56  */
  57 public class JRadioButtonMenuItem extends JMenuItem implements Accessible
  58 {
  59   private static final long serialVersionUID = 8482658191548521743L;
  60
  61   /** name for the UI delegate for this radio button menu item. */
  62   private static final String uiClassID = "RadioButtonMenuItemUI";
  63
  64   /**
  65    * Creates a new JRadioButtonMenuItem object.
  66    */
  67   public JRadioButtonMenuItem()
  68   {
  69     this(null, null);
  70   }
  71
  72   /**
  73    * Creates a new JRadioButtonMenuItem with specified icon
  74    *
  75    * @param icon Icon to be used for this menu item
  76    */
  77   public JRadioButtonMenuItem(Icon icon)
  78   {
  79     this(null, icon);
  80   }
  81
  82   /**
  83    * Creates a new JRadioButtonMenuItem with specified label
  84    *
  85    * @param text Label for this menu item
  86    */
  87   public JRadioButtonMenuItem(String text)
  88   {
  89     this(text, null);
  90   }
  91
  92   /**
  93    * Creates a new JRadioButtonMenuItem using specified action
  94    *
  95    * @param action Action for this menu item
  96    */
  97   public JRadioButtonMenuItem(Action action)
  98   {
  99     this();
 100     setAction(action);
 101   }
 102
 103   /**
 104    * Creates a new JRadioButtonMenuItem with specified label and icon
 105    *
 106    * @param text Label for this menu item
 107    * @param icon Icon for this menu item
 108    */
 109   public JRadioButtonMenuItem(String text, Icon icon)
 110   {
 111     this(text, icon, false);
 112   }
 113
 114   /**
 115    * Creates a new JRadioButtonMenuItem with specified label
 116    * and marked selected if 'selected' is true.
 117    *
 118    * @param text Text for this menu item
 119    * @param selected Selected state of this menu item
 120    */
 121   public JRadioButtonMenuItem(String text, boolean selected)
 122   {
 123     this(text, null, selected);
 124   }
 125
 126   /**
 127    * Creates a new JRadioButtonMenuItem with specified icon
 128    * and given selected state
 129    *
 130    * @param icon Icon for this menu item
 131    * @param selected Selected state for this menu item
 132    */
 133   public JRadioButtonMenuItem(Icon icon, boolean selected)
 134   {
 135     this(null, icon, selected);
 136   }
 137
 138   /**
 139    * Creates a new JRadioButtonMenuItem with specified label,
 140    * icon and selected state.
 141    *
 142    * @param text Label for this menu item
 143    * @param icon Icon to be use for this menu item
 144    * @param selected selected state of this menu item
 145    */
 146   public JRadioButtonMenuItem(String text, Icon icon, boolean selected)
 147   {
 148     super(text, icon);
 149     setModel(new JToggleButton.ToggleButtonModel());
 150     model.setSelected(selected);
 151   }
 152
 153   private void writeObject(ObjectOutputStream stream) throws IOException
 154   {
 155   }
 156
 157   /**
 158    * This method returns a name to identify which look and feel class will be
 159    * the UI delegate for the menuItem.
 160    *
 161    * @return The Look and Feel classID. "JRadioButtonMenuItemUI"
 162    */
 163   public String getUIClassID()
 164   {
 165     return uiClassID;
 166   }
 167
 168   /**
 169    * This method overrides JComponent.requestFocus with an empty
 170    * implementation, since JRadioButtonMenuItems should not
 171    * receve focus in general.
 172    */
 173   public void requestFocus()
 174   {
 175     //  Should do nothing here
 176   }
 177
 178   /**
 179    * A string that describes this JRadioButtonMenuItem. Normally only used
 180    * for debugging.
 181    *
 182    * @return A string describing this JRadioButtonMenuItem
 183    */
 184   protected String paramString()
 185   {
 186     return "JRadioButtonMenuItem";
 187   }
 188
 189   public AccessibleContext getAccessibleContext()
 190   {
 191     if (accessibleContext == null)
 192       accessibleContext = new AccessibleJRadioButtonMenuItem();
 193
 194     return accessibleContext;
 195   }
 196
 197   protected class AccessibleJRadioButtonMenuItem extends AccessibleJMenuItem
 198   {
 199     private static final long serialVersionUID = 4381471510145292179L;
 200
 201     /**
 202      * Creates a new AccessibleJRadioButtonMenuItem object.
 203      */
 204     protected AccessibleJRadioButtonMenuItem()
 205     {
 206     }
 207
 208     public AccessibleRole getAccessibleRole()
 209     {
 210       return AccessibleRole.RADIO_BUTTON;
 211     }
 212   }
 213 }