Overview Package Class Use Tree Deprecated Index Help

Prev Class Next Class Frames NoFrames All Classes

Summary: Nested Field Constr Method Detail: Field Constr Method

javax.swing

Class AbstractButton

public abstract class AbstractButton extends JComponent implements ItemSelectable, SwingConstants

Provides an abstract implementation of common button behaviour, data model and look & feel.

This class is supposed to serve as a base class for several kinds of buttons with similar but non-identical semantics: toggle buttons (radio buttons and checkboxes), simple push buttons, menu items, etc.

Buttons have many properties, some of which are stored in this class while others are delegated to the button's model. The following properties are available:

Property Stored inBound?
action button no
actionCommand model no
borderPainted button yes
contentAreaFilled button yes
disabledIcon button yes
disabledSelectedIcon button yes
displayedMnemonicIndex button no
enabled model no
focusPainted button yes
horizontalAlignment button yes
horizontalTextPosition button yes
icon button yes
iconTextGap button no
label (same as text) model yes
margin button yes
multiClickThreshold button no
pressedIcon button yes
rolloverEnabled button yes
rolloverIcon button yes
rolloverSelectedIcon button yes
selected model no
selectedIcon button yes
selectedObjects button no
text model yes
UI button yes
verticalAlignment button yes
verticalTextPosition button yes

The various behavioral aspects of these properties follows:

Nested Class Summary
protected abstract classAbstractButton.AccessibleAbstractButton
A Java Accessibility extension of the AbstractButton.
protected classAbstractButton.ButtonChangeListener
An extension of ChangeListener to be serializable.
Field Summary
protected ActionListeneractionListener
Listener the button uses to receive ActionEvents from its model.
static StringBORDER_PAINTED_CHANGED_PROPERTY
Fired in a PropertyChangeEvent when the "borderPainted" property changes.
protected ChangeEventchangeEvent
ChangeEvent that is fired to button's ChangeEventListeners
protected ChangeListenerchangeListener
Listener the button uses to receive ChangeEvents from its model.
static StringCONTENT_AREA_FILLED_CHANGED_PROPERTY
Fired in a PropertyChangeEvent when the "contentAreaFilled" property changes.
static StringDISABLED_ICON_CHANGED_PROPERTY
Fired in a PropertyChangeEvent when the "disabledIcon" property changes.
static StringDISABLED_SELECTED_ICON_CHANGED_PROPERTY
Fired in a PropertyChangeEvent when the "disabledSelectedIcon" property changes.
static StringFOCUS_PAINTED_CHANGED_PROPERTY
Fired in a PropertyChangeEvent when the "focusPainted" property changes.
static StringHORIZONTAL_ALIGNMENT_CHANGED_PROPERTY
Fired in a PropertyChangeEvent when the "horizontalAlignment" property changes.
static StringHORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY
Fired in a PropertyChangeEvent when the "horizontalTextPosition" property changes.
protected ItemListeneritemListener
Listener the button uses to receive ItemEvents from its model.
static StringICON_CHANGED_PROPERTY
Fired in a PropertyChangeEvent when the "icon" property changes.
protected ButtonModelmodel
The button's current state.
static StringMARGIN_CHANGED_PROPERTY
Fired in a PropertyChangeEvent when the "margin" property changes.
static StringMNEMONIC_CHANGED_PROPERTY
Fired in a PropertyChangeEvent when the "mnemonic" property changes.
static StringMODEL_CHANGED_PROPERTY
Fired in a PropertyChangeEvent when the "model" property changes.
static StringPRESSED_ICON_CHANGED_PROPERTY
Fired in a PropertyChangeEvent when the "pressedIcon" property changes.
static StringROLLOVER_ENABLED_CHANGED_PROPERTY
Fired in a PropertyChangeEvent when the "rolloverEnabled" property changes.
static StringROLLOVER_ICON_CHANGED_PROPERTY
Fired in a PropertyChangeEvent when the "rolloverIcon" property changes.
static StringROLLOVER_SELECTED_ICON_CHANGED_PROPERTY
Fired in a PropertyChangeEvent when the "rolloverSelectedIcon" property changes.
static StringSELECTED_ICON_CHANGED_PROPERTY
Fired in a PropertyChangeEvent when the "selectedIcon" property changes.
static StringTEXT_CHANGED_PROPERTY
Fired in a PropertyChangeEvent when the "text" property changes.
static StringVERTICAL_ALIGNMENT_CHANGED_PROPERTY
Fired in a PropertyChangeEvent when the "verticalAlignment" property changes.
static StringVERTICAL_TEXT_POSITION_CHANGED_PROPERTY
Fired in a PropertyChangeEvent when the "verticalTextPosition" property changes.
Constructor Summary
AbstractButton()
Creates a new AbstractButton object.
Method Summary
voidaddActionListener(ActionListener l)
Adds an ActionListener to the button's listener list.
voidaddChangeListener(ChangeListener l)
Adds a ChangeListener to the button's listener list.
protected voidaddImpl(Component comp, Object constraints, int index)
Adds the specified component to this AbstractButton.
voidaddItemListener(ItemListener l)
Adds an ItemListener to the button's listener list.
protected intcheckHorizontalKey(int key, String exception)
Verifies that a particular key is one of the valid constants used for describing horizontal alignment and positioning.
protected intcheckVerticalKey(int key, String exception)
Verifies that a particular key is one of the valid constants used for describing vertical alignment and positioning.
protected voidconfigurePropertiesFromAction(Action a)
Configure various properties of the button by reading properties of an {@link Action}.
protected ActionListenercreateActionListener()

