Module MaterialFX

Package io.github.palexdev.materialfx.controls

Class MFXToggleButton

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.control.Control

javafx.scene.control.Labeled

io.github.palexdev.materialfx.controls.MFXToggleButton

All Implemented Interfaces:

MFXLabeled, Styleable, EventTarget, Skinnable, Toggle

public class MFXToggleButton
extends Labeled
implements Toggle, MFXLabeled

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

Extends Labeled and implements Toggle and MFXLabeled, its CSS selector is "-mfx-toggle-button", includes a RippleGenerator(in the Skin) to generate ripple effect when selected/unselected.

It also introduces some new features like:

- contentDispositionProperty(): to control the toggle position

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

- lengthProperty(): to control the toggle's line width

- radiusProperty(): to control the toggle's circle 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	length	Specifies the length of the toggle button's line.
EventHandlerProperty<ActionEvent>	onAction	Specifies the action to perform when the toggle button is selected/unselected.
StyleableDoubleProperty	radius	Specifies the radius of the toggle button's circle.
BooleanProperty	selected
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.
ObjectProperty<ToggleGroup>	toggleGroup

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, 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

Field Summary

Fields

Modifier and Type	Field	Description
protected static final PseudoClass	SELECTED_PSEUDO_CLASS

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
MFXToggleButton()
MFXToggleButton(String text)
MFXToggleButton(String text, Node graphic)

Method Summary

Modifier and Type	Method	Description
StyleableObjectProperty<ContentDisplay>	contentDispositionProperty()	Specifies how the control is positioned relative to its text.
protected Skin<?>	createDefaultSkin()
void	fire()	Changes the state of the toggle button if not disabled.
StyleableDoubleProperty	gapProperty()	Specifies the spacing between the control and its text.
ContentDisplay	getContentDisposition()	Gets the value of the property contentDisposition.
List<CssMetaData<? extends Styleable,?>>	getControlCssMetaData()
static List<CssMetaData<? extends Styleable,?>>	getControlCssMetaDataList()
double	getGap()	Gets the value of the property gap.
double	getLength()	Gets the value of the property length.
EventHandler<ActionEvent>	getOnAction()	Gets the value of the property onAction.
double	getRadius()	Gets the value of the property radius.
ToggleGroup	getToggleGroup()	Gets the value of the property toggleGroup.
String	getUserAgentStylesheet()
boolean	isSelected()	Gets the value of the property selected.
boolean	isTextExpand()	Gets the value of the property textExpand.
StyleableDoubleProperty	lengthProperty()	Specifies the length of the toggle button's line.
EventHandlerProperty<ActionEvent>	onActionProperty()	Specifies the action to perform when the toggle button is selected/unselected.
StyleableDoubleProperty	radiusProperty()	Specifies the radius of the toggle button's circle.
BooleanProperty	selectedProperty()
protected void	setBehavior()
void	setColors(Color main, Color secondary)	Combines setMainColor(Color) and setSecondaryColor(Color) into one method.
void	setContentDisposition(ContentDisplay contentDisposition)	Sets the value of the property contentDisposition.
void	setGap(double gap)	Sets the value of the property gap.
void	setLength(double length)	Sets the value of the property length.
void	setMainColor(Color color)	Sets the colors of the toggle button when selected.
void	setOnAction(EventHandler<ActionEvent> onAction)	Sets the value of the property onAction.
void	setRadius(double radius)	Sets the value of the property radius.
void	setSecondaryColor(Color color)	Sets the colors of the toggle button when not selected.
void	setSelected(boolean selected)	Sets the value of the property selected.
void	setTextExpand(boolean textExpand)	Sets the value of the property textExpand.
void	setToggleGroup(ToggleGroup toggleGroup)	Sets the value of the property toggleGroup.
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.
ObjectProperty<ToggleGroup>	toggleGroupProperty()

Methods inherited from class javafx.scene.control.Labeled

alignmentProperty, contentDisplayProperty, ellipsisStringProperty, fontProperty, getAlignment, getClassCssMetaData, getContentBias, getContentDisplay, 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, executeAccessibleAction, getBaselineOffset, getContextMenu, getCssMetaData, getInitialFocusTraversable, getSkin, getTooltip, isResizable, layoutChildren, queryAccessibleAttribute, 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, 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, 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, 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

toggleGroup

public ObjectProperty<ToggleGroup> toggleGroupProperty

Specified by:

toggleGroupProperty in interface Toggle

See Also:

• getToggleGroup()
• setToggleGroup(ToggleGroup)

selected

public BooleanProperty selectedProperty

Specified by:

selectedProperty in interface Toggle

See Also:

• isSelected()
• setSelected(boolean)

onAction

public EventHandlerProperty<ActionEvent> onActionProperty

Specifies the action to perform when the toggle button is selected/unselected.

See Also:

• getOnAction()
• setOnAction(EventHandler)

contentDisposition

public StyleableObjectProperty<ContentDisplay> contentDispositionProperty

Specified by:

contentDispositionProperty in interface MFXLabeled

See Also:

• getContentDisposition()
• setContentDisposition(ContentDisplay)

gap

public StyleableDoubleProperty gapProperty

Specified by:

gapProperty in interface MFXLabeled

See Also:

• getGap()
• setGap(double)

length

public StyleableDoubleProperty lengthProperty

Specifies the length of the toggle button's line.

See Also:

• getLength()
• setLength(double)

radius

public StyleableDoubleProperty radiusProperty

