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 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
/* * @(#)JCheckBoxMenuItem.java 1.58 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.*; /** * A menu item that can be selected or deselected. If selected, the menu * item typically appears with a checkmark next to it. If unselected or * deselected, the menu item appears without a checkmark. Like a regular * menu item, a check box menu item can have either text or a graphic * icon associated with it, or both. * <p> * Either <code>isSelected</code>/<code>setSelected</code> or * <code>getState</code>/<code>setState</code> can be used * to determine/specify the menu item's selection state. The * preferred methods are <code>isSelected</code> and * <code>setSelected</code>, which work for all menus and buttons. * The <code>getState</code> and <code>setState</code> methods exist for * compatibility with other component sets. * <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 information and examples of using check box menu items, * 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 menu item which can be selected or deselected. * * @version 1.58 08/08/06 * @author Georges Saab * @author David Karlton */ public class JCheckBoxMenuItem extends JMenuItem implements SwingConstants, Accessible { /** * @see #getUIClassID * @see #readObject */ private static final String uiClassID = "CheckBoxMenuItemUI"; /** * Creates an initially unselected check box menu item with no set text or icon. */ public JCheckBoxMenuItem() { this(null, null, false); } /** * Creates an initially unselected check box menu item with an icon. * * @param icon the icon of the CheckBoxMenuItem. */ public JCheckBoxMenuItem(Icon icon) { this(null, icon, false); } /** * Creates an initially unselected check box menu item with text. * * @param text the text of the CheckBoxMenuItem */ public JCheckBoxMenuItem(String text) { this(text, null, false); } /** * Creates a menu item whose properties are taken from the * Action supplied. * * @since 1.3 */ public JCheckBoxMenuItem(Action a) { this(); setAction(a); } /** * Creates an initially unselected check box menu item with the specified text and icon. * * @param text the text of the CheckBoxMenuItem * @param icon the icon of the CheckBoxMenuItem */ public JCheckBoxMenuItem(String text, Icon icon) { this(text, icon, false); } /** * Creates a check box menu item with the specified text and selection state. * * @param text the text of the check box menu item. * @param b the selected state of the check box menu item */ public JCheckBoxMenuItem(String text, boolean b) { this(text, null, b); } /** * Creates a check box menu item with the specified text, icon, and selection state. * * @param text the text of the check box menu item * @param icon the icon of the check box menu item * @param b the selected state of the check box menu item */ public JCheckBoxMenuItem(String text, Icon icon, boolean b) { super(text, icon); setModel(new JToggleButton.ToggleButtonModel()); setSelected(b); setFocusable(false); } /** * Returns the name of the L&F class * that renders this component. * * @return "CheckBoxMenuItemUI" * @see JComponent#getUIClassID * @see UIDefaults#getUI */ public String getUIClassID() { return uiClassID; } /** * Returns the selected-state of the item. This method * exists for AWT compatibility only. New code should * use isSelected() instead. * * @return true if the item is selected */ public boolean getState() { return isSelected(); } /** * Sets the selected-state of the item. This method * exists for AWT compatibility only. New code should * use setSelected() instead. * * @param b a boolean value indicating the item's * selected-state, where true=selected * @beaninfo * description: The selection state of the check box menu item * hidden: true */ public synchronized void setState(boolean b) { setSelected(b); } /** * Returns an array (length 1) containing the check box menu item * label or null if the check box is not selected. * * @return an array containing one Object -- the text of the menu item * -- if the item is selected; otherwise null */ public Object[] getSelectedObjects() { if (isSelected() == false) return null; Object[] selectedObjects = new Object[1]; selectedObjects[0] = getText(); return selectedObjects; } /** * See readObject() and writeObject() in JComponent 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 JCheckBoxMenuItem. 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 JCheckBoxMenuItem. */ protected String paramString() { return super.paramString(); } /** * Overriden to return true, JCheckBoxMenuItem supports * the selected state. */ boolean shouldUpdateSelectedStateFromAction() { return true; } ///////////////// // Accessibility support //////////////// /** * Gets the AccessibleContext associated with this JCheckBoxMenuItem. * For JCheckBoxMenuItems, the AccessibleContext takes the form of an * AccessibleJCheckBoxMenuItem. * A new AccessibleJCheckBoxMenuItem instance is created if necessary. * * @return an AccessibleJCheckBoxMenuItem that serves as the * AccessibleContext of this AccessibleJCheckBoxMenuItem */ public AccessibleContext getAccessibleContext() { if (accessibleContext == null) { accessibleContext = new AccessibleJCheckBoxMenuItem(); } return accessibleContext; } /** * This class implements accessibility support for the * <code>JCheckBoxMenuItem</code> class. It provides an implementation * of the Java Accessibility API appropriate to checkbox menu item * 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 AccessibleJCheckBoxMenuItem extends AccessibleJMenuItem { /** * Get the role of this object. * * @return an instance of AccessibleRole describing the role of the * object */ public AccessibleRole getAccessibleRole() { return AccessibleRole.CHECK_BOX; } } // inner class AccessibleJCheckBoxMenuItem }