javax.swing
Class AbstractButton

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.AbstractButton
All Implemented Interfaces:
ImageObserver, ItemSelectable, MenuContainer, Serializable, SwingConstants
Direct Known Subclasses:
JButton, JMenuItem, JToggleButton

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:

See Also:
Serialized Form

Nested Class Summary
protected  class AbstractButton.AccessibleAbstractButton
          A Java Accessibility extension of the AbstractButton.
protected  class AbstractButton.ButtonChangeListener
          An extension of ChangeListener to be serializable.
 
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
 
Nested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainer
 
Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy
 
Field Summary
protected  ActionListener actionListener
          Listener the button uses to receive ActionEvents from its model.
static String BORDER_PAINTED_CHANGED_PROPERTY
          Fired in a PropertyChangeEvent when the "borderPainted" property changes.
protected  ChangeEvent changeEvent
          ChangeEvent that is fired to button's ChangeEventListeners
protected  ChangeListener changeListener
          Listener the button uses to receive ChangeEvents from its model.
static String CONTENT_AREA_FILLED_CHANGED_PROPERTY
          Fired in a PropertyChangeEvent when the "contentAreaFilled" property changes.
static String DISABLED_ICON_CHANGED_PROPERTY
          Fired in a PropertyChangeEvent when the "disabledIcon" property changes.
static String DISABLED_SELECTED_ICON_CHANGED_PROPERTY
          Fired in a PropertyChangeEvent when the "disabledSelectedIcon" property changes.
static String FOCUS_PAINTED_CHANGED_PROPERTY
          Fired in a PropertyChangeEvent when the "focusPainted" property changes.
static String HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY
          Fired in a PropertyChangeEvent when the "horizontalAlignment" property changes.
static String HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY
          Fired in a PropertyChangeEvent when the "horizontalTextPosition" property changes.
static String ICON_CHANGED_PROPERTY
          Fired in a PropertyChangeEvent when the "icon" property changes.
protected  ItemListener itemListener
          Listener the button uses to receive ItemEvents from its model.
static String MARGIN_CHANGED_PROPERTY
          Fired in a PropertyChangeEvent when the "margin" property changes.
static String MNEMONIC_CHANGED_PROPERTY
          Fired in a PropertyChangeEvent when the "mnemonic" property changes.
protected  ButtonModel model
          The button's current state.
static String MODEL_CHANGED_PROPERTY
          Fired in a PropertyChangeEvent when the "model" property changes.
static String PRESSED_ICON_CHANGED_PROPERTY
          Fired in a PropertyChangeEvent when the "pressedIcon" property changes.
static String ROLLOVER_ENABLED_CHANGED_PROPERTY
          Fired in a PropertyChangeEvent when the "rolloverEnabled" property changes.
static String ROLLOVER_ICON_CHANGED_PROPERTY
          Fired in a PropertyChangeEvent when the "rolloverIcon" property changes.
static String ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY
          Fired in a PropertyChangeEvent when the "rolloverSelectedIcon" property changes.
static String SELECTED_ICON_CHANGED_PROPERTY
          Fired in a PropertyChangeEvent when the "selectedIcon" property changes.
static String TEXT_CHANGED_PROPERTY
          Fired in a PropertyChangeEvent when the "text" property changes.
static String VERTICAL_ALIGNMENT_CHANGED_PROPERTY
          Fired in a PropertyChangeEvent when the "verticalAlignment" property changes.
static String VERTICAL_TEXT_POSITION_CHANGED_PROPERTY
          Fired in a PropertyChangeEvent when the "verticalTextPosition" property changes.
 
Fields inherited from class javax.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface javax.swing.SwingConstants
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
AbstractButton()
          Creates a new AbstractButton object.
 
Method Summary
 void addActionListener(ActionListener l)
          Adds an ActionListener to the button's listener list.
 void addChangeListener(ChangeListener l)
          Adds a ChangeListener to the button's listener list.
protected  void addImpl(Component comp, Object constraints, int index)
          Adds the specified component to this AbstractButton.
 void addItemListener(ItemListener l)
          Adds an ItemListener to the button's listener list.
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.
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.
protected  void configurePropertiesFromAction(Action a)
          Configure various properties of the button by reading properties of an Action.
protected  ActionListener createActionListener()
          A factory method which should return an ActionListener that propagates events from the button's ButtonModel to any of the button's ActionListeners.
protected  PropertyChangeListener createActionPropertyChangeListener(Action a)
          A factory method which should return a PropertyChangeListener that accepts changes to the specified Action and reconfigure the AbstractButton, by default using the configurePropertiesFromAction(javax.swing.Action) method.
protected  ChangeListener createChangeListener()
          Factory method which creates a AbstractButton.ButtonChangeListener, used to subscribe to ChangeEvents from the button's model.
