Module org.tquadrat.foundation.fx

Package org.tquadrat.foundation.fx.control

Class RangeSlider

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.control.Control

org.tquadrat.foundation.fx.internal.FoundationFXControl

org.tquadrat.foundation.fx.control.RangeSlider

All Implemented Interfaces:

Styleable, EventTarget, Skinnable

@ClassVersion(sourceVersion="$Id: RangeSlider.java 1121 2024-03-16 16:51:23Z tquadrat $")
@API(status=STABLE,
     since="0.4.6")
public final class RangeSlider
extends FoundationFXControl

The RangeSlider control is simply a JavaFX Slider control with support for two 'thumbs', rather than one. A thumb is the non-technical name for the draggable area inside the Slider/RangeSlider that allows for a value to be set.

Because the RangeSlider has two thumbs, it also has a few additional rules and user interactions:

1. The 'lower value' thumb can not move past the 'higher value' thumb.
2. Whereas the Slider control only has one value property, the RangeSlider has a low value and a high value property, not surprisingly represented by the 'low value' and 'high value' thumbs.
3. The area between the low and high values represents the allowable range. For example, if the low value is 2 and the high value is 8, then the allowable range is between 2 and 8.
4. The allowable range area is rendered differently. This area is able to be dragged with mouse/touch input to allow for the entire range to be modified. For example, following on from the previous example of the allowable range being between 2 and 8, if the user drags the range bar to the right, the low value will adjust to 3, and the high value 9, and so on until the user stops adjusting.

Code Samples

Instantiating a RangeSlider is simple. The first decision is to decide whether a horizontal or a vertical track is more appropriate. By default RangeSlider instances are horizontal, but this can be changed by setting the orientation property.

Once the orientation is determined, the next most important decision is to determine what the min/max and default low/high values are. The min/max values represent the smallest and largest legal values for the thumbs to be set to, whereas the low/high values represent where the thumbs are currently, within the bounds of the min/max values. Because all four values are required in all circumstances, they are all required parameters to instantiate a RangeSlider: the constructor takes four doubles, representing min, max, lowValue and highValue (in that order).

For example, here is a simple horizontal RangeSlider that has a minimum value of 0, a maximum value of 100, a low value of 10 and a high value of 90:

final RangeSlider hSlider = new RangeSlider( 0, 100, 10, 90 );

To create a vertical slider, simply do the following:

 final RangeSlider vSlider = new RangeSlider( 0, 200, 30, 150 );
  vSlider.setOrientation( Orientation.VERTICAL );

This code creates a vertical RangeSlider with a min value of 0, a max value of 200, a low value of 30, and a high value of 150.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: RangeSlider.java 1121 2024-03-16 16:51:23Z tquadrat $

Since:

0.4.6

See Also:

• Slider

Inspired through:

ControlsFX Project

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.fx.control.RangeSlider"

⁠

Property Summary

Properties

Type	Property	Description
final DoubleProperty	blockIncrement	Returns a reference to the property that holds the amount by which to adjust the slider if the track of the slider is clicked.
final BooleanProperty	highValueChanging	Returns a reference to the property that indicates a change to the high value of this RangeSlider.
final DoubleProperty	highValue	Returns a reference to the property that holds the high value.
final ObjectProperty<StringConverter<Number>>	labelFormatter	Returns a reference to the property that holds the StringConverter that is used to format the tick mark labels.
final BooleanProperty	lowValueChanging	Returns a reference to the property that indicates a change to the low value of this RangeSlider.
final DoubleProperty	lowValue	Returns a reference to the property that holds the low value.
final DoubleProperty	majorTickUnit	Returns a reference to the property that holds the unit distance between major tick marks.
final DoubleProperty	max	Returns a reference to the property that holds the maximum value for this RangeSlider.
final IntegerProperty	minorTickCount	Returns a reference to the property that holds the number of minor ticks to place between any two major ticks.
final DoubleProperty	min	Returns a reference to the property that holds the minimum value for this RangeSlider.
final ObjectProperty<Orientation>	orientation	Returns a reference to the property that holds the orientation of this RangeSlider.
final BooleanProperty	showTickLabels	Returns a reference to the property that holds the flag that indicates that the labels for tick marks should be shown.
final BooleanProperty	showTickMarks	Returns a reference to the property that holds the flag that specifies whether the Skin implementation should show tick marks.
final BooleanProperty	snapToTicks	Returns a reference to the property that holds the flag that indicates whether the low value/high value thumbs of the RangeSlider should always be aligned with the tick marks.

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

