public abstract class

AbstractButton

extends JComponent
implements ItemSelectable SwingConstants
java.lang.Object
   ↳ java.awt.Component
     ↳ java.awt.Container
       ↳ javax.swing.JComponent
         ↳ javax.swing.AbstractButton
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Defines common behaviors for buttons and menu items.

Buttons can be configured, and to some degree controlled, by Actions. Using an Action with a button has many benefits beyond directly configuring a button. Refer to Swing Components Supporting Action for more details, and you can find more information in How to Use Actions, a section in The Java Tutorial.

For further information see How to Use Buttons, Check Boxes, and Radio Buttons, a section in The Java Tutorial.

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 see XMLEncoder.

Summary

Nested Classes
class AbstractButton.AccessibleAbstractButton This class implements accessibility support for the AbstractButton class. 
class AbstractButton.ButtonChangeListener Extends ChangeListener to be serializable. 
Constants
String BORDER_PAINTED_CHANGED_PROPERTY Identifies a change to having the border drawn, or having it not drawn.
String CONTENT_AREA_FILLED_CHANGED_PROPERTY Identifies a change to having the button paint the content area.
String DISABLED_ICON_CHANGED_PROPERTY Identifies a change to the icon used when the button has been disabled.
String DISABLED_SELECTED_ICON_CHANGED_PROPERTY Identifies a change to the icon used when the button has been disabled and selected.
String FOCUS_PAINTED_CHANGED_PROPERTY Identifies a change to having the border highlighted when focused, or not.
String HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY Identifies a change in the button's horizontal alignment.
String HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY Identifies a change in the button's horizontal text position.
String ICON_CHANGED_PROPERTY Identifies a change to the icon that represents the button.
String MARGIN_CHANGED_PROPERTY Identifies a change in the button's margins.
String MNEMONIC_CHANGED_PROPERTY Identifies a change to the button's mnemonic.
String MODEL_CHANGED_PROPERTY Identifies a change in the button model.
String PRESSED_ICON_CHANGED_PROPERTY Identifies a change to the icon used when the button has been pressed.
String ROLLOVER_ENABLED_CHANGED_PROPERTY Identifies a change from rollover enabled to disabled or back to enabled.
String ROLLOVER_ICON_CHANGED_PROPERTY Identifies a change to the icon used when the cursor is over the button.
String ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY Identifies a change to the icon used when the cursor is over the button and it has been selected.
String SELECTED_ICON_CHANGED_PROPERTY Identifies a change to the icon used when the button has been selected.
String TEXT_CHANGED_PROPERTY Identifies a change in the button's text.
String VERTICAL_ALIGNMENT_CHANGED_PROPERTY Identifies a change in the button's vertical alignment.
String VERTICAL_TEXT_POSITION_CHANGED_PROPERTY Identifies a change in the button's vertical text position.
[Expand]
Inherited Constants
From class javax.swing.JComponent
From class java.awt.Component
From interface java.awt.image.ImageObserver
From interface javax.swing.SwingConstants
Fields
protected ActionListener actionListener The button model's ActionListener.
protected ChangeEvent changeEvent Only one ChangeEvent is needed per button instance since the event's only state is the source property.
protected ChangeListener changeListener The button model's changeListener.
protected ItemListener itemListener The button model's ItemListener.
protected ButtonModel model The data model that determines the button's state.
[Expand]
Inherited Fields
From class javax.swing.JComponent
Public Constructors
AbstractButton()
Public Methods
void addActionListener(ActionListener l)
Adds an ActionListener to the button.
void addChangeListener(ChangeListener l)
Adds a ChangeListener to the button.
void addItemListener(ItemListener l)
Adds an ItemListener to the checkbox.
void doClick()
Programmatically perform a "click".
void doClick(int pressTime)
Programmatically perform a "click".
Action getAction()
Returns the currently set Action for this ActionEvent source, or null if no Action is set.
String getActionCommand()
Returns the action command for this button.
ActionListener[] getActionListeners()
Returns an array of all the ActionListeners added to this AbstractButton with addActionListener().
ChangeListener[] getChangeListeners()
Returns an array of all the ChangeListeners added to this AbstractButton with addChangeListener().
Icon getDisabledIcon()
Returns the icon used by the button when it's disabled.
Icon getDisabledSelectedIcon()
Returns the icon used by the button when it's disabled and selected.
int getDisplayedMnemonicIndex()
Returns the character, as an index, that the look and feel should provide decoration for as representing the mnemonic character.
boolean getHideActionText()
Returns the value of the hideActionText property, which determines whether the button displays text from the Action.
int getHorizontalAlignment()
Returns the horizontal alignment of the icon and text.
int getHorizontalTextPosition()
Returns the horizontal position of the text relative to the icon.
Icon getIcon()
Returns the default icon.
int getIconTextGap()
Returns the amount of space between the text and the icon displayed in this button.
ItemListener[] getItemListeners()
Returns an array of all the ItemListeners added to this AbstractButton with addItemListener().
String getLabel()
This method is deprecated. - Replaced by getText
Insets getMargin()
Returns the margin between the button's border and the label.
int getMnemonic()
Returns the keyboard mnemonic from the the current model.
ButtonModel getModel()
Returns the model that this button represents.
long getMultiClickThreshhold()
Gets the amount of time (in milliseconds) required between mouse press events for the button to generate the corresponding action events.
Icon getPressedIcon()
Returns the pressed icon for the button.
Icon getRolloverIcon()
Returns the rollover icon for the button.
Icon getRolloverSelectedIcon()
Returns the rollover selection icon for the button.
Icon getSelectedIcon()
Returns the selected icon for the button.
Object[] getSelectedObjects()
Returns an array (length 1) containing the label or null if the button is not selected.
String getText()
Returns the button's text.
ButtonUI getUI()
Returns the L&F object that renders this component.
int getVerticalAlignment()
Returns the vertical alignment of the text and icon.
int getVerticalTextPosition()
Returns the vertical position of the text relative to the icon.
boolean imageUpdate(Image img, int infoflags, int x, int y, int w, int h)
This is overridden to return false if the current Icon's Image is not equal to the passed in Image img.
boolean isBorderPainted()
Gets the borderPainted property.
boolean isContentAreaFilled()
Gets the contentAreaFilled property.
boolean isFocusPainted()
Gets the paintFocus property.
boolean isRolloverEnabled()
Gets the rolloverEnabled property.
boolean isSelected()
Returns the state of the button.
void removeActionListener(ActionListener l)
Removes an ActionListener from the button.
void removeChangeListener(ChangeListener l)
Removes a ChangeListener from the button.
void removeItemListener(ItemListener l)
Removes an ItemListener from the button.
void removeNotify()
Notifies this component that it no longer has a parent component.
void setAction(Action a)
Sets the Action.
void setActionCommand(String actionCommand)
Sets the action command for this button.
void setBorderPainted(boolean b)
Sets the borderPainted property.
void setContentAreaFilled(boolean b)
Sets the contentAreaFilled property.
void setDisabledIcon(Icon disabledIcon)
Sets the disabled icon for the button.
void setDisabledSelectedIcon(Icon disabledSelectedIcon)
Sets the disabled selection icon for the button.
void setDisplayedMnemonicIndex(int index)
Provides a hint to the look and feel as to which character in the text should be decorated to represent the mnemonic.
void setEnabled(boolean b)
Enables (or disables) the button.
void setFocusPainted(boolean b)
Sets the paintFocus property, which must be true for the focus state to be painted.
void setHideActionText(boolean hideActionText)
Sets the hideActionText property, which determines whether the button displays text from the Action.
void setHorizontalAlignment(int alignment)
Sets the horizontal alignment of the icon and text.
void setHorizontalTextPosition(int textPosition)
Sets the horizontal position of the text relative to the icon.
void setIcon(Icon defaultIcon)
Sets the button's default icon.
void setIconTextGap(int iconTextGap)
If both the icon and text properties are set, this property defines the space between them.
void setLabel(String label)
This method is deprecated. - Replaced by setText(text)
void setLayout(LayoutManager mgr)
Sets the layout manager for this container, refer to setLayout(LayoutManager) for a complete description of this method.
void setMargin(Insets m)
Sets space for margin between the button's border and the label.
void setMnemonic(char mnemonic)
This method is now obsolete, please use setMnemonic(int) to set the mnemonic for a button.
void setMnemonic(int mnemonic)
Sets the keyboard mnemonic on the current model.
void setModel(ButtonModel newModel)
Sets the model that this button represents.
void setMultiClickThreshhold(long threshhold)
Sets the amount of time (in milliseconds) required between mouse press events for the button to generate the corresponding action events.
void setPressedIcon(Icon pressedIcon)
Sets the pressed icon for the button.
void setRolloverEnabled(boolean b)
Sets the rolloverEnabled property, which must be true for rollover effects to occur.
void setRolloverIcon(Icon rolloverIcon)
Sets the rollover icon for the button.
void setRolloverSelectedIcon(Icon rolloverSelectedIcon)
Sets the rollover selected icon for the button.
void setSelected(boolean b)
Sets the state of the button.
void setSelectedIcon(Icon selectedIcon)
Sets the selected icon for the button.
void setText(String text)
Sets the button's text.
void setUI(ButtonUI ui)
Sets the L&F object that renders this component.
void setVerticalAlignment(int alignment)
Sets the vertical alignment of the icon and text.
void setVerticalTextPosition(int textPosition)
Sets the vertical position of the text relative to the icon.
void updateUI()
Resets the UI property to a value from the current look and feel.
Protected Methods
void actionPropertyChanged(Action action, String propertyName)
Updates the button's state in response to property changes in the associated action.
void addImpl(Component comp, Object constraints, int index)
Adds the specified component to this container at the specified index, refer to addImpl(Component, Object, int) for a complete description of this method.
int checkHorizontalKey(int key, String exception)
Verify that the key argument is a legal value for the horizontalAlignment and horizontalTextPosition properties.
int checkVerticalKey(int key, String exception)
Verify that the key argument is a legal value for the vertical properties.
void configurePropertiesFromAction(Action a)
Sets the properties on this button to match those in the specified Action.
ActionListener createActionListener()
PropertyChangeListener createActionPropertyChangeListener(Action a)
Creates and returns a PropertyChangeListener that is responsible for listening for changes from the specified Action and updating the appropriate properties.
ChangeListener createChangeListener()
Subclasses that want to handle ChangeEvents differently can override this to return another ChangeListener implementation.
ItemListener createItemListener()
void fireActionPerformed(ActionEvent event)
Notifies all listeners that have registered interest for notification on this event type.
void fireItemStateChanged(ItemEvent event)
Notifies all listeners that have registered interest for notification on this event type.
void fireStateChanged()
Notifies all listeners that have registered interest for notification on this event type.
void init(String text, Icon icon)
void paintBorder(Graphics g)
Paint the button's border if BorderPainted property is true and the button has a border.
String paramString()
Returns a string representation of this AbstractButton.
[Expand]
Inherited Methods
From class javax.swing.JComponent
From class java.awt.Container
From class java.awt.Component
From class java.lang.Object
From interface java.awt.ItemSelectable
From interface java.awt.MenuContainer
From interface java.awt.image.ImageObserver

