Module org.tquadrat.foundation.fx

Package org.tquadrat.foundation.fx.control

Class TimeSlider

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.TimeSlider

All Implemented Interfaces:

Styleable, EventTarget, Skinnable

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

A TimeSlider is basically a RangeSlider for the input of times and durations.

In fact, this implementation wraps a RangeSlider instance that is configured in a special way.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.4.6

UML Diagram

⁠

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

⁠

Property Summary

Properties

Type	Property	Description
final ObjectProperty<LocalDate>	day	Returns a reference to the property that holds the day for the times.
final ReadOnlyObjectProperty<Duration>	duration	Returns a reference to the property that holds the duration of the time period between low and high.
final StyleableObjectProperty<TimeSlider.Granularity>	granularity	Returns a reference to the property that holds the granularity for the TimeSlider.
final ObjectProperty<OffsetTime>	highValue	Returns a reference to the property that holds the high value.
final ObjectProperty<OffsetTime>	lowValue	Returns a reference to the property that holds the low value.
final ObjectProperty<LocalTime>	maxDisplay	Returns a reference to the property that holds the maximum displayed value for this TimeSlider.
final ReadOnlyObjectProperty<ZonedDateTime>	maxValue	Returns a reference to the property that holds the maximum value for this TimeSlider.
final Property<LocalTime>	minDisplay	Returns a reference to the property that holds the minimum value for this TimeSlider.
final ReadOnlyObjectProperty<ZonedDateTime>	minValue	Returns a reference to the property that holds the minimum for this TimeSlider.
final BooleanProperty	snapToTicks	Returns a reference to the property that holds the flag that indicates whether the low value/high value thumbs of the TimeSlider should always be aligned with the tick marks.
final ReadOnlyObjectProperty<ZoneId>	timeZone	Returns a reference to the property that holds the time zone that is used to determine the offset for the times.

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
static enum	TimeSlider.Granularity	The granularity for the TimeSlider.
private static final class	TimeSlider.GranularityConverter	An implementation of StyleConverter for the TimeSlider.Granularity.
protected static final class	TimeSlider.StyleableProperties	The styleable properties for TimeSlider.

Field Summary

Fields

Modifier and Type	Field	Description
private final ObjectProperty<LocalDate>	m_DayProperty	The property for the day for that the times should be set.
private final ObjectProperty<Duration>	m_DurationProperty	The property that holds the duration of the time period between low and high.
private final StyleableObjectProperty<TimeSlider.Granularity>	m_GranularityProperty	The property that holds the granularity for the TimeSlider.
private final ObjectProperty<OffsetTime>	m_HighValueProperty	The high value property.
private final ObjectProperty<OffsetTime>	m_LowValueProperty	The low value property.
private final ObjectProperty<LocalTime>	m_MaxDisplayProperty	The property for the maximum displayed value of this TimeSlider.
private final ObjectBinding<ZonedDateTime>	m_MaxValueBinding	The binding that updates the internal m_MaxValueProperty.
private final ObjectProperty<ZonedDateTime>	m_MaxValueProperty	The property for the maximum value of this TimeSlider.
private final ObjectProperty<LocalTime>	m_MinDisplayProperty	The property for the minimum displayed value of this TimeSlider.
private final ObjectBinding<ZonedDateTime>	m_MinValueBinding	The binding that updates the internal m_MinValueProperty.
private final ObjectProperty<ZonedDateTime>	m_MinValueProperty	The property for the minimum value of this TimeSlider.
private final StyleableBooleanProperty	m_SnapToTicksProperty	The property for the flag that controls whether the thumbs will snap to the tick marks.
private final StyleableObjectProperty<ZoneId>	m_TimeZoneProperty	The property for the time zone that is used to calculate the offset for the times.

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
TimeSlider()	Creates a new instance of TimeSlider for the current day and the default time zone.
TimeSlider(LocalDate day)	Creates a new instance of TimeSlider for the given day and the default time zone.
TimeSlider(LocalDate day, LocalTime min, LocalTime max)	Creates a new instance of TimeSlider for the given day and the default time zone.
TimeSlider(LocalDate day, ZoneId timeZone)	Creates a new instance of TimeSlider for the given day and the given time zone.
TimeSlider(LocalDate day, ZoneId timeZone, LocalTime min, LocalTime max)	Creates a new instance of TimeSlider for the given day and the given time zone.
TimeSlider(LocalTime min, LocalTime max)	Creates a new instance of TimeSlider for the current day and the default time zone.

Method Summary

