0N/A/*
2362N/A * Copyright (c) 1997, 2006, Oracle and/or its affiliates. All rights reserved.
0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A *
0N/A * This code is free software; you can redistribute it and/or modify it
0N/A * under the terms of the GNU General Public License version 2 only, as
2362N/A * published by the Free Software Foundation. Oracle designates this
0N/A * particular file as subject to the "Classpath" exception as provided
2362N/A * by Oracle in the LICENSE file that accompanied this code.
0N/A *
0N/A * This code is distributed in the hope that it will be useful, but WITHOUT
0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A * version 2 for more details (a copy is included in the LICENSE file that
0N/A * accompanied this code).
0N/A *
0N/A * You should have received a copy of the GNU General Public License version
0N/A * 2 along with this work; if not, write to the Free Software Foundation,
0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0N/A *
2362N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
2362N/A * or visit www.oracle.com if you need additional information or have any
2362N/A * questions.
0N/A */
0N/Apackage javax.swing;
0N/A
0N/Aimport java.util.EventListener;
0N/A
0N/Aimport java.awt.*;
0N/Aimport java.awt.event.*;
0N/Aimport java.awt.image.*;
0N/A
0N/Aimport java.io.ObjectOutputStream;
0N/Aimport java.io.ObjectInputStream;
0N/Aimport java.io.IOException;
0N/A
0N/Aimport javax.swing.plaf.*;
0N/Aimport javax.accessibility.*;
0N/A
0N/A/**
0N/A * An implementation of a radio button menu item.
0N/A * A <code>JRadioButtonMenuItem</code> is
0N/A * a menu item that is part of a group of menu items in which only one
0N/A * item in the group can be selected. The selected item displays its
0N/A * selected state. Selecting it causes any other selected item to
0N/A * switch to the unselected state.
0N/A * To control the selected state of a group of radio button menu items,
0N/A * use a <code>ButtonGroup</code> object.
0N/A * <p>
0N/A * Menu items can be configured, and to some degree controlled, by
0N/A * <code><a href="Action.html">Action</a></code>s. Using an
0N/A * <code>Action</code> with a menu item has many benefits beyond directly
0N/A * configuring a menu item. Refer to <a href="Action.html#buttonActions">
0N/A * Swing Components Supporting <code>Action</code></a> for more
0N/A * details, and you can find more information in <a
0N/A * href="http://java.sun.com/docs/books/tutorial/uiswing/misc/action.html">How
0N/A * to Use Actions</a>, a section in <em>The Java Tutorial</em>.
0N/A * <p>
0N/A * For further documentation and examples see
0N/A * <a
0N/A href="http://java.sun.com/docs/books/tutorial/uiswing/components/menu.html">How to Use Menus</a>,
0N/A * a section in <em>The Java Tutorial.</em>
0N/A * <p>
0N/A * <strong>Warning:</strong> Swing is not thread safe. For more
0N/A * information see <a
0N/A * href="package-summary.html#threading">Swing's Threading
0N/A * Policy</a>.
0N/A * <p>
0N/A * <strong>Warning:</strong>
0N/A * Serialized objects of this class will not be compatible with
0N/A * future Swing releases. The current serialization support is
0N/A * appropriate for short term storage or RMI between applications running
0N/A * the same version of Swing. As of 1.4, support for long term storage
0N/A * of all JavaBeans<sup><font size="-2">TM</font></sup>
0N/A * has been added to the <code>java.beans</code> package.
0N/A * Please see {@link java.beans.XMLEncoder}.
0N/A *
0N/A * @beaninfo
0N/A * attribute: isContainer false
0N/A * description: A component within a group of menu items which can be selected.
0N/A *
0N/A * @author Georges Saab
0N/A * @author David Karlton
0N/A * @see ButtonGroup
0N/A */
0N/Apublic class JRadioButtonMenuItem extends JMenuItem implements Accessible {
0N/A /**
0N/A * @see #getUIClassID
0N/A * @see #readObject
0N/A */
0N/A private static final String uiClassID = "RadioButtonMenuItemUI";
0N/A
0N/A /**
0N/A * Creates a <code>JRadioButtonMenuItem</code> with no set text or icon.
0N/A */
0N/A public JRadioButtonMenuItem() {
0N/A this(null, null, false);
0N/A }
0N/A
0N/A /**
0N/A * Creates a <code>JRadioButtonMenuItem</code> with an icon.
0N/A *
0N/A * @param icon the <code>Icon</code> to display on the
0N/A * <code>JRadioButtonMenuItem</code>
0N/A */
0N/A public JRadioButtonMenuItem(Icon icon) {
0N/A this(null, icon, false);
0N/A }
0N/A
0N/A /**
0N/A * Creates a <code>JRadioButtonMenuItem</code> with text.
0N/A *
0N/A * @param text the text of the <code>JRadioButtonMenuItem</code>
0N/A */
0N/A public JRadioButtonMenuItem(String text) {
0N/A this(text, null, false);
0N/A }
0N/A
0N/A /**
0N/A * Creates a radio button menu item whose properties are taken from the
0N/A * <code>Action</code> supplied.
0N/A *
0N/A * @param a the <code>Action</code> on which to base the radio
0N/A * button menu item
0N/A *
0N/A * @since 1.3
0N/A */
0N/A public JRadioButtonMenuItem(Action a) {
0N/A this();
0N/A setAction(a);
0N/A }
0N/A
0N/A /**
0N/A * Creates a radio button menu item with the specified text
0N/A * and <code>Icon</code>.
0N/A *
0N/A * @param text the text of the <code>JRadioButtonMenuItem</code>
0N/A * @param icon the icon to display on the <code>JRadioButtonMenuItem</code>
0N/A */
0N/A public JRadioButtonMenuItem(String text, Icon icon) {
0N/A this(text, icon, false);
0N/A }
0N/A
0N/A /**
0N/A * Creates a radio button menu item with the specified text
0N/A * and selection state.
0N/A *
0N/A * @param text the text of the <code>CheckBoxMenuItem</code>
0N/A * @param selected the selected state of the <code>CheckBoxMenuItem</code>
0N/A */
0N/A public JRadioButtonMenuItem(String text, boolean selected) {
0N/A this(text);
0N/A setSelected(selected);
0N/A }
0N/A
0N/A /**
0N/A * Creates a radio button menu item with the specified image
0N/A * and selection state, but no text.
0N/A *
0N/A * @param icon the image that the button should display
0N/A * @param selected if true, the button is initially selected;
0N/A * otherwise, the button is initially unselected
0N/A */
0N/A public JRadioButtonMenuItem(Icon icon, boolean selected) {
0N/A this(null, icon, selected);
0N/A }
0N/A
0N/A /**
0N/A * Creates a radio button menu item that has the specified
0N/A * text, image, and selection state. All other constructors
0N/A * defer to this one.
0N/A *
0N/A * @param text the string displayed on the radio button
0N/A * @param icon the image that the button should display
0N/A */
0N/A public JRadioButtonMenuItem(String text, Icon icon, boolean selected) {
0N/A super(text, icon);
0N/A setModel(new JToggleButton.ToggleButtonModel());
0N/A setSelected(selected);
0N/A setFocusable(false);
0N/A }
0N/A
0N/A /**
0N/A * Returns the name of the L&F class that renders this component.
0N/A *
0N/A * @return the string "RadioButtonMenuItemUI"
0N/A * @see JComponent#getUIClassID
0N/A * @see UIDefaults#getUI
0N/A */
0N/A public String getUIClassID() {
0N/A return uiClassID;
0N/A }
0N/A
0N/A /**
0N/A * See <code>readObject</code> and <code>writeObject</code> in
0N/A * <code>JComponent</code> for more
0N/A * information about serialization in Swing.
0N/A */
0N/A private void writeObject(ObjectOutputStream s) throws IOException {
0N/A s.defaultWriteObject();
0N/A if (getUIClassID().equals(uiClassID)) {
0N/A byte count = JComponent.getWriteObjCounter(this);
0N/A JComponent.setWriteObjCounter(this, --count);
0N/A if (count == 0 && ui != null) {
0N/A ui.installUI(this);
0N/A }
0N/A }
0N/A }
0N/A
0N/A
0N/A /**
0N/A * Returns a string representation of this
0N/A * <code>JRadioButtonMenuItem</code>. This method
0N/A * is intended to be used only for debugging purposes, and the
0N/A * content and format of the returned string may vary between
0N/A * implementations. The returned string may be empty but may not
0N/A * be <code>null</code>.
0N/A *
0N/A * @return a string representation of this
0N/A * <code>JRadioButtonMenuItem</code>
0N/A */
0N/A protected String paramString() {
0N/A return super.paramString();
0N/A }
0N/A
0N/A /**
0N/A * Overriden to return true, JRadioButtonMenuItem supports
0N/A * the selected state.
0N/A */
0N/A boolean shouldUpdateSelectedStateFromAction() {
0N/A return true;
0N/A }
0N/A
0N/A/////////////////
0N/A// Accessibility support
0N/A////////////////
0N/A
0N/A /**
0N/A * Gets the AccessibleContext associated with this JRadioButtonMenuItem.
0N/A * For JRadioButtonMenuItems, the AccessibleContext takes the form of an
0N/A * AccessibleJRadioButtonMenuItem.
0N/A * A new AccessibleJRadioButtonMenuItem instance is created if necessary.
0N/A *
0N/A * @return an AccessibleJRadioButtonMenuItem that serves as the
0N/A * AccessibleContext of this JRadioButtonMenuItem
0N/A */
0N/A public AccessibleContext getAccessibleContext() {
0N/A if (accessibleContext == null) {
0N/A accessibleContext = new AccessibleJRadioButtonMenuItem();
0N/A }
0N/A return accessibleContext;
0N/A }
0N/A
0N/A /**
0N/A * This class implements accessibility support for the
0N/A * <code>JRadioButtonMenuItem</code> class. It provides an
0N/A * implementation of the Java Accessibility API appropriate to
0N/A * <code>JRadioButtonMenuItem</code> user-interface elements.
0N/A * <p>
0N/A * <strong>Warning:</strong>
0N/A * Serialized objects of this class will not be compatible with
0N/A * future Swing releases. The current serialization support is
0N/A * appropriate for short term storage or RMI between applications running
0N/A * the same version of Swing. As of 1.4, support for long term storage
0N/A * of all JavaBeans<sup><font size="-2">TM</font></sup>
0N/A * has been added to the <code>java.beans</code> package.
0N/A * Please see {@link java.beans.XMLEncoder}.
0N/A */
0N/A protected class AccessibleJRadioButtonMenuItem extends AccessibleJMenuItem {
0N/A /**
0N/A * Get the role of this object.
0N/A *
0N/A * @return an instance of AccessibleRole describing the role of the
0N/A * object
0N/A */
0N/A public AccessibleRole getAccessibleRole() {
0N/A return AccessibleRole.RADIO_BUTTON;
0N/A }
0N/A } // inner class AccessibleJRadioButtonMenuItem
0N/A}