Constants

public static final String BORDER_PAINTED_CHANGED_PROPERTY

Identifies a change to having the border drawn, or having it not drawn.

Constant Value: "borderPainted"

public static final String CONTENT_AREA_FILLED_CHANGED_PROPERTY

Identifies a change to having the button paint the content area.

Constant Value: "contentAreaFilled"

public static final String DISABLED_ICON_CHANGED_PROPERTY

Identifies a change to the icon used when the button has been disabled.

Constant Value: "disabledIcon"

public static final String DISABLED_SELECTED_ICON_CHANGED_PROPERTY

Identifies a change to the icon used when the button has been disabled and selected.

Constant Value: "disabledSelectedIcon"

public static final String FOCUS_PAINTED_CHANGED_PROPERTY

Identifies a change to having the border highlighted when focused, or not.

Constant Value: "focusPainted"

public static final String HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY

Identifies a change in the button's horizontal alignment.

Constant Value: "horizontalAlignment"

public static final String HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY

Identifies a change in the button's horizontal text position.

Constant Value: "horizontalTextPosition"

public static final String ICON_CHANGED_PROPERTY

Identifies a change to the icon that represents the button.

Constant Value: "icon"

public static final String MARGIN_CHANGED_PROPERTY

Identifies a change in the button's margins.

