javax.swing

Interface ButtonModel

public interface ButtonModel extends ItemSelectable

The data model that is used in all kinds of buttons.

Method Summary
void	addActionListener(ActionListener l) Adds an {@link ActionListener} to the list of registered listeners.
void	addChangeListener(ChangeListener l) Adds an {@link ChangeListener} to the list of registered listeners.
void	addItemListener(ItemListener l) Adds an {@link ItemListener} to the list of registered listeners.
String	getActionCommand() Returns the action command of the button.
int	getMnemonic() Returns the keyboard mnemonic for the button.
boolean	isArmed() Returns `true` if the button is armed, `false` otherwise.
boolean	isEnabled() Returns `true` if the button is enabled, `false` otherwise.
boolean	isPressed() Returns `true` if the button is pressed, `false` otherwise.
boolean	isRollover() Returns `true` if the button is rollover-ed, `false` otherwise.
boolean	isSelected() Returns `true` if the button is selected, `false` otherwise.
void	removeActionListener(ActionListener l) Removes an {@link ActionListener} from the list of registered listeners.
void	removeChangeListener(ChangeListener l) Adds an {@link ChangeListener} to the list of registered listeners.
void	removeItemListener(ItemListener l) Adds an {@link ItemListener} to the list of registered listeners.
void	setActionCommand(String s) Sets the action command for the button.
void	setArmed(boolean b) Sets the armed flag of the button.
void	setEnabled(boolean b) Sets the enabled flag of the button.
void	setGroup(ButtonGroup group) Sets the button group for the button.
void	setMnemonic(int key) Sets the keyboard mnemonic for the button.
void	setPressed(boolean b) Sets the pressed flag of the button.
void	setRollover(boolean b) Sets the rollover flag of the button.
void	setSelected(boolean b) Sets the selected flag of the button.

Method Detail

addActionListener

public void addActionListener(ActionListener l)

Adds an {@link ActionListener} to the list of registered listeners. An ActionEvent is usually fired when the user clicks on a button.

Parameters: l the action listener to add

addChangeListener

public void addChangeListener(ChangeListener l)

Adds an {@link ChangeListener} to the list of registered listeners. A ChangeEvent is fired when any one of the button's flags changes.

Parameters: l the change listener to add

addItemListener

public void addItemListener(ItemListener l)

Adds an {@link ItemListener} to the list of registered listeners. An ItemEvent is usually fired when a button's selected state changes. This applies only to buttons that support the selected flag.

Parameters: l the item listener to add

getActionCommand

public String getActionCommand()

Returns the action command of the button.

Returns: the action command of the button

getMnemonic

public int getMnemonic()

Returns the keyboard mnemonic for the button. This specifies a shortcut or accelerator key that can be used to activate the button.

Returns: the keyboard mnemonic for the button

See Also: ButtonModel

isArmed

public boolean isArmed()

Returns true if the button is armed, false otherwise. A button is armed, when the user has pressed the mouse over it, but has not yet released the mouse.

Returns: true if the button is armed, false otherwise

See Also: ButtonModel

isEnabled

public boolean isEnabled()

Returns true if the button is enabled, false otherwise. When a button is disabled, it is usually grayed out and the user cannot change its state.

Returns: true if the button is enabled, false otherwise

See Also: ButtonModel

isPressed

public boolean isPressed()

Returns true if the button is pressed, false otherwise. The button usually gets pressed when the user clicks on a button, it will be un-pressed when the user releases the mouse.

Returns: true if the button is pressed, false otherwise

See Also: ButtonModel

isRollover

public boolean isRollover()

Returns true if the button is rollover-ed, false otherwise. A button is rollover-ed, when the user has moved the mouse over it, but has not yet pressed the mouse.

Returns: true if the button is rollover, false otherwise

See Also: ButtonModel

Returns true if the button is selected, false otherwise. Some kinds of buttons (e.g. toggle buttons, check boxes, radio buttons) can be in one of two states: selected or unselected. The selected state is usually toggled by clicking on the button.

Returns: true if the button is selected, false otherwise

See Also: ButtonModel

removeActionListener

public void removeActionListener(ActionListener l)

Removes an {@link ActionListener} from the list of registered listeners.

Parameters: l the action listener to remove

removeChangeListener

public void removeChangeListener(ChangeListener l)

Adds an {@link ChangeListener} to the list of registered listeners.

Parameters: l the change listener to add

removeItemListener

public void removeItemListener(ItemListener l)

Adds an {@link ItemListener} to the list of registered listeners.

Parameters: l the item listener to add

setActionCommand

public void setActionCommand(String s)

Sets the action command for the button. This will be used in ActionEvents fired by the button.

Parameters: s the action command to set

setArmed

public void setArmed(boolean b)

Sets the armed flag of the button. A button is armed, when the user has pressed the mouse over it, but has not yet released the mouse.

Parameters: b true if the button is armed, false otherwise

setEnabled

public void setEnabled(boolean b)

Sets the enabled flag of the button. When a button is disabled, it is usually grayed out and the user cannot change its state.

Parameters: b true if the button is enabled, false otherwise

setGroup

public void setGroup(ButtonGroup group)

Sets the button group for the button. Some kinds of button (e.g. radio buttons) allow only one button within a button group selected at any one time.

Parameters: group the button group to set

setMnemonic

public void setMnemonic(int key)

Sets the keyboard mnemonic for the button. This specifies a shortcut or accelerator key that can be used to activate the button.

Parameters: key the keyboard mnemonic for the button

setPressed

public void setPressed(boolean b)

Sets the pressed flag of the button. The button usually gets pressed when the user clicks on a button, it will be un-pressed when the user releases the mouse.

Parameters: b true if the button is pressed, false otherwise

setRollover

public void setRollover(boolean b)

Sets the rollover flag of the button. A button is rollover-ed, when the user has moved the mouse over it, but has not yet pressed the mouse.

Parameters: b true if the button is rollover, false otherwise

setSelected

public void setSelected(boolean b)

Sets the selected flag of the button. Some kinds of buttons (e.g. toggle buttons, check boxes, radio buttons) can be in one of two states: selected or unselected. The selected state is usually toggled by clicking on the button.

Parameters: b true if the button is selected, false otherwise