Module atlantafx.base
Package atlantafx.base.controls

Class ToggleSwitch

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.control.Control
javafx.scene.control.Labeled
atlantafx.base.controls.ToggleSwitch
All Implemented Interfaces:
javafx.css.Styleable, javafx.event.EventTarget, javafx.scene.control.Skinnable, javafx.scene.control.Toggle
public class ToggleSwitch extends javafx.scene.control.Labeled implements javafx.scene.control.Toggle
A control that provides users with the ability to choose between two distinct values. It is functionally similar, though aesthetically different, from the RadioButton and Checkbox.

  • Property Summary

    Properties
    Type
    Property
    Description
    final javafx.beans.property.ObjectProperty<javafx.geometry.HorizontalDirection>
    labelPosition
    Specifies the side where Labeled.textProperty() value should be placed.
    final javafx.beans.property.BooleanProperty
    selected
    Returns whether this Toggle Switch is selected.
    final javafx.beans.property.ObjectProperty<javafx.scene.control.ToggleGroup>
    toggleGroup
    The ToggleGroup to which this ToggleSwitch belongs.

    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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected static final String
    DEFAULT_STYLE_CLASS
     
    protected static final javafx.css.PseudoClass
    PSEUDO_CLASS_RIGHT
     
    protected static final javafx.css.PseudoClass
    PSEUDO_CLASS_SELECTED
     

    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
    ToggleSwitch()
    Creates a toggle switch with empty string for its label.
    ToggleSwitch(String text)
    Creates a toggle switch with the specified label.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected javafx.scene.control.Skin<?>
    createDefaultSkin()
    void
    fire()
    Toggles the state of the switch, cycling through the selected and unselected states.
    List<javafx.css.CssMetaData<? extends javafx.css.Styleable,?>>
    getControlCssMetaData()
    final javafx.geometry.HorizontalDirection
    getLabelPosition()
    Gets the value of the property labelPosition.
    final javafx.scene.control.ToggleGroup
    getToggleGroup()
    Gets the value of the property toggleGroup.
    final boolean
    isSelected()
    Gets the value of the property selected.
    final javafx.beans.property.ObjectProperty<javafx.geometry.HorizontalDirection>
    labelPositionProperty()
    Specifies the side where Labeled.textProperty() value should be placed.
    final javafx.beans.property.BooleanProperty
    selectedProperty()
    Returns whether this Toggle Switch is selected.
    final void
    setLabelPosition(javafx.geometry.HorizontalDirection pos)
    Sets the value of the property labelPosition.
    final void
    setSelected(boolean value)
    Sets the value of the property selected.
    final void
    setToggleGroup(javafx.scene.control.ToggleGroup value)
    Sets the value of the property toggleGroup.
    final javafx.beans.property.ObjectProperty<javafx.scene.control.ToggleGroup>
    toggleGroupProperty()
    The ToggleGroup to which this ToggleSwitch belongs.

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

    • selected

      public final javafx.beans.property.BooleanProperty selectedProperty
      Returns whether this Toggle Switch is selected.
      Specified by:
      selectedProperty in interface javafx.scene.control.Toggle
      See Also:

    • toggleGroup

      public final javafx.beans.property.ObjectProperty<javafx.scene.control.ToggleGroup> toggleGroupProperty
      The ToggleGroup to which this ToggleSwitch belongs. A toggle can only be in one group at any one time. If the group is changed, then the toggle is removed from the old group prior to being added to the new group.
      Specified by:
      toggleGroupProperty in interface javafx.scene.control.Toggle
      See Also:

    • labelPosition

      public final javafx.beans.property.ObjectProperty<javafx.geometry.HorizontalDirection> labelPositionProperty
      Specifies the side where Labeled.textProperty() value should be placed. Default is HorizontalDirection.LEFT.
      See Also:

  • Field Details

    • DEFAULT_STYLE_CLASS

      protected static final String DEFAULT_STYLE_CLASS
      See Also:

    • PSEUDO_CLASS_SELECTED

      protected static final javafx.css.PseudoClass PSEUDO_CLASS_SELECTED

    • PSEUDO_CLASS_RIGHT

      protected static final javafx.css.PseudoClass PSEUDO_CLASS_RIGHT

  • Constructor Details

    • ToggleSwitch

      public ToggleSwitch()
      Creates a toggle switch with empty string for its label.

    • ToggleSwitch

      public ToggleSwitch(String text)
      Creates a toggle switch with the specified label.
      Parameters:
      text - The label string of the control.

  • Method Details

    • createDefaultSkin

      protected javafx.scene.control.Skin<?> createDefaultSkin()
      Overrides:
      createDefaultSkin in class javafx.scene.control.Control

    • selectedProperty

      public final javafx.beans.property.BooleanProperty selectedProperty()
      Returns whether this Toggle Switch is selected.
      Specified by:
      selectedProperty in interface javafx.scene.control.Toggle
      See Also:

    • setSelected

      public final void setSelected(boolean value)
      Sets the value of the property selected.
      Specified by:
      setSelected in interface javafx.scene.control.Toggle
      Property description:
      Returns whether this Toggle Switch is selected.

    • isSelected

      public final boolean isSelected()
      Gets the value of the property selected.
      Specified by:
      isSelected in interface javafx.scene.control.Toggle
      Property description:
      Returns whether this Toggle Switch is selected.

    • toggleGroupProperty

      public final javafx.beans.property.ObjectProperty<javafx.scene.control.ToggleGroup> toggleGroupProperty()
      The ToggleGroup to which this ToggleSwitch belongs. A toggle can only be in one group at any one time. If the group is changed, then the toggle is removed from the old group prior to being added to the new group.
      Specified by:
      toggleGroupProperty in interface javafx.scene.control.Toggle
      See Also:

    • setToggleGroup

      public final void setToggleGroup(javafx.scene.control.ToggleGroup value)
      Sets the value of the property toggleGroup.
      Specified by:
      setToggleGroup in interface javafx.scene.control.Toggle
      Property description:
      The ToggleGroup to which this ToggleSwitch belongs. A toggle can only be in one group at any one time. If the group is changed, then the toggle is removed from the old group prior to being added to the new group.

    • getToggleGroup

      public final javafx.scene.control.ToggleGroup getToggleGroup()
      Gets the value of the property toggleGroup.
      Specified by:
      getToggleGroup in interface javafx.scene.control.Toggle
      Property description:
      The ToggleGroup to which this ToggleSwitch belongs. A toggle can only be in one group at any one time. If the group is changed, then the toggle is removed from the old group prior to being added to the new group.

    • labelPositionProperty

      public final javafx.beans.property.ObjectProperty<javafx.geometry.HorizontalDirection> labelPositionProperty()
      Specifies the side where Labeled.textProperty() value should be placed. Default is HorizontalDirection.LEFT.
      See Also:

    • setLabelPosition

      public final void setLabelPosition(javafx.geometry.HorizontalDirection pos)
      Sets the value of the property labelPosition.
      Property description:
      Specifies the side where Labeled.textProperty() value should be placed. Default is HorizontalDirection.LEFT.

    • getLabelPosition

      public final javafx.geometry.HorizontalDirection getLabelPosition()
      Gets the value of the property labelPosition.
      Property description:
      Specifies the side where Labeled.textProperty() value should be placed. Default is HorizontalDirection.LEFT.

    • fire

      public void fire()
      Toggles the state of the switch, cycling through the selected and unselected states.

    • getControlCssMetaData

      public List<javafx.css.CssMetaData<? extends javafx.css.Styleable,?>> getControlCssMetaData()
      Overrides:
      getControlCssMetaData in class javafx.scene.control.Labeled