Constant Value: "margin"

public static final String MNEMONIC_CHANGED_PROPERTY

Identifies a change to the button's mnemonic.

Constant Value: "mnemonic"

public static final String MODEL_CHANGED_PROPERTY

Identifies a change in the button model.

Constant Value: "model"

public static final String PRESSED_ICON_CHANGED_PROPERTY

Identifies a change to the icon used when the button has been pressed.

Constant Value: "pressedIcon"

public static final String ROLLOVER_ENABLED_CHANGED_PROPERTY

Identifies a change from rollover enabled to disabled or back to enabled.

Constant Value: "rolloverEnabled"

public static final String ROLLOVER_ICON_CHANGED_PROPERTY

Identifies a change to the icon used when the cursor is over the button.

Constant Value: "rolloverIcon"

public static final String ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY

Identifies a change to the icon used when the cursor is over the button and it has been selected.

Constant Value: "rolloverSelectedIcon"

public static final String SELECTED_ICON_CHANGED_PROPERTY

Identifies a change to the icon used when the button has been selected.

Constant Value: "selectedIcon"

public static final String TEXT_CHANGED_PROPERTY

Identifies a change in the button's text.

Constant Value: "text"

public static final String VERTICAL_ALIGNMENT_CHANGED_PROPERTY

Identifies a change in the button's vertical alignment.

