javax.swing

Interface ButtonModel

All Superinterfaces:: ItemSelectable

Known Implementing Classes:: DefaultButtonModel, JToggleButton.ToggleButtonModel

public interface ButtonModel

extends ItemSelectable

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

Method Summary
`void`	`addActionListener(ActionListener l)` Adds an `ActionListener` to the list of registered listeners.
`void`	`addChangeListener(ChangeListener l)` Adds an `ChangeListener` to the list of registered listeners.
`void`	`addItemListener(ItemListener l)` Adds an `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 `ActionListener` from the list of registered listeners.
`void`	`removeChangeListener(ChangeListener l)` Adds an `ChangeListener` to the list of registered listeners.
`void`	`removeItemListener(ItemListener l)` Adds an `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.

Methods inherited from interface java.awt.ItemSelectable
`addItemListener`, `getSelectedObjects`, `removeItemListener`

addActionListener

public void addActionListener(ActionListener l)

Adds an 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
See Also:
removeActionListener(ActionListener)

addChangeListener

public void addChangeListener(ChangeListener l)

Adds an 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
See Also:
removeChangeListener(ChangeListener)

addItemListener

public void addItemListener(ItemListener l)

Adds an 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.
Specified by:
addItemListener in interface ItemSelectable
Parameters:
l - the item listener to add
See Also:
removeItemListener(ItemListener)

getActionCommand

public String getActionCommand()

Returns the action command of the button.
Returns:
the action command of the button
See Also:
setActionCommand(String)

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:
setMnemonic(int)

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:
setArmed(boolean)

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:
setEnabled(boolean)

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:
setPressed(boolean)

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:
setRollover(boolean)

isSelected

public boolean isSelected()

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:
setSelected(boolean)

removeActionListener

public void removeActionListener(ActionListener l)

Removes an ActionListener from the list of registered listeners.
Parameters:
l - the action listener to remove
See Also:
addActionListener(ActionListener)

removeChangeListener

public void removeChangeListener(ChangeListener l)

Adds an ChangeListener to the list of registered listeners.
Parameters:
l - the change listener to add
See Also:
removeChangeListener(ChangeListener)

removeItemListener

public void removeItemListener(ItemListener l)

Adds an ItemListener to the list of registered listeners.
Specified by:
removeItemListener in interface ItemSelectable
Parameters:
l - the item listener to add
See Also:
removeItemListener(ItemListener)

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
See Also:
getActionCommand()

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
See Also:
isArmed()

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
See Also:
isEnabled()

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
See Also:
getMnemonic()

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
See Also:
isPressed()

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
See Also:
isRollover()

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
See Also:
isSelected()

ButtonModel.java -- Copyright (C) 2002, 2004 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About	GNU Classpath (0.95)
Prev Class \| Next Class	GNU Classpath (0.95)	Frames \| No Frames
Summary: Nested \| Field \| Method \| Constr	Detail: Nested \| Field \| Method \| Constr