Modifier and Type	Method	Description
protected final Skin<?>	createDefaultSkin()
private final void	dayChangeListener(ObservableValue<? extends LocalDate> observable, LocalDate oldValue, LocalDate newValue)	The implementation of ChangeListener that responds on changes to the day property.
final ObjectProperty<LocalDate>	dayProperty()	Returns a reference to the property that holds the day for the times.
final ReadOnlyObjectProperty<Duration>	durationProperty()	Returns a reference to the property that holds the duration of the time period between low and high.
final LocalDate	getDay()	Returns the day for the times.
final Duration	getDuration()	Returns the duration for the time slider.
final TimeSlider.Granularity	getGranularity()	Returns the granularity for the time slider.
final OffsetTime	getHighValue()	Returns the current high value for the time slider.
final OffsetTime	getLowValue()	Returns the current low value for the range slider.
final LocalTime	getMax()	Returns the maximum displayed value for this TimeSlider.
final LocalTime	getMin()	Returns the minimum displayed value for this TimeSlider.
final ZoneId	getTimeZone()	Returns the time zone that is used to calculate the offset for the times.
final StyleableObjectProperty<TimeSlider.Granularity>	granularityProperty()	Returns a reference to the property that holds the granularity for the TimeSlider.
final ObjectProperty<OffsetTime>	highValueProperty()	Returns a reference to the property that holds the high value.
final boolean	isSnapToTicks()	Returns the flag that controls whether the thumbs will snap to the tick marks.
final ObjectProperty<OffsetTime>	lowValueProperty()	Returns a reference to the property that holds the low value.
final ObjectProperty<LocalTime>	maxDisplayProperty()	Returns a reference to the property that holds the maximum displayed value for this TimeSlider.
final ReadOnlyObjectProperty<ZonedDateTime>	maxValueProperty()	Returns a reference to the property that holds the maximum value for this TimeSlider.
final Property<LocalTime>	minDisplayProperty()	Returns a reference to the property that holds the minimum value for this TimeSlider.
final ReadOnlyObjectProperty<ZonedDateTime>	minValueProperty()	Returns a reference to the property that holds the minimum for this TimeSlider.
final void	setDay(LocalDate day)	Sets the day for this TimeSlider.
final void	setGranularity(TimeSlider.Granularity granularity)	Sets the granularity for this TimeSlider.
final void	setHighValue(LocalTime highValue)	Sets the high value for this TimeSlider, which may or may not be clamped to be within the allowable range as specified by the min and max properties.
final void	setHighValue(OffsetTime highValue)	Sets the high value for this TimeSlider, which may or may not be clamped to be within the allowable range as specified by the min and max properties.
final void	setLowValue(LocalTime lowValue)	Sets the low value for this TimeSlider, which may or may not be clamped to be within the allowable range as specified by the min and max properties.
final void	setLowValue(OffsetTime lowValue)	Sets the low value for this TimeSlider, which may or may not be clamped to be within the allowable range as specified by the min and max properties.
final void	setMax(LocalTime max)	Sets the maximum displayed value for this TimeSlider.
final void	setMin(LocalTime min)	Sets the minimum displayed value for this TimeSlider.
final void	setSnapToTicks(boolean flag)	Sets the flag that controls whether the thumbs will snap to the 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 TimeSlider should always be aligned with the tick marks.
final ReadOnlyObjectProperty<ZoneId>	timeZoneProperty()	Returns a reference to the property that holds the time zone that is used to determine the offset for the times.

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

day

public final ObjectProperty<LocalDate> dayProperty

Returns a reference to the property that holds the day for the times.

See Also:

• getDay()
• setDay(LocalDate)
• dayProperty()

duration

public final ReadOnlyObjectProperty<Duration> durationProperty

Returns a reference to the property that holds the duration of the time period between low and high.

See Also:

• getDuration()
• durationProperty()

granularity

public final StyleableObjectProperty<TimeSlider.Granularity> granularityProperty

Returns a reference to the property that holds the granularity for the TimeSlider. The granularity determines the steps size for the time selection.

See Also:

• getGranularity()
• setGranularity(TimeSlider.Granularity)
• granularityProperty()

highValue

public final ObjectProperty<OffsetTime> 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.

See Also:

• getHighValue()
• setHighValue(OffsetTime)
• highValueProperty()

lowValue

public final ObjectProperty<OffsetTime> 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.

See Also:

• getLowValue()
• setLowValue(OffsetTime)
• lowValueProperty()

maxDisplay

