Contents | Package | Class | Tree | Deprecated | Index | Help Java 1.2 Beta 3
PREV | NEXT SHOW LISTS | HIDE LISTS

Class java.awt.swing.AbstractButton

java.lang.Object
    |
    +----java.awt.Component
            |
            +----java.awt.Container
                    |
                    +----java.awt.swing.JComponent
                            |
                            +----java.awt.swing.AbstractButton
Subclasses:
JButton, JMenuItem, JToggleButton

public abstract class AbstractButton
extends JComponent
implements ItemSelectable, SwingConstants
Defines the common behaviors for the JButton, JToggleButton, JCheckbox, and the JRadioButton classes.

Warning: serialized objects of this class will not be compatible with future swing releases. The current serialization support is appropriate for short term storage or RMI between Swing1.0 applications. It will not be possible to load serialized Swing1.0 objects with future releases of Swing. The JDK1.2 release of Swing will be the compatibility baseline for the serialized form of Swing objects.


Inner Class Summary
 AbstractButton.AccessibleAbstractButton
Accessiblity support.
 AbstractButton.ButtonChangeListener
Extend ChangeListener to be serializable

Warning: serialized objects of this class will not be compatible with future swing releases.

 
Inner classes inherited from class java.awt.swing.JComponent
 JComponent.AccessibleJComponent
 

Field Summary
ActionListener  actionListener
 
ChangeEvent  changeEvent
Only one ChangeEvent is needed per button instance since the event's only state is the source property.
ChangeListener  changeListener
The button's model listeners.
ItemListener  itemListener
 
ButtonModel  model
 
 
Fields inherited from class java.awt.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
 

Constructor Summary
 AbstractButton()
 
 

Method Summary
void  addActionListener(ActionListener l)
adds an ActionListener to the button
void  addChangeListener(ChangeListener l)
Adds a ChangeListener to the button.
void  addItemListener(ItemListener l)
adds an ItemListener to the checkbox
int  checkHorizontalKey(int key, String exception)
Ensures that the key is a valid.
int  checkVerticalKey(int key, String exception)
Ensures that the key is a valid.
ActionListener  createActionListener()
 
ChangeListener  createChangeListener()
Subclasses that want to handle ChangeEvents differently can override this to return another ChangeListener implementation.
ItemListener  createItemListener()
 
void  doClick()
Programatically perform a "click".
void  doClick(int pressTime)
Programatically perform a "click".
void  fireActionPerformed(ActionEvent event)
 
void  fireItemStateChanged(ItemEvent event)
 
void  fireStateChanged()
 
String  getActionCommand()
Returns the action command for this button.
Icon  getDisabledIcon()
Returns the icon used by the button when it's disabled.
Icon  getDisabledSelectedIcon()
Returns the icon used by the button when it's disabled and selected.
int  getHorizontalAlignment()
Returns the horizontal alignment of the icon and text.
int  getHorizontalTextPosition()
Sets the horizontal position of the text relative to the icon.
Icon  getIcon()
Returns the default icon.
String  getLabel()
  Deprecated
Insets  getMargin()
Returns the margin between the button's border and the label.
int  getMnemonic()
Convenience to get the keyboard mnemonic from the the current model
ButtonModel  getModel()
Get the model that this button represents.
Icon  getPressedIcon()
Returns the pressed icon for the button.
Icon  getRolloverIcon()
Returns the rollover icon for the button.
Icon  getRolloverSelectedIcon()
Returns the rollover seletion icon for the button.
Icon  getSelectedIcon()
Returns the selected icon for the button.
Object[]  getSelectedObjects()
 
String  getText()
Returns the button's text.
java.awt.swing.plaf.ButtonUI  getUI()
Returns the button's current UI.
int  getVerticalAlignment()
Returns the vertical alignment of the text and icon.
int  getVerticalTextPosition()
Returns the vertical position of the text relative to the icon Valid keys: CENTER (the default), TOP, BOTTOM
void  init(String text, Icon icon)
 