Modifier and Type	Class	Description
protected static final class	RangeSlider.StyleableProperties	The styleable properties for RangeSlider.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_STYLE_CLASS	The default style class for RangeSlider instances: "range-slider".
private static final PseudoClass	HORIZONTAL_PSEUDOCLASS_STATE	The CSS pseudo class for the horizontal orientation of a RangeSlider.
private final StyleableDoubleProperty	m_BlockIncrementProperty	The property for the amount by which to adjust the slider if the track of the slider is clicked.
private final BooleanProperty	m_HighValueChangingProperty	The property that indicates a change to the high value of this RangeSlider.
private final DoubleProperty	m_HighValueProperty	The high value property.
private final BooleanProperty	m_LowValueChangingProperty	The property that indicates a change to the low value of this RangeSlider.
private final DoubleProperty	m_LowValueProperty	The low value property.
private final StyleableDoubleProperty	m_MajorTickUnitProperty	The property for the unit distance between major tick marks.
private final DoubleProperty	m_MaxProperty	The property for the maximum value of this RangeSlider.
private final StyleableIntegerProperty	m_MinorTickCountProperty	The property for the number of minor ticks to place between any two major ticks.
private final DoubleProperty	m_MinProperty	The property for the maximum value of this RangeSlider.
private final StyleableObjectProperty<Orientation>	m_OrientationProperty	The property that holds the orientation of this RangeSlider.
private final StyleableBooleanProperty	m_ShowTickLabelsProperty	The property for the flag that indicates whether the labels for the tick marks are shown or not.
private final StyleableBooleanProperty	m_ShowTickMarksProperty	The property that holds the flag that specifies whether the Skin implementation should show tick marks for this RangeSlider.
private final StyleableBooleanProperty	m_SnapToTicksProperty	The property for the flag that controls whether the thumbs will snap to the tick marks.
private final ObjectProperty<StringConverter<Number>>	m_TickLabelFormatterProperty	The property for the tick label formatter.
private static final PseudoClass	VERTICAL_PSEUDOCLASS_STATE	The CSS pseudo class for the vertical orientation of a RangeSlider.

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
RangeSlider()	Creates a new RangeSlider instance using default values of 0.0, 0.25, 0.75 and 1.0 for min/lowValue/highValue/max, respectively.
RangeSlider(double min, double max, double lowValue, double highValue)	Instantiates a default, horizontal RangeSlider instance with the specified min/max/low/high values.

Method Summary