public final ObjectProperty<LocalTime> maxDisplayProperty

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

See Also:

• maxDisplayProperty()

maxValue

public final ReadOnlyObjectProperty<ZonedDateTime> maxValueProperty

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

See Also:

• maxValueProperty()

minDisplay

public final Property<LocalTime> minDisplayProperty

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

See Also:

• minDisplayProperty()

minValue

public final ReadOnlyObjectProperty<ZonedDateTime> minValueProperty

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

See Also:

• minValueProperty()

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 TimeSlider 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()

timeZone

public final ReadOnlyObjectProperty<ZoneId> timeZoneProperty

Returns a reference to the property that holds the time zone that is used to determine the offset for the times.

See Also:

• getTimeZone()
• timeZoneProperty()

Field Details

m_DayProperty

private final ObjectProperty<LocalDate> m_DayProperty

The property for the day for that the times should be set. The value for this property may not be null.

m_DurationProperty

private final ObjectProperty<Duration> m_DurationProperty

The property that holds the duration of the time period between low and high.

m_GranularityProperty

private final StyleableObjectProperty<TimeSlider.Granularity> m_GranularityProperty

The property that holds the granularity for the TimeSlider. The granularity determines the steps size for the time selection.

m_HighValueProperty

private final ObjectProperty<OffsetTime> 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.

m_LowValueProperty

private final ObjectProperty<OffsetTime> 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.

m_MaxDisplayProperty

private final ObjectProperty<LocalTime> m_MaxDisplayProperty

The property for the maximum displayed value of this TimeSlider.

m_MaxValueProperty

private final ObjectProperty<ZonedDateTime> m_MaxValueProperty

The property for the maximum value of this TimeSlider.

This property is fixed bound to the properties maxDisplayProperty(), dayProperty() timeZoneProperty().

m_MaxValueBinding

private final ObjectBinding<ZonedDateTime> m_MaxValueBinding

The binding that updates the internal m_MaxValueProperty.

m_MinDisplayProperty

private final ObjectProperty<LocalTime> m_MinDisplayProperty

The property for the minimum displayed value of this TimeSlider.

m_MinValueProperty

private final ObjectProperty<ZonedDateTime> m_MinValueProperty

The property for the minimum value of this TimeSlider.

This property is fixed bound to the properties minDisplayProperty(), dayProperty() timeZoneProperty().

m_MinValueBinding

private final ObjectBinding<ZonedDateTime> m_MinValueBinding

The binding that updates the internal m_MinValueProperty.

m_SnapToTicksProperty

private final StyleableBooleanProperty m_SnapToTicksProperty

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

m_TimeZoneProperty

private final StyleableObjectProperty<ZoneId> m_TimeZoneProperty

The property for the time zone that is used to calculate the offset for the times.

Constructor Details

TimeSlider

public TimeSlider()

Creates a new instance of TimeSlider for the current day and the default time zone. The time range will be set from 00:00 to 23:59.

Once created, the time zone for the TimeSlider cannot be modified.

TimeSlider

public TimeSlider(LocalDate day)

Creates a new instance of TimeSlider for the given day and the default time zone. The time range will be set from 00:00 to 23:59.

Once created, the time zone for the TimeSlider cannot be modified.

Parameters:

day - The day for the time slider.

TimeSlider

public TimeSlider(LocalDate day,
 ZoneId timeZone)

Creates a new instance of TimeSlider for the given day and the given time zone. The time range will be set from 00:00 to 23:59.

Once created, the time zone for the TimeSlider cannot be modified.

Parameters:

day - The day for the time slider.

timeZone - The time zone.

TimeSlider

public TimeSlider(LocalTime min,
 LocalTime max)

Creates a new instance of TimeSlider for the current day and the default time zone.

Once created, the time zone for the TimeSlider cannot be modified.

Parameters:

min - The minimum displayed time for the slider.

max - The maximum displayed time for the slider.

TimeSlider

public TimeSlider(LocalDate day,
 LocalTime min,
 LocalTime max)

Creates a new instance of TimeSlider for the given day and the default time zone.

Once created, the time zone for the TimeSlider cannot be modified.

Parameters:

day - The day for the time slider.

min - The minimum displayed time for the slider.

max - The maximum displayed time for the slider.

TimeSlider

public TimeSlider(LocalDate day,
 ZoneId timeZone,
 LocalTime min,
 LocalTime max)

Creates a new instance of TimeSlider for the given day and the given time zone.

Once created, the time zone for the TimeSlider cannot be modified.

