1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
/* * @(#)JRadioButtonMenuItem.java 1.52 06/08/08 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package javax.swing; import java.util.EventListener; import java.awt.*; import java.awt.event.*; import java.awt.image.*; import java.io.ObjectOutputStream; import java.io.ObjectInputStream; import java.io.IOException; import javax.swing.plaf.*; import javax.accessibility.*; /** * An implementation of a radio button menu item. * A <code>JRadioButtonMenuItem</code> is * a menu item that is part of a group of menu items in which only one * item in the group can be selected. The selected item displays its * selected state. Selecting it causes any other selected item to * switch to the unselected state. * To control the selected state of a group of radio button menu items, * use a <code>ButtonGroup</code> object. * <p> * Menu items can be configured, and to some degree controlled, by * <code><a href="Action.html">Action</a></code>s. Using an * <code>Action</code> with a menu item has many benefits beyond directly * configuring a menu item. Refer to <a href="Action.html#buttonActions"> * Swing Components Supporting <code>Action</code></a> for more * details, and you can find more information in <a * href="http://java.sun.com/docs/books/tutorial/uiswing/misc/action.html">How * to Use Actions</a>, a section in <em>The Java Tutorial</em>. * <p> * For further documentation and examples see * <a href="http://java.sun.com/docs/books/tutorial/uiswing/components/menu.html">How to Use Menus</a>, * a section in <em>The Java Tutorial.</em> * <p> * <strong>Warning:</strong> Swing is not thread safe. For more * information see <a * href="package-summary.html#threading">Swing's Threading * Policy</a>. * <p> * <strong>Warning:</strong> * Serialized objects of this class will not be compatible with * future Swing releases. The current serialization support is * appropriate for short term storage or RMI between applications running * the same version of Swing. As of 1.4, support for long term storage * of all JavaBeans<sup><font size="-2">TM</font></sup> * has been added to the <code>java.beans</code> package. * Please see {@link java.beans.XMLEncoder}. * * @beaninfo * attribute: isContainer false * description: A component within a group of menu items which can be selected. * * @version 1.52 08/08/06 * @author Georges Saab * @author David Karlton * @see ButtonGroup */ public class JRadioButtonMenuItem extends JMenuItem implements Accessible { /** * @see #getUIClassID * @see #readObject */ private static final String uiClassID = "RadioButtonMenuItemUI"; /** * Creates a <code>JRadioButtonMenuItem</code> with no set text or icon. */ public JRadioButtonMenuItem() { this(null, null, false); } /** * Creates a <code>JRadioButtonMenuItem</code> with an icon. * * @param icon the <code>Icon</code> to display on the * <code>JRadioButtonMenuItem</code> */ public JRadioButtonMenuItem(Icon icon) { this(null, icon, false); } /** * Creates a <code>JRadioButtonMenuItem</code> with text. * * @param text the text of the <code>JRadioButtonMenuItem</code> */ public JRadioButtonMenuItem(String text) { this(text, null, false); } /** * Creates a radio button menu item whose properties are taken from the * <code>Action</code> supplied. * * @param a the <code>Action</code> on which to base the radio * button menu item * * @since 1.3 */ public JRadioButtonMenuItem(Action a) { this(); setAction(a); } /** * Creates a radio button menu item with the specified text * and <code>Icon</code>. * * @param text the text of the <code>JRadioButtonMenuItem</code> * @param icon the icon to display on the <code>JRadioButtonMenuItem</code> */ public JRadioButtonMenuItem(String text, Icon icon) { this(text, icon, false); } /** * Creates a radio button menu item with the specified text * and selection state. * * @param text the text of the <code>CheckBoxMenuItem</code> * @param selected the selected state of the <code>CheckBoxMenuItem</code> */ public JRadioButtonMenuItem(String text, boolean selected) { this(text); setSelected(selected); } /** * Creates a radio button menu item with the specified image * and selection state, but no text. * * @param icon the image that the button should display * @param selected if true, the button is initially selected; * otherwise, the button is initially unselected */ public JRadioButtonMenuItem(Icon icon, boolean selected) { this(null, icon, selected); } /** * Creates a radio button menu item that has the specified * text, image, and selection state. All other constructors * defer to this one. * * @param text the string displayed on the radio button * @param icon the image that the button should display */ public JRadioButtonMenuItem(String text, Icon icon, boolean selected) { super(text, icon); setModel(new JToggleButton.ToggleButtonModel()); setSelected(selected); setFocusable(false); } /** * Returns the name of the L&F class that renders this component. * * @return the string "RadioButtonMenuItemUI" * @see JComponent#getUIClassID * @see UIDefaults#getUI */ public String getUIClassID() { return uiClassID; } /** * See <code>readObject</code> and <code>writeObject</code> in * <code>JComponent</code> for more * information about serialization in Swing. */ private void writeObject(ObjectOutputStream s) throws IOException { s.defaultWriteObject(); if (getUIClassID().equals(uiClassID)) { byte count = JComponent.getWriteObjCounter(this); JComponent.setWriteObjCounter(this, --count); if (count == 0 && ui != null) { ui.installUI(this); } } } /** * Returns a string representation of this * <code>JRadioButtonMenuItem</code>. This method * is intended to be used only for debugging purposes, and the * content and format of the returned string may vary between * implementations. The returned string may be empty but may not * be <code>null</code>. * * @return a string representation of this * <code>JRadioButtonMenuItem</code> */ protected String paramString() { return super.paramString(); } /** * Overriden to return true, JRadioButtonMenuItem supports * the selected state. */ boolean shouldUpdateSelectedStateFromAction() { return true; } ///////////////// // Accessibility support //////////////// /** * Gets the AccessibleContext associated with this JRadioButtonMenuItem. * For JRadioButtonMenuItems, the AccessibleContext takes the form of an * AccessibleJRadioButtonMenuItem. * A new AccessibleJRadioButtonMenuItem instance is created if necessary. * * @return an AccessibleJRadioButtonMenuItem that serves as the * AccessibleContext of this JRadioButtonMenuItem */ public AccessibleContext getAccessibleContext() { if (accessibleContext == null) { accessibleContext = new AccessibleJRadioButtonMenuItem(); } return accessibleContext; } /** * This class implements accessibility support for the * <code>JRadioButtonMenuItem</code> class. It provides an * implementation of the Java Accessibility API appropriate to * <code>JRadioButtonMenuItem</code> user-interface elements. * <p> * <strong>Warning:</strong> * Serialized objects of this class will not be compatible with * future Swing releases. The current serialization support is * appropriate for short term storage or RMI between applications running * the same version of Swing. As of 1.4, support for long term storage * of all JavaBeans<sup><font size="-2">TM</font></sup> * has been added to the <code>java.beans</code> package. * Please see {@link java.beans.XMLEncoder}. */ protected class AccessibleJRadioButtonMenuItem extends AccessibleJMenuItem { /** * Get the role of this object. * * @return an instance of AccessibleRole describing the role of the * object */ public AccessibleRole getAccessibleRole() { return AccessibleRole.RADIO_BUTTON; } } // inner class AccessibleJRadioButtonMenuItem }