javax.swing
Class DefaultButtonModel

java.lang.Object
  |
  +--javax.swing.DefaultButtonModel

All Implemented Interfaces:

ButtonModel, ItemSelectable, Serializable

Direct Known Subclasses:

javax.swing.JToggleButton.ToggleButtonModel

public class DefaultButtonModel

extends Object

implements ButtonModel, Serializable

Safe: The default implementation of a Button 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 JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder.

Version:

1.41 12/03/01

Author:

Jeff Dinkins

See Also:

Serialized Form

Field Summary

protected String	actionCommand
static int	ARMED Enabled: Indicates partial commitment towards choosing the button.
protected ChangeEvent	changeEvent Only one ChangeEvent is needed per button model instance since the event's only state is the source property.
static int	ENABLED Enabled: Indicates that the button can be selected by an input device (such as a mouse pointer).
protected ButtonGroup	group
protected EventListenerList	listenerList
protected int	mnemonic
static int	PRESSED Enabled: Indicates that the button has been "pressed" (typically, when the mouse is released).
static int	ROLLOVER Enabled: Indicates that the mouse is over the button.
static int	SELECTED Enabled: Indicates that the button has been selected.
protected int	stateMask

Constructor Summary

DefaultButtonModel()
Enabled: Constructs a default JButtonModel.

Method Summary

void	addActionListener(ActionListener l) Enabled: Adds an ActionListener to the button.
void	addChangeListener(ChangeListener l) Enabled: Adds a ChangeListener to the button.
void	addItemListener(ItemListener l) Enabled: Adds an ItemListener to the button.
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() Suppressed: Returns the action command for this button.
ActionListener[]	getActionListeners() Suppressed: Returns an array of all the action listeners registered on this DefaultButtonModel.
ChangeListener[]	getChangeListeners() Suppressed: Returns an array of all the change listeners registered on this DefaultButtonModel.
ButtonGroup	getGroup() Enabled: Returns the group that this button belongs to.
ItemListener[]	getItemListeners() Suppressed: Returns an array of all the item listeners registered on this DefaultButtonModel.
EventListener[]	getListeners(Class listenerType) Suppressed: Returns an array of all the objects currently registered as FooListeners upon this model.
int	getMnemonic() Enabled: Gets the keyboard mnemonic for this model
Object[]	getSelectedObjects() Enabled: Overridden to return null.
boolean	isArmed() Enabled: Indicates partial commitment towards pressing the button.
boolean	isEnabled() Enabled: Indicates whether the button can be selected or pressed by an input device (such as a mouse pointer).
boolean	isPressed() Enabled: Indicates whether button has been pressed.
boolean	isRollover() Enabled: Indicates that the mouse is over the button.
boolean	isSelected() Enabled: Indicates if the button has been selected.
void	removeActionListener(ActionListener l) Enabled: Removes an ActionListener from the button.
void	removeChangeListener(ChangeListener l) Enabled: Removes a ChangeListener from the button.
void	removeItemListener(ItemListener l) Enabled: Removes an ItemListener from the button.
void	setActionCommand(String actionCommand) Enabled: Sets the actionCommand string that gets sent as part of the event when the button is pressed.
void	setArmed(boolean b) Enabled: Marks the button as "armed".
void	setEnabled(boolean b) Enabled: Enables or disables the button.
void	setGroup(ButtonGroup group) Enabled: Identifies the group this button belongs to -- needed for radio buttons, which are mutually exclusive within their group.
void	setMnemonic(int key) Enabled: Sets the keyboard mnemonic (shortcut key or accelerator key) for this button.
void	setPressed(boolean b) Enabled: Sets the button to pressed or unpressed.
void	setRollover(boolean b) Enabled: Sets or clears the button's rollover state
void	setSelected(boolean b) Enabled: Selects or deselects the button.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

stateMask

protected int stateMask

actionCommand

protected String actionCommand

group

protected ButtonGroup group

mnemonic

protected int mnemonic

changeEvent

protected transient ChangeEvent changeEvent

Only one ChangeEvent 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

ARMED

public static final int ARMED

Enabled: Indicates partial commitment towards choosing the button.

SELECTED

public static final int SELECTED

Enabled: Indicates that the button has been selected. Only needed for certain types of buttons - such as RadioButton or Checkbox.

PRESSED

public static final int PRESSED

Enabled: Indicates that the button has been "pressed" (typically, when the mouse is released).

ENABLED

public static final int ENABLED

Enabled: Indicates that the button can be selected by an input device (such as a mouse pointer).

ROLLOVER

public static final int ROLLOVER

Enabled: Indicates that the mouse is over the button.

Constructor Detail

DefaultButtonModel

public DefaultButtonModel()

Enabled: Constructs a default JButtonModel.

Method Detail

setActionCommand

public void setActionCommand(String actionCommand)

Enabled: Sets the actionCommand string that gets sent as part of the event when the button is pressed.

Specified by:

setActionCommand in interface ButtonModel

Parameters:

actionCommand - the String that identifies the generated event

getActionCommand

public String getActionCommand()

Suppressed: Returns the action command for this button.

Specified by:

getActionCommand in interface ButtonModel

Returns:

the String that identifies the generated event

See Also:

setActionCommand(java.lang.String)

isArmed

public boolean isArmed()

Enabled: Indicates partial commitment towards pressing the button.

Specified by:

isArmed in interface ButtonModel

Returns:

true if the button is armed, and ready to be pressed

See Also:

setArmed(boolean)

isSelected

public boolean isSelected()