Modifier and Type	Method	Description
final void	adjustHighValue(double newHigh)	Adjusts highValue to match the given newHigh, or as closely as possible within the constraints imposed by the min and max properties.
private final void	adjustHighValues()	Adjusts the high value.
final void	adjustLowValue(double newLow)	Adjusts the lowValue to match the given newLow, or as closely as possible within the constraints imposed by the min and max properties.
private final void	adjustLowValues()	Adjusts the low value.
private final void	adjustValues()	Ensures that min is always < max, that the current value is always somewhere between the two, and that if snapToTicks is set then the value will always be set to align with a tick mark.
final DoubleProperty	blockIncrementProperty()	Returns a reference to the property that holds the amount by which to adjust the slider if the track of the slider is clicked.
protected final Skin<?>	createDefaultSkin()
final void	decrementHighValue()	Decrements the high value by the block increment amount.
final void	decrementLowValue()	Decrements the low value by the block increment amount.
final double	getBlockIncrement()	Returns the amount by which to adjust the slider if the track of the slider is clicked.
static List<CssMetaData<? extends Styleable,?>>	getClassCssMetaData()	Gets the CssMetaData associated with this class, which may include the CssMetaData of its super classes.
final List<CssMetaData<? extends Styleable,?>>	getControlCssMetaData()
final double	getHighValue()	Returns the current high value for the range slider.
final StringConverter<Number>	getLabelFormatter()	Returns the tick label formatter.
final double	getLowValue()	Returns the current low value for the range slider.
final double	getMajorTickUnit()	Returns the unit distance between major tick marks.
final double	getMax()	Returns the maximum value for this RangeSlider.
final double	getMin()	Returns the minimum value for this RangeSlider.
final int	getMinorTickCount()	Returns the number of minor ticks to place between any two major ticks.
final Orientation	getOrientation()	Returns the orientation of the RangeSlider.
final String	getUserAgentStylesheet()
final BooleanProperty	highValueChangingProperty()	Returns a reference to the property that indicates a change to the high value of this RangeSlider.
final DoubleProperty	highValueProperty()	Returns a reference to the property that holds the high value.
final void	incrementHighValue()	Increments the high value by the block increment amount.
final void	incrementLowValue()	Increments the low value value by the block increment amount.
final boolean	isHighValueChanging()	Returns whether the high value of this RangeSlider is currently changing.
final boolean	isLowValueChanging()	Returns whether the low value of this RangeSlider is currently changing.
final boolean	isShowTickLabels()	Returns the flag indicating whether labels of tick marks are being shown.
final boolean	isShowTickMarks()	Returns the flag indication whether the tick marks are shown.
final boolean	isSnapToTicks()	Returns the flag that controls whether the thumbs will snap to the tick marks.
final ObjectProperty<StringConverter<Number>>	labelFormatterProperty()	Returns a reference to the property that holds the StringConverter that is used to format the tick mark labels.
final BooleanProperty	lowValueChangingProperty()	Returns a reference to the property that indicates a change to the low value of this RangeSlider.
final DoubleProperty	lowValueProperty()	Returns a reference to the property that holds the low value.
final DoubleProperty	majorTickUnitProperty()	Returns a reference to the property that holds the unit distance between major tick marks.
final DoubleProperty	maxProperty()	Returns a reference to the property that holds the maximum value for this RangeSlider.
final IntegerProperty	minorTickCountProperty()	Returns a reference to the property that holds the number of minor ticks to place between any two major ticks.
final DoubleProperty	minProperty()	Returns a reference to the property that holds the minimum value for this RangeSlider.
final ObjectProperty<Orientation>	orientationProperty()	Returns a reference to the property that holds the orientation of this RangeSlider.
final void	setBlockIncrement(double value)	Sets the amount by which to adjust the slider if the track of the slider is clicked.
final void	setHighValue(double high)	Sets the high value for the range slider, which may or may not be clamped to be within the allowable range as specified by the min and max properties.
final void	setHighValueChanging(boolean flag)	Call this when high value is changing.
final void	setLabelFormatter(StringConverter<Number> formatter)	Sets the tick label formatter.
final void	setLowValue(double low)	Sets the low value for the range slider, which may or may not be clamped to be within the allowable range as specified by the min and max properties.
final void	setLowValueChanging(boolean flag)	Call this when the low value is changing.
final void	setMajorTickUnit(double tickUnit)	Sets the unit distance between major tick marks.
final void	setMax(double max)	Sets the maximum value for this RangeSlider.
final void	setMin(double min)	Sets the minimum value for this RangeSlider.
final void	setMinorTickCount(int numberOfTicks)	Sets the number of minor ticks to place between any two major ticks.
final void	setOrientation(Orientation orientation)	Sets the orientation of the RangeSlider.
final void	setShowTickLabels(boolean flag)	Sets whether labels of tick marks should be shown or not.
final void	setShowTickMarks(boolean flag)	Sets whether tick marks should be shown or not.
final void	setSnapToTicks(boolean flag)	Sets the flag that controls whether the thumbs will snap to the tick marks.
final BooleanProperty	showTickLabelsProperty()	Returns a reference to the property that holds the flag that indicates that the labels for tick marks should be shown.
final BooleanProperty	showTickMarksProperty()	Returns a reference to the property that holds the flag that specifies whether the Skin implementation should show tick marks.
final BooleanProperty	snapToTicksProperty()	Returns a reference to the property that holds the flag that indicates whether the low value/high value thumbs of the RangeSlider should always be aligned with the tick marks.
private final double	snapValueToTicks(double value)	Aligns the given value with the nearest tick mark value.

