javafx.scene.control

Class SpinnerValueFactory.LocalTimeSpinnerValueFactory

java.lang.Object

javafx.scene.control.SpinnerValueFactory<java.time.LocalTime>

javafx.scene.control.SpinnerValueFactory.LocalTimeSpinnerValueFactory

Enclosing class:

SpinnerValueFactory<T>

static class SpinnerValueFactory.LocalTimeSpinnerValueFactory
extends SpinnerValueFactory<java.time.LocalTime>

A SpinnerValueFactory implementation designed to iterate through LocalTime values.

Note that the default converter is implemented simply as shown below, which may be adequate in many cases, but it is important for users to ensure that this suits their needs (and adjust when necessary):

 setConverter(new StringConverter<LocalTime>() {
     @Override public String toString(LocalTime object) {
         if (object == null) {
             return "";
         }
         return object.toString();
     }

     @Override public LocalTime fromString(String string) {
         return LocalTime.parse(string);
     }
 });

Property Summary

Type	Property and Description
LongProperty	amountToStepBy Sets the amount to increment or decrement by, per step.
<any>	max Sets the maximum allowable value for this value factory
<any>	min Sets the minimum allowable value for this value factory
<any>	temporalUnit The size of each step (e.g.

Properties inherited from class javafx.scene.control.SpinnerValueFactory

converterProperty, valueProperty, wrapAroundProperty

Nested Class Summary

Nested classes/interfaces inherited from class javafx.scene.control.SpinnerValueFactory

SpinnerValueFactory.DoubleSpinnerValueFactory, SpinnerValueFactory.IntegerSpinnerValueFactory, SpinnerValueFactory.ListSpinnerValueFactory<T>, SpinnerValueFactory.LocalDateSpinnerValueFactory, SpinnerValueFactory.LocalTimeSpinnerValueFactory

Field Summary

Fields

Modifier and Type	Field and Description
private LongProperty	amountToStepBy
private <any>	max
private <any>	min * Properties * *
private <any>	temporalUnit

Constructor Summary

Constructors

Constructor and Description
LocalTimeSpinnerValueFactory() Creates a new instance of the LocalTimepinnerValueFactory, using the value returned by calling LocalTime#now() as the initial value, and using a stepping amount of one day.
LocalTimeSpinnerValueFactory(java.time.LocalTime initialValue) Creates a new instance of the LocalTimeSpinnerValueFactory, using the provided initial value, and a stepping amount of one hour.
LocalTimeSpinnerValueFactory(java.time.LocalTime min, java.time.LocalTime max, java.time.LocalTime initialValue) Creates a new instance of the LocalTimeSpinnerValueFactory, using the provided initial value, and a stepping amount of one hour.
LocalTimeSpinnerValueFactory(java.time.LocalTime min, java.time.LocalTime max, java.time.LocalTime initialValue, long amountToStepBy, java.time.temporal.TemporalUnit temporalUnit) Creates a new instance of the LocalTimeSpinnerValueFactory, using the provided min, max, and initial values, as well as the amount to step by and TemporalUnit.

Method Summary

Modifier and Type	Method and Description
LongProperty	amountToStepByProperty() Sets the amount to increment or decrement by, per step.
void	decrement(int steps) Attempts to decrement the value by the given number of steps.
long	getAmountToStepBy() Gets the value of the property amountToStepBy.
java.time.LocalTime	getMax() Gets the value of the property max.
java.time.LocalTime	getMin() Gets the value of the property min.
java.time.temporal.TemporalUnit	getTemporalUnit() Gets the value of the property temporalUnit.
void	increment(int steps) Attempts to omcrement the value by the given number of steps.
<any>	maxProperty() Sets the maximum allowable value for this value factory
<any>	minProperty() Sets the minimum allowable value for this value factory
void	setAmountToStepBy(long value) Sets the value of the property amountToStepBy.
void	setMax(java.time.LocalTime value) Sets the value of the property max.
void	setMin(java.time.LocalTime value) Sets the value of the property min.
void	setTemporalUnit(java.time.temporal.TemporalUnit value) Sets the value of the property temporalUnit.
<any>	temporalUnitProperty() The size of each step (e.g.

Methods inherited from class javafx.scene.control.SpinnerValueFactory

converterProperty, getConverter, getValue, isWrapAround, setConverter, setValue, setWrapAround, valueProperty, wrapAroundProperty

Methods inherited from class java.lang.Object

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

Property Detail

min

public final <any> minProperty

Sets the minimum allowable value for this value factory

max

public final <any> maxProperty

Sets the maximum allowable value for this value factory

See Also:

getMax(), setMax(LocalTime)

temporalUnit

public final <any> temporalUnitProperty

The size of each step (e.g. day, week, month, year, etc).

See Also:

getTemporalUnit(), setTemporalUnit(TemporalUnit)

amountToStepBy

public final LongProperty amountToStepByProperty

Sets the amount to increment or decrement by, per step.

See Also:

getAmountToStepBy(), setAmountToStepBy(long)

Field Detail

min

private <any> min

* Properties * *

max

private <any> max

temporalUnit

private <any> temporalUnit

amountToStepBy

private LongProperty amountToStepBy

Constructor Detail

LocalTimeSpinnerValueFactory

public LocalTimeSpinnerValueFactory()

Creates a new instance of the LocalTimepinnerValueFactory, using the value returned by calling LocalTime#now() as the initial value, and using a stepping amount of one day.

LocalTimeSpinnerValueFactory

public LocalTimeSpinnerValueFactory(java.time.LocalTime initialValue)

Creates a new instance of the LocalTimeSpinnerValueFactory, using the provided initial value, and a stepping amount of one hour.

Parameters:

initialValue - The value of the Spinner when first instantiated.

LocalTimeSpinnerValueFactory

public LocalTimeSpinnerValueFactory(java.time.LocalTime min,
                                    java.time.LocalTime max,
                                    java.time.LocalTime initialValue)

Creates a new instance of the LocalTimeSpinnerValueFactory, using the provided initial value, and a stepping amount of one hour.

Parameters:

min - The minimum allowed double value for the Spinner.

max - The maximum allowed double value for the Spinner.

initialValue - The value of the Spinner when first instantiated.

LocalTimeSpinnerValueFactory

public LocalTimeSpinnerValueFactory(java.time.LocalTime min,
                                    java.time.LocalTime max,
                                    java.time.LocalTime initialValue,
                                    long amountToStepBy,
                                    java.time.temporal.TemporalUnit temporalUnit)

Creates a new instance of the LocalTimeSpinnerValueFactory, using the provided min, max, and initial values, as well as the amount to step by and TemporalUnit.

To better understand, here are a few examples:

• To step by one hour from the current time: new LocalTimeSpinnerValueFactory(LocalTime.MIN, LocalTime.MAX, LocalTime.now(), 1, ChronoUnit.HOURS)
• To step by one minute from the current time: new LocalTimeSpinnerValueFactory(LocalTime.MIN, LocalTime.MAX, LocalTime.now(), 1, ChronoUnit.MINUTES)

Parameters:

min - The minimum allowed double value for the Spinner.

max - The maximum allowed double value for the Spinner.

initialValue - The value of the Spinner when first instantiated.

amountToStepBy - The amount to increment or decrement by, per step.

temporalUnit - The size of each step (e.g. day, week, month, year, etc)

Method Detail

setMin

public final void setMin(java.time.LocalTime value)

Sets the value of the property min.

getMin

public final java.time.LocalTime getMin()

Gets the value of the property min.

minProperty

public final <any> minProperty()

Sets the minimum allowable value for this value factory

setMax

public final void setMax(java.time.LocalTime value)

Sets the value of the property max.

getMax

public final java.time.LocalTime getMax()

Gets the value of the property max.

maxProperty

public final <any> maxProperty()

Sets the maximum allowable value for this value factory

See Also:

getMax(), setMax(LocalTime)

setTemporalUnit

public final void setTemporalUnit(java.time.temporal.TemporalUnit value)

Sets the value of the property temporalUnit.

getTemporalUnit

public final java.time.temporal.TemporalUnit getTemporalUnit()

Gets the value of the property temporalUnit.

temporalUnitProperty

public final <any> temporalUnitProperty()

The size of each step (e.g. day, week, month, year, etc).

See Also:

getTemporalUnit(), setTemporalUnit(TemporalUnit)

setAmountToStepBy

public final void setAmountToStepBy(long value)

Sets the value of the property amountToStepBy.

getAmountToStepBy

public final long getAmountToStepBy()

Gets the value of the property amountToStepBy.

amountToStepByProperty

public final LongProperty amountToStepByProperty()

Sets the amount to increment or decrement by, per step.

See Also:

getAmountToStepBy(), setAmountToStepBy(long)

decrement

public void decrement(int steps)

Attempts to decrement the value by the given number of steps.

Specified by:

decrement in class SpinnerValueFactory<java.time.LocalTime>

Parameters:

steps - The number of decrements that should be performed on the value.

increment

public void increment(int steps)

Attempts to omcrement the value by the given number of steps.

Specified by:

increment in class SpinnerValueFactory<java.time.LocalTime>

Parameters:

steps - The number of increments that should be performed on the value.