Constant Value: "verticalAlignment"

public static final String VERTICAL_TEXT_POSITION_CHANGED_PROPERTY

Identifies a change in the button's vertical text position.

Constant Value: "verticalTextPosition"

Fields

protected ActionListener actionListener

The button model's ActionListener.

protected ChangeEvent changeEvent

Only one ChangeEvent is needed per button instance since the event's only state is the source property. The source of events generated is always "this".

protected ChangeListener changeListener

The button model's changeListener.

protected ItemListener itemListener

The button model's ItemListener.

protected ButtonModel model

The data model that determines the button's state.

Public Constructors

public AbstractButton ()

Public Methods

public void addActionListener (ActionListener l)

Adds an ActionListener to the button.

Parameters
l the ActionListener to be added

public void addChangeListener (ChangeListener l)

Adds a ChangeListener to the button.

Parameters
l the listener to be added

public void addItemListener (ItemListener l)

Adds an ItemListener to the checkbox.

Parameters
l the ItemListener to be added

public void doClick ()

Programmatically perform a "click". This does the same thing as if the user had pressed and released the button.

public void doClick (int pressTime)

Programmatically perform a "click". This does the same thing as if the user had pressed and released the button. The button stays visually "pressed" for pressTime milliseconds.

Parameters
pressTime the time to "hold down" the button, in milliseconds

public Action getAction ()

Returns the currently set Action for this ActionEvent source, or null if no Action is set.

Returns
  • the Action for this ActionEvent source, or null

public String getActionCommand ()

Returns the action command for this button.

Returns
  • the action command for this button

public ActionListener[] getActionListeners ()

Returns an array of all the ActionListeners added to this AbstractButton with addActionListener().

Returns
  • all of the ActionListeners added or an empty array if no listeners have been added

public ChangeListener[] getChangeListeners ()

Returns an array of all the ChangeListeners added to this AbstractButton with addChangeListener().

Returns
  • all of the ChangeListeners added or an empty array if no listeners have been added

public Icon getDisabledIcon ()

Returns the icon used by the button when it's disabled. If no disabled icon has been set this will forward the call to the look and feel to construct an appropriate disabled Icon.

Some look and feels might not render the disabled Icon, in which case they will ignore this.

Returns
  • the disabledIcon property

public Icon getDisabledSelectedIcon ()

Returns the icon used by the button when it's disabled and selected. If no disabled selection icon has been set, this will forward the call to the LookAndFeel to construct an appropriate disabled Icon from the selection icon if it has been set and to getDisabledIcon() otherwise.

Some look and feels might not render the disabled selected Icon, in which case they will ignore this.

Returns
  • the disabledSelectedIcon property

public int getDisplayedMnemonicIndex ()

Returns the character, as an index, that the look and feel should provide decoration for as representing the mnemonic character.

Returns
  • index representing mnemonic character

public boolean getHideActionText ()

Returns the value of the hideActionText property, which determines whether the button displays text from the Action. This is useful only if an Action has been installed on the button.

Returns
  • true if the button's text property should not reflect that of the Action; the default is false

public int getHorizontalAlignment ()

Returns the horizontal alignment of the icon and text. AbstractButton's default is SwingConstants.CENTER, but subclasses such as JCheckBox may use a different default.

