All Packages  Class Hierarchy  This Package  Previous  Next  Index  

Class java.awt.swing.AbstractButton

java.lang.Object
    |
    +----java.awt.Component
            |
            +----java.awt.Container
                    |
                    +----java.awt.swing.JComponent
                            |
                            +----java.awt.swing.AbstractButton

public abstract class AbstractButton

extends JComponent

implements ItemSelectable, SwingConstants

AbstractButton.ButtonChangeListener

Extend ChangeListener to be serializable

actionListener

changeEvent

Only one ChangeEvent is needed per button instance since the event's only state is the source property.

changeListener

The button's model listeners.

itemListener

model

AbstractButton()

addAccessibleSelection(int)

Calls setSelected(true);

addActionListener(ActionListener)

adds an ActionListener to the button

addChangeListener(ChangeListener)

Adds a ChangeListener to the button.

addItemListener(ItemListener)

adds an ItemListener to the checkbox

checkHorizontalKey(int, String)

Ensures that the key is a valid.

checkVerticalKey(int, String)

Ensures that the key is a valid.

clearAccessibleSelection()

Calls setSelected(false);

createActionListener()

createChangeListener()

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

createItemListener()

doAccessibleAction(int)

Perform the specified Action on the object

doClick()

Programatically perform a "click".

doClick(int)

Programatically perform a "click".

fireActionPerformed(ActionEvent)

fireItemStateChanged(ItemEvent)

fireStateChanged()

getAccessibleActionCount()

Returns the number of Actions available in this object.

getAccessibleActionDescription(int)

Return a description of the specified action of the object.

getAccessibleName()

Get the accessible name of this object.

getAccessibleSelection(int)

Returns an Accessible representing the specified selected item in the object.

getAccessibleSelectionCount()

Returns the number of items currently selected.

getAccessibleStateSet()

Get the state set of this object.

getAccessibleValue()

Get the value of this object as a Number.

getActionCommand()

Returns the action command for this button.

getDisabledIcon()

Returns the icon used by the button when it's disabled.

getDisabledSelectedIcon()

Returns the icon used by the button when it's disabled and selected.

getHorizontalAlignment()

Returns the horizontal alignment of the icon and text.

getHorizontalTextPosition()

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

getIcon()

Returns the default icon.

getKeyAccelerator()

Convenience to get the keyboard accelerator from the the current model

getLabel()

Deprecated.

getMargin()

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

getMaximumAccessibleValue()

Get the maximum value of this object as a Number.

getMinimumAccessibleValue()

Get the minimum value of this object as a Number.

getModel()

Get the model that this button represents.

getPressedIcon()

Returns the pressed icon for the button.

getRolloverIcon()

Returns the rollover icon for the button.

getRolloverSelectedIcon()

Returns the rollover seletion icon for the button.

getSelectedIcon()

Returns the selected icon for the button.

getSelectedObjects()

getText()

Returns the button's text.

getUI()

Returns the button's current UI.

getVerticalAlignment()

Returns the vertical alignment of the text and icon.

getVerticalTextPosition()

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

init(String, Icon)

isBorderPainted()

Returns whether the border should be painted.

isFocusPainted()

Returns whether focus should be painted.

isOpaque()

isRolloverEnabled()

Checks whether rollover effects are enabled.

isSelected()

Returns the state of the button.

paintBorder(Graphics)

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

removeAccessibleSelection(int)

Calls setSelected(false);

removeActionListener(ActionListener)

removes an ActionListener from the button

removeChangeListener(ChangeListener)

Removes a ChangeListener from the button.

removeItemListener(ItemListener)

removes an ItemListener from the button

selectAllAccessibleSelection()

Calls setSelected(true)

setAccessibleValue(Number)

Set the value of this object as a Number.

setActionCommand(String)

Sets the action command for this button.

setBorderPainted(boolean)

Sets whether the border should be painted.

setDisabledIcon(Icon)

Sets the disabled icon for the button.

setDisabledSelectedIcon(Icon)

Sets the disabled selection icon for the button.

setEnabled(boolean)

Enables (or disables) the button.

setFocusPainted(boolean)

Sets whether focus should be painted.

setHorizontalAlignment(int)

Sets the horizontal alignment of the icon and text.

setHorizontalTextPosition(int)

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

setIcon(Icon)

Sets the button's default icon.

setKeyAccelerator(int)

Convenience to set the keyboard accelerator on the current model

