Module MaterialFX

Package io.github.palexdev.materialfx.controls

Class MFXCircleToggleNode

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

io.github.palexdev.materialfx.controls.base.AbstractMFXToggleNode

io.github.palexdev.materialfx.controls.MFXCircleToggleNode

All Implemented Interfaces:

Styleable, EventTarget, Skinnable, Toggle

public class MFXCircleToggleNode
extends AbstractMFXToggleNode

This is the implementation of a ToggleButton with a completely different skin, MFXCircleToggleNodeSkin.

Extends ToggleButton and redefines the style class to "mfx-toggle-node" for usage in CSS.

Allows to specify up to three icons: one icon for the toggle, and tho other two for the toggle's label.

Property Summary

Properties

Type	Property	Description
StyleableDoubleProperty	gap	Specifies the gap between the toggle and its text.
StyleableDoubleProperty	size	Specifies the toggle's radius.
StyleableObjectProperty<TextPosition>	textPosition	Specifies the position of the label, above or underneath the toggle's circle.

Properties inherited from class io.github.palexdev.materialfx.controls.base.AbstractMFXToggleNode

labelLeadingIcon, labelTrailingIcon

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, 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 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
MFXCircleToggleNode()
MFXCircleToggleNode(String text)
MFXCircleToggleNode(String text, Node icon)
MFXCircleToggleNode(String text, Node icon, Node leadingIcon, Node trailingIcon)

Method Summary

Modifier and Type	Method	Description
protected Skin<?>	createDefaultSkin()
StyleableDoubleProperty	gapProperty()	Specifies the gap between the toggle and its text.
List<CssMetaData<? extends Styleable,?>>	getControlCssMetaData()
static List<CssMetaData<? extends Styleable,?>>	getControlCssMetaDataList()
double	getGap()	Gets the value of the property gap.
double	getSize()	Gets the value of the property size.
TextPosition	getTextPosition()	Gets the value of the property textPosition.
String	getUserAgentStylesheet()
void	setGap(double gap)	Sets the value of the property gap.
void	setSize(double size)	Sets the value of the property size.
void	setTextPosition(TextPosition textPosition)	Sets the value of the property textPosition.
StyleableDoubleProperty	sizeProperty()	Specifies the toggle's radius.
StyleableObjectProperty<TextPosition>	textPositionProperty()	Specifies the position of the label, above or underneath the toggle's circle.

Methods inherited from class io.github.palexdev.materialfx.controls.base.AbstractMFXToggleNode

getLabelLeadingIcon, getLabelTrailingIcon, labelLeadingIconProperty, labelTrailingIconProperty, setLabelLeadingIcon, setLabelTrailingIcon

Methods inherited from class javafx.scene.control.ToggleButton

fire, getInitialAlignment, getToggleGroup, isSelected, queryAccessibleAttribute, 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, 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

gap

public StyleableDoubleProperty gapProperty

Specifies the gap between the toggle and its text.

See Also:

• getGap()
• setGap(double)

size

public StyleableDoubleProperty sizeProperty

Specifies the toggle's radius.

See Also:

• getSize()
• setSize(double)

textPosition

public StyleableObjectProperty<TextPosition> textPositionProperty

Specifies the position of the label, above or underneath the toggle's circle.

See Also:

• getTextPosition()
• setTextPosition(TextPosition)

Constructor Details

MFXCircleToggleNode

public MFXCircleToggleNode()

MFXCircleToggleNode

public MFXCircleToggleNode(String text)

MFXCircleToggleNode

public MFXCircleToggleNode(String text,
 Node icon)

MFXCircleToggleNode

public MFXCircleToggleNode(String text,
 Node icon,
 Node leadingIcon,
 Node trailingIcon)

Method Details

getGap

public double getGap()

Gets the value of the property gap.

Property description:

Specifies the gap between the toggle and its text.

gapProperty

public StyleableDoubleProperty gapProperty()

Specifies the gap between the toggle and its text.

See Also:

• getGap()
• setGap(double)

setGap

public void setGap(double gap)

Sets the value of the property gap.

Property description:

Specifies the gap between the toggle and its text.

getSize

public double getSize()

Gets the value of the property size.

Property description:

Specifies the toggle's radius.

sizeProperty

public StyleableDoubleProperty sizeProperty()

Specifies the toggle's radius.

See Also:

• getSize()
• setSize(double)

setSize

public void setSize(double size)

Sets the value of the property size.

Property description:

Specifies the toggle's radius.

getTextPosition

public TextPosition getTextPosition()

Gets the value of the property textPosition.

Property description:

Specifies the position of the label, above or underneath the toggle's circle.

textPositionProperty

public StyleableObjectProperty<TextPosition> textPositionProperty()

Specifies the position of the label, above or underneath the toggle's circle.

See Also:

• getTextPosition()
• setTextPosition(TextPosition)

setTextPosition

public void setTextPosition(TextPosition textPosition)

Sets the value of the property textPosition.

Property description:

Specifies the position of the label, above or underneath the toggle's circle.

getControlCssMetaDataList

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

createDefaultSkin

protected Skin<?> createDefaultSkin()

Overrides:

createDefaultSkin in class ToggleButton

getControlCssMetaData

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

Overrides:

getControlCssMetaData in class Labeled

getUserAgentStylesheet

public String getUserAgentStylesheet()

Overrides:

getUserAgentStylesheet in class Region