libjava/classpath/javax/swing/JRadioButtonMenuItem.java

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