Module MaterialFX

Package io.github.palexdev.materialfx.controls

Class MFXRadioButton

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.control.Control

javafx.scene.control.Labeled

javafx.scene.control.ButtonBase

javafx.scene.control.ToggleButton

javafx.scene.control.RadioButton

io.github.palexdev.materialfx.controls.MFXRadioButton

All Implemented Interfaces:

MFXLabeled, Themable, Styleable, EventTarget, Skinnable, Toggle

public class MFXRadioButton
extends RadioButton
implements MFXLabeled, Themable

This is the implementation of a radio button following Google's material design guidelines in JavaFX.

Extends RadioButton, redefines the style class to "mfx-radio-button" for usage in CSS and includes a RippleGenerator to generate ripple effects on click.

It also introduces some new features like:

- contentDispositionProperty(): to control the radio position

- gapProperty(): to control the gap between the radio button and the text

- radioGapProperty(): to control the gap between the outer and inner circle

- radiusProperty(): to control the circles' radius

- textExpandProperty(): to control the text size and the checkbox layout (see documentation)

Property Summary

Properties

Type	Property	Description
StyleableObjectProperty<ContentDisplay>	contentDisposition	Specifies how the control is positioned relative to its text.
StyleableDoubleProperty	gap	Specifies the spacing between the control and its text.
StyleableDoubleProperty	radioGap	Specifies the gap between the outer and the inner circles of the radio button.
StyleableDoubleProperty	radius	Specifies the radius of the radio button.
StyleableBooleanProperty	textExpand	When setting a specific size for the control (by using setPrefSize for example, and this is true for SceneBuilder too), this flag will tell the control's label to take all the space available.

Properties inherited from class javafx.scene.control.ToggleButton

selected, toggleGroup

Properties inherited from class javafx.scene.control.ButtonBase

armed, onAction

Properties inherited from class javafx.scene.control.Labeled

alignment, contentDisplay, ellipsisString, font, graphic, graphicTextGap, labelPadding, lineSpacing, mnemonicParsing, textAlignment, textFill, textOverrun, text, underline, wrapText

Properties inherited from class javafx.scene.control.Control

contextMenu, skin, tooltip

Properties inherited from class javafx.scene.layout.Region

background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, width

Properties inherited from class javafx.scene.Parent

needsLayout

Properties inherited from class javafx.scene.Node

accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, focusVisible, focusWithin, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragEntered, onMouseDragExited, onMouseDragged, onMouseDragOver, onMouseDragReleased, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onRotate, onRotationFinished, onRotationStarted, onScrollFinished, onScroll, onScrollStarted, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, onZoomFinished, onZoom, onZoomStarted, opacity, parent, pickOnBounds, pressed, rotate, rotationAxis, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, translateZ, viewOrder, visible

Nested Class Summary

Nested classes/interfaces inherited from interface io.github.palexdev.materialfx.controls.base.Themable

Themable.Helper

Field Summary

Fields inherited from class javafx.scene.layout.Region

USE_COMPUTED_SIZE, USE_PREF_SIZE

Fields inherited from class javafx.scene.Node

BASELINE_OFFSET_SAME_AS_HEIGHT

Constructor Summary

Constructors

Constructor	Description
MFXRadioButton()
MFXRadioButton(String text)

Method Summary

Modifier and Type	Method	Description
StyleableObjectProperty<ContentDisplay>	contentDispositionProperty()	Specifies how the control is positioned relative to its text.
protected Skin<?>	createDefaultSkin()
StyleableDoubleProperty	gapProperty()	Specifies the spacing between the control and its text.
ContentDisplay	getContentDisposition()	Gets the value of the contentDisposition property.
List<CssMetaData<? extends Styleable,?>>	getControlCssMetaData()
static List<CssMetaData<? extends Styleable,?>>	getControlCssMetaDataList()
double	getGap()	Gets the value of the gap property.
double	getRadioGap()	Gets the value of the radioGap property.
double	getRadius()	Gets the value of the radius property.
Theme	getTheme()	Implementations of this should return the Theme responsible for styling themselves, most MaterialFX controls return one of the constants offered by Stylesheets.
boolean	isTextExpand()	Gets the value of the textExpand property.
StyleableDoubleProperty	radioGapProperty()	Specifies the gap between the outer and the inner circles of the radio button.
StyleableDoubleProperty	radiusProperty()	Specifies the radius of the radio button.
boolean	sceneBuilderIntegration()	This is the method responsible for SceneBuilder detection and integration.
void	setContentDisposition(ContentDisplay contentDisposition)	Sets the value of the contentDisposition property.
void	setGap(double gap)	Sets the value of the gap property.
void	setRadioGap(double radioGap)	Sets the value of the radioGap property.
void	setRadius(double radius)	Sets the value of the radius property.
void	setTextExpand(boolean textExpand)	Sets the value of the textExpand property.
StyleableBooleanProperty	textExpandProperty()	When setting a specific size for the control (by using setPrefSize for example, and this is true for SceneBuilder too), this flag will tell the control's label to take all the space available.
Parent	toParent()	Implementations should return the Parent node onto which themes and stylesheets will be applied.