boolean  isBorderPainted()
Returns whether the border should be painted.
boolean  isFocusPainted()
Returns whether focus should be painted.
boolean  isRolloverEnabled()
Checks whether rollover effects are enabled.
boolean  isSelected()
Returns the state of the button.
void  paintBorder(Graphics g)
Paint the button's border if BorderPainted property is true.
void  removeActionListener(ActionListener l)
removes an ActionListener from the button
void  removeChangeListener(ChangeListener l)
Removes a ChangeListener from the button.
void  removeItemListener(ItemListener l)
removes an ItemListener from the button
void  setActionCommand(String actionCommand)
Sets the action command for this button.
void  setBorderPainted(boolean b)
Sets whether the border should be painted.
void  setDisabledIcon(Icon disabledIcon)
Sets the disabled icon for the button.
void  setDisabledSelectedIcon(Icon disabledSelectedIcon)
Sets the disabled selection icon for the button.
void  setEnabled(boolean b)
Enables (or disables) the button.
void  setFocusPainted(boolean b)
Sets whether focus should be painted.
void  setHorizontalAlignment(int alignment)
Sets the horizontal alignment of the icon and text.
void  setHorizontalTextPosition(int textPosition)
Sets the horizontal position of the text relative to the icon.
void  setIcon(Icon defaultIcon)
Sets the button's default icon.
void  setLabel(String label)
  Deprecated
void  setMargin(Insets m)
Sets space for margin between the button's border and the label.
void  setMnemonic(int mnemonic)
Convenience to set the keyboard mnemonic on the current model
void  setMnemonic(char mnemonic)
 
void  setModel(ButtonModel newModel)
Set the model that this button represents.
void  setPressedIcon(Icon pressedIcon)
Sets the pressed icon for the button.
void  setRolloverEnabled(boolean b)
Sets whether rollover effects should be enabled.
void  setRolloverIcon(Icon rolloverIcon)
Sets the rollover icon for the button.
void  setRolloverSelectedIcon(Icon rolloverSelectedIcon)
Sets the rollover selected icon for the button.
void  setSelected(boolean b)
Sets the state of the button.
void  setSelectedIcon(Icon selectedIcon)
Sets the selected icon for the button.
void  setText(String text)
Sets the button's text.
void  setUI(java.awt.swing.plaf.ButtonUI ui)
Sets the button's UI.
void  setVerticalAlignment(int alignment)
Sets the vertical alignment of the icon and text.
void  setVerticalTextPosition(int textPosition)
Sets the vertical position of the text relative to the icon.
void  updateUI()
Gets a new UI object from the default UIFactory.
 
Methods inherited from class java.awt.swing.JComponent
 addAncestorListener, addNotify, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInsets, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getUIClassID, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, processComponentKeyEvent, processFocusEvent, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setBounds, setDebugGraphicsOptions, setDoubleBuffered, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVisible, unregisterKeyboardAction, update, updateUI
 
Methods inherited from class java.awt.Container
 add, add, add, add, add, addContainerListener, addImpl, addNotify, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paint, paintComponents, paramString, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setLayout, update, validate, validateTree
 
Methods inherited from class java.awt.Component
 action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, getAlignmentX, getAlignmentY, getBackground, getBounds, getColorModel, getComponentAt, getComponentAt, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getName, getParent, getPeer, getPreferredSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isDisplayable, isEnabled, isFocusTraversable, isLightweight, isOpaque, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, paramString, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processEvent, processFocusEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, reshape, resize, resize, setBackground, setBounds, setBounds, setCursor, setDropTarget, setEnabled, setFont, setForeground, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, show, size, toString, transferFocus, update, validate
 
Methods inherited from class java.lang.Object
 clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

model

protected ButtonModel model

changeListener

protected ChangeListener changeListener
The button's model listeners.

actionListener

protected ActionListener actionListener

itemListener

protected ItemListener itemListener

changeEvent

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

AbstractButton

public AbstractButton()
Method Detail

getText

public String getText()
Returns the button's text.
See Also:
setText

setText

public void setText(String text)
Sets the button's text.
Parameters:
t - the string used to set the text
See Also:
getText

isSelected

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

setSelected

public void setSelected(boolean b)
Sets the state of the button.

doClick

public void doClick()
Programatically perform a "click". This does the same thing as if the user had pressed and released the button.

doClick

public void doClick(int pressTime)
Programatically perform a "click". This does the same thing as if the user had pressed and released the button. The button stays visually "pressed" for pressTime milliseconds.

setMargin

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

getMargin

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

getIcon

