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
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.
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.
(add-action-listener this l)
Adds an ActionListener to the model.
l - the listener to add - java.awt.event.ActionListener
Adds an ActionListener to the model. l - the listener to add - `java.awt.event.ActionListener`
(add-change-listener this l)
Adds a ChangeListener to the model.
l - the listener to add - javax.swing.event.ChangeListener
Adds a ChangeListener to the model. l - the listener to add - `javax.swing.event.ChangeListener`
(add-item-listener this l)
Adds an ItemListener to the model.
l - the listener to add - java.awt.event.ItemListener
Adds an ItemListener to the model. l - the listener to add - `java.awt.event.ItemListener`
(armed? this)
Indicates partial commitment towards triggering the button.
returns: true if the button is armed,
and ready to be triggered - boolean
Indicates partial commitment towards triggering the button. returns: true if the button is armed, and ready to be triggered - `boolean`
(enabled? this)
Indicates if the button can be selected or triggered by an input device, such as a mouse pointer.
returns: true if the button is enabled - boolean
Indicates if the button can be selected or triggered by an input device, such as a mouse pointer. returns: true if the button is enabled - `boolean`
(get-action-command this)
Returns the action command string for the button.
returns: the String that identifies the generated event - java.lang.String
Returns the action command string for the button. returns: the String that identifies the generated event - `java.lang.String`
(get-mnemonic this)
Gets the keyboard mnemonic for the button.
returns: an int specifying the accelerator key - int
Gets the keyboard mnemonic for the button. returns: an int specifying the accelerator key - `int`
(pressed? this)
Indicates if the button is pressed.
returns: true if the button is pressed - boolean
Indicates if the button is pressed. returns: true if the button is pressed - `boolean`
(remove-action-listener this l)
Removes an ActionListener from the model.
l - the listener to remove - java.awt.event.ActionListener
Removes an ActionListener from the model. l - the listener to remove - `java.awt.event.ActionListener`
(remove-change-listener this l)
Removes a ChangeListener from the model.
l - the listener to remove - javax.swing.event.ChangeListener
Removes a ChangeListener from the model. l - the listener to remove - `javax.swing.event.ChangeListener`
(remove-item-listener this l)
Removes an ItemListener from the model.
l - the listener to remove - java.awt.event.ItemListener
Removes an ItemListener from the model. l - the listener to remove - `java.awt.event.ItemListener`
(rollover? this)
Indicates that the mouse is over the button.
returns: true if the mouse is over the button - boolean
Indicates that the mouse is over the button. returns: true if the mouse is over the button - `boolean`
(selected? this)
Indicates if the button has been selected. Only needed for certain types of buttons - such as radio buttons and check boxes.
returns: true if the button is selected - boolean
Indicates if the button has been selected. Only needed for certain types of buttons - such as radio buttons and check boxes. returns: true if the button is selected - `boolean`
(set-action-command this s)
Sets the action command string that gets sent as part of the ActionEvent when the button is triggered.
s - the String that identifies the generated event - java.lang.String
Sets the action command string that gets sent as part of the ActionEvent when the button is triggered. s - the String that identifies the generated event - `java.lang.String`
(set-armed this b)
Marks the button as armed or unarmed.
b - whether or not the button should be armed - boolean
Marks the button as armed or unarmed. b - whether or not the button should be armed - `boolean`
(set-enabled this b)
Enables or disables the button.
b - whether or not the button should be enabled - boolean
Enables or disables the button. b - whether or not the button should be enabled - `boolean`
(set-group this group)
Identifies the group the button belongs to -- needed for radio buttons, which are mutually exclusive within their group.
group - the ButtonGroup the button belongs to - javax.swing.ButtonGroup
Identifies the group the button belongs to -- needed for radio buttons, which are mutually exclusive within their group. group - the ButtonGroup the button belongs to - `javax.swing.ButtonGroup`
(set-mnemonic this key)
Sets the keyboard mnemonic (shortcut key or accelerator key) for the button.
key - an int specifying the accelerator key - int
Sets the keyboard mnemonic (shortcut key or accelerator key) for the button. key - an int specifying the accelerator key - `int`
(set-pressed this b)
Sets the button to pressed or unpressed.
b - whether or not the button should be pressed - boolean
Sets the button to pressed or unpressed. b - whether or not the button should be pressed - `boolean`
(set-rollover this b)
Sets or clears the button's rollover state
b - whether or not the button is in the rollover state - boolean
Sets or clears the button's rollover state b - whether or not the button is in the rollover state - `boolean`
(set-selected this b)
Selects or deselects the button.
b - true selects the button, false deselects the button - boolean
Selects or deselects the button. b - true selects the button, false deselects the button - `boolean`
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close