Module org.tquadrat.foundation.fx

Package org.tquadrat.foundation.fx.control.skin

Class RangeSliderSkin

java.lang.Object

javafx.scene.control.SkinBase<RangeSlider>

org.tquadrat.foundation.fx.control.skin.RangeSliderSkin

All Implemented Interfaces:

Skin<RangeSlider>

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

The skin for instances of RangeSlider.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.4.6

Inspired through:

ControlsFX Project

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.fx.control.skin.RangeSliderSkin"

⁠

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static enum	RangeSliderSkin.FocusedChild	The indicators for the focus owners.
private static final class	RangeSliderSkin.ThumbPane	The implementation of StackPane that is used for the thumbs of a RangeSlider instance.

Field Summary

Fields

Modifier and Type	Field	Description
private RangeSliderSkin.FocusedChild	m_CurrentFocus	The current focus owner.
private RangeSliderSkin.ThumbPane	m_HighThumb	The high thumb itself.
private RangeSliderSkin.ThumbPane	m_LowThumb	The low thumb itself.
private double	m_LowThumbPos	The position for the low thumb.
private Orientation	m_Orientation	The orientation for the RangeSlider.
private double	m_PreDragPos	Used as a temp value for low and high thumbs.
private Point2D	m_PreDragThumbPoint	The m_PreDragPos in skin coordinates.
private StackPane	m_RangeBar	The bar between the two thumbs, can be dragged.
private double	m_RangeEnd	The end of the range.
private double	m_RangeStart	The start of the range.
private Callback<Void,RangeSliderSkin.FocusedChild>	m_SelectedValue	The callback for the value selection.
private boolean	m_ShowTickMarks	The flag that indicates whether the tick marks are shown or not.
private double	m_ThumbHeight	The height of the thumbs.
private double	m_ThumbWidth	The width of the thumbs.
private NumberAxis	m_TickLine	The tick line.
private StackPane	m_Track	The container that represents the slider track.
private double	m_TrackLength	The length of the track.
private double	m_TrackStart	The start of the track.
private double	m_TrackToTickGap	The width of the gap between the slider track and the tick line.

Constructor Summary

Constructors

Constructor	Description
RangeSliderSkin(RangeSlider control)	Creates a new instance of RangeSliderSkin.

Method Summary

Modifier and Type	Method	Description
private final double	computeIncrement()	Calculates the increment/decrement value that is used by incrementValue() and decrementValue() to move the thumps.
protected final double	computeMaxHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset)
protected final double	computeMaxWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset)
protected final double	computeMinHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset)
protected final double	computeMinWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset)
protected final double	computePrefHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset)
protected final double	computePrefWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset)
private void	confirmRange()	Adjusts the range bar's position after it was released.
private final void	decrementValue()	Moves the selected thumb in the direction to the min value.
private final void	end()	Responds to the END key.
private final double	getMaxMinusMinNoZero()	Returns the difference between RangeSlider.getMax() and RangeSlider.getMin(), but if they have the same value, 1.0 is returned instead of 0.0 because otherwise the division where the result value can be used will return Double.NaN.
private final void	highThumbDragged(MouseEvent ignoredMouseEvent, double position)	Updates the high value based on the new position of the high thumb after it was dragged with the mouse.
private final void	highThumbPressed(MouseEvent ignoredMouseEvent, double ignoredPosition)	Prepares the dragging of the high thumb.
private final void	highThumbReleased(MouseEvent mouseEvent)	Adjusts the high value when the high thumb is released.
private final void	home()	Responds to the HOME key.
private final void	incrementValue()	Moves the selected thumb in the direction to the max value.
private final void	initHighThumb()	Initialises the high thumb.
private final void	initLowThumb()	Initialises the low thumb.
private final void	initRangeBar()	Initialises the range bar.
private final boolean	isHorizontal()	Checks whether the orientation of the RangeSlider is horizontal.
protected final void	layoutChildren(double contentX, double contentY, double contentWidth, double contentHeight)
final void	lowThumbDragged(MouseEvent ignoredMouseEvent, double position)	Updates the low value based on the new position of the low thumb after it was dragged with the mouse.
void	lowThumbPressed(MouseEvent ignoredMouseEvent, double ignoredPosition)	Prepares the dragging of the low thumb.
final void	lowThumbReleased(MouseEvent mouseEvent)	Adjusts the low value when the low thumb is released.
private final double	minTrackLength()	Calculates the minimum length for the track.
private final void	moveRange(double position)	Sets the new positions after a move of the range bar.
private final void	positionHighThumb()	Called whenever either min, max or highValue has changed, so that high thumb's Node.setLayoutX(double) and Node.setLayoutY(double) is recomputed.
private final void	positionLowThumb()	Called whenever either min, max or lowValue has changed, so that low thumb's Node.setLayoutX(double) and Node.setLayoutY(double) is recomputed.
private final void	rtl(RangeSlider node, Runnable rtlMethod, Runnable nonRtlMethod)	Implements the inverted orientation.
private void	setSelectedValue(Callback<Void,RangeSliderSkin.FocusedChild> callback)	Set up a callback to indicate which thumb is currently selected (via enum).
private void	setShowTickMarks(boolean ticksVisible, boolean labelsVisible)	Shows tick marks and their labels.
private final double	snapValueToTicks(double calculatedPosition)	Adjusts the position of a thumb to the nearest tick mark.
private final void	trackPress(MouseEvent ignoredMouseEvent, double position)	Invoked by the RangeSlider's Skin implementation whenever a mouse press occurs on the "track" of the slider.