Specifies the radius of the toggle button's circle.

See Also:

• getRadius()
• setRadius(double)

textExpand

public StyleableBooleanProperty textExpandProperty

Specified by:

textExpandProperty in interface MFXLabeled

See Also:

• isTextExpand()
• setTextExpand(boolean)

Field Details

SELECTED_PSEUDO_CLASS

protected static final PseudoClass SELECTED_PSEUDO_CLASS

Constructor Details

MFXToggleButton

public MFXToggleButton()

MFXToggleButton

public MFXToggleButton(String text)

MFXToggleButton

public MFXToggleButton(String text,
 Node graphic)

Method Details

setBehavior

protected void setBehavior()

fire

public void fire()

Changes the state of the toggle button if not disabled.

getToggleGroup

public ToggleGroup getToggleGroup()

Gets the value of the property toggleGroup.

Specified by:

getToggleGroup in interface Toggle

Property description:

toggleGroupProperty

public ObjectProperty<ToggleGroup> toggleGroupProperty()

Specified by:

toggleGroupProperty in interface Toggle

See Also:

• getToggleGroup()
• setToggleGroup(ToggleGroup)

setToggleGroup

public void setToggleGroup(ToggleGroup toggleGroup)

Sets the value of the property toggleGroup.

Specified by:

setToggleGroup in interface Toggle

Property description:

isSelected

public boolean isSelected()

Gets the value of the property selected.

Specified by:

isSelected in interface Toggle

Property description:

selectedProperty

public BooleanProperty selectedProperty()

Specified by:

selectedProperty in interface Toggle

See Also:

• isSelected()
• setSelected(boolean)

setSelected

public void setSelected(boolean selected)

Sets the value of the property selected.

Specified by:

setSelected in interface Toggle

Property description:

getOnAction

public EventHandler<ActionEvent> getOnAction()

Gets the value of the property onAction.

Property description:

Specifies the action to perform when the toggle button is selected/unselected.

onActionProperty

public EventHandlerProperty<ActionEvent> onActionProperty()

Specifies the action to perform when the toggle button is selected/unselected.

See Also:

• getOnAction()
• setOnAction(EventHandler)

setOnAction

public void setOnAction(EventHandler<ActionEvent> onAction)

Sets the value of the property onAction.

Property description:

Specifies the action to perform when the toggle button is selected/unselected.

getContentDisposition

public ContentDisplay getContentDisposition()

Gets the value of the property contentDisposition.

Specified by:

getContentDisposition in interface MFXLabeled

Property description:

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

See Also:

• getContentDisposition()
• setContentDisposition(ContentDisplay)

setContentDisposition

public void setContentDisposition(ContentDisplay contentDisposition)

Sets the value of the property contentDisposition.

Specified by:

setContentDisposition in interface MFXLabeled

Property description:

getGap

public double getGap()

Gets the value of the property gap.

Specified by:

getGap in interface MFXLabeled

Property description:

gapProperty

public StyleableDoubleProperty gapProperty()

Description copied from interface: MFXLabeled

Specifies the spacing between the control and its text.

Specified by:

gapProperty in interface MFXLabeled

See Also:

• getGap()
• setGap(double)

setGap

public void setGap(double gap)

Sets the value of the property gap.

Specified by:

setGap in interface MFXLabeled

Property description:

getLength

public double getLength()

Gets the value of the property length.

Property description:

Specifies the length of the toggle button's line.

lengthProperty

public StyleableDoubleProperty lengthProperty()

Specifies the length of the toggle button's line.

See Also:

• getLength()
• setLength(double)

setLength

public void setLength(double length)

Sets the value of the property length.

Property description:

Specifies the length of the toggle button's line.

getRadius

public double getRadius()

Gets the value of the property radius.

Property description:

Specifies the radius of the toggle button's circle.

radiusProperty

public StyleableDoubleProperty radiusProperty()

Specifies the radius of the toggle button's circle.

See Also:

• getRadius()
• setRadius(double)

setRadius

public void setRadius(double radius)

Sets the value of the property radius.

Property description:

Specifies the radius of the toggle button's circle.

isTextExpand

public boolean isTextExpand()

Gets the value of the property textExpand.

Specified by:

isTextExpand in interface MFXLabeled

Property description:

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

See Also:

• isTextExpand()
• setTextExpand(boolean)

setTextExpand

public void setTextExpand(boolean textExpand)

Sets the value of the property textExpand.

Specified by:

setTextExpand in interface MFXLabeled

Property description:

setMainColor

public void setMainColor(Color color)

Sets the colors of the toggle button when selected.

The color is set inline by using Node.setStyle(String), the set CSS value is the "-mfx-main" property.

setSecondaryColor

public void setSecondaryColor(Color color)

Sets the colors of the toggle button when not selected.

The color is set inline by using Node.setStyle(String), the set CSS value is the "-mfx-secondary" property.

setColors

public void setColors(Color main,
 Color secondary)

Combines setMainColor(Color) and setSecondaryColor(Color) into one method.

If you want to set both colors then you must use this method since multiple calls to Node.setStyle(String) retain only the last specified style.

getControlCssMetaDataList

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

createDefaultSkin

protected Skin<?> createDefaultSkin()

Overrides:

createDefaultSkin in class Control

getUserAgentStylesheet

public String getUserAgentStylesheet()

Overrides:

getUserAgentStylesheet in class Region

getControlCssMetaData

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

Overrides:

getControlCssMetaData in class Labeled