Returns
  • the horizontalAlignment property, one of the following values:
    • SwingConstants.RIGHT
    • SwingConstants.LEFT
    • SwingConstants.CENTER
    • SwingConstants.LEADING
    • SwingConstants.TRAILING

public int getHorizontalTextPosition ()

Returns the horizontal position of the text relative to the icon.

Returns
  • the horizontalTextPosition property, one of the following values:
    • SwingConstants.RIGHT
    • SwingConstants.LEFT
    • SwingConstants.CENTER
    • SwingConstants.LEADING
    • SwingConstants.TRAILING (the default)

public Icon getIcon ()

Returns the default icon.

Returns
  • the default Icon
See Also

public int getIconTextGap ()

Returns the amount of space between the text and the icon displayed in this button.

Returns
  • an int equal to the number of pixels between the text and the icon.

public ItemListener[] getItemListeners ()

Returns an array of all the ItemListeners added to this AbstractButton with addItemListener().

Returns
  • all of the ItemListeners added or an empty array if no listeners have been added

public String getLabel ()

This method is deprecated.
- Replaced by getText

Returns the label text.

Returns
  • a String containing the label

public Insets getMargin ()

Returns the margin between the button's border and the label.

Returns
  • an Insets object specifying the margin between the botton's border and the label

public int getMnemonic ()

Returns the keyboard mnemonic from the the current model.

Returns
  • the keyboard mnemonic from the model

public ButtonModel getModel ()

Returns the model that this button represents.

Returns
  • the model property

public long getMultiClickThreshhold ()

Gets the amount of time (in milliseconds) required between mouse press events for the button to generate the corresponding action events.

Returns
  • the amount of time required between mouse press events to generate corresponding action events

public Icon getPressedIcon ()

Returns the pressed icon for the button.

Returns
  • the pressedIcon property

public Icon getRolloverIcon ()

Returns the rollover icon for the button.

Returns
  • the rolloverIcon property

public Icon getRolloverSelectedIcon ()

Returns the rollover selection icon for the button.

Returns
  • the rolloverSelectedIcon property

public Icon getSelectedIcon ()

Returns the selected icon for the button.

Returns
  • the selectedIcon property

public Object[] getSelectedObjects ()

Returns an array (length 1) containing the label or null if the button is not selected.

Returns
  • an array containing 1 Object: the text of the button, if the item is selected; otherwise null

public String getText ()

Returns the button's text.

Returns
  • the buttons text
See Also

public ButtonUI getUI ()

Returns the L&F object that renders this component.

Returns
  • the ButtonUI object
See Also

public int getVerticalAlignment ()

Returns the vertical alignment of the text and icon.

Returns
  • the verticalAlignment property, one of the following values:
    • SwingConstants.CENTER (the default)
    • SwingConstants.TOP
    • SwingConstants.BOTTOM

public int getVerticalTextPosition ()

Returns the vertical position of the text relative to the icon.

Returns
  • the verticalTextPosition property, one of the following values:
    • SwingConstants.CENTER (the default)
    • SwingConstants.TOP
    • SwingConstants.BOTTOM

public boolean imageUpdate (Image img, int infoflags, int x, int y, int w, int h)

This is overridden to return false if the current Icon's Image is not equal to the passed in Image img.

Parameters
img the Image to be compared
infoflags flags used to repaint the button when the image is updated and which determine how much is to be painted
x the x coordinate
y the y coordinate
w the width
h the height
Returns
  • false if the infoflags indicate that the image is completely loaded; true otherwise.

public boolean isBorderPainted ()

Gets the borderPainted property.

Returns
  • the value of the borderPainted property

public boolean isContentAreaFilled ()

Gets the contentAreaFilled property.

Returns
  • the contentAreaFilled property

public boolean isFocusPainted ()

Gets the paintFocus property.

Returns
  • the paintFocus property

public boolean isRolloverEnabled ()

Gets the rolloverEnabled property.

Returns
  • the value of the rolloverEnabled property

public boolean isSelected ()

Returns the state of the button. True if the toggle button is selected, false if it's not.

Returns
  • true if the toggle button is selected, otherwise false

public void removeActionListener (ActionListener l)

Removes an ActionListener from the button. If the listener is the currently set Action for the button, then the Action is set to null.

