javax.swing.AbstractButton

public abstract class javax.swing

AbstractButton

Java SE 6

Extends: Component > Container > JComponent

Implements: ItemSelectable, SwingConstants

Inner classes: AbstractButton.ButtonChangeListener, AbstractButton.AccessibleAbstractButton

Extended by: JButton, JMenuItem, JToggleButton

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 JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder.

version 1.190 05/09/06

Fields

final public static String

MODEL_CHANGED_PROPERTY
Identifies a change in the button model.

final public static String

TEXT_CHANGED_PROPERTY
Identifies a change in the button's text.

final public static String

MNEMONIC_CHANGED_PROPERTY
Identifies a change to the button's mnemonic.

final public static String

MARGIN_CHANGED_PROPERTY
Identifies a change in the button's margins.

final public static String

VERTICAL_ALIGNMENT_CHANGED_PROPERTY
Identifies a change in the button's vertical alignment.

final public static String

HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY
Identifies a change in the button's horizontal alignment.

final public static String

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

final public static String

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

final public static String

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

final public static String

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

final public static String

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

final public static String

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

final public static String

ICON_CHANGED_PROPERTY
Identifies a change to the icon that represents the button.

final public static String

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

final public static String

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

final public static String

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

final public static 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.

final public static String

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

final public static String

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

protected ButtonModel

model
The data model that determines the button's state.

protected ChangeListener

changeListener
The button model's changeListener.

protected ActionListener

actionListener
The button model's ActionListener.

protected ItemListener

itemListener
The button model's ItemListener.

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".

Constructors

public

AbstractButton()

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.

action the Action associated with this button

propertyName the name of the property that changed

since 1.6

See also javax.swing.Action, configurePropertiesFromAction

public void

addActionListener(ActionListener l)
Adds an ActionListener to the button.

l	the `ActionListener` to be added

public void

addChangeListener(ChangeListener l)
Adds a ChangeListener to the button.

l	the listener to be added

protected void

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

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
Throws	IllegalArgumentException: if adding the container's parent to itself
Throws	IllegalArgumentException: if adding a window to a container
since	1.5

public void

addItemListener(ItemListener l)
Adds an ItemListener to the checkbox.

l	the `ItemListener` to be added

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

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
See also	setHorizontalTextPosition, setHorizontalAlignment

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

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.

a	the `Action` from which to get the properties, or `null`
since	1.3
See also	javax.swing.Action, setAction

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.

a the button's action

since 1.3

See also (UNLABELED), javax.swing.Action, setAction

protected ChangeListener

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

return the new ChangeListener

protected ItemListener

createItemListener()

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.

pressTime

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

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.

event	the `ActionEvent` object
See also	javax.swing.event.EventListenerList

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.

event	the `ItemEvent` object
See also	javax.swing.event.EventListenerList

protected void

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

See also

javax.swing.event.EventListenerList

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.

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
See also	java.awt.image.ImageObserver, imageUpdate(java.awt.Image, int, int, int, int, int)

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.

g	the `Graphics` context in which to paint
See also	paint, setBorder

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.

return a string representation of this AbstractButton

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.

l	the listener to be removed

public void

removeChangeListener(ChangeListener l)
Removes a ChangeListener from the button.

l	the listener to be removed

public void

removeItemListener(ItemListener l)
Removes an ItemListener from the button.

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.

since

1.6

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));

Properties

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.

a the Action for the AbstractButton, or null

since 1.3

beaninfo bound: true attribute: visualUpdate true description: the Action instance connected with this ActionEvent source

See also javax.swing.Action, getAction, configurePropertiesFromAction, createActionPropertyChangeListener, actionPropertyChanged

public Action

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

return	the `Action` for this `ActionEvent` source, or `null`
since	1.3
See also	javax.swing.Action, setAction

public void

setActionCommand(String actionCommand)
Sets the action command for this button.

actionCommand

the action command for this button

public String

getActionCommand()
Returns the action command for this button.

return

the action command for this button

public ActionListener[]

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

return	all of the `ActionListener`s added or an empty array if no listeners have been added
since	1.4

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.

b	if true and border property is not `null`, the border is painted
beaninfo	bound: true attribute: visualUpdate true description: Whether the border should be painted.
See also	isBorderPainted

public boolean

isBorderPainted()
Gets the borderPainted property.

return	the value of the `borderPainted` property
See also	setBorderPainted

public ChangeListener[]

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

return	all of the `ChangeListener`s added or an empty array if no listeners have been added
since	1.4

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.

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

beaninfo bound: true attribute: visualUpdate true description: Whether the button should paint the content area or leave it transparent.

See also isContentAreaFilled, setOpaque

public boolean

isContentAreaFilled()
Gets the contentAreaFilled property.

return	the `contentAreaFilled` property
See also	setContentAreaFilled