protected  ItemListener createItemListener()
          Factory method which creates a ItemListener, used to subscribe to ItemEvents from the button's model.
 void doClick()
          Programmatically perform a "click" on the button: arming, pressing, waiting, un-pressing, and disarming the model.
 void doClick(int pressTime)
          Programmatically perform a "click" on the button: arming, pressing, waiting, un-pressing, and disarming the model.
protected  void fireActionPerformed(ActionEvent e)
          Calls ActionListener.actionPerformed(java.awt.event.ActionEvent) on each ActionListener in the button's listener list.
protected  void fireItemStateChanged(ItemEvent e)
          Calls ItemListener.itemStateChanged(java.awt.event.ItemEvent) on each ItemListener in the button's listener list.
protected  void fireStateChanged()
          Calls AbstractButton.ButtonChangeListener.stateChanged(javax.swing.event.ChangeEvent) on each AbstractButton.ButtonChangeListener in the button's listener list.
 Action getAction()
          Get the value of the "action" property.
 String getActionCommand()
          Returns the action command string for this button's model.
 ActionListener[] getActionListeners()
          Returns all added ActionListener objects.
 ChangeListener[] getChangeListeners()
          Returns all added ChangeListener objects.
 Icon getDisabledIcon()
          Return the button's "disabledIcon" property.
 Icon getDisabledSelectedIcon()
          Return the button's disabled selected icon.
 int getDisplayedMnemonicIndex()
          Get the button's mnemonic index, which is an offset into the button's "text" property.
 int getHorizontalAlignment()
          Set the horizontal alignment of the button's text and icon.
 int getHorizontalTextPosition()
          Get the horizontal position of the button's text relative to its icon.
 Icon getIcon()
          Return the button's default "icon" property.
 int getIconTextGap()
          Get the value of the iconTextGap property.
 ItemListener[] getItemListeners()
          Returns all added ItemListener objects.
 String getLabel()
          Deprecated. use getText()
 Insets getMargin()
          Return the button's "margin" property, which is an Insets object describing the distance between the button's border and its text and icon.
 int getMnemonic()
          Get the current keyboard mnemonic value.
 ButtonModel getModel()
          Get the model the button is currently using.
 long getMultiClickThreshhold()
          Returns the current time in milliseconds in which clicks gets coalesced into a single ActionEvent.
 Icon getPressedIcon()
          Return the button's "pressedIcon" property.
 Icon getRolloverIcon()
          Return the button's rollover icon.
 Icon getRolloverSelectedIcon()
          Return the button's rollover selected icon.
 Icon getSelectedIcon()
          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.
 String getText()
          Return the button's "text" property.
 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.
 int getVerticalAlignment()
          Get the vertical alignment of the button's text and icon.
 int getVerticalTextPosition()
          Get the vertical position of the button's text relative to its icon.
 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.
protected  void init(String text, Icon icon)
           
 boolean isBorderPainted()
          Set the value of the "borderPainted" property.
 boolean isContentAreaFilled()
          Returns the value of the button's "contentAreaFilled" property.
 boolean isFocusPainted()
          Return the button's "paintFocus" property.
 boolean isRolloverEnabled()
          Returns whether or not rollover icon changes are enabled on the button.
 boolean isSelected()
          Get the value of the button's "selected" property.
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.
protected  String paramString()
          Returns a string, used only for debugging, which identifies or somehow represents this button.
 void removeActionListener(ActionListener l)
          Removes an ActionListener from the button's listener list.
 void removeChangeListener(ChangeListener l)
          Removes a ChangeListener from the button's listener list.
 void removeItemListener(ItemListener l)
          Removes an ItemListener from the button's listener list.
 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.
 void setActionCommand(String actionCommand)
          Sets the action command string for this button's model.
 void setBorderPainted(boolean b)
          Set the value of the "borderPainted" property.
 void setContentAreaFilled(boolean b)
          Sets the value of the button's "contentAreaFilled" property.
 void setDisabledIcon(Icon d)
          Set the button's "disabledIcon" property.
 void setDisabledSelectedIcon(Icon icon)
          Set the button's disabled selected icon.
 void setDisplayedMnemonicIndex(int index)
          Sets the button's mnemonic index.
 void setEnabled(boolean b)
          Enables or disables the button.
 void setFocusPainted(boolean p)
          Set the button's "paintFocus" property.
 void setHorizontalAlignment(int a)
          Set the horizontal alignment of the button's text and icon.
 void setHorizontalTextPosition(int t)
          Set the horizontal position of the button's text relative to its icon.
 void setIcon(Icon i)
          Set the button's default "icon" property.
 void setIconTextGap(int i)
          Set the value of the iconTextGap property.
 void setLabel(String label)
          Deprecated. use setText(text)
 void setLayout(LayoutManager layout)
          Sets a layout manager on this AbstractButton.
 void setMargin(Insets m)
          Set the button's "margin" property, which is an Insets object describing the distance between the button's border and its text and icon.
 void setMnemonic(char mne)
          Set the current keyboard mnemonic value.
 void setMnemonic(int mne)
          Set the current keyboard mnemonic value.
 void setModel(ButtonModel newModel)
          Set the model the button is currently using.
 void setMultiClickThreshhold(long threshhold)
          Sets the time in milliseconds in which clicks gets coalesced into a single ActionEvent.
 void setPressedIcon(Icon pressedIcon)
          Set the button's "pressedIcon" property.
 void setRolloverEnabled(boolean r)
          Set the "rolloverEnabled" property.
 void setRolloverIcon(Icon r)
          Set the button's rollover icon and sets the rolloverEnabled property to true.
 void setRolloverSelectedIcon(Icon r)
          Set the button's rollover selected icon and sets the rolloverEnabled property to true.
 void setSelected(boolean s)
          Set the value of the button's "selected" property.
 void setSelectedIcon(Icon s)
          Set the button's selected icon.
 void setText(String t)
          Set the button's "text" property.
 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.
 void setVerticalAlignment(int a)
          Set the vertical alignment of the button's text and icon.
 void setVerticalTextPosition(int t)
          Set the vertical position of the button's text relative to its icon.
 void updateUI()
          Set the "UI" property to a class constructed, via the UIManager, from the current look and feel.
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setNextFocusableComponent, setOpaque, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusDownCycle, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

