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 and Description |
---|---|
public void | |
public void | |
public void | addItemListener(ItemListener
the listener to add l)Redeclares java. ItemListener to the model.
|
public String | Returns: theString that identifies the generated eventReturns the action command string for the button. |
public default ButtonGroup | Returns: theButtonGroup that the button belongs toReturns the group that the button belongs to. |
public int | Returns: an int specifying the accelerator keyGets the keyboard mnemonic for the button. |
public boolean | Returns: true if the button is armed,
and ready to be triggeredIndicates partial commitment towards triggering the button. |
public boolean | Returns: true if the button is enabledIndicates if the button can be selected or triggered by an input device, such as a mouse pointer. |
public boolean | |
public boolean | Returns: true if the mouse is over the buttonIndicates that the mouse is over the button. |
public boolean | |
public void | removeActionListener(ActionListener
the listener to remove l)Removes an |
public void | removeChangeListener(ChangeListener
the listener to remove l)Removes a |
public void | removeItemListener(ItemListener
the listener to remove l)Redeclares java. ItemListener from the model.
|
public void | setActionCommand(String
the s)String that identifies the generated eventSets the action command string that gets sent as part of the
|
public void | |
public void | |
public void | setGroup(ButtonGroup
the group)ButtonGroup the button belongs toIdentifies the group the button belongs to -- needed for radio buttons, which are mutually exclusive within their group. |
public void | setMnemonic(int
an int specifying the accelerator key key)Sets the keyboard mnemonic (shortcut key or accelerator key) for the button. |
public void | setPressed(boolean
whether or not the button should be pressed b)Sets the button to pressed or unpressed. |
public void | setRollover(boolean
whether or not the button is in the rollover state b)Sets or clears the button's rollover state |
public void | setSelected(boolean
true selects the button,
false deselects the buttonSelects or deselects the button. |
addActionListener | back to summary |
---|---|
public void addActionListener(ActionListener l) Adds an
|
addChangeListener | back to summary |
---|---|
public void addChangeListener(ChangeListener l) Adds a
|
addItemListener | back to summary |
---|---|
public void addItemListener(ItemListener l) Redeclares java. Adds an
|
getActionCommand | back to summary |
---|---|
public String getActionCommand() Returns the action command string for the button.
|
getGroup | back to summary |
---|---|
public default ButtonGroup getGroup() Returns the group that the button belongs to. Normally used with radio buttons, which are mutually exclusive within their group. Implementation Specification The default implementation of this method returns
|
getMnemonic | back to summary |
---|---|
public int getMnemonic() Gets the keyboard mnemonic for the button.
|
isArmed | back to summary |
---|---|
public boolean isArmed() Indicates partial commitment towards triggering the button.
|
isEnabled | back to summary |
---|---|
public boolean isEnabled() Indicates if the button can be selected or triggered by an input device, such as a mouse pointer.
|
isPressed | back to summary |
---|---|
public boolean isPressed() Indicates if the button is pressed.
|
isRollover | back to summary |
---|---|
public boolean isRollover() Indicates that the mouse is over the button.
|
isSelected | back to summary |
---|---|
public boolean isSelected() Indicates if the button has been selected. Only needed for certain types of buttons - such as radio buttons and check boxes.
|
removeActionListener | back to summary |
---|---|
public void removeActionListener(ActionListener l) Removes an
|
removeChangeListener | back to summary |
---|---|
public void removeChangeListener(ChangeListener l) Removes a
|
removeItemListener | back to summary |
---|---|
public void removeItemListener(ItemListener l) Redeclares java. Removes an
|
setActionCommand | back to summary |
---|---|
public void setActionCommand(String s) Sets the action command string that gets sent as part of the
|
setArmed | back to summary |
---|---|
public void setArmed(boolean b) Marks the button as armed or unarmed.
|
setEnabled | back to summary |
---|---|
public void setEnabled(boolean b) Enables or disables the button.
|
setGroup | back to summary |
---|---|
public void setGroup(ButtonGroup group) Identifies the group the button belongs to -- needed for radio buttons, which are mutually exclusive within their group.
|
setMnemonic | back to summary |
---|---|
public void setMnemonic(int key) Sets the keyboard mnemonic (shortcut key or accelerator key) for the button.
|
setPressed | back to summary |
---|---|
public void setPressed(boolean b) Sets the button to pressed or unpressed.
|
setRollover | back to summary |
---|---|
public void setRollover(boolean b) Sets or clears the button's rollover state
|
setSelected | back to summary |
---|---|
public void setSelected(boolean b) Selects or deselects the button.
|