public interface javax.swing
ButtonModel


Hide details Login
Java SE 6
  
Implements: ItemSelectable
Implemented by: DefaultButtonModel

State model for buttons.

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.
version1.29 02/14/06


Methods
public void addActionListener(ActionListener l)
Adds an ActionListener to the model.
lthe listener to add
public void addChangeListener(ChangeListener l)
Adds a ChangeListener to the model.
lthe listener to add
public void addItemListener(ItemListener l)
Adds an ItemListener to the model.
lthe listener to add
public void removeActionListener(ActionListener l)
Removes an ActionListener from the model.
lthe listener to remove
public void removeChangeListener(ChangeListener l)
Removes a ChangeListener from the model.
lthe listener to remove
public void removeItemListener(ItemListener l)
Removes an ItemListener from the model.
lthe listener to remove

Properties
public void setActionCommand(String s)
Sets the action command string that gets sent as part of the ActionEvent when the button is triggered.
sthe String that identifies the generated event
See also getActionCommand, getActionCommand
public String getActionCommand()
Returns the action command string for the button.
returnthe String that identifies the generated event
See also setActionCommand
public void setArmed(boolean b)
Marks the button as armed or unarmed.
bwhether or not the button should be armed
public boolean isArmed()
Indicates partial commitment towards triggering the button.
returntrue if the button is armed, and ready to be triggered
See also setArmed
public void setEnabled(boolean b)
Enables or disables the button.
bwhether or not the button should be enabled
See also isEnabled
public boolean isEnabled()
Indicates if the button can be selected or triggered by an input device, such as a mouse pointer.
returntrue if the button is enabled
public void setGroup(ButtonGroup group)
Identifies the group the button belongs to -- needed for radio buttons, which are mutually exclusive within their group.
groupthe ButtonGroup the button belongs to
public void setMnemonic(int key)
Sets the keyboard mnemonic (shortcut key or accelerator key) for the button.
keyan int specifying the accelerator key
public int getMnemonic()
Gets the keyboard mnemonic for the button.
returnan int specifying the accelerator key
See also setMnemonic
public void setPressed(boolean b)
Sets the button to pressed or unpressed.
bwhether or not the button should be pressed
See also isPressed
public boolean isPressed()
Indicates if the button is pressed.
returntrue if the button is pressed
public void setRollover(boolean b)
Sets or clears the button's rollover state
bwhether or not the button is in the rollover state
See also isRollover
public boolean isRollover()
Indicates that the mouse is over the button.
returntrue if the mouse is over the button
public void setSelected(boolean b)
Selects or deselects the button.
btrue selects the button, false deselects the button
public boolean isSelected()
Indicates if the button has been selected. Only needed for certain types of buttons - such as radio buttons and check boxes.
returntrue if the button is selected