model

protected ButtonModel model
The button's current state.


actionListener

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


itemListener

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


changeListener

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


changeEvent

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


BORDER_PAINTED_CHANGED_PROPERTY

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

See Also:
Constant Field Values

CONTENT_AREA_FILLED_CHANGED_PROPERTY

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

See Also:
Constant Field Values

DISABLED_ICON_CHANGED_PROPERTY

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

See Also:
Constant Field Values

DISABLED_SELECTED_ICON_CHANGED_PROPERTY

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

See Also:
Constant Field Values

FOCUS_PAINTED_CHANGED_PROPERTY

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

See Also:
Constant Field Values

HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY

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

See Also:
Constant Field Values

HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY

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

See Also:
Constant Field Values

ICON_CHANGED_PROPERTY

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

See Also:
Constant Field Values

MARGIN_CHANGED_PROPERTY

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

See Also:
Constant Field Values

MNEMONIC_CHANGED_PROPERTY

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

See Also:
Constant Field Values

MODEL_CHANGED_PROPERTY

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

See Also:
Constant Field Values

PRESSED_ICON_CHANGED_PROPERTY

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

See Also:
Constant Field Values

ROLLOVER_ENABLED_CHANGED_PROPERTY

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

See Also:
Constant Field Values

ROLLOVER_ICON_CHANGED_PROPERTY

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

See Also:
Constant Field Values

ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY

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

See Also:
Constant Field Values

SELECTED_ICON_CHANGED_PROPERTY

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

See Also:
Constant Field Values

TEXT_CHANGED_PROPERTY

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

See Also:
Constant Field Values

VERTICAL_ALIGNMENT_CHANGED_PROPERTY

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

See Also:
Constant Field Values

VERTICAL_TEXT_POSITION_CHANGED_PROPERTY

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

See Also:
Constant Field Values
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 init(String, Icon) method is not called automatically by this constructor.

See Also:
init(String, Icon)
Method Detail

getModel

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

Returns:
The current model

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

init

protected void init(String text,
                    Icon icon)

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

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.

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

removeActionListener

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

Parameters:
l - The listener to remove

getActionListeners

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

Returns:
an array of listeners
Since:
1.4

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.

Specified by:
addItemListener in interface ItemSelectable
Parameters:
l - The new listener to add

removeItemListener

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

Specified by:
removeItemListener in interface ItemSelectable
Parameters:
l - The listener to remove

getItemListeners

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

Returns:
an array of listeners
Since:
1.4

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

removeChangeListener

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

Parameters:
l - The listener to remove

getChangeListeners

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

Returns:
an array of listeners
Since:
1.4

fireItemStateChanged

protected void fireItemStateChanged(ItemEvent e)
Calls ItemListener.itemStateChanged(java.awt.event.ItemEvent) on each ItemListener in the button's listener list.

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

fireActionPerformed

protected void fireActionPerformed(ActionEvent e)
Calls ActionListener.actionPerformed(java.awt.event.ActionEvent) on each ActionListener in the button's listener list.

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

fireStateChanged

