- java.lang.Object
-
- javax.swing.DefaultButtonModel
-
- All Implemented Interfaces:
- ItemSelectable, Serializable, ButtonModel
- Direct Known Subclasses:
- JToggleButton.ToggleButtonModel
public class DefaultButtonModel extends Object implements ButtonModel, Serializable
The default implementation of aButton
component's data model.Warning: 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 JavaBeansTM has been added to the
java.beans
package. Please seeXMLEncoder
.
-
-
Field Summary
Fields Modifier and Type Field and Description protected String
actionCommand
The action command string fired by the button.static int
ARMED
Identifies the "armed" bit in the bitmask, which indicates partial commitment towards choosing/triggering the button.protected ChangeEvent
changeEvent
Only oneChangeEvent
is needed per button model instance since the event's only state is the source property.static int
ENABLED
Identifies the "enabled" bit in the bitmask, which indicates that the button can be selected by an input device (such as a mouse pointer).protected ButtonGroup
group
The button group that the button belongs to.protected EventListenerList
listenerList
Stores the listeners on this model.protected int
mnemonic
The button's mnemonic.static int
PRESSED
Identifies the "pressed" bit in the bitmask, which indicates that the button is pressed.static int
ROLLOVER
Identifies the "rollover" bit in the bitmask, which indicates that the mouse is over the button.static int
SELECTED
Identifies the "selected" bit in the bitmask, which indicates that the button has been selected.protected int
stateMask
The bitmask used to store the state of the button.
-
Constructor Summary
Constructors Constructor and Description DefaultButtonModel()
Constructs aDefaultButtonModel
.
-
Method Summary
Methods Modifier and Type Method and Description void
addActionListener(ActionListener l)
Adds anActionListener
to the model.void
addChangeListener(ChangeListener l)
Adds aChangeListener
to the model.void
addItemListener(ItemListener l)
Adds anItemListener
to the model.protected void
fireActionPerformed(ActionEvent e)
Notifies all listeners that have registered interest for notification on this event type.protected void
fireItemStateChanged(ItemEvent e)
Notifies all listeners that have registered interest for notification on this event type.protected void
fireStateChanged()
Notifies all listeners that have registered interest for notification on this event type.String
getActionCommand()
Returns the action command string for the button.ActionListener[]
getActionListeners()
Returns an array of all the action listeners registered on thisDefaultButtonModel
.ChangeListener[]
getChangeListeners()
Returns an array of all the change listeners registered on thisDefaultButtonModel
.ButtonGroup
getGroup()
Returns the group that the button belongs to.ItemListener[]
getItemListeners()
Returns an array of all the item listeners registered on thisDefaultButtonModel
.<T extends EventListener>
T[]getListeners(Class<T> listenerType)
Returns an array of all the objects currently registered asFooListener
s upon this model.int
getMnemonic()
Gets the keyboard mnemonic for the button.Object[]
getSelectedObjects()
Overridden to returnnull
.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(ActionListener l)
Removes anActionListener
from the model.void
removeChangeListener(ChangeListener l)
Removes aChangeListener
from the model.void
removeItemListener(ItemListener l)
Removes anItemListener
from the model.void
setActionCommand(String actionCommand)
Sets the action command string that gets sent as part of theActionEvent
when the button is triggered.void
setArmed(boolean b)
Marks the button as armed or unarmed.void
setEnabled(boolean b)
Enables or disables the button.void
setGroup(ButtonGroup group)
Identifies the group the button belongs to -- needed for radio buttons, which are mutually exclusive within their group.void
setMnemonic(int key)
Sets the keyboard mnemonic (shortcut key or accelerator key) for the button.void
setPressed(boolean b)
Sets the button to pressed or unpressed.void
setRollover(boolean b)
Sets or clears the button's rollover statevoid
setSelected(boolean b)
Selects or deselects the button.
-
-
-
Field Detail
-
stateMask
protected int stateMask
The bitmask used to store the state of the button.
-
actionCommand
protected String actionCommand
The action command string fired by the button.
-
group
protected ButtonGroup group
The button group that the button belongs to.
-
mnemonic
protected int mnemonic
The button's mnemonic.
-
changeEvent
protected transient ChangeEvent changeEvent
Only oneChangeEvent
is needed per button model instance since the event's only state is the source property. The source of events generated is always "this".
-
listenerList
protected EventListenerList listenerList
Stores the listeners on this model.
-
ARMED
public static final int ARMED
Identifies the "armed" bit in the bitmask, which indicates partial commitment towards choosing/triggering the button.- See Also:
- Constant Field Values
-
SELECTED
public static final int SELECTED
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.- See Also:
- Constant Field Values
-
PRESSED
public static final int PRESSED
Identifies the "pressed" bit in the bitmask, which indicates that the button is pressed.- See Also:
- Constant Field Values
-
ENABLED
public static final int ENABLED
Identifies the "enabled" bit in the bitmask, which indicates that the button can be selected by an input device (such as a mouse pointer).- See Also:
- Constant Field Values
-
ROLLOVER
public static final int ROLLOVER
Identifies the "rollover" bit in the bitmask, which indicates that the mouse is over the button.- See Also:
- Constant Field Values
-
-
Method Detail
-
setActionCommand
public void setActionCommand(String actionCommand)
Sets the action command string that gets sent as part of theActionEvent
when the button is triggered.- Specified by:
setActionCommand
in interfaceButtonModel
- Parameters:
actionCommand
- theString
that identifies the generated event- See Also:
ButtonModel.getActionCommand()
,ActionEvent.getActionCommand()
-
getActionCommand
public String getActionCommand()
Returns the action command string for the button.- Specified by:
getActionCommand
in interfaceButtonModel
- Returns:
- the
String
that identifies the generated event - See Also:
ButtonModel.setActionCommand(java.lang.String)
-
isArmed
public boolean isArmed()
Indicates partial commitment towards triggering the button.- Specified by:
isArmed
in interfaceButtonModel
- Returns:
true
if the button is armed, and ready to be triggered- See Also:
ButtonModel.setArmed(boolean)
-
isSelected
public boolean isSelected()
Indicates if the button has been selected. Only needed for certain types of buttons - such as radio buttons and check boxes.- Specified by:
isSelected
in interfaceButtonModel
- Returns:
true
if the button is selected
-
isEnabled
public boolean isEnabled()
Indicates if the button can be selected or triggered by an input device, such as a mouse pointer.- Specified by:
isEnabled
in interfaceButtonModel
- Returns:
true
if the button is enabled
-
isPressed
public boolean isPressed()
Indicates if the button is pressed.- Specified by:
isPressed
in interfaceButtonModel
- Returns:
true
if the button is pressed
-
isRollover
public boolean isRollover()
Indicates that the mouse is over the button.- Specified by:
isRollover
in interfaceButtonModel
- Returns:
true
if the mouse is over the button
-
setArmed
public void setArmed(boolean b)
Marks the button as armed or unarmed.- Specified by:
setArmed
in interfaceButtonModel
- Parameters:
b
- whether or not the button should be armed
-
setEnabled
public void setEnabled(boolean b)
Enables or disables the button.- Specified by:
setEnabled
in interfaceButtonModel
- Parameters:
b
- whether or not the button should be enabled- See Also:
ButtonModel.isEnabled()
-
setSelected
public void setSelected(boolean b)
Selects or deselects the button.- Specified by:
setSelected
in interfaceButtonModel
- Parameters:
b
-true
selects the button,false
deselects the button
-
setPressed
public void setPressed(boolean b)
Sets the button to pressed or unpressed.- Specified by:
setPressed
in interfaceButtonModel
- Parameters:
b
- whether or not the button should be pressed- See Also:
ButtonModel.isPressed()
-
setRollover
public void setRollover(boolean b)
Sets or clears the button's rollover state- Specified by:
setRollover
in interfaceButtonModel
- Parameters:
b
- whether or not the button is in the rollover state- See Also:
ButtonModel.isRollover()
-
setMnemonic
public void setMnemonic(int key)
Sets the keyboard mnemonic (shortcut key or accelerator key) for the button.- Specified by:
setMnemonic
in interfaceButtonModel
- Parameters:
key
- an int specifying the accelerator key
-
getMnemonic
public int getMnemonic()
Gets the keyboard mnemonic for the button.- Specified by:
getMnemonic
in interfaceButtonModel
- Returns:
- an int specifying the accelerator key
- See Also:
ButtonModel.setMnemonic(int)
-
addChangeListener
public void addChangeListener(ChangeListener l)
Adds aChangeListener
to the model.- Specified by:
addChangeListener
in interfaceButtonModel
- Parameters:
l
- the listener to add
-
removeChangeListener
public void removeChangeListener(ChangeListener l)
Removes aChangeListener
from the model.- Specified by:
removeChangeListener
in interfaceButtonModel
- Parameters:
l
- the listener to remove
-
getChangeListeners
public ChangeListener[] getChangeListeners()
Returns an array of all the change listeners registered on thisDefaultButtonModel
.- Returns:
- all of this model's
ChangeListener
s or an empty array if no change listeners are currently registered - Since:
- 1.4
- See Also:
addChangeListener(javax.swing.event.ChangeListener)
,removeChangeListener(javax.swing.event.ChangeListener)
-
fireStateChanged
protected void fireStateChanged()
Notifies all listeners that have registered interest for notification on this event type. The event instance is created lazily.- See Also:
EventListenerList
-
addActionListener
public void addActionListener(ActionListener l)
Adds anActionListener
to the model.- Specified by:
addActionListener
in interfaceButtonModel
- Parameters:
l
- the listener to add
-
removeActionListener
public void removeActionListener(ActionListener l)
Removes anActionListener
from the model.- Specified by:
removeActionListener
in interfaceButtonModel
- Parameters:
l
- the listener to remove
-
getActionListeners
public ActionListener[] getActionListeners()
Returns an array of all the action listeners registered on thisDefaultButtonModel
.- Returns:
- all of this model's
ActionListener
s or an empty array if no action listeners are currently registered - Since:
- 1.4
- See Also:
addActionListener(java.awt.event.ActionListener)
,removeActionListener(java.awt.event.ActionListener)
-
fireActionPerformed
protected void fireActionPerformed(ActionEvent e)
Notifies all listeners that have registered interest for notification on this event type.- Parameters:
e
- theActionEvent
to deliver to listeners- See Also:
EventListenerList
-
addItemListener
public void addItemListener(ItemListener l)
Adds anItemListener
to the model.- Specified by:
addItemListener
in interfaceItemSelectable
- Specified by:
addItemListener
in interfaceButtonModel
- Parameters:
l
- the listener to add- See Also:
ItemEvent
-
removeItemListener
public void removeItemListener(ItemListener l)
Removes anItemListener
from the model.- Specified by:
removeItemListener
in interfaceItemSelectable
- Specified by:
removeItemListener
in interfaceButtonModel
- Parameters:
l
- the listener to remove- See Also:
ItemEvent
-
getItemListeners
public ItemListener[] getItemListeners()
Returns an array of all the item listeners registered on thisDefaultButtonModel
.- Returns:
- all of this model's
ItemListener
s or an empty array if no item listeners are currently registered - Since:
- 1.4
- See Also:
addItemListener(java.awt.event.ItemListener)
,removeItemListener(java.awt.event.ItemListener)
-
fireItemStateChanged
protected void fireItemStateChanged(ItemEvent e)
Notifies all listeners that have registered interest for notification on this event type.- Parameters:
e
- theItemEvent
to deliver to listeners- See Also:
EventListenerList
-
getListeners
public <T extends EventListener> T[] getListeners(Class<T> listenerType)
Returns an array of all the objects currently registered asFooListener
s upon this model.FooListener
s are registered using theaddFooListener
method.You can specify the
listenerType
argument with a class literal, such asFooListener.class
. For example, you can query aDefaultButtonModel
instancem
for its action listeners with the following code:ActionListener[] als = (ActionListener[])(m.getListeners(ActionListener.class));
If no such listeners exist, this method returns an empty array.- Parameters:
listenerType
- the type of listeners requested; this parameter should specify an interface that descends fromjava.util.EventListener
- Returns:
- an array of all objects registered as
FooListener
s on this model, or an empty array if no such listeners have been added - Throws:
ClassCastException
- iflistenerType
doesn't specify a class or interface that implementsjava.util.EventListener
- Since:
- 1.3
- See Also:
getActionListeners()
,getChangeListeners()
,getItemListeners()
-
getSelectedObjects
public Object[] getSelectedObjects()
Overridden to returnnull
.- Specified by:
getSelectedObjects
in interfaceItemSelectable
-
setGroup
public void setGroup(ButtonGroup group)
Identifies the group the button belongs to -- needed for radio buttons, which are mutually exclusive within their group.- Specified by:
setGroup
in interfaceButtonModel
- Parameters:
group
- theButtonGroup
the button belongs to
-
getGroup
public ButtonGroup getGroup()
Returns the group that the button belongs to. Normally used with radio buttons, which are mutually exclusive within their group.- Returns:
- the
ButtonGroup
that the button belongs to - Since:
- 1.3
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
22/12/2024 10:35:42 Cette version de la page est en cache (à la date du 22/12/2024 10:35:42) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 30/08/2006, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-javax/swing/DefaultButtonModel.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.