Parameters
l the listener to be removed

public void removeChangeListener (ChangeListener l)

Removes a ChangeListener from the button.

Parameters
l the listener to be removed

public void removeItemListener (ItemListener l)

Removes an ItemListener from the button.

Parameters
l the ItemListener to be removed

public void removeNotify ()

Notifies this component that it no longer has a parent component. When this method is invoked, any KeyboardActions set up in the the chain of parent components are removed.

public void setAction (Action a)

Sets the Action. The new Action replaces any previously set Action but does not affect ActionListeners independently added with addActionListener. If the Action is already a registered ActionListener for the button, it is not re-registered.

Setting the Action results in immediately changing all the properties described in Swing Components Supporting Action. Subsequently, the button's properties are automatically updated as the Action's properties change.

This method uses three other methods to set and help track the Action's property values. It uses the configurePropertiesFromAction method to immediately change the button's properties. To track changes in the Action's property values, this method registers the PropertyChangeListener returned by createActionPropertyChangeListener. The default PropertyChangeListener invokes the actionPropertyChanged method when a property in the Action changes.

Parameters
a the Action for the AbstractButton, or null

public void setActionCommand (String actionCommand)

Sets the action command for this button.

Parameters
actionCommand the action command for this button

public void setBorderPainted (boolean b)

Sets the borderPainted property. If true and the button has a border, the border is painted. The default value for the borderPainted property is true.

Parameters
b if true and border property is not null, the border is painted

public void setContentAreaFilled (boolean b)

Sets the contentAreaFilled property. If true the button will paint the content area. If you wish to have a transparent button, such as an icon only button, for example, then you should set this to false. Do not call setOpaque(false). The default value for the the contentAreaFilled property is true.

This function may cause the component's opaque property to change.

The exact behavior of calling this function varies on a component-by-component and L&F-by-L&F basis.

Parameters
b if true, the content should be filled; if false the content area is not filled

public void setDisabledIcon (Icon disabledIcon)

Sets the disabled icon for the button.

Parameters
disabledIcon the icon used as the disabled image

public void setDisabledSelectedIcon (Icon disabledSelectedIcon)

Sets the disabled selection icon for the button.

Parameters
disabledSelectedIcon the icon used as the disabled selection image

public void setDisplayedMnemonicIndex (int index)

Provides a hint to the look and feel as to which character in the text should be decorated to represent the mnemonic. Not all look and feels may support this. A value of -1 indicates either there is no mnemonic, the mnemonic character is not contained in the string, or the developer does not wish the mnemonic to be displayed.

The value of this is updated as the properties relating to the mnemonic change (such as the mnemonic itself, the text...). You should only ever have to call this if you do not wish the default character to be underlined. For example, if the text was 'Save As', with a mnemonic of 'a', and you wanted the 'A' to be decorated, as 'Save As', you would have to invoke setDisplayedMnemonicIndex(5) after invoking setMnemonic(KeyEvent.VK_A).

Parameters
index Index into the String to underline
Throws
IllegalArgumentException will be thrown if index is >= length of the text, or < -1

public void setEnabled (boolean b)

Enables (or disables) the button.

Parameters
b true to enable the button, otherwise false

public void setFocusPainted (boolean b)

Sets the paintFocus property, which must be true for the focus state to be painted. The default value for the paintFocus property is true. Some look and feels might not paint focus state; they will ignore this property.

Parameters
b if true, the focus state should be painted
See Also

public void setHideActionText (boolean hideActionText)

Sets the hideActionText property, which determines whether the button displays text from the Action. This is useful only if an Action has been installed on the button.

Parameters
hideActionText true if the button's text property should not reflect that of the Action; the default is false

public void setHorizontalAlignment (int alignment)

Sets the horizontal alignment of the icon and text. AbstractButton's default is SwingConstants.CENTER, but subclasses such as JCheckBox may use a different default.

Parameters
alignment the alignment value, one of the following values:
  • SwingConstants.RIGHT
  • SwingConstants.LEFT
  • SwingConstants.CENTER
  • SwingConstants.LEADING
  • SwingConstants.TRAILING
Throws
IllegalArgumentException if the alignment is not one of the valid values

public void setHorizontalTextPosition (int textPosition)

Sets the horizontal position of the text relative to the icon.