public Icon getIcon()
Returns the default icon.
See Also:
setIcon

setIcon

public void setIcon(Icon defaultIcon)
Sets the button's default icon. This icon is also used as the "pressed" and "disabled" icon if there is no explicitly set pressed icon.
Parameters:
g - the icon used as the default image
See Also:
getIcon, setPressedIcon

getPressedIcon

public Icon getPressedIcon()
Returns the pressed icon for the button.
See Also:
setPressedIcon

setPressedIcon

public void setPressedIcon(Icon pressedIcon)
Sets the pressed icon for the button.
Parameters:
g - the icon used as the "pressed" image
See Also:
getPressedIcon

getSelectedIcon

public Icon getSelectedIcon()
Returns the selected icon for the button.
See Also:
setSelectedIcon

setSelectedIcon

public void setSelectedIcon(Icon selectedIcon)
Sets the selected icon for the button.
Parameters:
g - the icon used as the "selected" image
See Also:
getSelectedIcon

getRolloverIcon

public Icon getRolloverIcon()
Returns the rollover icon for the button.
See Also:
setRolloverIcon

setRolloverIcon

public void setRolloverIcon(Icon rolloverIcon)
Sets the rollover icon for the button.
Parameters:
g - the icon used as the "rollover" image
See Also:
getRolloverIcon

getRolloverSelectedIcon

public Icon getRolloverSelectedIcon()
Returns the rollover seletion icon for the button.
See Also:
setRolloverSelectedIcon

setRolloverSelectedIcon

public void setRolloverSelectedIcon(Icon rolloverSelectedIcon)
Sets the rollover selected icon for the button.
Parameters:
g - the icon used as the "selected rollover" image
See Also:
getRolloverSelectedIcon

getDisabledIcon

public Icon getDisabledIcon()
Returns the icon used by the button when it's disabled. If not no disabled icon has been set, the button constructs one from the default icon. PENDING(jeff): the disabled icon really should be created (if necesary) by the L&F.
See Also:
getPressedIcon, setDisabledIcon

setDisabledIcon

public void setDisabledIcon(Icon disabledIcon)
Sets the disabled icon for the button.
Parameters:
g - the icon used as the disabled image
See Also:
getDisabledIcon

getDisabledSelectedIcon

public Icon getDisabledSelectedIcon()
Returns the icon used by the button when it's disabled and selected. If not no disabled selection icon has been set, the button constructs one from the selection icon. PENDING(jeff): the disabled selection icon really should be created (if necesary) by the L&F.
See Also:
getPressedIcon, setDisabledIcon

setDisabledSelectedIcon

public void setDisabledSelectedIcon(Icon disabledSelectedIcon)
Sets the disabled selection icon for the button.
Parameters:
g - the icon used as the disabled selection image
See Also:
getDisabledSelectedIcon

getVerticalAlignment

public int getVerticalAlignment()
Returns the vertical alignment of the text and icon. Valid keys: CENTER (the default), TOP, BOTTOM

setVerticalAlignment

public void setVerticalAlignment(int alignment)
Sets the vertical alignment of the icon and text. Valid keys: CENTER (the default), TOP, BOTTOM

getHorizontalAlignment

public int getHorizontalAlignment()
Returns the horizontal alignment of the icon and text. Valid keys: CENTER (the default), LEFT, RIGHT

setHorizontalAlignment

public void setHorizontalAlignment(int alignment)
Sets the horizontal alignment of the icon and text. Valid keys: CENTER (the default), LEFT, RIGHT

getVerticalTextPosition

public int getVerticalTextPosition()
Returns the vertical position of the text relative to the icon Valid keys: CENTER (the default), TOP, BOTTOM

setVerticalTextPosition

public void setVerticalTextPosition(int textPosition)
Sets the vertical position of the text relative to the icon. Valid keys: CENTER (the default), TOP, BOTTOM

getHorizontalTextPosition

public int getHorizontalTextPosition()
Sets the horizontal position of the text relative to the icon. Valid keys: RIGHT (the default), LEFT, CENTER

setHorizontalTextPosition

public void setHorizontalTextPosition(int textPosition)
Sets the horizontal position of the text relative to the icon. Valid keys: RIGHT (the default), LEFT, CENTER

checkHorizontalKey

