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 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518
/* * @(#)DefaultButtonModel.java 1.49 06/05/25 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package javax.swing; import java.awt.*; import java.awt.event.*; import java.awt.image.*; import java.io.Serializable; import java.util.EventListener; import javax.swing.event.*; /** * The default implementation of a <code>Button</code> component's data model. * <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}. * * @version 1.49 05/25/06 * @author Jeff Dinkins */ public class DefaultButtonModel implements ButtonModel, Serializable { /** The bitmask used to store the state of the button. */ protected int stateMask = 0; /** The action command string fired by the button. */ protected String actionCommand = null; /** The button group that the button belongs to. */ protected ButtonGroup group = null; /** The button's mnemonic. */ protected int mnemonic = 0; /** * Only one <code>ChangeEvent</code> is needed per button model * instance since the event's only state is the source property. * The source of events generated is always "this". */ protected transient ChangeEvent changeEvent = null; /** Stores the listeners on this model. */ protected EventListenerList listenerList = new EventListenerList(); // controls the usage of the MenuItem.disabledAreNavigable UIDefaults // property in the setArmed() method private boolean menuItem = false; /** * Constructs a <code>DefaultButtonModel</code>. * */ public DefaultButtonModel() { stateMask = 0; setEnabled(true); } /** * Identifies the "armed" bit in the bitmask, which * indicates partial commitment towards choosing/triggering * the button. */ public final static int ARMED = 1 << 0; /** * Identifies the "selected" bit in the bitmask, which * indicates that the button has been selected. Only needed for * certain types of buttons - such as radio button or check box. */ public final static int SELECTED = 1 << 1; /** * Identifies the "pressed" bit in the bitmask, which * indicates that the button is pressed. */ public final static int PRESSED = 1 << 2; /** * Identifies the "enabled" bit in the bitmask, which * indicates that the button can be selected by * an input device (such as a mouse pointer). */ public final static int ENABLED = 1 << 3; /** * Identifies the "rollover" bit in the bitmask, which * indicates that the mouse is over the button. */ public final static int ROLLOVER = 1 << 4; /** * {@inheritDoc} */ public void setActionCommand(String actionCommand) { this.actionCommand = actionCommand; } /** * {@inheritDoc} */ public String getActionCommand() { return actionCommand; } /** * {@inheritDoc} */ public boolean isArmed() { return (stateMask & ARMED) != 0; } /** * {@inheritDoc} */ public boolean isSelected() { return (stateMask & SELECTED) != 0; } /** * {@inheritDoc} */ public boolean isEnabled() { return (stateMask & ENABLED) != 0; } /** * {@inheritDoc} */ public boolean isPressed() { return (stateMask & PRESSED) != 0; } /** * {@inheritDoc} */ public boolean isRollover() { return (stateMask & ROLLOVER) != 0; } /** * {@inheritDoc} */ public void setArmed(boolean b) { if(isMenuItem() && UIManager.getBoolean("MenuItem.disabledAreNavigable")) { if ((isArmed() == b)) { return; } } else { if ((isArmed() == b) || !isEnabled()) { return; } } if (b) { stateMask |= ARMED; } else { stateMask &= ~ARMED; } fireStateChanged(); } /** * {@inheritDoc} */ public void setEnabled(boolean b) { if(isEnabled() == b) { return; } if (b) { stateMask |= ENABLED; } else { stateMask &= ~ENABLED; // unarm and unpress, just in case stateMask &= ~ARMED; stateMask &= ~PRESSED; } fireStateChanged(); } /** * {@inheritDoc} */ public void setSelected(boolean b) { if (this.isSelected() == b) { return; } if (b) { stateMask |= SELECTED; } else { stateMask &= ~SELECTED; } fireItemStateChanged( new ItemEvent(this, ItemEvent.ITEM_STATE_CHANGED, this, b ? ItemEvent.SELECTED : ItemEvent.DESELECTED)); fireStateChanged(); } /** * {@inheritDoc} */ public void setPressed(boolean b) { if((isPressed() == b) || !isEnabled()) { return; } if (b) { stateMask |= PRESSED; } else { stateMask &= ~PRESSED; } if(!isPressed() && isArmed()) { int modifiers = 0; AWTEvent currentEvent = EventQueue.getCurrentEvent(); if (currentEvent instanceof InputEvent) { modifiers = ((InputEvent)currentEvent).getModifiers(); } else if (currentEvent instanceof ActionEvent) { modifiers = ((ActionEvent)currentEvent).getModifiers(); } fireActionPerformed( new ActionEvent(this, ActionEvent.ACTION_PERFORMED, getActionCommand(), EventQueue.getMostRecentEventTime(), modifiers)); } fireStateChanged(); } /** * {@inheritDoc} */ public void setRollover(boolean b) { if((isRollover() == b) || !isEnabled()) { return; } if (b) { stateMask |= ROLLOVER; } else { stateMask &= ~ROLLOVER; } fireStateChanged(); } /** * {@inheritDoc} */ public void setMnemonic(int key) { mnemonic = key; fireStateChanged(); } /** * {@inheritDoc} */ public int getMnemonic() { return mnemonic; } /** * {@inheritDoc} */ public void addChangeListener(ChangeListener l) { listenerList.add(ChangeListener.class, l); } /** * {@inheritDoc} */ public void removeChangeListener(ChangeListener l) { listenerList.remove(ChangeListener.class, l); } /** * Returns an array of all the change listeners * registered on this <code>DefaultButtonModel</code>. * * @return all of this model's <code>ChangeListener</code>s * or an empty * array if no change listeners are currently registered * * @see #addChangeListener * @see #removeChangeListener * * @since 1.4 */ public ChangeListener[] getChangeListeners() { return (ChangeListener[])listenerList.getListeners( ChangeListener.class); } /** * Notifies all listeners that have registered interest for * notification on this event type. The event instance * is created lazily. * * @see EventListenerList */ protected void fireStateChanged() { // Guaranteed to return a non-null array Object[] listeners = listenerList.getListenerList(); // Process the listeners last to first, notifying // those that are interested in this event for (int i = listeners.length-2; i>=0; i-=2) { if (listeners[i]==ChangeListener.class) { // Lazily create the event: if (changeEvent == null) changeEvent = new ChangeEvent(this); ((ChangeListener)listeners[i+1]).stateChanged(changeEvent); } } } /** * {@inheritDoc} */ public void addActionListener(ActionListener l) { listenerList.add(ActionListener.class, l); } /** * {@inheritDoc} */ public void removeActionListener(ActionListener l) { listenerList.remove(ActionListener.class, l); } /** * Returns an array of all the action listeners * registered on this <code>DefaultButtonModel</code>. * * @return all of this model's <code>ActionListener</code>s * or an empty * array if no action listeners are currently registered * * @see #addActionListener * @see #removeActionListener * * @since 1.4 */ public ActionListener[] getActionListeners() { return (ActionListener[])listenerList.getListeners( ActionListener.class); } /** * Notifies all listeners that have registered interest for * notification on this event type. * * @param e the <code>ActionEvent</code> to deliver to listeners * @see EventListenerList */ protected void fireActionPerformed(ActionEvent e) { // Guaranteed to return a non-null array Object[] listeners = listenerList.getListenerList(); // Process the listeners last to first, notifying // those that are interested in this event for (int i = listeners.length-2; i>=0; i-=2) { if (listeners[i]==ActionListener.class) { // Lazily create the event: // if (changeEvent == null) // changeEvent = new ChangeEvent(this); ((ActionListener)listeners[i+1]).actionPerformed(e); } } } /** * {@inheritDoc} */ public void addItemListener(ItemListener l) { listenerList.add(ItemListener.class, l); } /** * {@inheritDoc} */ public void removeItemListener(ItemListener l) { listenerList.remove(ItemListener.class, l); } /** * Returns an array of all the item listeners * registered on this <code>DefaultButtonModel</code>. * * @return all of this model's <code>ItemListener</code>s * or an empty * array if no item listeners are currently registered * * @see #addItemListener * @see #removeItemListener * * @since 1.4 */ public ItemListener[] getItemListeners() { return (ItemListener[])listenerList.getListeners(ItemListener.class); } /** * Notifies all listeners that have registered interest for * notification on this event type. * * @param e the <code>ItemEvent</code> to deliver to listeners * @see EventListenerList */ protected void fireItemStateChanged(ItemEvent e) { // Guaranteed to return a non-null array Object[] listeners = listenerList.getListenerList(); // Process the listeners last to first, notifying // those that are interested in this event for (int i = listeners.length-2; i>=0; i-=2) { if (listeners[i]==ItemListener.class) { // Lazily create the event: // if (changeEvent == null) // changeEvent = new ChangeEvent(this); ((ItemListener)listeners[i+1]).itemStateChanged(e); } } } /** * Returns an array of all the objects currently registered as * <code><em>Foo</em>Listener</code>s * upon this model. * <code><em>Foo</em>Listener</code>s * are registered using the <code>add<em>Foo</em>Listener</code> method. * <p> * You can specify the <code>listenerType</code> argument * with a class literal, such as <code><em>Foo</em>Listener.class</code>. * For example, you can query a <code>DefaultButtonModel</code> * instance <code>m</code> * for its action listeners * with the following code: * * <pre>ActionListener[] als = (ActionListener[])(m.getListeners(ActionListener.class));</pre> * * If no such listeners exist, * this method returns an empty array. * * @param listenerType the type of listeners requested; * this parameter should specify an interface * that descends from <code>java.util.EventListener</code> * @return an array of all objects registered as * <code><em>Foo</em>Listener</code>s * on this model, * or an empty array if no such * listeners have been added * @exception ClassCastException if <code>listenerType</code> doesn't * specify a class or interface that implements * <code>java.util.EventListener</code> * * @see #getActionListeners * @see #getChangeListeners * @see #getItemListeners * * @since 1.3 */ public <T extends EventListener> T[] getListeners(Class<T> listenerType) { return listenerList.getListeners(listenerType); } /** Overridden to return <code>null</code>. */ public Object[] getSelectedObjects() { return null; } /** * {@inheritDoc} */ public void setGroup(ButtonGroup group) { this.group = group; } /** * Returns the group that the button belongs to. * Normally used with radio buttons, which are mutually * exclusive within their group. * * @return the <code>ButtonGroup</code> that the button belongs to * * @since 1.3 */ public ButtonGroup getGroup() { return group; } boolean isMenuItem() { return menuItem; } void setMenuItem(boolean menuItem) { this.menuItem = menuItem; } }