javafx.scene.control

Class ButtonBase

java.lang.Object

Region

javafx.scene.control.Control

javafx.scene.control.Labeled

javafx.scene.control.ButtonBase

All Implemented Interfaces:

Skinnable

Direct Known Subclasses:

Button, CheckBox, Hyperlink, MenuButton, ToggleButton

public abstract class ButtonBase
extends Labeled

Base class for button-like UI Controls, including Hyperlinks, Buttons, ToggleButtons, CheckBoxes, and RadioButtons. The primary contribution of ButtonBase is providing a consistent API for handling the concept of button "arming". In UIs, a button will typically only "fire" if some user gesture occurs while the button is "armed". For example, a Button may be armed if the mouse is pressed and the Button is enabled and the mouse is over the button. In such a situation, if the mouse is then released, then the Button is "fired", meaning its action takes place.

Since:

JavaFX 2.0

Property Summary

Type	Property and Description
ReadOnlyBooleanProperty	armed Indicates that the button has been "armed" such that a mouse release will cause the button's action to be invoked.
<any>	onAction The button's action, which is invoked whenever the button is fired.

Properties inherited from class javafx.scene.control.Labeled

alignmentProperty, contentDisplayProperty, ellipsisStringProperty, fontProperty, graphicProperty, graphicTextGapProperty, labelPaddingProperty, lineSpacingProperty, mnemonicParsingProperty, textAlignmentProperty, textFillProperty, textOverrunProperty, textProperty, underlineProperty, wrapTextProperty

Properties inherited from class javafx.scene.control.Control

contextMenuProperty, skinClassNameProperty, skinProperty, tooltipProperty

Field Summary

Fields

Modifier and Type	Field and Description
private ReadOnlyBooleanWrapper	armed
private static PseudoClass	ARMED_PSEUDOCLASS_STATE * Stylesheet Handling * *
private <any>	onAction

Constructor Summary

Constructors

Constructor and Description
ButtonBase() Create a default ButtonBase with empty text.
ButtonBase(java.lang.String text) Create a ButtonBase with the given text.
ButtonBase(java.lang.String text, Node graphic) Create a ButtonBase with the given text and graphic.

Method Summary

Modifier and Type	Method and Description
void	arm() Arms the button.
ReadOnlyBooleanProperty	armedProperty() Indicates that the button has been "armed" such that a mouse release will cause the button's action to be invoked.
void	disarm() Disarms the button.
void	executeAccessibleAction(AccessibleAction action, java.lang.Object... parameters)
abstract void	fire() Invoked when a user gesture indicates that an event for this ButtonBase should occur.
<any>	getOnAction() Gets the value of the property onAction.
boolean	isArmed() Gets the value of the property armed.
<any>	onActionProperty() The button's action, which is invoked whenever the button is fired.
private void	setArmed(boolean value)
void	setOnAction(<any> value) Sets the value of the property onAction.

Methods inherited from class javafx.scene.control.Labeled

alignmentProperty, contentDisplayProperty, ellipsisStringProperty, fontProperty, getAlignment, getClassCssMetaData, getContentBias, getContentDisplay, getControlCssMetaData, getEllipsisString, getFont, getGraphic, getGraphicTextGap, getInitialAlignment, getLabelPadding, getLineSpacing, getText, getTextAlignment, getTextFill, getTextOverrun, graphicProperty, graphicTextGapProperty, isMnemonicParsing, isUnderline, isWrapText, labelPaddingProperty, lineSpacingProperty, mnemonicParsingProperty, setAlignment, setContentDisplay, setEllipsisString, setFont, setGraphic, setGraphicTextGap, setLineSpacing, setMnemonicParsing, setText, setTextAlignment, setTextFill, setTextOverrun, setUnderline, setWrapText, textAlignmentProperty, textFillProperty, textOverrunProperty, textProperty, toString, underlineProperty, wrapTextProperty

Methods inherited from class javafx.scene.control.Control

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, createDefaultSkin, getBaselineOffset, getContextMenu, getControlChildren, getCssMetaData, getInitialFocusTraversable, getSkin, getTooltip, isResizable, layoutChildren, loadSkinClass, queryAccessibleAttribute, setContextMenu, setSkin, setTooltip, skinClassNameProperty, skinProperty, tooltipProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Property Detail

armed

public final ReadOnlyBooleanProperty armedProperty

Indicates that the button has been "armed" such that a mouse release will cause the button's action to be invoked. This is subtly different from pressed. Pressed indicates that the mouse has been pressed on a Node and has not yet been released. arm however also takes into account whether the mouse is actually over the button and pressed.

See Also:

isArmed()

onAction

public final <any> onActionProperty

The button's action, which is invoked whenever the button is fired. This may be due to the user clicking on the button with the mouse, or by a touch event, or by a key press, or if the developer programmatically invokes the fire() method.

See Also:

getOnAction(), #setOnAction()

Field Detail

armed

private ReadOnlyBooleanWrapper armed

onAction

private <any> onAction

ARMED_PSEUDOCLASS_STATE

private static final PseudoClass ARMED_PSEUDOCLASS_STATE

* Stylesheet Handling * *

Constructor Detail

ButtonBase

public ButtonBase()

Create a default ButtonBase with empty text.

ButtonBase

public ButtonBase(java.lang.String text)

Create a ButtonBase with the given text.

Parameters:

text - null text is treated as the empty string

ButtonBase

public ButtonBase(java.lang.String text,
                  Node graphic)

Create a ButtonBase with the given text and graphic.

Parameters:

text - null text is treated as the empty string

graphic - a null graphic is acceptable

Method Detail

armedProperty

public final ReadOnlyBooleanProperty armedProperty()

Indicates that the button has been "armed" such that a mouse release will cause the button's action to be invoked. This is subtly different from pressed. Pressed indicates that the mouse has been pressed on a Node and has not yet been released. arm however also takes into account whether the mouse is actually over the button and pressed.

See Also:

isArmed()

setArmed

private void setArmed(boolean value)

isArmed

public final boolean isArmed()

Gets the value of the property armed.

onActionProperty

public final <any> onActionProperty()

The button's action, which is invoked whenever the button is fired. This may be due to the user clicking on the button with the mouse, or by a touch event, or by a key press, or if the developer programmatically invokes the fire() method.

See Also:

getOnAction(), #setOnAction()

setOnAction

public final void setOnAction(<any> value)

Sets the value of the property onAction.

getOnAction

public final <any> getOnAction()

Gets the value of the property onAction.

arm

public void arm()

Arms the button. An armed button will fire an action (whether that be the action of a Button or toggling selection on a CheckBox or some other behavior) on the next expected UI gesture. Note: This function is intended to be used by experts, primarily by those implementing new Skins or Behaviors. It is not common for developers or designers to access this function directly.

disarm

public void disarm()

Disarms the button. See arm(). Note: This function is intended to be used by experts, primarily by those implementing new Skins or Behaviors. It is not common for developers or designers to access this function directly.

fire

public abstract void 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().

executeAccessibleAction

public void executeAccessibleAction(AccessibleAction action,
                                    java.lang.Object... parameters)

Overrides:

executeAccessibleAction in class Control