Parameters
textPosition one of the following values:
  • SwingConstants.RIGHT
  • SwingConstants.LEFT
  • SwingConstants.CENTER
  • SwingConstants.LEADING
  • SwingConstants.TRAILING (the default)
Throws
IllegalArgumentException if textPosition is not one of the legal values listed above

public void setIcon (Icon defaultIcon)

Sets the button's default icon. This icon is also used as the "pressed" and "disabled" icon if there is no explicitly set pressed icon.

Parameters
defaultIcon the icon used as the default image

public void setIconTextGap (int iconTextGap)

If both the icon and text properties are set, this property defines the space between them.

The default value of this property is 4 pixels.

This is a JavaBeans bound property.

See Also

public void setLabel (String label)

This method is deprecated.
- Replaced by setText(text)

Sets the label text.

Parameters
label a String containing the text

public void setLayout (LayoutManager mgr)

Sets the layout manager for this container, refer to setLayout(LayoutManager) for a complete description of this method.

Parameters
mgr the specified layout manager

public void setMargin (Insets m)

Sets space for margin between the button's border and the label. Setting to null will cause the button to use the default margin. The button's default Border object will use this value to create the proper margin. However, if a non-default border is set on the button, it is that Border object's responsibility to create the appropriate margin space (else this property will effectively be ignored).

Parameters
m the space between the border and the label

public void setMnemonic (char mnemonic)

This method is now obsolete, please use setMnemonic(int) to set the mnemonic for a button. This method is only designed to handle character values which fall between 'a' and 'z' or 'A' and 'Z'.

Parameters
mnemonic a char specifying the mnemonic value
See Also

public void setMnemonic (int mnemonic)

Sets the keyboard mnemonic on the current model. The mnemonic is the key which when combined with the look and feel's mouseless modifier (usually Alt) will activate this button if focus is contained somewhere within this button's ancestor window.

A mnemonic must correspond to a single key on the keyboard and should be specified using one of the VK_XXX keycodes defined in java.awt.event.KeyEvent. Mnemonics are case-insensitive, therefore a key event with the corresponding keycode would cause the button to be activated whether or not the Shift modifier was pressed.

If the character defined by the mnemonic is found within the button's label string, the first occurrence of it will be underlined to indicate the mnemonic to the user.

Parameters
mnemonic the key code which represents the mnemonic

public void setModel (ButtonModel newModel)

Sets the model that this button represents.

Parameters
newModel the new ButtonModel
See Also

public void setMultiClickThreshhold (long threshhold)

Sets the amount of time (in milliseconds) required between mouse press events for the button to generate the corresponding action events. After the initial mouse press occurs (and action event generated) any subsequent mouse press events which occur on intervals less than the threshhold will be ignored and no corresponding action event generated. By default the threshhold is 0, which means that for each mouse press, an action event will be fired, no matter how quickly the mouse clicks occur. In buttons where this behavior is not desirable (for example, the "OK" button in a dialog), this threshhold should be set to an appropriate positive value.

Parameters
threshhold the amount of time required between mouse press events to generate corresponding action events
Throws
IllegalArgumentException if threshhold < 0

public void setPressedIcon (Icon pressedIcon)

Sets the pressed icon for the button.

Parameters
pressedIcon the icon used as the "pressed" image
See Also

public void setRolloverEnabled (boolean b)

Sets the rolloverEnabled property, which must be true for rollover effects to occur. The default value for the rolloverEnabled property is false. Some look and feels might not implement rollover effects; they will ignore this property.

Parameters
b if true, rollover effects should be painted

public void setRolloverIcon (Icon rolloverIcon)

Sets the rollover icon for the button.

Parameters
rolloverIcon the icon used as the "rollover" image

public void setRolloverSelectedIcon (Icon rolloverSelectedIcon)

Sets the rollover selected icon for the button.

Parameters
rolloverSelectedIcon the icon used as the "selected rollover" image

public void setSelected (boolean b)

Sets the state of the button. Note that this method does not trigger an actionEvent. Call doClick to perform a programatic action change.

Parameters
b true if the button is selected, otherwise false

public void setSelectedIcon (Icon selectedIcon)

Sets the selected icon for the button.

Parameters
selectedIcon the icon used as the "selected" image

public void setText (String text)

Sets the button's text.

Parameters
text the string used to set the text
See Also