A factory method which should return an {@link ActionListener} that propagates events from the button's {@link ButtonModel} to any of the button's ActionListeners.

protected PropertyChangeListenercreateActionPropertyChangeListener(Action a)

A factory method which should return a {@link PropertyChangeListener} that accepts changes to the specified {@link Action} and reconfigure the {@link AbstractButton}, by default using the {@link #configurePropertiesFromAction} method.

The button calls this method whenever a new Action is assigned to the button's "action" property, via {@link #setAction}, and stores the resulting PropertyChangeListener in its actionPropertyChangeListener member field.

protected ChangeListenercreateChangeListener()

Factory method which creates a {@link ChangeListener}, used to subscribe to ChangeEvents from the button's model.

protected ItemListenercreateItemListener()

Factory method which creates a {@link ItemListener}, used to subscribe to ItemEvents from the button's model.

voiddoClick()
Programmatically perform a "click" on the button: arming, pressing, waiting, un-pressing, and disarming the model.
voiddoClick(int pressTime)
Programmatically perform a "click" on the button: arming, pressing, waiting, un-pressing, and disarming the model.
protected voidfireActionPerformed(ActionEvent e)
Calls {@link ActionListener#actionPerformed} on each {@link ActionListener} in the button's listener list.
protected voidfireItemStateChanged(ItemEvent e)
Calls {@link ItemListener#itemStateChanged} on each ItemListener in the button's listener list.
protected voidfireStateChanged()
Calls {@link ChangeListener#stateChanged} on each {@link ChangeListener} in the button's listener list.
ActiongetAction()
Get the value of the "action" property.
StringgetActionCommand()

Returns the action command string for this button's model.

If the action command was set to null, the button's text (label) is returned instead.

ActionListener[]getActionListeners()
Returns all added ActionListener objects.
ChangeListener[]getChangeListeners()
Returns all added ChangeListener objects.
IcongetDisabledIcon()
Return the button's "disabledIcon" property.
IcongetDisabledSelectedIcon()
Return the button's disabled selected icon.
intgetDisplayedMnemonicIndex()
Get the button's mnemonic index, which is an offset into the button's "text" property.
intgetHorizontalAlignment()
Set the horizontal alignment of the button's text and icon.
intgetHorizontalTextPosition()
Get the horizontal position of the button's text relative to its icon.
IcongetIcon()
Return the button's default "icon" property.
intgetIconTextGap()
Get the value of the {@link #iconTextGap} property.
ItemListener[]getItemListeners()
Returns all added ItemListener objects.
StringgetLabel()
Return the button's "label" property.
InsetsgetMargin()
Return the button's "margin" property, which is an {@link Insets} object describing the distance between the button's border and its text and icon.
intgetMnemonic()
Get the current keyboard mnemonic value.
ButtonModelgetModel()
Get the model the button is currently using.
longgetMultiClickThreshhold()
Returns the current time in milliseconds in which clicks gets coalesced into a single ActionEvent.
IcongetPressedIcon()
Return the button's "pressedIcon" property.
IcongetRolloverIcon()
Return the button's rollover icon.
IcongetRolloverSelectedIcon()
Return the button's rollover selected icon.
IcongetSelectedIcon()
Return the button's selected icon.
Object[]getSelectedObjects()
Returns an single-element array containing the "text" property of the button if the "selected" property of the button's model is true, otherwise returns null.
StringgetText()
Return the button's "text" property.
ButtonUIgetUI()
Set the "UI" property of the button, which is a look and feel class responsible for handling the button's input events and painting it.
intgetVerticalAlignment()
Get the vertical alignment of the button's text and icon.
intgetVerticalTextPosition()
Get the vertical position of the button's text relative to its icon.
booleanimageUpdate(Image img, int infoflags, int x, int y, int w, int h)
Called when image data becomes available for one of the button's icons.
protected voidinit(String text, Icon icon)
booleanisBorderPainted()
Set the value of the "borderPainted" property.
booleanisContentAreaFilled()
Returns the value of the button's "contentAreaFilled" property.
booleanisFocusPainted()
Return the button's "paintFocus" property.
booleanisRolloverEnabled()
Returns whether or not rollover icon changes are enabled on the button.
booleanisSelected()
Get the value of the button's "selected" property.
protected voidpaintBorder(Graphics g)
Paints the button's border, if the button's "borderPainted" property is true, by out calling to the button's look and feel class.
protected StringparamString()
Returns a string, used only for debugging, which identifies or somehow represents this button.
voidremoveActionListener(ActionListener l)
Removes an ActionListener from the button's listener list.
voidremoveChangeListener(ChangeListener l)
Removes a ChangeListener from the button's listener list.
voidremoveItemListener(ItemListener l)
Removes an ItemListener from the button's listener list.
voidsetAction(Action a)

Set the button's "action" property, subscribing the new action to the button, as an ActionListener, if it is not already subscribed.

voidsetActionCommand(String actionCommand)
Sets the action command string for this button's model.
voidsetBorderPainted(boolean b)
Set the value of the "borderPainted" property.
voidsetContentAreaFilled(boolean b)
Sets the value of the button's "contentAreaFilled" property.
voidsetDisabledIcon(Icon d)
Set the button's "disabledIcon" property.
voidsetDisabledSelectedIcon(Icon icon)
Set the button's disabled selected icon.
voidsetDisplayedMnemonicIndex(int index)
Sets the button's mnemonic index.
voidsetEnabled(boolean b)
Enables or disables the button.
voidsetFocusPainted(boolean p)
Set the button's "paintFocus" property.
voidsetHorizontalAlignment(int a)
Set the horizontal alignment of the button's text and icon.
voidsetHorizontalTextPosition(int t)
Set the horizontal position of the button's text relative to its icon.
voidsetIcon(Icon i)
Set the button's default "icon" property.
voidsetIconTextGap(int i)
Set the value of the {@link #iconTextGap} property.
voidsetLabel(String label)
Set the button's "label" property.
voidsetLayout(LayoutManager layout)
Sets a layout manager on this AbstractButton.
voidsetMargin(Insets m)
Set the button's "margin" property, which is an {@link Insets} object describing the distance between the button's border and its text and icon.
voidsetMnemonic(char mne)
Set the current keyboard mnemonic value.
voidsetMnemonic(int mne)
Set the current keyboard mnemonic value.
voidsetModel(ButtonModel newModel)
Set the model the button is currently using.
voidsetMultiClickThreshhold(long threshhold)
Sets the time in milliseconds in which clicks gets coalesced into a single ActionEvent.
voidsetPressedIcon(Icon pressedIcon)
Set the button's "pressedIcon" property.
voidsetRolloverEnabled(boolean r)
Set the "rolloverEnabled" property.
voidsetRolloverIcon(Icon r)
Set the button's rollover icon and sets the rolloverEnabled property to true.
voidsetRolloverSelectedIcon(Icon r)
Set the button's rollover selected icon and sets the rolloverEnabled property to true.
voidsetSelected(boolean s)
Set the value of the button's "selected" property.
voidsetSelectedIcon(Icon s)
Set the button's selected icon.
voidsetText(String t)
Set the button's "text" property.
voidsetUI(ButtonUI ui)
Set the "UI" property of the button, which is a look and feel class responsible for handling the button's input events and painting it.
voidsetVerticalAlignment(int a)
Set the vertical alignment of the button's text and icon.
voidsetVerticalTextPosition(int t)
Set the vertical position of the button's text relative to its icon.
voidupdateUI()
Set the "UI" property to a class constructed, via the {@link UIManager}, from the current look and feel.

Field Detail

actionListener

protected ActionListener actionListener
Listener the button uses to receive ActionEvents from its model.

BORDER_PAINTED_CHANGED_PROPERTY

public static final String BORDER_PAINTED_CHANGED_PROPERTY
Fired in a PropertyChangeEvent when the "borderPainted" property changes.

changeEvent

protected ChangeEvent changeEvent
ChangeEvent that is fired to button's ChangeEventListeners

changeListener

protected ChangeListener changeListener
Listener the button uses to receive ChangeEvents from its model.

CONTENT_AREA_FILLED_CHANGED_PROPERTY

public static final String CONTENT_AREA_FILLED_CHANGED_PROPERTY
Fired in a PropertyChangeEvent when the "contentAreaFilled" property changes.

DISABLED_ICON_CHANGED_PROPERTY

public static final String DISABLED_ICON_CHANGED_PROPERTY
Fired in a PropertyChangeEvent when the "disabledIcon" property changes.

DISABLED_SELECTED_ICON_CHANGED_PROPERTY

public static final String DISABLED_SELECTED_ICON_CHANGED_PROPERTY
Fired in a PropertyChangeEvent when the "disabledSelectedIcon" property changes.

FOCUS_PAINTED_CHANGED_PROPERTY

public static final String FOCUS_PAINTED_CHANGED_PROPERTY
Fired in a PropertyChangeEvent when the "focusPainted" property changes.

HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY

public static final String HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY
Fired in a PropertyChangeEvent when the "horizontalAlignment" property changes.

HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY

public static final String HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY
Fired in a PropertyChangeEvent when the "horizontalTextPosition" property changes.

itemListener

protected ItemListener itemListener
Listener the button uses to receive ItemEvents from its model.

ICON_CHANGED_PROPERTY

public static final String ICON_CHANGED_PROPERTY
Fired in a PropertyChangeEvent when the "icon" property changes.

model

protected ButtonModel model
The button's current state.

MARGIN_CHANGED_PROPERTY

public static final String MARGIN_CHANGED_PROPERTY
Fired in a PropertyChangeEvent when the "margin" property changes.

MNEMONIC_CHANGED_PROPERTY

public static final String MNEMONIC_CHANGED_PROPERTY
Fired in a PropertyChangeEvent when the "mnemonic" property changes.

MODEL_CHANGED_PROPERTY

public static final String MODEL_CHANGED_PROPERTY
Fired in a PropertyChangeEvent when the "model" property changes.

PRESSED_ICON_CHANGED_PROPERTY

public static final String PRESSED_ICON_CHANGED_PROPERTY
Fired in a PropertyChangeEvent when the "pressedIcon" property changes.

ROLLOVER_ENABLED_CHANGED_PROPERTY

public static final String ROLLOVER_ENABLED_CHANGED_PROPERTY
Fired in a PropertyChangeEvent when the "rolloverEnabled" property changes.

ROLLOVER_ICON_CHANGED_PROPERTY

public static final String ROLLOVER_ICON_CHANGED_PROPERTY
Fired in a PropertyChangeEvent when the "rolloverIcon" property changes.

ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY

public static final String ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY
Fired in a PropertyChangeEvent when the "rolloverSelectedIcon" property changes.

SELECTED_ICON_CHANGED_PROPERTY

public static final String SELECTED_ICON_CHANGED_PROPERTY
Fired in a PropertyChangeEvent when the "selectedIcon" property changes.

TEXT_CHANGED_PROPERTY

public static final String TEXT_CHANGED_PROPERTY
Fired in a PropertyChangeEvent when the "text" property changes.

VERTICAL_ALIGNMENT_CHANGED_PROPERTY

public static final String VERTICAL_ALIGNMENT_CHANGED_PROPERTY
Fired in a PropertyChangeEvent when the "verticalAlignment" property changes.

VERTICAL_TEXT_POSITION_CHANGED_PROPERTY

public static final String VERTICAL_TEXT_POSITION_CHANGED_PROPERTY
Fired in a PropertyChangeEvent when the "verticalTextPosition" property changes.

Constructor Detail

AbstractButton

public AbstractButton()
Creates a new AbstractButton object. Subclasses should call the following sequence in their constructor in order to initialize the button correctly: 
 super();
 init(text, icon);
The {@link #init(String, Icon)} method is not called automatically by this constructor.

See Also: AbstractButton

Method Detail

addActionListener

public void addActionListener(ActionListener l)
Adds an ActionListener to the button's listener list. When the button's model is clicked it fires an ActionEvent, and these listeners will be called.

Parameters: l The new listener to add

addChangeListener

public void addChangeListener(ChangeListener l)
Adds a ChangeListener to the button's listener list. When the button's model changes any of its (non-bound) properties, these listeners will be called.

Parameters: l The new listener to add

addImpl

protected void addImpl(Component comp, Object constraints, int index)
Adds the specified component to this AbstractButton. This overrides the default in order to install an {@link OverlayLayout} layout manager before adding the component. The layout manager is only installed if no other layout manager has been installed before.

Parameters: comp the component to be added constraints constraints for the layout manager index the index at which the component is added

Since: 1.5

addItemListener

public void addItemListener(ItemListener l)
Adds an ItemListener to the button's listener list. When the button's model changes state (between any of ARMED, ENABLED, PRESSED, ROLLOVER or SELECTED) it fires an ItemEvent, and these listeners will be called.

Parameters: l The new listener to add

checkHorizontalKey

protected int checkHorizontalKey(int key, String exception)
Verifies that a particular key is one of the valid constants used for describing horizontal alignment and positioning. The valid constants are the following members of {@link SwingConstants}: RIGHT, LEFT, CENTER, LEADING or TRAILING.

Parameters: key The key to check exception A message to include in an IllegalArgumentException

Returns: the value of key

Throws: IllegalArgumentException If key is not one of the valid constants

See Also: AbstractButton AbstractButton

checkVerticalKey

protected int checkVerticalKey(int key, String exception)
Verifies that a particular key is one of the valid constants used for describing vertical alignment and positioning. The valid constants are the following members of {@link SwingConstants}: TOP, BOTTOM or CENTER.

Parameters: key The key to check exception A message to include in an IllegalArgumentException

Returns: the value of key

Throws: IllegalArgumentException If key is not one of the valid constants

See Also: AbstractButton AbstractButton

configurePropertiesFromAction

protected void configurePropertiesFromAction(Action a)
Configure various properties of the button by reading properties of an {@link Action}. The mapping of properties is as follows:
Action keyed property AbstractButton property
NAME text
SMALL_ICON icon
SHORT_DESCRIPTION toolTipText
MNEMONIC_KEY mnemonic
ACTION_COMMAND_KEY actionCommand

In addition, this method always sets the button's "enabled" property to the value of the Action's "enabled" property.

If the provided Action is null, the text, icon, and toolTipText properties of the button are set to null, and the "enabled" property is set to true; the mnemonic and actionCommand properties are unchanged.

Parameters: a An Action to configure the button from

createActionListener

protected ActionListener createActionListener()

A factory method which should return an {@link ActionListener} that propagates events from the button's {@link ButtonModel} to any of the button's ActionListeners. By default, this is an inner class which calls {@link AbstractButton#fireActionPerformed} with a modified copy of the incoming model {@link ActionEvent}.

The button calls this method during construction, stores the resulting ActionListener in its actionListener member field, and subscribes it to the button's model. If the button's model is changed, this listener is unsubscribed from the old model and subscribed to the new one.

Returns: A new ActionListener

createActionPropertyChangeListener

protected PropertyChangeListener createActionPropertyChangeListener(Action a)

A factory method which should return a {@link PropertyChangeListener} that accepts changes to the specified {@link Action} and reconfigure the {@link AbstractButton}, by default using the {@link #configurePropertiesFromAction} method.

The button calls this method whenever a new Action is assigned to the button's "action" property, via {@link #setAction}, and stores the resulting PropertyChangeListener in its actionPropertyChangeListener member field. The button then subscribes the listener to the button's new action. If the button's action is changed subsequently, the listener is unsubscribed from the old action and subscribed to the new one.

Parameters: a The Action which will be listened to, and which should be the same as the source of any PropertyChangeEvents received by the new listener returned from this method.

Returns: A new PropertyChangeListener

createChangeListener

protected ChangeListener createChangeListener()

Factory method which creates a {@link ChangeListener}, used to subscribe to ChangeEvents from the button's model. Subclasses of AbstractButton may wish to override the listener used to subscribe to such ChangeEvents. By default, the listener just propagates the {@link ChangeEvent} to the button's ChangeListeners, via the {@link AbstractButton#fireStateChanged} method.

The button calls this method during construction, stores the resulting ChangeListener in its changeListener member field, and subscribes it to the button's model. If the button's model is changed, this listener is unsubscribed from the old model and subscribed to the new one.

Returns: The new ChangeListener

createItemListener

protected ItemListener createItemListener()

Factory method which creates a {@link ItemListener}, used to subscribe to ItemEvents from the button's model. Subclasses of AbstractButton may wish to override the listener used to subscribe to such ItemEvents. By default, the listener just propagates the {@link ItemEvent} to the button's ItemListeners, via the {@link AbstractButton#fireItemStateChanged} method.

The button calls this method during construction, stores the resulting ItemListener in its changeListener member field, and subscribes it to the button's model. If the button's model is changed, this listener is unsubscribed from the old model and subscribed to the new one.

Note that ItemEvents are only generated from the button's model when the model's selected property changes. If you want to subscribe to other properties of the model, you must subscribe to ChangeEvents.

Returns: The new ItemListener

doClick

public void doClick()
Programmatically perform a "click" on the button: arming, pressing, waiting, un-pressing, and disarming the model.

doClick

public void doClick(int pressTime)
Programmatically perform a "click" on the button: arming, pressing, waiting, un-pressing, and disarming the model.

Parameters: pressTime The number of milliseconds to wait in the pressed state

fireActionPerformed

protected void fireActionPerformed(ActionEvent e)
Calls {@link ActionListener#actionPerformed} on each {@link ActionListener} in the button's listener list.

Parameters: e The event signifying that the button's model was clicked

fireItemStateChanged

protected void fireItemStateChanged(ItemEvent e)
Calls {@link ItemListener#itemStateChanged} on each ItemListener in the button's listener list.

Parameters: e The event signifying that the button's model changed state

fireStateChanged

protected void fireStateChanged()
Calls {@link ChangeListener#stateChanged} on each {@link ChangeListener} in the button's listener list.

getAction

public Action getAction()
Get the value of the "action" property.

Returns: The current value of the "action" property

getActionCommand

public String getActionCommand()

Returns the action command string for this button's model.

If the action command was set to null, the button's text (label) is returned instead.

Returns: The current action command string from the button's model

getActionListeners

public ActionListener[] getActionListeners()
Returns all added ActionListener objects.

Returns: an array of listeners

Since: 1.4

getChangeListeners

public ChangeListener[] getChangeListeners()
Returns all added ChangeListener objects.

Returns: an array of listeners

Since: 1.4

getDisabledIcon

public Icon getDisabledIcon()
Return the button's "disabledIcon" property. The look and feel class should paint this icon when the "enabled" property of the button's {@link ButtonModel} is false. This property may be null, in which case an icon is constructed, based on the default icon.

Returns: The current "disabledIcon" property

getDisabledSelectedIcon

public Icon getDisabledSelectedIcon()
Return the button's disabled selected icon. The look and feel class should paint this icon when the "enabled" property of the button's model is false and its "selected" property is true. This icon can be null, in which case it is synthesized from the button's selected icon.

Returns: The current disabled selected icon

getDisplayedMnemonicIndex

public int getDisplayedMnemonicIndex()
Get the button's mnemonic index, which is an offset into the button's "text" property. The character specified by this offset should be underlined when the look and feel class draws this button.

Returns: An index into the button's "text" property

getHorizontalAlignment

public int getHorizontalAlignment()
Set the horizontal alignment of the button's text and icon. The alignment is a numeric constant from {@link SwingConstants}. It must be one of: RIGHT, LEFT, CENTER, LEADING or TRAILING. The default is CENTER.

Returns: The current horizontal alignment

See Also: AbstractButton

getHorizontalTextPosition

public int getHorizontalTextPosition()
Get the horizontal position of the button's text relative to its icon. The position is a numeric constant from {@link SwingConstants}. It must be one of: RIGHT, LEFT, CENTER, LEADING or TRAILING. The default is TRAILING.

Returns: The current horizontal text position

getIcon

public Icon getIcon()
Return the button's default "icon" property.

Returns: The current default icon

getIconTextGap

public int getIconTextGap()
Get the value of the {@link #iconTextGap} property.

Returns: The current value of the property

Since: 1.4

getItemListeners

public ItemListener[] getItemListeners()
Returns all added ItemListener objects.

Returns: an array of listeners

Since: 1.4

getLabel

public String getLabel()

Deprecated: use getText()

Return the button's "label" property. This property is synonymous with the "text" property.

Returns: The current "label" property

getMargin

public Insets getMargin()
Return the button's "margin" property, which is an {@link Insets} object describing the distance between the button's border and its text and icon.

Returns: The current "margin" property

getMnemonic

public int getMnemonic()
Get the current keyboard mnemonic value. This value corresponds to a single key code (one of the {@link java.awt.event.KeyEvent} VK_* codes) and is used to activate the button when pressed in conjunction with the "mouseless modifier" of the button's look and feel class, and when focus is in one of the button's ancestors.

Returns: The button's current keyboard mnemonic

getModel

public ButtonModel getModel()
Get the model the button is currently using.

Returns: The current model

getMultiClickThreshhold

public long getMultiClickThreshhold()
Returns the current time in milliseconds in which clicks gets coalesced into a single ActionEvent.

Returns: the time in milliseconds

Since: 1.4

getPressedIcon

public Icon getPressedIcon()
Return the button's "pressedIcon" property. The look and feel class should paint this icon when the "pressed" property of the button's {@link ButtonModel} is true. This property may be null, in which case the default icon is used.

Returns: The current "pressedIcon" property

getRolloverIcon

public Icon getRolloverIcon()
Return the button's rollover icon. The look and feel class should paint this icon when the "rolloverEnabled" property of the button is true and the mouse rolls over the button.

Returns: The current rollover icon

getRolloverSelectedIcon

public Icon getRolloverSelectedIcon()
Return the button's rollover selected icon. The look and feel class should paint this icon when the "rolloverEnabled" property of the button is true, the "selected" property of the button's model is true, and the mouse rolls over the button.

Returns: The current rollover selected icon

getSelectedIcon

public Icon getSelectedIcon()
Return the button's selected icon. The look and feel class should paint this icon when the "selected" property of the button's model is true, and either the "rolloverEnabled" property of the button is false or the mouse is not currently rolled over the button.

Returns: The current selected icon

getSelectedObjects

public Object[] getSelectedObjects()
Returns an single-element array containing the "text" property of the button if the "selected" property of the button's model is true, otherwise returns null.

Returns: The button's "selected object" array

getText

public String getText()
Return the button's "text" property. This property is synonymous with the "label" property.

Returns: The current "text" property

getUI

public ButtonUI getUI()
Set the "UI" property of the button, which is a look and feel class responsible for handling the button's input events and painting it.

Returns: The current "UI" property

getVerticalAlignment

public int getVerticalAlignment()
Get the vertical alignment of the button's text and icon. The alignment is a numeric constant from {@link SwingConstants}. It must be one of: CENTER, TOP, or BOTTOM. The default is CENTER.

Returns: The current vertical alignment

See Also: AbstractButton

getVerticalTextPosition

public int getVerticalTextPosition()
Get the vertical position of the button's text relative to its icon. The alignment is a numeric constant from {@link SwingConstants}. It must be one of: CENTER, TOP, or BOTTOM. The default is CENTER.

Returns: The current vertical position

imageUpdate

public boolean imageUpdate(Image img, int infoflags, int x, int y, int w, int h)
Called when image data becomes available for one of the button's icons.

Parameters: img The image being updated infoflags One of the constant codes in {@link ImageObserver} used to describe updated portions of an image. x X coordinate of the region being updated y Y coordinate of the region being updated w Width of the region beign updated h Height of the region being updated

Returns: true if img is equal to the button's current icon, otherwise false

init

protected void init(String text, Icon icon)

isBorderPainted

public boolean isBorderPainted()
Set the value of the "borderPainted" property. If set to false, the button's look and feel class should not paint a border for the button. The default is true.

Returns: The current value of the property.

isContentAreaFilled

public boolean isContentAreaFilled()
Returns the value of the button's "contentAreaFilled" property. This property indicates whether the area surrounding the text and icon of the button should be filled by the look and feel class. If this property is false, the look and feel class should leave the content area transparent.

Returns: The current value of the "contentAreaFilled" property

isFocusPainted

public boolean isFocusPainted()
Return the button's "paintFocus" property. This property controls whether or not the look and feel class will paint a special indicator of focus state for the button. If it is false, the button still paints when focused, but no special decoration is painted to indicate the presence of focus.

Returns: The current "paintFocus" property

isRolloverEnabled

public boolean isRolloverEnabled()
Returns whether or not rollover icon changes are enabled on the button.

Returns: The state of the "rolloverEnabled" property

isSelected

public boolean isSelected()
Get the value of the button's "selected" property. Selection is only meaningful for toggle-type buttons (check boxes, radio buttons).

Returns: The value of the property

paintBorder

protected void paintBorder(Graphics g)
Paints the button's border, if the button's "borderPainted" property is true, by out calling to the button's look and feel class.

Parameters: g The graphics context used to paint the border

paramString

protected String paramString()
Returns a string, used only for debugging, which identifies or somehow represents this button. The exact value is implementation-defined.

Returns: A string representation of the button

removeActionListener

public void removeActionListener(ActionListener l)
Removes an ActionListener from the button's listener list.

Parameters: l The listener to remove

removeChangeListener

public void removeChangeListener(ChangeListener l)
Removes a ChangeListener from the button's listener list.

Parameters: l The listener to remove

removeItemListener

public void removeItemListener(ItemListener l)
Removes an ItemListener from the button's listener list.

Parameters: l The listener to remove

setAction

public void setAction(Action a)

Set the button's "action" property, subscribing the new action to the button, as an ActionListener, if it is not already subscribed. The old Action, if it exists, is unsubscribed, and the button is unsubscribed from the old Action if it was previously subscribed as a PropertyChangeListener.

This method also configures several of the button's properties from the Action, by calling {@link #configurePropertiesFromAction}, and subscribes the button to the Action as a PropertyChangeListener. Subsequent changes to the Action will thus reconfigure the button automatically.

Parameters: a The new value of the "action" property

setActionCommand

public void setActionCommand(String actionCommand)
Sets the action command string for this button's model.

Parameters: actionCommand The new action command string to set in the button's model.

setBorderPainted

public void setBorderPainted(boolean b)
Set the value of the "borderPainted" property. If set to false, the button's look and feel class should not paint a border for the button. The default is true.

Parameters: b The new value of the property.

setContentAreaFilled

public void setContentAreaFilled(boolean b)
Sets the value of the button's "contentAreaFilled" property. This property indicates whether the area surrounding the text and icon of the button should be filled by the look and feel class. If this property is false, the look and feel class should leave the content area transparent.

Parameters: b The new value of the "contentAreaFilled" property

setDisabledIcon

public void setDisabledIcon(Icon d)
Set the button's "disabledIcon" property. The look and feel class should paint this icon when the "enabled" property of the button's {@link ButtonModel} is false. This property may be null, in which case an icon is constructed, based on the default icon.

Parameters: d The new "disabledIcon" property

setDisabledSelectedIcon

public void setDisabledSelectedIcon(Icon icon)
Set the button's disabled selected icon. The look and feel class should paint this icon when the "enabled" property of the button's model is false and its "selected" property is true. This icon can be null, in which case it is synthesized from the button's selected icon.

Parameters: icon The new disabled selected icon

setDisplayedMnemonicIndex

public void setDisplayedMnemonicIndex(int index)
Sets the button's mnemonic index. The mnemonic index is a hint to the look and feel class, suggesting which character in the button's label should be underlined when drawing the label. If the mnemonic index is -1, no mnemonic will be displayed. If no mnemonic index is set, the button will choose a mnemonic index by default, which will be the first occurrence of the mnemonic character in the button's text.

Parameters: index An offset into the "text" property of the button

Throws: IllegalArgumentException If index is not within the range of legal offsets for the "text" property of the button.

Since: 1.4

setEnabled

public void setEnabled(boolean b)
Enables or disables the button. A button will neither be selectable nor preform any actions unless it is enabled.

Parameters: b Whether or not to enable the button

setFocusPainted

public void setFocusPainted(boolean p)
Set the button's "paintFocus" property. This property controls whether or not the look and feel class will paint a special indicator of focus state for the button. If it is false, the button still paints when focused, but no special decoration is painted to indicate the presence of focus.

Parameters: p The new "paintFocus" property

setHorizontalAlignment

public void setHorizontalAlignment(int a)
Set the horizontal alignment of the button's text and icon. The alignment is a numeric constant from {@link SwingConstants}. It must be one of: RIGHT, LEFT, CENTER, LEADING or TRAILING. The default is CENTER.

Parameters: a The new horizontal alignment

Throws: IllegalArgumentException If alignment is not one of the legal constants.

See Also: getHorizontalAlignment

setHorizontalTextPosition

public void setHorizontalTextPosition(int t)
Set the horizontal position of the button's text relative to its icon. The position is a numeric constant from {@link SwingConstants}. It must be one of: RIGHT, LEFT, CENTER, LEADING or TRAILING. The default is TRAILING.

Parameters: t The new horizontal text position

Throws: IllegalArgumentException If position is not one of the legal constants.

setIcon

public void setIcon(Icon i)
Set the button's default "icon" property. This icon is used as a basis for the pressed and disabled icons, if none are explicitly set.

Parameters: i The new default icon

setIconTextGap

public void setIconTextGap(int i)
Set the value of the {@link #iconTextGap} property.

Parameters: i The new value of the property

Since: 1.4

setLabel

public void setLabel(String label)

Deprecated: use setText(text)

Set the button's "label" property. This property is synonymous with the "text" property.

Parameters: label The new "label" property

setLayout

public void setLayout(LayoutManager layout)
Sets a layout manager on this AbstractButton. This is overridden in order to detect if the application sets a custom layout manager. If no custom layout manager is set, {@link #addImpl(Component, Object, int)} installs an OverlayLayout before adding a component.

Parameters: layout the layout manager to install

Since: 1.5

setMargin

public void setMargin(Insets m)
Set the button's "margin" property, which is an {@link Insets} object describing the distance between the button's border and its text and icon.

Parameters: m The new "margin" property

setMnemonic

public void setMnemonic(char mne)
Set the current keyboard mnemonic value. This value corresponds to a single key code (one of the {@link java.awt.event.KeyEvent} VK_* codes) and is used to activate the button when pressed in conjunction with the "mouseless modifier" of the button's look and feel class, and when focus is in one of the button's ancestors.

Parameters: mne A new mnemonic to use for the button

setMnemonic

public void setMnemonic(int mne)
Set the current keyboard mnemonic value. This value corresponds to a single key code (one of the {@link java.awt.event.KeyEvent} VK_* codes) and is used to activate the button when pressed in conjunction with the "mouseless modifier" of the button's look and feel class, and when focus is in one of the button's ancestors.

Parameters: mne A new mnemonic to use for the button

setModel

public void setModel(ButtonModel newModel)
Set the model the button is currently using. This un-registers all listeners associated with the current model, and re-registers them with the new model.

Parameters: newModel The new model

setMultiClickThreshhold

public void setMultiClickThreshhold(long threshhold)
Sets the time in milliseconds in which clicks gets coalesced into a single ActionEvent.

Parameters: threshhold the time in milliseconds

Since: 1.4

setPressedIcon

public void setPressedIcon(Icon pressedIcon)
Set the button's "pressedIcon" property. The look and feel class should paint this icon when the "pressed" property of the button's {@link ButtonModel} is true. This property may be null, in which case the default icon is used.

Parameters: pressedIcon The new "pressedIcon" property

setRolloverEnabled

public void setRolloverEnabled(boolean r)
Set the "rolloverEnabled" property. When rollover is enabled, and the look and feel supports it, the button will change its icon to rolloverIcon, when the mouse passes over it.

Parameters: r Whether or not to enable rollover icon changes

setRolloverIcon

public void setRolloverIcon(Icon r)
Set the button's rollover icon and sets the rolloverEnabled property to true. The look and feel class should paint this icon when the "rolloverEnabled" property of the button is true and the mouse rolls over the button.

Parameters: r The new rollover icon

setRolloverSelectedIcon

public void setRolloverSelectedIcon(Icon r)
Set the button's rollover selected icon and sets the rolloverEnabled property to true. The look and feel class should paint this icon when the "rolloverEnabled" property of the button is true, the "selected" property of the button's model is true, and the mouse rolls over the button.

Parameters: r The new rollover selected icon.

setSelected

public void setSelected(boolean s)
Set the value of the button's "selected" property. Selection is only meaningful for toggle-type buttons (check boxes, radio buttons).

Parameters: s New value for the property

setSelectedIcon

public void setSelectedIcon(Icon s)
Set the button's selected icon. The look and feel class should paint this icon when the "selected" property of the button's model is true, and either the "rolloverEnabled" property of the button is false or the mouse is not currently rolled over the button.

Parameters: s The new selected icon

setText

public void setText(String t)
Set the button's "text" property. This property is synonymous with the "label" property.

Parameters: t The new "text" property

setUI

public void setUI(ButtonUI ui)
Set the "UI" property of the button, which is a look and feel class responsible for handling the button's input events and painting it.

Parameters: ui The new "UI" property

setVerticalAlignment

public void setVerticalAlignment(int a)
Set the vertical alignment of the button's text and icon. The alignment is a numeric constant from {@link SwingConstants}. It must be one of: CENTER, TOP, or BOTTOM. The default is CENTER.

Parameters: a The new vertical alignment

Throws: IllegalArgumentException If alignment is not one of the legal constants.

See Also: getVerticalAlignment

setVerticalTextPosition

public void setVerticalTextPosition(int t)
Set the vertical position of the button's text relative to its icon. The alignment is a numeric constant from {@link SwingConstants}. It must be one of: CENTER, TOP, or BOTTOM. The default is CENTER.

Parameters: t The new vertical position

Throws: IllegalArgumentException If position is not one of the legal constants.

updateUI

public void updateUI()
Set the "UI" property to a class constructed, via the {@link UIManager}, from the current look and feel. This should be overridden for each subclass of AbstractButton, to retrieve a suitable {@link ButtonUI} look and feel class.

Overview Package Class Use Tree Deprecated Index Help

Prev Class Next Class Frames NoFrames All Classes

Summary: Nested Field Constr Method Detail: Field Constr Method