| Overview | Package | Class | Tree | Deprecated | Index | Help | Legend |
|
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Object
|
+--java.awt.Component
|
+--java.awt.Container
|
+--javax.swing.JComponent
|
+--javax.swing.AbstractButton
Safe: Defines common behaviors for buttons and menu items. For further information see How to Use Buttons, Check Boxes, and Radio Buttons, a section in The Java Tutorial.
Warning:
Serialized objects of this class will not be compatible with
future Swing releases. The current serialization support is
appropriate for short term storage or RMI between applications running
the same version of Swing. As of 1.4, support for long term storage
of all JavaBeansTM
has been added to the java.beans package.
Please see java.beans.XMLEncoder.
| Field Summary | |
private AccessibleIcon |
accessibleIcon
|
private Action |
action
|
protected ActionListener |
actionListener
The button model's ActionListener. |
private java.beans.PropertyChangeListener |
actionPropertyChangeListener
|
static String |
BORDER_PAINTED_CHANGED_PROPERTY
Suppressed: Identifies a change to having the border drawn, or having it not drawn. |
protected ChangeEvent |
changeEvent
Only one ChangeEvent is needed per button
instance since the
event's only state is the source property. |
protected ChangeListener |
changeListener
The button model's changeListener. |
static String |
CONTENT_AREA_FILLED_CHANGED_PROPERTY
Suppressed: Identifies a change to having the button paint the content area. |
private boolean |
contentAreaFilled
|
private Icon |
defaultIcon
|
private Insets |
defaultMargin
|
static String |
DISABLED_ICON_CHANGED_PROPERTY
Suppressed: Identifies a change to the icon used when the button has been disabled. |
static String |
DISABLED_SELECTED_ICON_CHANGED_PROPERTY
Suppressed: Identifies a change to the icon used when the button has been disabled and selected. |
private Icon |
disabledIcon
|
private Icon |
disabledSelectedIcon
|
static String |
FOCUS_PAINTED_CHANGED_PROPERTY
Suppressed: Identifies a change to having the border highlighted when focused, or not. |
static String |
HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY
Suppressed: Identifies a change in the button's horizontal alignment. |
static String |
HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY
Suppressed: Identifies a change in the button's horizontal text position. |
private int |
horizontalAlignment
|
private int |
horizontalTextPosition
|
static String |
ICON_CHANGED_PROPERTY
Suppressed: Identifies a change to the icon that represents the button. |
private int |
iconTextGap
|
protected ItemListener |
itemListener
The button model's ItemListener. |
private Insets |
margin
|
static String |
MARGIN_CHANGED_PROPERTY
Suppressed: Identifies a change in the button's margins. |
private int |
mnemonic
|
static String |
MNEMONIC_CHANGED_PROPERTY
Suppressed: Identifies a change to the button's mnemonic. |
private int |
mnemonicIndex
|
protected ButtonModel |
model
The data model that determines the button's state. |
static String |
MODEL_CHANGED_PROPERTY
Suppressed: Identifies a change in the button model. |
private long |
multiClickThreshhold
|
private boolean |
paintBorder
|
private boolean |
paintFocus
|
static String |
PRESSED_ICON_CHANGED_PROPERTY
Suppressed: Identifies a change to the icon used when the button has been pressed. |
private Icon |
pressedIcon
|
static String |
ROLLOVER_ENABLED_CHANGED_PROPERTY
Suppressed: Identifies a change from rollover enabled to disabled or back to enabled. |
static String |
ROLLOVER_ICON_CHANGED_PROPERTY
Suppressed: Identifies a change to the icon used when the cursor is over the button. |
static String |
ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY
Suppressed: Identifies a change to the icon used when the cursor is over the button and it has been selected. |
private boolean |
rolloverEnabled
|
private Icon |
rolloverIcon
|
private Icon |
rolloverSelectedIcon
|
static String |
SELECTED_ICON_CHANGED_PROPERTY
Suppressed: Identifies a change to the icon used when the button has been selected. |
private Icon |
selectedIcon
|
private String |
text
|
static String |
TEXT_CHANGED_PROPERTY
Suppressed: Identifies a change in the button's text. |
static String |
VERTICAL_ALIGNMENT_CHANGED_PROPERTY
Suppressed: Identifies a change in the button's vertical alignment. |
static String |
VERTICAL_TEXT_POSITION_CHANGED_PROPERTY
Suppressed: Identifies a change in the button's vertical text position. |
private int |
verticalAlignment
|
private int |
verticalTextPosition
|
| Fields inherited from class javax.swing.JComponent |
_bounds, accessibleContext, listenerList, paintingChild, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW |
| Fields inherited from class java.awt.Container |
|
| 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 |
| Constructor Summary | |
AbstractButton()
Enabled: |
|
| Method Summary | |
void |
addActionListener(ActionListener l)
Enabled: Adds an ActionListener to the button. |
void |
addChangeListener(ChangeListener l)
Enabled: Adds a ChangeListener to the button. |
void |
addItemListener(ItemListener l)
Enabled: Adds an ItemListener to the checkbox. |
protected int |
checkHorizontalKey(int key,
String exception)
Verify that key is a legal value for the horizontalAlignment properties. |
protected int |
checkVerticalKey(int key,
String exception)
Ensures that the key is a valid. |
protected void |
configurePropertiesFromAction(Action a)
Factory method which sets the ActionEvent
source's properties according to values from the
Action instance. |
(package private) void |
configurePropertiesFromAction(Action a,
String[] types)
Configures the AbstractButton's properties according to values from the Action instance. |
protected ActionListener |
createActionListener()
|
protected java.beans.PropertyChangeListener |
createActionPropertyChangeListener(Action a)
Factory method which creates the PropertyChangeListener
used to update the ActionEvent source as properties
change on its Action instance. |
protected ChangeListener |
createChangeListener()
Subclasses that want to handle ChangeEvents differently
can override this to return another ChangeListener
implementation. |
protected ItemListener |
createItemListener()
|
void |
doClick()
Suppressed: Programmatically perform a "click". |
void |
doClick(int pressTime)
Suppressed: Programmatically perform a "click". |
protected void |
fireActionPerformed(ActionEvent event)
Notifies all listeners that have registered interest for notification on this event type. |
protected void |
fireItemStateChanged(ItemEvent event)
Notifies all listeners that have registered interest for notification on this event type. |
protected void |
fireStateChanged()
Notifies all listeners that have registered interest for notification on this event type. |
Action |
getAction()
Suppressed: Returns the currently set Action for this
ActionEvent source, or null
if no Action is set. |
String |
getActionCommand()
Suppressed: Returns the action command for this button. |
ActionListener[] |
getActionListeners()
Suppressed: Returns an array of all the ActionListeners added
to this AbstractButton with addActionListener(). |
ChangeListener[] |
getChangeListeners()
Suppressed: Returns an array of all the ChangeListeners added
to this AbstractButton with addChangeListener(). |
Icon |
getDisabledIcon()
Enabled: Returns the icon used by the button when it's disabled. |
Icon |
getDisabledSelectedIcon()
Enabled: Returns the icon used by the button when it's disabled and selected. |
int |
getDisplayedMnemonicIndex()
Enabled: Returns the character, as an index, that the look and feel should provide decoration for as representing the mnemonic character. |
int |
getHorizontalAlignment()
Enabled: Returns the horizontal alignment of the icon and text. |
int |
getHorizontalTextPosition()
Enabled: Returns the horizontal position of the text relative to the icon. |
Icon |
getIcon()
Enabled: Returns the default icon. |
int |
getIconTextGap()
Suppressed: Returns the amount of space between the text and the icon displayed in this button. |
ItemListener[] |
getItemListeners()
Suppressed: Returns an array of all the ItemListeners added
to this AbstractButton with addItemListener(). |
String |
getLabel()
Deprecated. - Replaced by getText |
Insets |
getMargin()
Enabled: Returns the margin between the button's border and the label. |
int |
getMnemonic()
Enabled: Returns the keyboard mnemonic from the the current model. |
ButtonModel |
getModel()
Enabled: Returns the model that this button represents. |
long |
getMultiClickThreshhold()
Enabled: Gets the amount of time (in milliseconds) required between mouse press events for the button to generate the corresponding action events. |
Icon |
getPressedIcon()
Enabled: Returns the pressed icon for the button. |
Icon |
getRolloverIcon()
Enabled: Returns the rollover icon for the button. |
Icon |
getRolloverSelectedIcon()
Enabled: Returns the rollover selection icon for the button. |
Icon |
getSelectedIcon()
Enabled: Returns the selected icon for the button. |
Object[] |
getSelectedObjects()
Enabled: Returns an array (length 1) containing the label or null if the button is not selected. |
String |
getText()
Enabled: Returns the button's text. |
javax.swing.plaf.ButtonUI |
getUI()
Enabled: Returns the L&F object that renders this component. |
int |
getVerticalAlignment()
Enabled: Returns the vertical alignment of the text and icon. |
int |
getVerticalTextPosition()
Enabled: Returns the vertical position of the text relative to the icon. |
boolean |
imageUpdate(Image img,
int infoflags,
int x,
int y,
int w,
int h)
Enabled: This is overridden to return false if the current Icon's
Image is not equal to the
passed in Image img. |
protected void |
init(String text,
Icon icon)
|
boolean |
isBorderPainted()
Enabled: Gets the borderPainted property. |
boolean |
isContentAreaFilled()
Enabled: Gets the contentAreaFilled property. |
boolean |
isFocusPainted()
Enabled: Gets the paintFocus property. |
private boolean |
isListener(Class c,
ActionListener a)
|
boolean |
isRolloverEnabled()
Enabled: Gets the rolloverEnabled property. |
boolean |
isSelected()
Enabled: Returns the state of the button. |
protected void |
paintBorder(Graphics g)
Paint the button's border if BorderPainted
property is true and the button has a border. |
protected String |
paramString()
Returns a string representation of this AbstractButton. |
void |
removeActionListener(ActionListener l)
Enabled: Removes an ActionListener from the button. |
void |
removeChangeListener(ChangeListener l)
Enabled: Removes a ChangeListener from the button. |
void |
removeItemListener(ItemListener l)
Enabled: Removes an ItemListener from the button. |
void |
setAction(Action a)
Enabled: Sets the Action for the ActionEvent source. |
void |
setActionCommand(String actionCommand)
Enabled: Sets the action command for this button. |
void |
setBorderPainted(boolean b)
Enabled: Sets the borderPainted property. |
void |
setContentAreaFilled(boolean b)
Enabled: Sets the contentAreaFilled property. |
void |
setDisabledIcon(Icon disabledIcon)
Enabled: Sets the disabled icon for the button. |
void |
setDisabledSelectedIcon(Icon disabledSelectedIcon)
Enabled: Sets the disabled selection icon for the button. |
void |
setDisplayedMnemonicIndex(int index)
Enabled: Provides a hint to the look and feel as to which character in the text should be decorated to represent the mnemonic. |
void |
setEnabled(boolean b)
Enabled: Enables (or disables) the button. |
void |
setFocusPainted(boolean b)
Enabled: Sets the paintFocus property, which must
be true for the focus state to be painted. |
void |
setHorizontalAlignment(int alignment)
Enabled: Sets the horizontal alignment of the icon and text. |
void |
setHorizontalTextPosition(int textPosition)
Enabled: Sets the horizontal position of the text relative to the icon. |
void |
setIcon(Icon defaultIcon)
Enabled: Sets the button's default icon. |
void |
setIconTextGap(int iconTextGap)
Suppressed: If both the icon and text properties are set, this property defines the space between them. |
void |
setLabel(String label)
Deprecated. - Replaced by setText(text) |
void |
setMargin(Insets m)
Enabled: Sets space for margin between the button's border and the label. |
void |
setMnemonic(char mnemonic)
Enabled: This method is now obsolete, please use setMnemonic(int)
to set the mnemonic for a button. |
void |
setMnemonic(int mnemonic)
Enabled: Sets the keyboard mnemonic on the current model. |
void |
setModel(ButtonModel newModel)
Enabled: Sets the model that this button represents. |
void |
setMultiClickThreshhold(long threshhold)
Enabled: Sets the amount of time (in milliseconds) required between mouse press events for the button to generate the corresponding action events. |
void |
setPressedIcon(Icon pressedIcon)
Enabled: Sets the pressed icon for the button. |
void |
setRolloverEnabled(boolean b)
Enabled: Sets the rolloverEnabled property, which
must be true for rollover effects to occur. |
void |
setRolloverIcon(Icon rolloverIcon)
Enabled: Sets the rollover icon for the button. |
void |
setRolloverSelectedIcon(Icon rolloverSelectedIcon)
Enabled: Sets the rollover selected icon for the button. |
void |
setSelected(boolean b)
Enabled: Sets the state of the button. |
void |
setSelectedIcon(Icon selectedIcon)
Enabled: Sets the selected icon for the button. |
void |
setText(String text)
Enabled: Sets the button's text. |
void |
setUI(javax.swing.plaf.ButtonUI ui)
Enabled: Sets the L&F object that renders this component. |
void |
setVerticalAlignment(int alignment)
Enabled: Sets the vertical alignment of the icon and text. |
void |
setVerticalTextPosition(int textPosition)
Enabled: Sets the vertical position of the text relative to the icon. |
private void |
updateDisplayedMnemonicIndex(String text,
int mnemonic)
Update the displayedMnemonicIndex property. |
private void |
updateMnemonicProperties()
Brings the mnemonic property in accordance with model's mnemonic. |
void |
updateUI()
Enabled: Resets the UI property to a value from the current look and feel. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
public static final String MODEL_CHANGED_PROPERTY
public static final String TEXT_CHANGED_PROPERTY
public static final String MNEMONIC_CHANGED_PROPERTY
public static final String MARGIN_CHANGED_PROPERTY
public static final String VERTICAL_ALIGNMENT_CHANGED_PROPERTY
public static final String HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY
public static final String VERTICAL_TEXT_POSITION_CHANGED_PROPERTY
public static final String HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY
public static final String BORDER_PAINTED_CHANGED_PROPERTY
public static final String FOCUS_PAINTED_CHANGED_PROPERTY
public static final String ROLLOVER_ENABLED_CHANGED_PROPERTY
public static final String CONTENT_AREA_FILLED_CHANGED_PROPERTY
public static final String ICON_CHANGED_PROPERTY
public static final String PRESSED_ICON_CHANGED_PROPERTY
public static final String SELECTED_ICON_CHANGED_PROPERTY
public static final String ROLLOVER_ICON_CHANGED_PROPERTY
public static final String ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY
public static final String DISABLED_ICON_CHANGED_PROPERTY
public static final String DISABLED_SELECTED_ICON_CHANGED_PROPERTY
protected ButtonModel model
private String text
private Insets margin
private Insets defaultMargin
private Icon defaultIcon
private Icon pressedIcon
private Icon disabledIcon
private Icon selectedIcon
private Icon disabledSelectedIcon
private Icon rolloverIcon
private Icon rolloverSelectedIcon
private boolean paintBorder
private boolean paintFocus
private boolean rolloverEnabled
private boolean contentAreaFilled
private int verticalAlignment
private int horizontalAlignment
private int verticalTextPosition
private int horizontalTextPosition
private int iconTextGap
private int mnemonic
private int mnemonicIndex
private long multiClickThreshhold
private AccessibleIcon accessibleIcon
protected ChangeListener changeListener
changeListener.
protected ActionListener actionListener
ActionListener.
protected ItemListener itemListener
ItemListener.
protected transient ChangeEvent changeEvent
ChangeEvent is needed per button
instance since the
event's only state is the source property. The source of events
generated is always "this".
private Action action