Parameters:

day - The day for the time slider.

timeZone - The time zone.

min - The minimum displayed time for the slider.

max - The maximum displayed time for the slider.

Method Details

createDefaultSkin

protected final Skin<?> createDefaultSkin()

Overrides:

createDefaultSkin in class Control

dayChangeListener

private final void dayChangeListener(ObservableValue<? extends LocalDate> observable,
 LocalDate oldValue,
 LocalDate newValue)

The implementation of ChangeListener that responds on changes to the day property.

Parameters:

observable - The observable.

oldValue - The old value.

newValue - The new value.

dayProperty

public final ObjectProperty<LocalDate> dayProperty()

Returns a reference to the property that holds the day for the times.

Returns:

The property reference.

See Also:

• getDay()
• setDay(LocalDate)

durationProperty

public final ReadOnlyObjectProperty<Duration> durationProperty()

Returns a reference to the property that holds the duration of the time period between low and high.

Returns:

The property reference.

See Also:

• getDuration()

getDay

public final LocalDate getDay()

Returns the day for the times.

Returns:

The day.

getDuration

public final Duration getDuration()

Returns the duration for the time slider.

Returns:

The duration.

getGranularity

public final TimeSlider.Granularity getGranularity()

Returns the granularity for the time slider.

Returns:

The granularity.

getHighValue

public final OffsetTime getHighValue()

Returns the current high value for the time slider.

Returns:

The high value.

getLowValue

public final OffsetTime getLowValue()

Returns the current low value for the range slider.

Returns:

The low value.

getMax

public final LocalTime getMax()

Returns the maximum displayed value for this TimeSlider.

23:59:59 is returned if the maximum value has never been set explicitly.

Returns:

The maximum value for this time slider.

getMin

public final LocalTime getMin()

Returns the minimum displayed value for this TimeSlider.

00:00:00 is returned if the minimum has never been set explicitly.

Returns:

The minimum value for this time slider.

getTimeZone

public final ZoneId getTimeZone()

Returns the time zone that is used to calculate the offset for the times.

Returns:

The time zone.

granularityProperty

public final StyleableObjectProperty<TimeSlider.Granularity> granularityProperty()

Returns a reference to the property that holds the granularity for the TimeSlider. The granularity determines the steps size for the time selection.

Returns:

The property reference.

See Also:

• getGranularity()
• setGranularity(TimeSlider.Granularity)

highValueProperty

public final ObjectProperty<OffsetTime> 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.

Returns:

The property reference.

See Also:

• getHighValue()
• setHighValue(OffsetTime)

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()

lowValueProperty

public final ObjectProperty<OffsetTime> 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.

Returns:

The property reference.

See Also:

• getLowValue()
• setLowValue(OffsetTime)

maxDisplayProperty

public final ObjectProperty<LocalTime> maxDisplayProperty()

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

Returns:

The property reference.

maxValueProperty

public final ReadOnlyObjectProperty<ZonedDateTime> maxValueProperty()

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

Returns:

The property reference.

minDisplayProperty

public final Property<LocalTime> minDisplayProperty()

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

Returns:

The property reference.

minValueProperty

public final ReadOnlyObjectProperty<ZonedDateTime> minValueProperty()

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

Returns:

The property reference.

setDay

public final void setDay(LocalDate day)

Sets the day for this TimeSlider.

Parameters:

day - The day.

setGranularity

public final void setGranularity(TimeSlider.Granularity granularity)

Sets the granularity for this TimeSlider.

Parameters:

granularity - The granularity.

setHighValue

public final void setHighValue(OffsetTime highValue)

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

Parameters:

highValue - The value.

setHighValue

public final void setHighValue(LocalTime highValue)

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

Parameters:

highValue - The value.

setLowValue

public final void setLowValue(OffsetTime lowValue)

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

Parameters:

lowValue - The value.

setLowValue

public final void setLowValue(LocalTime lowValue)

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

Parameters:

lowValue - The value.

setMax

public final void setMax(LocalTime max)

Sets the maximum displayed value for this TimeSlider.

Parameters:

max - The new value.

setMin

public final void setMin(LocalTime min)

Sets the minimum displayed value for this TimeSlider.

Parameters:

min - The new value

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()

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 TimeSlider 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)

timeZoneProperty

public final ReadOnlyObjectProperty<ZoneId> timeZoneProperty()

Returns a reference to the property that holds the time zone that is used to determine the offset for the times.

Returns:

The property reference.

See Also:

• getTimeZone()