Module atlantafx.base

Package atlantafx.base.controls

Class SegmentedControl

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.control.Control

atlantafx.base.controls.SegmentedControl

All Implemented Interfaces:

javafx.css.Styleable, javafx.event.EventTarget, javafx.scene.control.Skinnable

public class SegmentedControl
extends javafx.scene.control.Control

The SegmentedControl is a group of labels that are joined together in a single group, maintaining the selection model via the toggleGroupProperty().

This component offers an alternative flavor to TabLine or TabPane, but it does not support features such as closing tabs (labels) or overflow handling.

Property Summary

Properties

Type	Property	Description
javafx.beans.property.ObjectProperty<javafx.util.Duration>	animationDuration	Specifies the duration for animating the transition between toggles.
javafx.beans.property.ObjectProperty<javafx.scene.control.ToggleGroup>	toggleGroup	The ToggleGroup that is used internally maintain the selection.

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 final javafx.beans.property.ObjectProperty<javafx.util.Duration>	animationDuration
protected static final javafx.util.Duration	DEFAULT_ANIMATION_DURATION
protected final javafx.collections.ObservableList<ToggleLabel>	segments
protected final javafx.beans.property.ObjectProperty<javafx.scene.control.ToggleGroup>	toggleGroup

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
SegmentedControl()
SegmentedControl(ToggleLabel... segments)
SegmentedControl(String... segments)
SegmentedControl(javafx.collections.ObservableList<ToggleLabel> segments)	Creates a SegmentedButton with the provided segments inserted into it.

Method Summary

Modifier and Type	Method	Description
javafx.beans.property.ObjectProperty<javafx.util.Duration>	animationDurationProperty()	Specifies the duration for animating the transition between toggles.
protected javafx.scene.control.Skin<?>	createDefaultSkin()
javafx.util.Duration	getAnimationDuration()	Gets the value of the animationDuration property.
final javafx.collections.ObservableList<ToggleLabel>	getSegments()	Returns the list of buttons that this SegmentedButton consists of.
javafx.scene.control.ToggleGroup	getToggleGroup()	Gets the value of the toggleGroup property.
void	setAnimationDuration(@Nullable javafx.util.Duration duration)	Sets the value of the animationDuration property.
void	setToggleGroup(javafx.scene.control.ToggleGroup toggleGroup)	Sets the value of the toggleGroup property.
javafx.beans.property.ObjectProperty<javafx.scene.control.ToggleGroup>	toggleGroupProperty()	The ToggleGroup that is used internally maintain the selection.

Methods inherited from class javafx.scene.control.Control

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, executeAccessibleAction, getBaselineOffset, getClassCssMetaData, getContextMenu, getControlCssMetaData, 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, getContentBias, 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, toString, 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

Property Details

toggleGroup

public javafx.beans.property.ObjectProperty<javafx.scene.control.ToggleGroup> toggleGroupProperty

The ToggleGroup that is used internally maintain the selection.

See Also:

• getToggleGroup()
• setToggleGroup(ToggleGroup)
• toggleGroupProperty()

animationDuration

public javafx.beans.property.ObjectProperty<javafx.util.Duration> animationDurationProperty

Specifies the duration for animating the transition between toggles. Setting this value to zero or null disables the animation.

See Also:

• getAnimationDuration()
• setAnimationDuration(Duration)
• animationDurationProperty()

Field Details

DEFAULT_ANIMATION_DURATION

protected static final javafx.util.Duration DEFAULT_ANIMATION_DURATION

segments

protected final javafx.collections.ObservableList<ToggleLabel> segments

toggleGroup

protected final javafx.beans.property.ObjectProperty<javafx.scene.control.ToggleGroup> toggleGroup

animationDuration

protected final javafx.beans.property.ObjectProperty<javafx.util.Duration> animationDuration

Constructor Details

SegmentedControl

public SegmentedControl()

SegmentedControl

public SegmentedControl(String... segments)

SegmentedControl

public SegmentedControl(ToggleLabel... segments)

SegmentedControl

public SegmentedControl(javafx.collections.ObservableList<ToggleLabel> segments)

Creates a SegmentedButton with the provided segments inserted into it.

Method Details

createDefaultSkin

protected javafx.scene.control.Skin<?> createDefaultSkin()

Overrides:

createDefaultSkin in class javafx.scene.control.Control

getSegments

public final javafx.collections.ObservableList<ToggleLabel> getSegments()

Returns the list of buttons that this SegmentedButton consists of.

toggleGroupProperty

public javafx.beans.property.ObjectProperty<javafx.scene.control.ToggleGroup> toggleGroupProperty()

The ToggleGroup that is used internally maintain the selection.

Returns:

the toggleGroup property

See Also:

• getToggleGroup()
• setToggleGroup(ToggleGroup)

getToggleGroup

public javafx.scene.control.ToggleGroup getToggleGroup()

Gets the value of the toggleGroup property.

Property description:

The ToggleGroup that is used internally maintain the selection.

Returns:

the value of the toggleGroup property

See Also:

• setToggleGroup(ToggleGroup)
• toggleGroupProperty()

setToggleGroup

public void setToggleGroup(javafx.scene.control.ToggleGroup toggleGroup)

Sets the value of the toggleGroup property.

Property description:

The ToggleGroup that is used internally maintain the selection.

Parameters:

toggleGroup - the value for the toggleGroup property

See Also:

• getToggleGroup()
• toggleGroupProperty()

animationDurationProperty

public javafx.beans.property.ObjectProperty<javafx.util.Duration> animationDurationProperty()

Specifies the duration for animating the transition between toggles. Setting this value to zero or null disables the animation.

Returns:

the animationDuration property

See Also:

• getAnimationDuration()
• setAnimationDuration(Duration)

getAnimationDuration

public javafx.util.Duration getAnimationDuration()

Gets the value of the animationDuration property.

Property description:

Specifies the duration for animating the transition between toggles. Setting this value to zero or null disables the animation.

Returns:

the value of the animationDuration property

See Also:

• setAnimationDuration(Duration)
• animationDurationProperty()

setAnimationDuration

public void setAnimationDuration(@Nullable
 @Nullable javafx.util.Duration duration)

Sets the value of the animationDuration property.

Property description:

Specifies the duration for animating the transition between toggles. Setting this value to zero or null disables the animation.

Parameters:

duration - the value for the animationDuration property

See Also:

• getAnimationDuration()
• animationDurationProperty()