setLabel(String)

Deprecated.

setMargin(Insets)

Sets space for margin between the button's border and the label.

setModel(ButtonModel)

Set the model that this button represents.

setOpaque(boolean)

If true the buttons background will be filled with the background color.

setPressedIcon(Icon)

Sets the pressed icon for the button.

setRolloverEnabled(boolean)

Sets whether rollover effects should be enabled.

setRolloverIcon(Icon)

Sets the rollover icon for the button.

setRolloverSelectedIcon(Icon)

Sets the rollover selected icon for the button.

setSelected(boolean)

Sets the state of the button.

setSelectedIcon(Icon)

Sets the selected icon for the button.

setText(String)

Sets the button's text.

setUI(ButtonUI)

Sets the button's UI.

setVerticalAlignment(int)

Sets the vertical alignment of the icon and text.

setVerticalTextPosition(int)

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

updateUI()

Gets a new UI object from the default UIFactory.

protected ButtonModel model

protected ChangeListener changeListener

The button's model listeners.

protected ActionListener actionListener

protected ItemListener itemListener

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

public AbstractButton()

public String getText()

Returns the button's text.

See Also:

setText

public void setText(String text)

Sets the button's text.

Parameters:

t - the string used to set the text

See Also:

getText

public boolean isSelected()

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

public void setSelected(boolean b)

Sets the state of the button.

public void doClick()

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

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.

public void setMargin(Insets m)

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

Parameters:

m - the space between the border and the label

public Insets getMargin()

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

public Icon getIcon()

Returns the default icon.

See Also:

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

public Icon getPressedIcon()

Returns the pressed icon for the button.

See Also:

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

public Icon getSelectedIcon()

Returns the selected icon for the button.

See Also:

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

public Icon getRolloverIcon()

Returns the rollover icon for the button.

See Also:

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

public Icon getRolloverSelectedIcon()

Returns the rollover seletion icon for the button.

See Also:

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

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

public void setDisabledIcon(Icon disabledIcon)

Sets the disabled icon for the button.

Parameters:

g - the icon used as the disabled image

See Also:

getDisabledIcon

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

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

public int getVerticalAlignment()

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

public void setVerticalAlignment(int alignment)

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

public int getHorizontalAlignment()

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

public void setHorizontalAlignment(int alignment)

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

public int getVerticalTextPosition()

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

public void setVerticalTextPosition(int textPosition)

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

public int getHorizontalTextPosition()

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

public void setHorizontalTextPosition(int textPosition)

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

protected int checkHorizontalKey(int key,
                                 String exception)

Ensures that the key is a valid. Throws an IllegalArgument exception exception otherwise.

protected int checkVerticalKey(int key,
                               String exception)

Ensures that the key is a valid. Throws an IllegalArgument exception exception otherwise.

public void setActionCommand(String actionCommand)

Sets the action command for this button.

public String getActionCommand()

Returns the action command for this button.

public boolean isBorderPainted()

Returns whether the border should be painted.

See Also:

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

protected void paintBorder(Graphics g)

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

Overrides:

paintBorder in class JComponent

See Also:

paint, setBorder

public boolean isFocusPainted()

Returns whether focus should be painted.

See Also:

setFocusPainted

public void setFocusPainted(boolean b)

Sets whether focus should be painted.

Parameters:

b - if true, the focus state is painted.

See Also:

isFocusPainted

public boolean isRolloverEnabled()

Checks whether rollover effects are enabled.

See Also:

setFocusPainted

public void setRolloverEnabled(boolean b)

Sets whether rollover effects should be enabled.

Parameters:

b - if true, rollover effects should be painted.

See Also:

isRolloverEnabled

public void setOpaque(boolean isOpaque)

If true the buttons background will be filled with the background color.

The default value of this property is true.

This is a JavaBeans bound property.

See Also:

isOpaque, getBackground

public boolean isOpaque()

Returns:

The value of the opaque property.

Overrides:

isOpaque in class JComponent

See Also:

setOpaque

public int getKeyAccelerator()

Convenience to get the keyboard accelerator from the the current model

public void setKeyAccelerator(int keyAccelerator)

Convenience to set the keyboard accelerator on the current model

public ButtonModel getModel()

Get the model that this button represents.

See Also:

setModel

public void setModel(ButtonModel newModel)

Set the model that this button represents.

Parameters:

m - the Model

See Also:

getModel

