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 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
/* * @(#)JButton.java 1.100 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 javax.swing.plaf.*; import javax.swing.event.*; import javax.accessibility.*; import java.io.ObjectOutputStream; import java.io.ObjectInputStream; import java.io.IOException; /** * An implementation of a "push" button. * <p> * Buttons 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 button has many benefits beyond directly * configuring a button. 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> * See <a href="http://java.sun.com/docs/books/tutorial/uiswing/components/button.html">How to Use Buttons, Check Boxes, and Radio Buttons</a> * in <em>The Java Tutorial</em> * for information and examples of using buttons. * <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: An implementation of a \"push\" button. * * @version 1.100 08/08/06 * @author Jeff Dinkins */ public class JButton extends AbstractButton implements Accessible { /** * @see #getUIClassID * @see #readObject */ private static final String uiClassID = "ButtonUI"; /** * Creates a button with no set text or icon. */ public JButton() { this(null, null); } /** * Creates a button with an icon. * * @param icon the Icon image to display on the button */ public JButton(Icon icon) { this(null, icon); } /** * Creates a button with text. * * @param text the text of the button */ public JButton(String text) { this(text, null); } /** * Creates a button where properties are taken from the * <code>Action</code> supplied. * * @param a the <code>Action</code> used to specify the new button * * @since 1.3 */ public JButton(Action a) { this(); setAction(a); } /** * Creates a button with initial text and an icon. * * @param text the text of the button * @param icon the Icon image to display on the button */ public JButton(String text, Icon icon) { // Create the model setModel(new DefaultButtonModel()); // initialize init(text, icon); } /** * Resets the UI property to a value from the current look and * feel. * * @see JComponent#updateUI */ public void updateUI() { setUI((ButtonUI)UIManager.getUI(this)); } /** * Returns a string that specifies the name of the L&F class * that renders this component. * * @return the string "ButtonUI" * @see JComponent#getUIClassID * @see UIDefaults#getUI * @beaninfo * expert: true * description: A string that specifies the name of the L&F class. */ public String getUIClassID() { return uiClassID; } /** * Gets the value of the <code>defaultButton</code> property, * which if <code>true</code> means that this button is the current * default button for its <code>JRootPane</code>. * Most look and feels render the default button * differently, and may potentially provide bindings * to access the default button. * * @return the value of the <code>defaultButton</code> property * @see JRootPane#setDefaultButton * @see #isDefaultCapable * @beaninfo * description: Whether or not this button is the default button */ public boolean isDefaultButton() { JRootPane root = SwingUtilities.getRootPane(this); if (root != null) { return root.getDefaultButton() == this; } return false; } /** * Gets the value of the <code>defaultCapable</code> property. * * @return the value of the <code>defaultCapable</code> property * @see #setDefaultCapable * @see #isDefaultButton * @see JRootPane#setDefaultButton */ public boolean isDefaultCapable() { return defaultCapable; } /** * Sets the <code>defaultCapable</code> property, * which determines whether this button can be * made the default button for its root pane. * The default value of the <code>defaultCapable</code> * property is <code>true</code> unless otherwise * specified by the look and feel. * * @param defaultCapable <code>true</code> if this button will be * capable of being the default button on the * <code>RootPane</code>; otherwise <code>false</code> * @see #isDefaultCapable * @beaninfo * bound: true * attribute: visualUpdate true * description: Whether or not this button can be the default button */ public void setDefaultCapable(boolean defaultCapable) { boolean oldDefaultCapable = this.defaultCapable; this.defaultCapable = defaultCapable; firePropertyChange("defaultCapable", oldDefaultCapable, defaultCapable); } /** * Overrides <code>JComponent.removeNotify</code> to check if * this button is currently set as the default button on the * <code>RootPane</code>, and if so, sets the <code>RootPane</code>'s * default button to <code>null</code> to ensure the * <code>RootPane</code> doesn't hold onto an invalid button reference. */ public void removeNotify() { JRootPane root = SwingUtilities.getRootPane(this); if (root != null && root.getDefaultButton() == this) { root.setDefaultButton(null); } super.removeNotify(); } /** * 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 <code>JButton</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>JButton</code> */ protected String paramString() { String defaultCapableString = (defaultCapable ? "true" : "false"); return super.paramString() + ",defaultCapable=" + defaultCapableString; } ///////////////// // Accessibility support //////////////// /** * Gets the <code>AccessibleContext</code> associated with this * <code>JButton</code>. For <code>JButton</code>s, * the <code>AccessibleContext</code> takes the form of an * <code>AccessibleJButton</code>. * A new <code>AccessibleJButton</code> instance is created if necessary. * * @return an <code>AccessibleJButton</code> that serves as the * <code>AccessibleContext</code> of this <code>JButton</code> * @beaninfo * expert: true * description: The AccessibleContext associated with this Button. */ public AccessibleContext getAccessibleContext() { if (accessibleContext == null) { accessibleContext = new AccessibleJButton(); } return accessibleContext; } /** * This class implements accessibility support for the * <code>JButton</code> class. It provides an implementation of the * Java Accessibility API appropriate to button 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 AccessibleJButton extends AccessibleAbstractButton { /** * Get the role of this object. * * @return an instance of AccessibleRole describing the role of the * object * @see AccessibleRole */ public AccessibleRole getAccessibleRole() { return AccessibleRole.PUSH_BUTTON; } } // inner class AccessibleJButton }