Methods inherited from class org.tquadrat.foundation.fx.internal.FoundationFXControl

getUserAgentStylesheet

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

blockIncrement

public final DoubleProperty blockIncrementProperty

Returns a reference to the property that holds the amount by which to adjust the slider if the track of the slider is clicked. This is used when manipulating the slider position using keys. If snapToTicks is true then the nearest tick mark to the adjusted value will be used.

See Also:

• getBlockIncrement()
• setBlockIncrement(double)
• blockIncrementProperty()

highValueChanging

public final BooleanProperty highValueChangingProperty

Returns a reference to the property that indicates a change to the high value of this RangeSlider.

When the property is set to true, it indicates that the current high value of this RangeSlider is changing. It provides notification that the high value is changing. Once the high value is computed, it is set back to false.

See Also:

• isHighValueChanging()
• setHighValueChanging(boolean)
• highValueChangingProperty()

highValue

public final DoubleProperty highValueProperty

Returns a reference to the property that holds the high value.

The high value property represents the current position of the high value thumb, and is within the allowable range as specified by the min and max properties. By default this value is 100.

See Also:

• getHighValue()
• setHighValue(double)
• highValueProperty()

labelFormatter

public final ObjectProperty<StringConverter<Number>> labelFormatterProperty

Returns a reference to the property that holds the StringConverter that is used to format the tick mark labels.

If null, a default will be used.

See Also:

• getLabelFormatter()
• setLabelFormatter(StringConverter)
• labelFormatterProperty()

lowValueChanging

public final BooleanProperty lowValueChangingProperty

Returns a reference to the property that indicates a change to the low value of this RangeSlider.

When the property is set to true, it indicates that the current low value of this RangeSlider is changing. It provides notification that the low value is changing. Once the low value is computed, the property is set back to false.

See Also:

• isLowValueChanging()
• setLowValueChanging(boolean)
• lowValueChangingProperty()

lowValue

public final DoubleProperty lowValueProperty

Returns a reference to the property that holds the low value.

The low value property represents the current position of the low value thumb, and is within the allowable range as specified by the min and max properties. By default this value is 0.

See Also:

• getLowValue()
• setLowValue(double)
• lowValueProperty()

majorTickUnit

public final DoubleProperty majorTickUnitProperty

Returns a reference to the property that holds the unit distance between major tick marks. For example, if the min value is 0 and the max value is 100 and the majorTickUnit is set to 25, then there would be 5 tick marks: one at position 0, one at position 25, one at position 50, one at position 75, and a final one at position 100.

This value should be positive and should be a value less than the span. Out of range values are essentially the same as disabling tick marks.

See Also:

• getMajorTickUnit()
• setMajorTickUnit(double)
• majorTickUnitProperty()

max

public final DoubleProperty maxProperty

Returns a reference to the property that holds the maximum value for this RangeSlider.

See Also:

• getMax()
• setMax(double)
• maxProperty()

minorTickCount

public final IntegerProperty minorTickCountProperty

Returns a reference to the property that holds the number of minor ticks to place between any two major ticks. This number should be positive or zero. Out of range values will disable minor ticks, as will a value of zero.

See Also:

• getMinorTickCount()
• setMinorTickCount(int)
• minorTickCountProperty()

min

public final DoubleProperty minProperty

Returns a reference to the property that holds the minimum value for this RangeSlider.

See Also:

• getMin()
• setMin(double)
• minProperty()

orientation

public final ObjectProperty<Orientation> orientationProperty

Returns a reference to the property that holds the orientation of this RangeSlider.

The orientation can either be horizontal or vertical.

See Also:

• getOrientation()
• setOrientation(Orientation)
• orientationProperty()

showTickLabels

public final BooleanProperty showTickLabelsProperty

Returns a reference to the property that holds the flag that indicates that the labels for tick marks should be shown.

Typically, a Skin implementation will only show labels if showTickMarks is also true.

See Also:

• isShowTickLabels()
• setShowTickLabels(boolean)
• showTickLabelsProperty()

showTickMarks

public final BooleanProperty showTickMarksProperty

Returns a reference to the property that holds the flag that specifies whether the Skin implementation should show tick marks.

See Also:

• isShowTickMarks()
• setShowTickMarks(boolean)
• showTickMarksProperty()

snapToTicks

public final BooleanProperty snapToTicksProperty

Returns a reference to the property that holds the flag that indicates whether the low value/high value thumbs of the RangeSlider should always be aligned with the tick marks. This is honored even if the tick marks are not shown.

See Also:

• isSnapToTicks()
• setSnapToTicks(boolean)
• snapToTicksProperty()

Field Details

DEFAULT_STYLE_CLASS

public static final String DEFAULT_STYLE_CLASS

The default style class for RangeSlider instances: "range-slider".

See Also:

• Constant Field Values

m_BlockIncrementProperty

private final StyleableDoubleProperty m_BlockIncrementProperty

The property for the amount by which to adjust the slider if the track of the slider is clicked.

m_HighValueChangingProperty

private final BooleanProperty m_HighValueChangingProperty

The property that indicates a change to the high value of this RangeSlider.

m_HighValueProperty

private final DoubleProperty m_HighValueProperty

The high value property. It represents the current position of the high value thumb, and is within the allowable range as specified by the min and max properties. By default this value is 100.

m_LowValueChangingProperty

private final BooleanProperty m_LowValueChangingProperty

The property that indicates a change to the low value of this RangeSlider.

m_LowValueProperty

private final DoubleProperty m_LowValueProperty

The low value property. It represents the current position of the low value thumb, and is within the allowable range as specified by the min and max properties. By default this value is 0.

m_MajorTickUnitProperty

private final StyleableDoubleProperty m_MajorTickUnitProperty

The property for the unit distance between major tick marks.

m_MaxProperty

private final DoubleProperty m_MaxProperty

The property for the maximum value of this RangeSlider.

m_MinorTickCountProperty

private final StyleableIntegerProperty m_MinorTickCountProperty

The property for the number of minor ticks to place between any two major ticks.

m_MinProperty

private final DoubleProperty m_MinProperty

The property for the maximum value of this RangeSlider.

m_OrientationProperty

private final StyleableObjectProperty<Orientation> m_OrientationProperty

The property that holds the orientation of this RangeSlider.

m_ShowTickLabelsProperty

private final StyleableBooleanProperty m_ShowTickLabelsProperty

The property for the flag that indicates whether the labels for the tick marks are shown or not.

m_ShowTickMarksProperty

private final StyleableBooleanProperty m_ShowTickMarksProperty

The property that holds the flag that specifies whether the Skin implementation should show tick marks for this RangeSlider.

m_SnapToTicksProperty

private final StyleableBooleanProperty m_SnapToTicksProperty

The property for the flag that controls whether the thumbs will snap to the tick marks.

m_TickLabelFormatterProperty

private final ObjectProperty<StringConverter<Number>> m_TickLabelFormatterProperty

The property for the tick label formatter.

HORIZONTAL_PSEUDOCLASS_STATE

private static final PseudoClass HORIZONTAL_PSEUDOCLASS_STATE

The CSS pseudo class for the horizontal orientation of a RangeSlider.

VERTICAL_PSEUDOCLASS_STATE

private static final PseudoClass VERTICAL_PSEUDOCLASS_STATE

The CSS pseudo class for the vertical orientation of a RangeSlider.

Constructor Details

RangeSlider

public RangeSlider()

Creates a new RangeSlider instance using default values of 0.0, 0.25, 0.75 and 1.0 for min/lowValue/highValue/max, respectively.

RangeSlider