public ButtonUI getUI()

Returns the button's current UI.

See Also:

setUI

public void setUI(ButtonUI ui)

Sets the button's UI.

Parameters:

ui - the new ButtonUI

See Also:

getUI

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.basic.BasicButtonUI", this));

Overrides:

updateUI in class JComponent

public void addChangeListener(ChangeListener l)

Adds a ChangeListener to the button.

public void removeChangeListener(ChangeListener l)

Removes a ChangeListener from the button.

protected void fireStateChanged()

public void addActionListener(ActionListener l)

adds an ActionListener to the button

public void removeActionListener(ActionListener l)

removes an ActionListener from the button

protected ChangeListener createChangeListener()

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

protected void fireActionPerformed(ActionEvent event)

protected void fireItemStateChanged(ItemEvent event)

protected ActionListener createActionListener()

protected ItemListener createItemListener()

public void setEnabled(boolean b)

Enables (or disables) the button.

Overrides:

setEnabled in class Component

public String getLabel()

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

public void setLabel(String label)

Note: setLabel() is deprecated. - Replaced by setText(text)

public void addItemListener(ItemListener l)

adds an ItemListener to the checkbox

public void removeItemListener(ItemListener l)

removes an ItemListener from the button

public Object[] getSelectedObjects()

protected void init(String text,
                    Icon icon)

public String getAccessibleName()

Get the accessible name of this object.

Returns:

the localized name of the object -- can be null if this object does not have a name

Overrides:

getAccessibleName in class JComponent

See Also:

setAccessibleName

public AccessibleStateSet getAccessibleStateSet()

Get the state set of this object.

Returns:

an instance of AccessibleState containing the current state of the object

Overrides:

getAccessibleStateSet in class JComponent

See Also:

AccessibleState

public Number getAccessibleValue()

Get the value of this object as a Number.

Returns:

An Integer of 0 if this isn't selected or an Integer of 1 if this is selected.

Overrides:

getAccessibleValue in class JComponent

See Also:

isSelected

public boolean setAccessibleValue(Number n)

Set the value of this object as a Number.

Returns:

True if the value was set.

Overrides:

setAccessibleValue in class JComponent

public Number getMinimumAccessibleValue()

Get the minimum value of this object as a Number.

Returns:

An Integer of 0.

Overrides:

getMinimumAccessibleValue in class JComponent

public Number getMaximumAccessibleValue()

Get the maximum value of this object as a Number.

Returns:

An Integer of 1.

Overrides:

getMaximumAccessibleValue in class JComponent

public int getAccessibleSelectionCount()

Returns the number of items currently selected. If no items are selected, the return value will be 0.

Returns:

1 if this is selected; otherwise 0.

Overrides:

getAccessibleSelectionCount in class JComponent

public Accessible getAccessibleSelection(int i)

Returns an Accessible representing the specified selected item in the object. If there isn't a selection, or there are fewer items selcted than the integer passed in, the return value will be null.

Parameters:

i - the zero-based index of selected items

Returns:

this if this is selected; otherwise null.

Overrides:

getAccessibleSelection in class JComponent

public void addAccessibleSelection(int i)

Calls setSelected(true);

Overrides:

addAccessibleSelection in class JComponent

See Also:

setSelected

public void removeAccessibleSelection(int i)

Calls setSelected(false);

Overrides:

removeAccessibleSelection in class JComponent

See Also:

setSelected

public void clearAccessibleSelection()

Calls setSelected(false);

Overrides:

clearAccessibleSelection in class JComponent

See Also:

setSelected

public void selectAllAccessibleSelection()

Calls setSelected(true)

Overrides:

selectAllAccessibleSelection in class JComponent

See Also:

setSelected

public int getAccessibleActionCount()

Returns the number of Actions available in this object. If there is more than one, the first one is the "default" action.

Returns:

the number of Actions in this object

Overrides:

getAccessibleActionCount in class JComponent

public String getAccessibleActionDescription(int i)

Return a description of the specified action of the object.

Parameters:

i - zero-based index of the actions

Returns:

a description of the action ("press").

Overrides:

getAccessibleActionDescription in class JComponent

public boolean doAccessibleAction(int i)

Perform the specified Action on the object

Parameters:

i - zero-based index of actions

Returns:

true if the the action was performed; else false.

Overrides:

doAccessibleAction in class JComponent

All Packages  Class Hierarchy  This Package  Previous  Next  Index