Methods inherited from class javafx.scene.control.RadioButton

fire, getInitialAlignment, queryAccessibleAttribute

Methods inherited from class javafx.scene.control.ToggleButton

getToggleGroup, isSelected, selectedProperty, setSelected, setToggleGroup, toggleGroupProperty

Methods inherited from class javafx.scene.control.ButtonBase

arm, armedProperty, disarm, executeAccessibleAction, getOnAction, isArmed, onActionProperty, setOnAction

Methods inherited from class javafx.scene.control.Labeled

alignmentProperty, contentDisplayProperty, ellipsisStringProperty, fontProperty, getAlignment, getClassCssMetaData, getContentBias, getContentDisplay, getEllipsisString, getFont, getGraphic, getGraphicTextGap, 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, getBaselineOffset, getContextMenu, getCssMetaData, getInitialFocusTraversable, getSkin, getTooltip, isResizable, layoutChildren, setContextMenu, setSkin, setTooltip, skinProperty, tooltipProperty

Methods inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, insetsProperty, isCacheShape, isCenterShape, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent

getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, requestParentLayout, setNeedsLayout, updateBounds

Methods inherited from class javafx.scene.Node

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, focusVisibleProperty, focusWithinProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInitialCursor, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, getViewOrder, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isFocusVisible, isFocusWithin, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setViewOrder, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, translateXProperty, translateYProperty, translateZProperty, usesMirroring, viewOrderProperty, visibleProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface javafx.css.Styleable

getStyleableNode

Methods inherited from interface javafx.scene.control.Toggle

getProperties, getUserData, setUserData

Property Details

contentDisposition

public StyleableObjectProperty<ContentDisplay> contentDispositionProperty

Specified by:

contentDispositionProperty in interface MFXLabeled

Returns:

the contentDisposition property

See Also:

• getContentDisposition()
• setContentDisposition(ContentDisplay)
• contentDispositionProperty()

gap

public StyleableDoubleProperty gapProperty

Specified by:

gapProperty in interface MFXLabeled

Returns:

the gap property

See Also:

• getGap()
• setGap(double)
• gapProperty()

radioGap

public StyleableDoubleProperty radioGapProperty

Specifies the gap between the outer and the inner circles of the radio button.

See Also:

• getRadioGap()
• setRadioGap(double)
• radioGapProperty()

radius

public StyleableDoubleProperty radiusProperty

Specifies the radius of the radio button.

See Also:

• getRadius()
• setRadius(double)
• radiusProperty()

textExpand

public StyleableBooleanProperty textExpandProperty

Specified by:

textExpandProperty in interface MFXLabeled

Returns:

the textExpand property

See Also:

• isTextExpand()
• setTextExpand(boolean)
• textExpandProperty()

Constructor Details

MFXRadioButton

public MFXRadioButton()

MFXRadioButton

public MFXRadioButton(String text)

Method Details

getContentDisposition

public ContentDisplay getContentDisposition()

Gets the value of the contentDisposition property.

Specified by:

getContentDisposition in interface MFXLabeled

Property description:

Returns:

the value of the contentDisposition property

See Also:

• setContentDisposition(ContentDisplay)
• contentDispositionProperty()

contentDispositionProperty

public StyleableObjectProperty<ContentDisplay> contentDispositionProperty()

Description copied from interface: MFXLabeled

Specifies how the control is positioned relative to its text.

Specified by:

contentDispositionProperty in interface MFXLabeled

Returns:

the contentDisposition property

See Also:

• getContentDisposition()
• setContentDisposition(ContentDisplay)

setContentDisposition

public void setContentDisposition(ContentDisplay contentDisposition)

Sets the value of the contentDisposition property.

Specified by:

setContentDisposition in interface MFXLabeled

Property description:

Parameters:

contentDisposition - the value for the contentDisposition property

See Also:

• getContentDisposition()
• contentDispositionProperty()

getGap

public double getGap()

Gets the value of the gap property.

Specified by:

getGap in interface MFXLabeled

Property description:

Returns:

the value of the gap property

See Also:

• setGap(double)
• gapProperty()

gapProperty

public StyleableDoubleProperty gapProperty()

Description copied from interface: MFXLabeled

Specifies the spacing between the control and its text.

Specified by:

gapProperty in interface MFXLabeled

Returns:

the gap property

See Also:

• getGap()
• setGap(double)

setGap

public void setGap(double gap)

Sets the value of the gap property.

Specified by:

setGap in interface MFXLabeled

Property description:

Parameters:

gap - the value for the gap property

See Also:

• getGap()
• gapProperty()

getRadioGap

public double getRadioGap()

Gets the value of the radioGap property.

Property description:

Specifies the gap between the outer and the inner circles of the radio button.

Returns:

the value of the radioGap property

See Also:

• setRadioGap(double)
• radioGapProperty()

radioGapProperty

public StyleableDoubleProperty radioGapProperty()

Specifies the gap between the outer and the inner circles of the radio button.

Returns:

the radioGap property

See Also:

• getRadioGap()
• setRadioGap(double)

setRadioGap

public void setRadioGap(double radioGap)

Sets the value of the radioGap property.

Property description:

Specifies the gap between the outer and the inner circles of the radio button.

Parameters:

radioGap - the value for the radioGap property

See Also:

• getRadioGap()
• radioGapProperty()

getRadius

public double getRadius()

Gets the value of the radius property.

Property description:

Specifies the radius of the radio button.

Returns:

the value of the radius property

See Also:

• setRadius(double)
• radiusProperty()

radiusProperty

public StyleableDoubleProperty radiusProperty()

Specifies the radius of the radio button.

Returns:

the radius property

See Also:

• getRadius()
• setRadius(double)

setRadius

public void setRadius(double radius)

Sets the value of the radius property.

Property description:

Specifies the radius of the radio button.

Parameters:

radius - the value for the radius property

See Also:

• getRadius()
• radiusProperty()

isTextExpand

public boolean isTextExpand()

Gets the value of the textExpand property.

Specified by:

isTextExpand in interface MFXLabeled

Property description:

Returns:

the value of the textExpand property

See Also:

• setTextExpand(boolean)
• textExpandProperty()

textExpandProperty

public StyleableBooleanProperty textExpandProperty()

Description copied from interface: MFXLabeled

When setting a specific size for the control (by using setPrefSize for example, and this is true for SceneBuilder too), this flag will tell the control's label to take all the space available.

This allows, in combination with the MFXLabeled.contentDispositionProperty(), to layout the control's content in many interesting ways. When the text is expanded (this property is true) use Labeled.alignmentProperty() to position the text.

Specified by:

textExpandProperty in interface MFXLabeled

Returns:

the textExpand property

See Also:

• isTextExpand()
• setTextExpand(boolean)

setTextExpand

public void setTextExpand(boolean textExpand)

Sets the value of the textExpand property.

Specified by:

setTextExpand in interface MFXLabeled

Property description:

Parameters:

textExpand - the value for the textExpand property

See Also:

• isTextExpand()
• textExpandProperty()

getControlCssMetaDataList

public static List<CssMetaData<? extends Styleable,?>> getControlCssMetaDataList()

toParent

public Parent toParent()

Description copied from interface: Themable

Implementations should return the Parent node onto which themes and stylesheets will be applied. Most of the case its themselves.

Specified by:

toParent in interface Themable

getTheme

public Theme getTheme()

Description copied from interface: Themable

Implementations of this should return the Theme responsible for styling themselves, most MaterialFX controls return one of the constants offered by Stylesheets.

Specified by:

getTheme in interface Themable

sceneBuilderIntegration

public boolean sceneBuilderIntegration()

Description copied from interface: Themable

This is the method responsible for SceneBuilder detection and integration.

By default, this adds the Theme returned by Themable.getTheme() on the Parent returned by Themable.toParent().

Specified by:

sceneBuilderIntegration in interface Themable

Returns:

whether SceneBuilder was detected or not, allowing overrides of this to avoid calling the check again and just checking the return of this method

createDefaultSkin

protected Skin<?> createDefaultSkin()

Overrides:

createDefaultSkin in class RadioButton

getControlCssMetaData

public List<CssMetaData<? extends Styleable,?>> getControlCssMetaData()

Overrides:

getControlCssMetaData in class Labeled