Enabled: Indicates if the button has been selected. Only needed for certain types of buttons - such as RadioButton or Checkbox.

Specified by:

isSelected in interface ButtonModel

Returns:

true if the button is selected

isEnabled

public boolean isEnabled()

Enabled: Indicates whether the button can be selected or pressed by an input device (such as a mouse pointer). (Checkbox-buttons are selected, regular buttons are "pressed".)

Specified by:

isEnabled in interface ButtonModel

Returns:

true if the button is enabled, and therefore selectable (or pressable)

isPressed

public boolean isPressed()

Enabled: Indicates whether button has been pressed.

Specified by:

isPressed in interface ButtonModel

Returns:

true if the button has been pressed

isRollover

public boolean isRollover()

Enabled: Indicates that the mouse is over the button.

Specified by:

isRollover in interface ButtonModel

Returns:

true if the mouse is over the button

setArmed

public void setArmed(boolean b)

Enabled: Marks the button as "armed". If the mouse button is released while it is over this item, the button's action event fires. If the mouse button is released elsewhere, the event does not fire and the button is disarmed.

Specified by:

setArmed in interface ButtonModel

Parameters:

b - true to arm the button so it can be selected

setEnabled

public void setEnabled(boolean b)

Enabled: Enables or disables the button.

Specified by:

setEnabled in interface ButtonModel

Parameters:

b - true to enable the button

See Also:

isEnabled()

setSelected

public void setSelected(boolean b)

Enabled: Selects or deselects the button.

Specified by:

setSelected in interface ButtonModel

Parameters:

b - true selects the button, false deselects the button

setPressed

public void setPressed(boolean b)

Enabled: Sets the button to pressed or unpressed.

Specified by:

setPressed in interface ButtonModel

Parameters:

b - true to set the button to "pressed"

See Also:

isPressed()

setRollover

public void setRollover(boolean b)

Enabled: Sets or clears the button's rollover state

Specified by:

setRollover in interface ButtonModel

Parameters:

b - true to turn on rollover

See Also:

isRollover()

setMnemonic

public void setMnemonic(int key)

Enabled: Sets the keyboard mnemonic (shortcut key or accelerator key) for this button.

Specified by:

setMnemonic in interface ButtonModel

Parameters:

key - an int specifying the accelerator key

getMnemonic

public int getMnemonic()

Enabled: Gets the keyboard mnemonic for this model

Specified by:

getMnemonic in interface ButtonModel

Returns:

an int specifying the accelerator key

See Also:

setMnemonic(int)

addChangeListener

public void addChangeListener(ChangeListener l)

Enabled: Adds a ChangeListener to the button.

Specified by:

addChangeListener in interface ButtonModel

Parameters:

l - the listener to add

removeChangeListener

public void removeChangeListener(ChangeListener l)

Enabled: Removes a ChangeListener from the button.

Specified by:

removeChangeListener in interface ButtonModel

Parameters:

l - the listener to remove

getChangeListeners

public ChangeListener[] getChangeListeners()

Suppressed: Returns an array of all the change listeners registered on this DefaultButtonModel.

Returns:

all of this model's ChangeListeners 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)

Enabled: Adds an ActionListener to the button.

Specified by:

addActionListener in interface ButtonModel

Parameters:

l - the listener to add

removeActionListener

public void removeActionListener(ActionListener l)

Enabled: Removes an ActionListener from the button.

Specified by:

removeActionListener in interface ButtonModel

Parameters:

l - the listener to remove

getActionListeners

public ActionListener[] getActionListeners()

Suppressed: Returns an array of all the action listeners registered on this DefaultButtonModel.

Returns:

all of this model's ActionListeners 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 - the ActionEvent to deliver to listeners

See Also:

EventListenerList

addItemListener

public void addItemListener(ItemListener l)

Enabled: Adds an ItemListener to the button.

Specified by:

addItemListener in interface ButtonModel

Parameters:

l - the listener to add

removeItemListener

public void removeItemListener(ItemListener l)

Enabled: Removes an ItemListener from the button.

Specified by:

removeItemListener in interface ButtonModel

Parameters:

l - the listener to remove

getItemListeners

public ItemListener[] getItemListeners()

Suppressed: Returns an array of all the item listeners registered on this DefaultButtonModel.

Returns:

all of this model's ItemListeners 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 - the ItemEvent to deliver to listeners

See Also:

EventListenerList

getListeners

public EventListener[] getListeners(Class listenerType)

Suppressed: Returns an array of all the objects currently registered as FooListeners upon this model. FooListeners are registered using the addFooListener method.

You can specify the listenerType argument with a class literal, such as FooListener.class. For example, you can query a DefaultButtonModel instance m 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 from java.util.EventListener

Returns:

an array of all objects registered as FooListeners on this model, or an empty array if no such listeners have been added

Since:

1.3

See Also:

getActionListeners(), getChangeListeners(), getItemListeners()

getSelectedObjects

public Object[] getSelectedObjects()

Enabled: Overridden to return null.

Specified by:

getSelectedObjects in interface ItemSelectable

setGroup

public void setGroup(ButtonGroup group)

Enabled: Identifies the group this button belongs to -- needed for radio buttons, which are mutually exclusive within their group.

Specified by:

setGroup in interface ButtonModel

Parameters:

group - the ButtonGroup this button belongs to

getGroup

public ButtonGroup getGroup()

Enabled: Returns the group that this button belongs to. Normally used with radio buttons, which are mutually exclusive within their group.

Returns:

a ButtonGroup that this button belongs to

Since:

1.3