Methods inherited from class javafx.scene.control.SkinBase

computeBaselineOffset, consumeMouseEvents, dispose, executeAccessibleAction, getChildren, getClassCssMetaData, getCssMetaData, getNode, getSkinnable, layoutInArea, layoutInArea, layoutInArea, positionInArea, positionInArea, pseudoClassStateChanged, queryAccessibleAttribute, registerChangeListener, registerInvalidationListener, registerListChangeListener, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, unregisterChangeListeners, unregisterInvalidationListeners, unregisterListChangeListeners

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javafx.scene.control.Skin

install

Field Details

m_CurrentFocus

private RangeSliderSkin.FocusedChild m_CurrentFocus

The current focus owner.

m_HighThumb

private RangeSliderSkin.ThumbPane m_HighThumb

The high thumb itself.

m_LowThumb

private RangeSliderSkin.ThumbPane m_LowThumb

The low thumb itself.

m_LowThumbPos

private double m_LowThumbPos

The position for the low thumb.

m_Orientation

private Orientation m_Orientation

The orientation for the RangeSlider.

m_PreDragPos

private double m_PreDragPos

Used as a temp value for low and high thumbs.

m_PreDragThumbPoint

private Point2D m_PreDragThumbPoint

The m_PreDragPos in skin coordinates.

m_RangeBar

private StackPane m_RangeBar

The bar between the two thumbs, can be dragged.

m_RangeEnd

private double m_RangeEnd

The end of the range.

m_RangeStart

private double m_RangeStart

The start of the range.

m_SelectedValue

private Callback<Void,RangeSliderSkin.FocusedChild> m_SelectedValue

The callback for the value selection.

m_ShowTickMarks

private boolean m_ShowTickMarks

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

m_ThumbHeight

private double m_ThumbHeight

The height of the thumbs.

m_ThumbWidth

private double m_ThumbWidth

The width of the thumbs.

m_TickLine

private NumberAxis m_TickLine

The tick line.

m_Track

private StackPane m_Track

The container that represents the slider track.

m_TrackLength

private double m_TrackLength

The length of the track.

m_TrackStart

private double m_TrackStart

The start of the track.

m_TrackToTickGap

private double m_TrackToTickGap

The width of the gap between the slider track and the tick line.

Constructor Details

RangeSliderSkin

public RangeSliderSkin(RangeSlider control)

Creates a new instance of RangeSliderSkin.

Parameters:

control - The control for which this Skin should attach to.

Method Details

computeIncrement

private final double computeIncrement()

Calculates the increment/decrement value that is used by incrementValue() and decrementValue() to move the thumps.

Returns:

The increment value (that is also used decrement the position values for the thumbs).

computeMaxHeight

protected final double computeMaxHeight(double width,
 double topInset,
 double rightInset,
 double bottomInset,
 double leftInset)

Overrides:

computeMaxHeight in class SkinBase<RangeSlider>

computeMaxWidth

protected final double computeMaxWidth(double height,
 double topInset,
 double rightInset,
 double bottomInset,
 double leftInset)

Overrides:

computeMaxWidth in class SkinBase<RangeSlider>

computeMinHeight

protected final double computeMinHeight(double width,
 double topInset,
 double rightInset,
 double bottomInset,
 double leftInset)

Overrides:

computeMinHeight in class SkinBase<RangeSlider>

computeMinWidth

protected final double computeMinWidth(double height,
 double topInset,
 double rightInset,
 double bottomInset,
 double leftInset)

Overrides:

computeMinWidth in class SkinBase<RangeSlider>

computePrefHeight

protected final double computePrefHeight(double width,
 double topInset,
 double rightInset,
 double bottomInset,
 double leftInset)

Overrides:

computePrefHeight in class SkinBase<RangeSlider>

computePrefWidth

protected final double computePrefWidth(double height,
 double topInset,
 double rightInset,
 double bottomInset,
 double leftInset)

Overrides:

computePrefWidth in class SkinBase<RangeSlider>

confirmRange

private void confirmRange()

Adjusts the range bar's position after it was released.

decrementValue

private final void decrementValue()

Moves the selected thumb in the direction to the min value.

end

private final void end()

Responds to the END key.

getMaxMinusMinNoZero

private final double getMaxMinusMinNoZero()