protected int checkHorizontalKey(int key,
                                 String exception)
Ensures that the key is a valid. Throws an IllegalArgument exception exception otherwise.

checkVerticalKey

protected int checkVerticalKey(int key,
                               String exception)
Ensures that the key is a valid. Throws an IllegalArgument exception exception otherwise.

setActionCommand

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

getActionCommand

public String getActionCommand()
Returns the action command for this button.

isBorderPainted

public boolean isBorderPainted()
Returns whether the border should be painted.
See Also:
setBorderPainted

setBorderPainted

public void setBorderPainted(boolean b)
Sets whether the border should be painted.
Parameters:
b - if true and border property is not null, the border is painted.
See Also:
isBorderPainted

paintBorder

protected void paintBorder(Graphics g)
Paint the button's border if BorderPainted property is true.
Overrides:
paintBorder in class JComponent
See Also:
paint, setBorder

isFocusPainted

public boolean isFocusPainted()
Returns whether focus should be painted.
See Also:
setFocusPainted

setFocusPainted

public void setFocusPainted(boolean b)
Sets whether focus should be painted.
Parameters:
b - if true, the focus state is painted.
See Also:
isFocusPainted

isRolloverEnabled

public boolean isRolloverEnabled()
Checks whether rollover effects are enabled.
See Also:
setFocusPainted

setRolloverEnabled

public void setRolloverEnabled(boolean b)
Sets whether rollover effects should be enabled.
Parameters:
b - if true, rollover effects should be painted.
See Also:
isRolloverEnabled

getMnemonic

public int getMnemonic()
Convenience to get the keyboard mnemonic from the the current model

setMnemonic

public void setMnemonic(int mnemonic)
Convenience to set the keyboard mnemonic on the current model
Parameters:
mnemonic - the key code which represents the mnemonic

setMnemonic

public void setMnemonic(char mnemonic)

getModel

public ButtonModel getModel()
Get the model that this button represents.
See Also:
setModel

setModel

public void setModel(ButtonModel newModel)
Set the model that this button represents.
Parameters:
m - the Model
See Also:
getModel

getUI

public java.awt.swing.plaf.ButtonUI getUI()
Returns the button's current UI.
See Also:
setUI

setUI

public void setUI(java.awt.swing.plaf.ButtonUI ui)
Sets the button's UI.
Parameters:
ui - the new ButtonUI
See Also:
getUI

updateUI

public void updateUI()
Gets a new UI object from the default UIFactory. Subtypes of AbstractButton should override this to update the UI. For example, JButton might do the following: setUI((ButtonUI)UIManager.getUI( "ButtonUI", "java.awt.swing.plaf.basic.BasicButtonUI", this));
Overrides:
updateUI in class JComponent

addChangeListener

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

removeChangeListener

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

fireStateChanged

protected void fireStateChanged()

addActionListener

public void addActionListener(ActionListener l)
adds an ActionListener to the button

removeActionListener

public void removeActionListener(ActionListener l)
removes an ActionListener from the button

createChangeListener

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

fireActionPerformed

protected void fireActionPerformed(ActionEvent event)

fireItemStateChanged

protected void fireItemStateChanged(ItemEvent event)

createActionListener

protected ActionListener createActionListener()

createItemListener

protected ItemListener createItemListener()

setEnabled

public void setEnabled(boolean b)
Enables (or disables) the button.
Overrides:
setEnabled in class Component

getLabel

public String getLabel()
Note: getLabel() is deprecated.- Replaced by getText()


setLabel

public void setLabel(String label)
Note: setLabel() is deprecated.- Replaced by setText(text)


addItemListener

public void addItemListener(ItemListener l)
adds an ItemListener to the checkbox
Implements:
addItemListener in interface ItemSelectable

removeItemListener

public void removeItemListener(ItemListener l)
removes an ItemListener from the button
Implements:
removeItemListener in interface ItemSelectable

getSelectedObjects

public Object[] getSelectedObjects()
Implements:
getSelectedObjects in interface ItemSelectable

init

protected void init(String text,
                    Icon icon)

Contents | Package | Class | Tree | Deprecated | Index | Help Java 1.2 Beta 3
PREV | NEXT SHOW LISTS | HIDE LISTS

Submit a bug or feature
Submit comments/suggestions about new javadoc look.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.