JavaFX 24 · javafx.scene.control.Button · APIdia, the JavaDoc alternative

A simple button control. The button control can contain text and/or a graphic. A button control has three different modes

Normal: A normal push button.
Default: The default button is rendered differently to make it apparent to users that it should be the default choice should they be unclear as to what should be selected. The behavior of the default button differs depending on the platform in which it is presented:
- Windows / Linux: A default Button receives ENTER key presses when it has focus. When the default button does not have focus, and focus is on another Button control, the ENTER key press will be received by the other, non-default Button. When focus is elsewhere in the user interface, and not on any Button, the ENTER key press will be received by the default button, if one is specified, and if no other node in the scene consumes it first.
- Mac OS X: A default Button is the only Button in the user interface that responds to the ENTER key press. If focus is on another non-default Button and ENTER is pressed, the event is only received by the default Button. On macOS, the only way to fire a non-default Button is through the SPACE key.
Cancel: A Cancel Button is the button that receives a keyboard VK_ESC press, if no other node in the scene consumes it.

When a button is pressed and released a ActionEvent is sent. Your application can perform some action based on this event by implementing an javafx.event.EventHandler to process the ActionEvent. Buttons can also respond to mouse events by implementing an javafx.event.EventHandler to process the javafx.scene.input.MouseEvent

MnemonicParsing is enabled by default for Button.

Example:

Button button = new Button("Click Me");

Field Summary

Modifier and Type	Field and Description
private BooleanProperty	cancelButton A Cancel Button is the button that receives a keyboard VK_ESC press, if no other node in the scene consumes it.
private static final String	DEFAULT_STYLE_CLASS Initialize the style class to 'button'.
private BooleanProperty	defaultButton A default Button is the button that receives a keyboard VK_ENTER press, if no other node in the scene consumes it.
private static final PseudoClass	PSEUDO_CLASS_CANCEL
private static final PseudoClass	PSEUDO_CLASS_DEFAULT

Access	Constructor and Description
public	Button() Creates a button with an empty string for its label.
public	Button(String A text string for its label. text) Creates a button with the specified text as its label.
public	Button(String A text string for its label. text, Node the icon for its label. graphic) Creates a button with the specified text and icon for its label.

Method Summary

Modifier and Type	Method and Description
public final BooleanProperty	cancelButtonProperty()
protected Skin<?>	createDefaultSkin() Overrides javafx.scene.control.Control.createDefaultSkin. Create a new instance of the default skin for this control.
public final BooleanProperty	defaultButtonProperty()
public void	fire() Implements abstract javafx.scene.control.ButtonBase.fire. Invoked when a user gesture indicates that an event for this `ButtonBase` should occur.
private void	initialize()
public final boolean	isCancelButton()
public final boolean	isDefaultButton()
public final void	setCancelButton(boolean value)
public final void	setDefaultButton(boolean value)

Inherited from javafx.scene.control.ButtonBase:: arm armedProperty disarm executeAccessibleAction getOnAction isArmed onActionProperty setOnAction

Field Detail

cancelButton	back to summary
private BooleanProperty cancelButton A Cancel Button is the button that receives a keyboard VK_ESC press, if no other node in the scene consumes it.

DEFAULT_STYLE_CLASS	back to summary
private static final String DEFAULT_STYLE_CLASS Initialize the style class to 'button'. This is the selector class from which CSS can be used to style this control.

defaultButton	back to summary
private BooleanProperty defaultButton A default Button is the button that receives a keyboard VK_ENTER press, if no other node in the scene consumes it.

PSEUDO_CLASS_CANCEL	back to summary
private static final PseudoClass PSEUDO_CLASS_CANCEL

PSEUDO_CLASS_DEFAULT	back to summary
private static final PseudoClass PSEUDO_CLASS_DEFAULT

Constructor Detail

Button	back to summary
public Button() Creates a button with an empty string for its label.

Button	back to summary
public Button(String text) Creates a button with the specified text as its label. Parameters text:String A text string for its label.

Button

back to summary

public Button(String text)

Creates a button with the specified text as its label.

Parameters

text:String: A text string for its label.

Button	back to summary
public Button(String text, Node graphic) Creates a button with the specified text and icon for its label. Parameters text:String A text string for its label. graphic:Node the icon for its label.

Button

back to summary

public Button(String text, Node graphic)

Creates a button with the specified text and icon for its label.

Parameters

text:String: A text string for its label.
graphic:Node: the icon for its label.

Method Detail

cancelButtonProperty	back to summary
public final BooleanProperty cancelButtonProperty()

createDefaultSkin back to summary

createDefaultSkin	back to summary
protected Skin<?> createDefaultSkin() Overrides javafx.scene.control.Control.createDefaultSkin. Doc from javafx.scene.control.Control.createDefaultSkin. Create a new instance of the default skin for this control. This is called to create a skin for the control if no skin is provided via CSS `-fx-skin` or set explicitly in a sub-class with `setSkin(...)`. Returns:Skin<?> new instance of default skin for this control. If null then the control will have no skin unless one is provided by css. Annotations @Override

protected Skin<?> createDefaultSkin()

Overrides javafx.scene.control.Control.createDefaultSkin.

Doc from javafx.scene.control.Control.createDefaultSkin.

Create a new instance of the default skin for this control. This is called to create a skin for the control if no skin is provided via CSS -fx-skin or set explicitly in a sub-class with setSkin(...).

Returns:Skin<?>

new instance of default skin for this control. If null then the control will have no skin unless one is provided by css.

Annotations

@Override

defaultButtonProperty	back to summary
public final BooleanProperty defaultButtonProperty()

fire back to summary

fire	back to summary
public void fire() Implements abstract javafx.scene.control.ButtonBase.fire. Doc from javafx.scene.control.ButtonBase.fire. Invoked when a user gesture indicates that an event for this `ButtonBase` should occur. If invoked, this method will be executed regardless of the status of `arm`. Annotations @Override

public void fire()

Implements abstract javafx.scene.control.ButtonBase.fire.

Doc from javafx.scene.control.ButtonBase.fire.

Invoked when a user gesture indicates that an event for this ButtonBase should occur.

If invoked, this method will be executed regardless of the status of arm.