Returns the difference between RangeSlider.getMax() and RangeSlider.getMin(), but if they have the same value, 1.0 is returned instead of 0.0 because otherwise the division where the result value can be used will return Double.NaN.

Returns:

The difference.

highThumbDragged

private final void highThumbDragged(MouseEvent ignoredMouseEvent,
 double position)

Updates the high value based on the new position of the high thumb after it was dragged with the mouse.

Parameters:

ignoredMouseEvent - The mouse event.

position - The mouse position on the track with 0.0 being the start of the track and 1.0 being the end.

highThumbPressed

private final void highThumbPressed(MouseEvent ignoredMouseEvent,
 double ignoredPosition)

Prepares the dragging of the high thumb.

When the high thumb is released, RangeSlider.highValueChangingProperty() is set to false.

Parameters:

ignoredMouseEvent - The mouse event.

ignoredPosition - The new position.

highThumbReleased

private final void highThumbReleased(MouseEvent mouseEvent)

Adjusts the high value when the high thumb is released.

Parameters:

mouseEvent - The mouse event.

home

private final void home()

Responds to the HOME key.

incrementValue

private final void incrementValue()

Moves the selected thumb in the direction to the max value.

initHighThumb

private final void initHighThumb()

Initialises the high thumb.

Needs to be called after initLowThumb() and before initRangeBar().

initLowThumb

private final void initLowThumb()

Initialises the low thumb.

Needs to be called before initHighThumb().

initRangeBar

private final void initRangeBar()

Initialises the range bar.

Needs to be called after initHighThumb().

isHorizontal

private final boolean isHorizontal()

Checks whether the orientation of the RangeSlider is horizontal.

Returns:

true if the orientation is Orientation.HORIZONTAL, false when it is Orientation.VERTICAL.

layoutChildren

protected final void layoutChildren(double contentX,
 double contentY,
 double contentWidth,
 double contentHeight)

Overrides:

layoutChildren in class SkinBase<RangeSlider>

lowThumbDragged

public final void lowThumbDragged(MouseEvent ignoredMouseEvent,
 double position)

Updates the low value based on the new position of the low thumb after it was dragged with the mouse.

Parameters:

ignoredMouseEvent - The mouse event.

position - The mouse position on the track with 0.0 being the start of the track and 1.0 being the end.

lowThumbPressed

public void lowThumbPressed(MouseEvent ignoredMouseEvent,
 double ignoredPosition)

Prepares the dragging of the low thumb.

When the low thumb is released, RangeSlider.lowValueChangingProperty() is set to false.

Parameters:

ignoredMouseEvent - The mouse event.

ignoredPosition - The new position.

lowThumbReleased

public final void lowThumbReleased(MouseEvent mouseEvent)

Adjusts the low value when the low thumb is released.

Parameters:

mouseEvent - The mouse event.

minTrackLength

private final double minTrackLength()

Calculates the minimum length for the track.

Returns:

The minimum track length.

moveRange

private final void moveRange(double position)

Sets the new positions after a move of the range bar.

Parameters:

position - The new position.

positionHighThumb

private final void positionHighThumb()

Called whenever either min, max or highValue has changed, so that high thumb's Node.setLayoutX(double) and Node.setLayoutY(double) is recomputed.

positionLowThumb

private final void positionLowThumb()

Called whenever either min, max or lowValue has changed, so that low thumb's Node.setLayoutX(double) and Node.setLayoutY(double) is recomputed.

rtl

private final void rtl(RangeSlider node,
 Runnable rtlMethod,
 Runnable nonRtlMethod)

Implements the inverted orientation.

Parameters:

node - A reference to the node.

rtlMethod - The function that has to be used for an orientation from right to left.

nonRtlMethod - The function that has to be used for an orientation from left to right.

setSelectedValue

private void setSelectedValue(Callback<Void,RangeSliderSkin.FocusedChild> callback)

Set up a callback to indicate which thumb is currently selected (via enum).

Parameters:

callback - The callback.

setShowTickMarks

private void setShowTickMarks(boolean ticksVisible,
 boolean labelsVisible)

Shows tick marks and their labels.

When ticks or labels change their visibility, we have to compute the new visibility and to add the necessary objects. After this method returns, we must be sure to add the high thumb and the range bar.

Parameters:

ticksVisible - true if the tick marks are visible, false if not.

labelsVisible - true if the tick labels are visible, false if not.

snapValueToTicks

private final double snapValueToTicks(double calculatedPosition)

Adjusts the position of a thumb to the nearest tick mark.

Parameters:

calculatedPosition - The calculated raw position.

Returns:

The adjusted position.

trackPress

private final void trackPress(MouseEvent ignoredMouseEvent,
 double position)

Invoked by the RangeSlider's Skin implementation whenever a mouse press occurs on the "track" of the slider. This will cause the thumb to be moved by some amount.

Parameters:

ignoredMouseEvent - The mouse event.

position - The relative mouse position on the track, with 0.0 being the start of the track and 1.0 being the end.