public RangeSlider(double min,
 double max,
 double lowValue,
 double highValue)

Instantiates a default, horizontal RangeSlider instance with the specified min/max/low/high values.

Parameters:

min - The minimum allowable value that the RangeSlider will allow.

max - The maximum allowable value that the RangeSlider will allow.

lowValue - The initial value for the low value in the RangeSlider.

highValue - The initial value for the high value in the RangeSlider.

Method Details

adjustHighValue

public final void adjustHighValue(double newHigh)

Adjusts highValue to match the given newHigh, or as closely as possible within the constraints imposed by the min and max properties. This method also takes into account the snapToTicks flag, which is the main difference between adjustHighValue() and setHighValue().

Parameters:

newHigh - The new value.

adjustHighValues

private final void adjustHighValues()

Adjusts the high value.

See Also:

• adjustValues()

adjustLowValue

public final void adjustLowValue(double newLow)

Adjusts the lowValue to match the given newLow, or as closely as possible within the constraints imposed by the min and max properties. This method also takes into account the snapToTicks flag, which is the main difference between adjustLowValue() and setLowValue().

Parameters:

newLow - The new value.

adjustLowValues

private final void adjustLowValues()

Adjusts the low value.

See Also:

• adjustValues()

adjustValues

private final void adjustValues()

Ensures that min is always < max, that the current value is always somewhere between the two, and that if snapToTicks is set then the value will always be set to align with a tick mark.

blockIncrementProperty

public final DoubleProperty blockIncrementProperty()

Returns a reference to the property that holds the amount by which to adjust the slider if the track of the slider is clicked. This is used when manipulating the slider position using keys. If snapToTicks is true then the nearest tick mark to the adjusted value will be used.

Returns:

The property reference.

See Also:

• getBlockIncrement()
• setBlockIncrement(double)

createDefaultSkin

protected final Skin<?> createDefaultSkin()

Overrides:

createDefaultSkin in class Control

decrementHighValue

public final void decrementHighValue()

Decrements the high value by the block increment amount.

decrementLowValue

public final void decrementLowValue()

Decrements the low value by the block increment amount.

getBlockIncrement

public final double getBlockIncrement()

Returns the amount by which to adjust the slider if the track of the slider is clicked.

Returns:

The amount by which to adjust the slider if the track of the slider is clicked.

See Also:

• blockIncrementProperty()

getClassCssMetaData

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

Gets the CssMetaData associated with this class, which may include the CssMetaData of its super classes.

Returns:

The CssMetaData for this class.

getControlCssMetaData

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

Overrides:

getControlCssMetaData in class Control

getHighValue

public final double getHighValue()

Returns the current high value for the range slider.

Returns:

The high value.

getLabelFormatter

public final StringConverter<Number> getLabelFormatter()

Returns the tick label formatter.

Returns:

The StringConverter that is used as the tick label formatter.

getLowValue

public final double getLowValue()

Returns the current low value for the range slider.

Returns:

The low value.

getMajorTickUnit

public final double getMajorTickUnit()

Returns the unit distance between major tick marks.

Returns:

The unit distance between major tick marks.

See Also:

• majorTickUnitProperty()

getMax

public final double getMax()

Returns the maximum value for this RangeSlider.

100 is returned if the maximum value has never been set.

Returns:

The maximum value for this range slider.

getMin

public final double getMin()

Returns the minimum value for this RangeSlider.

0 is returned if the minimum has never been set.

Returns:

The minimum value for this range slider.

getMinorTickCount

public final int getMinorTickCount()

Returns the number of minor ticks to place between any two major ticks.

Returns:

The number of minor ticks to place between any two major ticks.

See Also:

• minorTickCountProperty()

getOrientation

public final Orientation getOrientation()

Returns the orientation of the RangeSlider.

Returns:

The orientation of the RangeSlider. Orientation.HORIZONTAL is returned by default.

getUserAgentStylesheet

public final String getUserAgentStylesheet()

Overrides:

getUserAgentStylesheet in class Region

highValueChangingProperty

public final BooleanProperty highValueChangingProperty()