public void setUI (ButtonUI ui)

Sets the L&F object that renders this component.

Parameters
ui the ButtonUI L&F object
See Also

public void setVerticalAlignment (int alignment)

Sets the vertical alignment of the icon and text.

Parameters
alignment one of the following values:
  • SwingConstants.CENTER (the default)
  • SwingConstants.TOP
  • SwingConstants.BOTTOM
Throws
IllegalArgumentException if the alignment is not one of the legal values listed above

public void setVerticalTextPosition (int textPosition)

Sets the vertical position of the text relative to the icon.

Parameters
textPosition one of the following values:
  • SwingConstants.CENTER (the default)
  • SwingConstants.TOP
  • SwingConstants.BOTTOM

public void updateUI ()

Resets the UI property to a value from the current look and feel. Subtypes of AbstractButton should override this to update the UI. For example, JButton might do the following:

      setUI((ButtonUI)UIManager.getUI(
          "ButtonUI", "javax.swing.plaf.basic.BasicButtonUI", this));
 

Protected Methods

protected void actionPropertyChanged (Action action, String propertyName)

Updates the button's state in response to property changes in the associated action. This method is invoked from the PropertyChangeListener returned from createActionPropertyChangeListener. Subclasses do not normally need to invoke this. Subclasses that support additional Action properties should override this and configurePropertiesFromAction.

Refer to the table at Swing Components Supporting Action for a list of the properties this method sets.

Parameters
action the Action associated with this button
propertyName the name of the property that changed

protected void addImpl (Component comp, Object constraints, int index)

Adds the specified component to this container at the specified index, refer to addImpl(Component, Object, int) for a complete description of this method.

Parameters
comp the component to be added
constraints an object expressing layout constraints for this component
index the position in the container's list at which to insert the component, where -1 means append to the end
Throws
IllegalArgumentException if index is invalid
IllegalArgumentException if adding the container's parent to itself
IllegalArgumentException if adding a window to a container

protected int checkHorizontalKey (int key, String exception)

Verify that the key argument is a legal value for the horizontalAlignment and horizontalTextPosition properties. Valid values are:

  • SwingConstants.RIGHT
  • SwingConstants.LEFT
  • SwingConstants.CENTER
  • SwingConstants.LEADING
  • SwingConstants.TRAILING

Parameters
key the property value to check
exception the message to use in the IllegalArgumentException that is thrown for an invalid value
Throws
IllegalArgumentException if key is not one of the legal values listed above

protected int checkVerticalKey (int key, String exception)

Verify that the key argument is a legal value for the vertical properties. Valid values are:

  • SwingConstants.CENTER
  • SwingConstants.TOP
  • SwingConstants.BOTTOM

Parameters
key the property value to check
exception the message to use in the IllegalArgumentException that is thrown for an invalid value
Throws
IllegalArgumentException if key is not one of the legal values listed above

protected void configurePropertiesFromAction (Action a)

Sets the properties on this button to match those in the specified Action. Refer to Swing Components Supporting Action for more details as to which properties this sets.

Parameters
a the Action from which to get the properties, or null

protected ActionListener createActionListener ()

protected PropertyChangeListener createActionPropertyChangeListener (Action a)

Creates and returns a PropertyChangeListener that is responsible for listening for changes from the specified Action and updating the appropriate properties.

Warning: If you subclass this do not create an anonymous inner class. If you do the lifetime of the button will be tied to that of the Action.

Parameters
a the button's action

protected ChangeListener createChangeListener ()

Subclasses that want to handle ChangeEvents differently can override this to return another ChangeListener implementation.

Returns
  • the new ChangeListener

protected ItemListener createItemListener ()

protected void fireActionPerformed (ActionEvent event)

Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created using the event parameter.

Parameters
event the ActionEvent object

protected void fireItemStateChanged (ItemEvent event)

Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created using the event parameter.

Parameters
event the ItemEvent object

protected void fireStateChanged ()

Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created.

protected void init (String text, Icon icon)

protected void paintBorder (Graphics g)

Paint the button's border if BorderPainted property is true and the button has a border.

Parameters
g the Graphics context in which to paint

protected String paramString ()

Returns a string representation of this AbstractButton. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null.

Overriding paramString to provide information about the specific new aspects of the JFC components.

Returns
  • a string representation of this AbstractButton