ItemSelectable
DefaultButtonModel
, JToggleButton.ToggleButtonModel
public interface ButtonModel extends ItemSelectable
This model is used for regular buttons, as well as check boxes and radio buttons, which are special kinds of buttons. In practice, a button's UI takes the responsibility of calling methods on its model to manage the state, as detailed below:
In simple terms, pressing and releasing the mouse over a regular button triggers the button and causes and ActionEvent
to be fired. The same behavior can be produced via a keyboard key defined by the look and feel of the button (typically the SPACE BAR). Pressing and releasing this key while the button has focus will give the same results. For check boxes and radio buttons, the mouse or keyboard equivalent sequence just described causes the button to become selected.
In details, the state model for buttons works as follows when used with the mouse:
Pressing the mouse on top of a button makes the model both armed and pressed. As long as the mouse remains down, the model remains pressed, even if the mouse moves outside the button. On the contrary, the model is only armed while the mouse remains pressed within the bounds of the button (it can move in or out of the button, but the model is only armed during the portion of time spent within the button). A button is triggered, and an ActionEvent
is fired, when the mouse is released while the model is armed - meaning when it is released over top of the button after the mouse has previously been pressed on that button (and not already released). Upon mouse release, the model becomes unarmed and unpressed.
In details, the state model for buttons works as follows when used with the keyboard:
Pressing the look and feel defined keyboard key while the button has focus makes the model both armed and pressed. As long as this key remains down, the model remains in this state. Releasing the key sets the model to unarmed and unpressed, triggers the button, and causes an ActionEvent
to be fired.
Modifier and Type | Method | Description |
---|---|---|
void |
addActionListener |
Adds an ActionListener to the model. |
void |
addChangeListener |
Adds a ChangeListener to the model. |
void |
addItemListener |
Adds an ItemListener to the model. |
String |
getActionCommand() |
Returns the action command string for the button. |
default ButtonGroup |
getGroup() |
Returns the group that the button belongs to. |
int |
getMnemonic() |
Gets the keyboard mnemonic for the button. |
boolean |
isArmed() |
Indicates partial commitment towards triggering the button. |
boolean |
isEnabled() |
Indicates if the button can be selected or triggered by an input device, such as a mouse pointer. |
boolean |
isPressed() |
Indicates if the button is pressed. |
boolean |
isRollover() |
Indicates that the mouse is over the button. |
boolean |
isSelected() |
Indicates if the button has been selected. |
void |
removeActionListener |
Removes an ActionListener from the model. |
void |
removeChangeListener |
Removes a ChangeListener from the model. |
void |
removeItemListener |
Removes an ItemListener from the model. |
void |
setActionCommand |
Sets the action command string that gets sent as part of the ActionEvent when the button is triggered. |
void |
setArmed |
Marks the button as armed or unarmed. |
void |
setEnabled |
Enables or disables the button. |
void |
setGroup |
Identifies the group the button belongs to -- needed for radio buttons, which are mutually exclusive within their group. |
void |
setMnemonic |
Sets the keyboard mnemonic (shortcut key or accelerator key) for the button. |
void |
setPressed |
Sets the button to pressed or unpressed. |
void |
setRollover |
Sets or clears the button's rollover state |
void |
setSelected |
Selects or deselects the button. |
getSelectedObjects
boolean isArmed()
true
if the button is armed, and ready to be triggeredboolean isSelected()
true
if the button is selectedboolean isEnabled()
true
if the button is enabledboolean isPressed()
true
if the button is pressedboolean isRollover()
true
if the mouse is over the buttonvoid setArmed(boolean b)
b
- whether or not the button should be armedvoid setSelected(boolean b)
b
- true
selects the button, false
deselects the buttonvoid setEnabled(boolean b)
b
- whether or not the button should be enabledvoid setPressed(boolean b)
b
- whether or not the button should be pressedvoid setRollover(boolean b)
b
- whether or not the button is in the rollover statevoid setMnemonic(int key)
key
- an int specifying the accelerator keyint getMnemonic()
void setActionCommand(String s)
ActionEvent
when the button is triggered.s
- the String
that identifies the generated eventString getActionCommand()
String
that identifies the generated eventvoid setGroup(ButtonGroup group)
group
- the ButtonGroup
the button belongs todefault ButtonGroup getGroup()
null
. Subclasses should return the group set by setGroup().ButtonGroup
that the button belongs tovoid addActionListener(ActionListener l)
ActionListener
to the model.l
- the listener to addvoid removeActionListener(ActionListener l)
ActionListener
from the model.l
- the listener to removevoid addItemListener(ItemListener l)
ItemListener
to the model.addItemListener
in interface ItemSelectable
l
- the listener to addvoid removeItemListener(ItemListener l)
ItemListener
from the model.removeItemListener
in interface ItemSelectable
l
- the listener to removevoid addChangeListener(ChangeListener l)
ChangeListener
to the model.l
- the listener to addvoid removeChangeListener(ChangeListener l)
ChangeListener
from the model.l
- the listener to remove
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/swing/ButtonModel.html