public void

setDisabledIcon(Icon disabledIcon)
Sets the disabled icon for the button.

disabledIcon	the icon used as the disabled image
beaninfo	bound: true attribute: visualUpdate true description: The disabled icon for the button.
See also	getDisabledIcon

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.

return the disabledIcon property

See also getPressedIcon, setDisabledIcon, getDisabledIcon

public void

setDisabledSelectedIcon(Icon disabledSelectedIcon)
Sets the disabled selection icon for the button.

disabledSelectedIcon	the icon used as the disabled selection image
beaninfo	bound: true attribute: visualUpdate true description: The disabled selection icon for the button.
See also	getDisabledSelectedIcon

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.

return the disabledSelectedIcon property

See also getDisabledIcon, setDisabledSelectedIcon, getDisabledSelectedIcon

public void

setDisplayedMnemonicIndex(int index) throws IllegalArgumentException
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).

since 1.4

index Index into the String to underline

Throws IllegalArgumentException: will be thrown if index is >= length of the text, or < -1

beaninfo bound: true attribute: visualUpdate true description: the index into the String to draw the keyboard character mnemonic at

See also getDisplayedMnemonicIndex

public int

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

since	1.4
return	index representing mnemonic character
See also	setDisplayedMnemonicIndex

public void

setEnabled(boolean b)
Enables (or disables) the button.

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.

b	if `true`, the focus state should be painted
beaninfo	bound: true attribute: visualUpdate true description: Whether focus should be painted
See also	isFocusPainted

public boolean

isFocusPainted()
Gets the paintFocus property.

return	the `paintFocus` property
See also	setFocusPainted

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.

hideActionText	`true` if the button's `text` property should not reflect that of the `Action`; the default is `false`
since	1.6
beaninfo	bound: true expert: true description: Whether the text of the button should come from the `Action`.
See also	(UNLABELED)

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.

return	`true` if the button's `text` property should not reflect that of the `Action`; the default is `false`
since	1.6

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.

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
beaninfo	bound: true enum: LEFT SwingConstants.LEFT CENTER SwingConstants.CENTER RIGHT SwingConstants.RIGHT LEADING SwingConstants.LEADING TRAILING SwingConstants.TRAILING attribute: visualUpdate true description: The horizontal alignment of the icon and text.

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.

return

the horizontalAlignment property, one of the following values:

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

public void

setHorizontalTextPosition(int textPosition)
Sets the horizontal position of the text relative to the icon.

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
beaninfo	bound: true enum: LEFT SwingConstants.LEFT CENTER SwingConstants.CENTER RIGHT SwingConstants.RIGHT LEADING SwingConstants.LEADING TRAILING SwingConstants.TRAILING attribute: visualUpdate true description: The horizontal position of the text relative to the icon.

public int

getHorizontalTextPosition()
Returns the horizontal position of the text relative to the icon.

return

the horizontalTextPosition property, one of the following values:

SwingConstants.RIGHT
SwingConstants.LEFT
SwingConstants.CENTER
SwingConstants.LEADING
SwingConstants.TRAILING (the default)

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.

defaultIcon	the icon used as the default image
beaninfo	bound: true attribute: visualUpdate true description: The button's default icon
See also	getIcon, setPressedIcon

public Icon

getIcon()
Returns the default icon.

return	the default `Icon`
See also	setIcon

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.

since 1.4

beaninfo bound: true attribute: visualUpdate true description: If both the icon and text properties are set, this property defines the space between them.

See also getIconTextGap

public int

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

return	an int equal to the number of pixels between the text and the icon.
since	1.4
See also	setIconTextGap

public ItemListener[]

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

return	all of the `ItemListener`s added or an empty array if no listeners have been added
since	1.4

public void

setLabel(String label)

Sets the label text.

label	a `String` containing the text
deprecated	- Replaced by `setText(text)`
beaninfo	bound: true description: Replace by setText(text)

public String

getLabel()

Returns the label text.

return	a `String` containing the label
deprecated	- Replaced by `getText`

public void

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

mgr	the specified layout manager
since	1.5

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).

m	the space between the border and the label
beaninfo	bound: true attribute: visualUpdate true description: The space between the button's border and the label.

public Insets

getMargin()
Returns the margin between the button's border and the label.

return	an `Insets` object specifying the margin between the botton's border and the label
See also	setMargin

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.

mnemonic the key code which represents the mnemonic

beaninfo bound: true attribute: visualUpdate true description: the keyboard character mnemonic

See also java.awt.event.KeyEvent, setDisplayedMnemonicIndex

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'.

mnemonic	a char specifying the mnemonic value
beaninfo	bound: true attribute: visualUpdate true description: the keyboard character mnemonic
See also	setMnemonic(int)

public int

getMnemonic()
Returns the keyboard mnemonic from the the current model.

return

