Class JButton

All Implemented Interfaces:
ImageObserver, ItemSelectable, MenuContainer, Serializable, Accessible, SwingConstants
Direct Known Subclasses:
BasicArrowButton, MetalComboBoxButton

@JavaBean(defaultProperty="UIClassID", description="An implementation of a \"push\" button.") public class JButton extends AbstractButton implements Accessible
An implementation of a "push" button.

Buttons can be configured, and to some degree controlled, by Actions. Using an Action with a button has many benefits beyond directly configuring a button. Refer to Swing Components Supporting Action for more details, and you can find more information in How to Use Actions, a section in The Java Tutorial.

See How to Use Buttons, Check Boxes, and Radio Buttons in The Java Tutorial for information and examples of using buttons.

Warning: Swing is not thread safe. For more information see Swing's Threading Policy.

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 JavaBeans has been added to the java.beans package. Please see XMLEncoder.

Since:
1.2
  • Constructor Details

    • JButton

      public JButton()
      Creates a button with no set text or icon.
    • JButton

      public JButton(Icon icon)
      Creates a button with an icon.
      Parameters:
      icon - the Icon image to display on the button
    • JButton

      @ConstructorProperties("text") public JButton(String text)
      Creates a button with text.
      Parameters:
      text - the text of the button
    • JButton

      public JButton(Action a)
      Creates a button where properties are taken from the Action supplied.
      Parameters:
      a - the Action used to specify the new button
      Since:
      1.3
    • JButton

      public JButton(String text, Icon icon)
      Creates a button with initial text and an icon.
      Parameters:
      text - the text of the button
      icon - the Icon image to display on the button
  • Method Details

    • updateUI

      public void updateUI()
      Resets the UI property to a value from the current look and feel.
      Overrides:
      updateUI in class AbstractButton
      See Also:
    • getUIClassID

      @BeanProperty(bound=false, expert=true, description="A string that specifies the name of the L&F class.") public String getUIClassID()
      Returns a string that specifies the name of the L&F class that renders this component.
      Overrides:
      getUIClassID in class JComponent
      Returns:
      the string "ButtonUI"
      See Also:
    • isDefaultButton

      @BeanProperty(bound=false, description="Whether or not this button is the default button") public boolean isDefaultButton()
      Gets the value of the defaultButton property, which if true means that this button is the current default button for its JRootPane. Most look and feels render the default button differently, and may potentially provide bindings to access the default button.
      Returns:
      the value of the defaultButton property
      See Also:
    • isDefaultCapable

      public boolean isDefaultCapable()
      Gets the value of the defaultCapable property.
      Returns:
      the value of the defaultCapable property
      See Also:
    • setDefaultCapable

      @BeanProperty(visualUpdate=true, description="Whether or not this button can be the default button") public void setDefaultCapable(boolean defaultCapable)
      Sets the defaultCapable property, which determines whether this button can be made the default button for its root pane. The default value of the defaultCapable property is true unless otherwise specified by the look and feel.
      Parameters:
      defaultCapable - true if this button will be capable of being the default button on the RootPane; otherwise false
      See Also:
    • removeNotify

      public void removeNotify()
      Overrides JComponent.removeNotify to check if this button is currently set as the default button on the RootPane, and if so, sets the RootPane's default button to null to ensure the RootPane doesn't hold onto an invalid button reference.
      Overrides:
      removeNotify in class AbstractButton
      See Also:
    • paramString

      protected String paramString()
      Returns a string representation of this JButton. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null.
      Overrides:
      paramString in class AbstractButton
      Returns:
      a string representation of this JButton
    • getAccessibleContext

      @BeanProperty(bound=false, expert=true, description="The AccessibleContext associated with this Button.") public AccessibleContext getAccessibleContext()
      Gets the AccessibleContext associated with this JButton. For JButtons, the AccessibleContext takes the form of an AccessibleJButton. A new AccessibleJButton instance is created if necessary.
      Specified by:
      getAccessibleContext in interface Accessible
      Overrides:
      getAccessibleContext in class Component
      Returns:
      an AccessibleJButton that serves as the AccessibleContext of this JButton