protected void fireStateChanged()
Calls AbstractButton.ButtonChangeListener.stateChanged(javax.swing.event.ChangeEvent) on each AbstractButton.ButtonChangeListener in the button's listener list.


getMnemonic

public int getMnemonic()
Get the current keyboard mnemonic value. This value corresponds to a single key code (one of the 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

setMnemonic

public void setMnemonic(char mne)
Set the current keyboard mnemonic value. This value corresponds to a single key code (one of the 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 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

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

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

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

isRolloverEnabled

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

Returns:
The state of the "rolloverEnabled" property

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

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

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.

Overrides:
setEnabled in class JComponent
Parameters:
b - Whether or not to enable the button
See Also:
Component.isEnabled(), Component.isLightweight()

getHorizontalAlignment

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

Returns:
The current horizontal alignment
See Also:
setHorizontalAlignment(int)

setHorizontalAlignment

public void setHorizontalAlignment(int a)
Set the horizontal alignment of the button's text and icon. The alignment is a numeric constant from 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()

getHorizontalTextPosition

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

Returns:
The current horizontal text position

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

getVerticalAlignment

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

Returns:
The current vertical alignment
See Also:
setVerticalAlignment(int)

setVerticalAlignment

public void setVerticalAlignment(int a)
Set the vertical alignment of the button's text and icon. The alignment is a numeric constant from 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()

getVerticalTextPosition

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

Returns:
The current vertical position

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

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.

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.

getAction

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

Returns:
The current value of the "action" property

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 configurePropertiesFromAction(javax.swing.Action), 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

getIcon

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

Returns:
The current default icon

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

getText

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

Returns:
The current "text" property

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

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

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

setIconTextGap

public void setIconTextGap(int i)
Set the value of the iconTextGap property.

Parameters:
i - The new value of the property
Since:
1.4

getIconTextGap

public int getIconTextGap()
Get the value of the iconTextGap property.

Returns:
The current value of the property
Since:
1.4

getMargin

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

Returns:
The current "margin" property

setMargin

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

Parameters:
m - The new "margin" property

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 ButtonModel is true. This property may be null, in which case the default icon is used.

Returns:
The current "pressedIcon" property

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 ButtonModel is true. This property may be null, in which case the default icon is used.

Parameters:
pressedIcon - The new "pressedIcon" property

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

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

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

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

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 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:
setHorizontalTextPosition(int), setHorizontalAlignment(int)

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 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:
setVerticalTextPosition(int), setVerticalAlignment(int)

configurePropertiesFromAction

protected void configurePropertiesFromAction(Action a)
Configure various properties of the button by reading properties of an 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 ActionListener that propagates events from the button's ButtonModel to any of the button's ActionListeners. By default, this is an inner class which calls fireActionPerformed(java.awt.event.ActionEvent) with a modified copy of the incoming model 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 PropertyChangeListener that accepts changes to the specified Action and reconfigure the AbstractButton, by default using the configurePropertiesFromAction(javax.swing.Action) method.

The button calls this method whenever a new Action is assigned to the button's "action" property, via setAction(javax.swing.Action), 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 AbstractButton.ButtonChangeListener, 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 ChangeEvent to the button's ChangeListeners, via the 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 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 ItemEvent to the button's ItemListeners, via the fireItemStateChanged(java.awt.event.ItemEvent) 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

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

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

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

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

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

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.

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

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

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.

Specified by:
getSelectedObjects in interface ItemSelectable
Returns:
The button's "selected object" array

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.

Specified by:
imageUpdate in interface ImageObserver
Overrides:
imageUpdate in class Component
Parameters:
img - The image being updated
infoflags - One of the constant codes in 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
See Also:
ImageObserver, Graphics.drawImage(Image, int, int, Color, ImageObserver), Graphics.drawImage(Image, int, int, ImageObserver), Graphics.drawImage(Image, int, int, int, int, Color, ImageObserver), Graphics.drawImage(Image, int, int, int, int, ImageObserver), ImageObserver.imageUpdate(Image, int, int, int, int, int)

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

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

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.

Overrides:
paintBorder in class JComponent
Parameters:
g - The graphics context used to paint the border
See Also:
JComponent.paint(java.awt.Graphics), JComponent.paintChildren(java.awt.Graphics), JComponent.paintComponent(java.awt.Graphics)

paramString

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

Overrides:
paramString in class JComponent
Returns:
A string representation of the button

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

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

updateUI

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

Overrides:
updateUI in class JComponent

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

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

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 OverlayLayout layout manager before adding the component. The layout manager is only installed if no other layout manager has been installed before.

Overrides:
addImpl in class Container
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

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, addImpl(Component, Object, int) installs an OverlayLayout before adding a component.

Overrides:
setLayout in class Container
Parameters:
layout - the layout manager to install
Since:
1.5