the keyboard mnemonic from the model

public void

setModel(ButtonModel newModel)
Sets the model that this button represents.

newModel	the new `ButtonModel`
beaninfo	bound: true description: Model that the Button uses.
See also	getModel

public ButtonModel

getModel()
Returns the model that this button represents.

return	the `model` property
See also	setModel

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.

threshhold	the amount of time required between mouse press events to generate corresponding action events
Throws	IllegalArgumentException: if threshhold < 0
since	1.4
See also	getMultiClickThreshhold

public long

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

return	the amount of time required between mouse press events to generate corresponding action events
since	1.4
See also	setMultiClickThreshhold

public void

setPressedIcon(Icon pressedIcon)
Sets the pressed icon for the button.

pressedIcon	the icon used as the "pressed" image
beaninfo	bound: true attribute: visualUpdate true description: The pressed icon for the button.
See also	getPressedIcon

public Icon

getPressedIcon()
Returns the pressed icon for the button.

return	the `pressedIcon` property
See also	setPressedIcon

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.

b	if `true`, rollover effects should be painted
beaninfo	bound: true attribute: visualUpdate true description: Whether rollover effects should be enabled.
See also	isRolloverEnabled

public boolean

isRolloverEnabled()
Gets the rolloverEnabled property.

return	the value of the `rolloverEnabled` property
See also	setRolloverEnabled

public void

setRolloverIcon(Icon rolloverIcon)
Sets the rollover icon for the button.

rolloverIcon	the icon used as the "rollover" image
beaninfo	bound: true attribute: visualUpdate true description: The rollover icon for the button.
See also	getRolloverIcon

public Icon

getRolloverIcon()
Returns the rollover icon for the button.

return	the `rolloverIcon` property
See also	setRolloverIcon

public void

setRolloverSelectedIcon(Icon rolloverSelectedIcon)
Sets the rollover selected icon for the button.

rolloverSelectedIcon	the icon used as the "selected rollover" image
beaninfo	bound: true attribute: visualUpdate true description: The rollover selected icon for the button.
See also	getRolloverSelectedIcon

public Icon

getRolloverSelectedIcon()
Returns the rollover selection icon for the button.

return	the `rolloverSelectedIcon` property
See also	setRolloverSelectedIcon

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.

b	true if the button is selected, otherwise false

public boolean

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

return

true if the toggle button is selected, otherwise false

public void

setSelectedIcon(Icon selectedIcon)
Sets the selected icon for the button.

selectedIcon	the icon used as the "selected" image
beaninfo	bound: true attribute: visualUpdate true description: The selected icon for the button.
See also	getSelectedIcon

public Icon

getSelectedIcon()
Returns the selected icon for the button.

return	the `selectedIcon` property
See also	setSelectedIcon

public Object[]

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

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

public void

setText(String text)
Sets the button's text.

text	the string used to set the text
beaninfo	bound: true preferred: true attribute: visualUpdate true description: The button's text.
See also	getText

public String

getText()
Returns the button's text.

return	the buttons text
See also	setText

public void

setUI(ButtonUI ui)
Sets the L&F object that renders this component.

ui	the `ButtonUI` L&F object
beaninfo	bound: true hidden: true attribute: visualUpdate true description: The UI object that implements the LookAndFeel.
See also	getUI

public ButtonUI

getUI()
Returns the L&F object that renders this component.

return	the ButtonUI object
See also	setUI

public void

setVerticalAlignment(int alignment)
Sets the vertical alignment of the icon and text.

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
beaninfo	bound: true enum: TOP SwingConstants.TOP CENTER SwingConstants.CENTER BOTTOM SwingConstants.BOTTOM attribute: visualUpdate true description: The vertical alignment of the icon and text.

public int

getVerticalAlignment()
Returns the vertical alignment of the text and icon.

return

the verticalAlignment property, one of the following values:

SwingConstants.CENTER (the default)
SwingConstants.TOP
SwingConstants.BOTTOM

public void

setVerticalTextPosition(int textPosition)
Sets the vertical position of the text relative to the icon.

textPosition	one of the following values: `SwingConstants.CENTER` (the default) `SwingConstants.TOP` `SwingConstants.BOTTOM`
beaninfo	bound: true enum: TOP SwingConstants.TOP CENTER SwingConstants.CENTER BOTTOM SwingConstants.BOTTOM attribute: visualUpdate true description: The vertical position of the text relative to the icon.

public int

getVerticalTextPosition()
Returns the vertical position of the text relative to the icon.

return

the verticalTextPosition property, one of the following values:

SwingConstants.CENTER (the default)
SwingConstants.TOP
SwingConstants.BOTTOM

About DocWeb · Bundles · Export · Export All

Top 10 · Statistics · Login

About Sun · Contact · Privacy · Terms of Use · Trademarks

Java SE 6