Returns a reference to the property that indicates a change to the high value of this RangeSlider.

When the property is set to true, it indicates that the current high value of this RangeSlider is changing. It provides notification that the high value is changing. Once the high value is computed, it is set back to false.

Returns:

The property reference.

See Also:

• isHighValueChanging()
• setHighValueChanging(boolean)

highValueProperty

public final DoubleProperty highValueProperty()

Returns a reference to the property that holds the high value.

The high value property represents the current position of the high value thumb, and is within the allowable range as specified by the min and max properties. By default this value is 100.

Returns:

The property reference.

See Also:

• getHighValue()
• setHighValue(double)

incrementHighValue

public final void incrementHighValue()

Increments the high value by the block increment amount.

incrementLowValue

public final void incrementLowValue()

Increments the low value value by the block increment amount.

isHighValueChanging

public final boolean isHighValueChanging()

Returns whether the high value of this RangeSlider is currently changing.

Returns:

true if the high value is currently changing, otherwise false.

isLowValueChanging

public final boolean isLowValueChanging()

Returns whether the low value of this RangeSlider is currently changing.

Returns:

true if the low value is currently changing, otherwise false.

isShowTickLabels

public final boolean isShowTickLabels()

Returns the flag indicating whether labels of tick marks are being shown.

Returns:

true if the tick mark label are shown, otherwise false.

isShowTickMarks

public final boolean isShowTickMarks()

Returns the flag indication whether the tick marks are shown.

Returns:

true if the tick marks are shown, otherwise false.

isSnapToTicks

public final boolean isSnapToTicks()

Returns the flag that controls whether the thumbs will snap to the tick marks.

Returns:

true if the thumbs will snap to the tick marks, otherwise false.

See Also:

• snapToTicksProperty()

labelFormatterProperty

public final ObjectProperty<StringConverter<Number>> labelFormatterProperty()

Returns a reference to the property that holds the StringConverter that is used to format the tick mark labels.

If null, a default will be used.

Returns:

The property reference.

See Also:

• getLabelFormatter()
• setLabelFormatter(StringConverter)

lowValueChangingProperty

public final BooleanProperty lowValueChangingProperty()

Returns a reference to the property that indicates a change to the low value of this RangeSlider.

When the property is set to true, it indicates that the current low value of this RangeSlider is changing. It provides notification that the low value is changing. Once the low value is computed, the property is set back to false.

Returns:

The property reference.

See Also:

• isLowValueChanging()
• setLowValueChanging(boolean)

lowValueProperty

public final DoubleProperty lowValueProperty()

Returns a reference to the property that holds the low value.

The low value property represents the current position of the low value thumb, and is within the allowable range as specified by the min and max properties. By default this value is 0.

Returns:

The property reference.

See Also:

• getLowValue()
• setLowValue(double)

majorTickUnitProperty

public final DoubleProperty majorTickUnitProperty()

Returns a reference to the property that holds the unit distance between major tick marks. For example, if the min value is 0 and the max value is 100 and the majorTickUnit is set to 25, then there would be 5 tick marks: one at position 0, one at position 25, one at position 50, one at position 75, and a final one at position 100.

This value should be positive and should be a value less than the span. Out of range values are essentially the same as disabling tick marks.

Returns:

The property reference.

See Also:

• getMajorTickUnit()
• setMajorTickUnit(double)

maxProperty

public final DoubleProperty maxProperty()

Returns a reference to the property that holds the maximum value for this RangeSlider.

Returns:

The property reference.

See Also:

• getMax()
• setMax(double)

minorTickCountProperty

public final IntegerProperty minorTickCountProperty()

Returns a reference to the property that holds the number of minor ticks to place between any two major ticks. This number should be positive or zero. Out of range values will disable minor ticks, as will a value of zero.

Returns:

The property reference.

See Also:

• getMinorTickCount()
• setMinorTickCount(int)

minProperty

public final DoubleProperty minProperty()

Returns a reference to the property that holds the minimum value for this RangeSlider.

Returns:

The property reference.

See Also:

• getMin()
• setMin(double)

orientationProperty

public final ObjectProperty<Orientation> orientationProperty()

Returns a reference to the property that holds the orientation of this RangeSlider.

The orientation can either be horizontal or vertical.

Returns:

The property reference.

See Also:

• getOrientation()
• setOrientation(Orientation)

setBlockIncrement

public final void setBlockIncrement(double value)

Sets the amount by which to adjust the slider if the track of the slider is clicked.

Parameters:

value - The adjustment value.

See Also:

• blockIncrementProperty()

setHighValueChanging

public final void setHighValueChanging(boolean flag)

Call this when high value is changing.

Parameters:

flag - true if the high value is currently changing, false otherwise.

setHighValue

public final void setHighValue(double high)

Sets the high value for the range slider, which may or may not be clamped to be within the allowable range as specified by the min and max properties.

Parameters:

high - The value.

setLabelFormatter

public final void setLabelFormatter(StringConverter<Number> formatter)

Sets the tick label formatter.

Parameters:

formatter - The StringConverter that is used to format the tick labels.

setLowValue

public final void setLowValue(double low)

Sets the low value for the range slider, which may or may not be clamped to be within the allowable range as specified by the min and max properties.

Parameters:

low - The value.

setLowValueChanging

public final void setLowValueChanging(boolean flag)

Call this when the low value is changing.

Parameters:

flag - true if the low value is changing, false otherwise.

setMajorTickUnit

public final void setMajorTickUnit(double tickUnit)

Sets the unit distance between major tick marks.

Parameters:

tickUnit - The unit distance.

See Also:

• majorTickUnitProperty()

setMax

public final void setMax(double max)

Sets the maximum value for this RangeSlider.

Parameters:

max - The new value.

setMin

public final void setMin(double min)

Sets the minimum value for this RangeSlider.

Parameters:

min - The new value

setMinorTickCount

public final void setMinorTickCount(int numberOfTicks)

Sets the number of minor ticks to place between any two major ticks.

Parameters:

numberOfTicks - The number of minor ticks; should be 0 or a positive number, out of range values will disable the feature.

See Also:

• minorTickCountProperty()

setOrientation

public final void setOrientation(Orientation orientation)

Sets the orientation of the RangeSlider.

Parameters:

orientation - The orientation.

setSnapToTicks

public final void setSnapToTicks(boolean flag)

Sets the flag that controls whether the thumbs will snap to the tick marks.

Parameters:

flag - true if the thumbs snaps to the tick marks, false if not.

See Also:

• snapToTicksProperty()

setShowTickLabels

public final void setShowTickLabels(boolean flag)

Sets whether labels of tick marks should be shown or not.

Parameters:

flag - true if the tick mark labels should be shown, false if not.

setShowTickMarks

public final void setShowTickMarks(boolean flag)

Sets whether tick marks should be shown or not.

Parameters:

flag - true if the tick marks are shown, false if not.

showTickLabelsProperty

public final BooleanProperty showTickLabelsProperty()

Returns a reference to the property that holds the flag that indicates that the labels for tick marks should be shown.

Typically, a Skin implementation will only show labels if showTickMarks is also true.

Returns:

The property reference.

See Also:

• isShowTickLabels()
• setShowTickLabels(boolean)

showTickMarksProperty

public final BooleanProperty showTickMarksProperty()

Returns a reference to the property that holds the flag that specifies whether the Skin implementation should show tick marks.

Returns:

The property reference.

See Also:

• isShowTickMarks()
• setShowTickMarks(boolean)

snapToTicksProperty

public final BooleanProperty snapToTicksProperty()

Returns a reference to the property that holds the flag that indicates whether the low value/high value thumbs of the RangeSlider should always be aligned with the tick marks. This is honored even if the tick marks are not shown.

Returns:

The property reference.

See Also:

• isSnapToTicks()
• setSnapToTicks(boolean)

snapValueToTicks

private final double snapValueToTicks(double value)

Aligns the given value with the nearest tick mark value.

Parameters:

value - The value.

Returns:

The adjusted value.