public abstract Class SpinnerValueFactory<T>

Class Inheritance

extends Object

java.lang.Object
javafx.scene.control.SpinnerValueFactory

Known Direct Subclasses

javafx.scene.control.SpinnerValueFactory.ListSpinnerValueFactory, javafx.scene.control.SpinnerValueFactory.IntegerSpinnerValueFactory, javafx.scene.control.SpinnerValueFactory.DoubleSpinnerValueFactory, javafx.scene.control.SpinnerValueFactory.LocalDateSpinnerValueFactory, javafx.scene.control.SpinnerValueFactory.LocalTimeSpinnerValueFactory

Type Parameters

<T>: The type of the data this value factory deals with, which must coincide with the type of the Spinner that the value factory is set on.

Imports

javafx.beans.NamedArg, javafx.beans.property.BooleanProperty, .DoubleProperty, .IntegerProperty, .LongProperty, .ObjectProperty, .SimpleBooleanProperty, .SimpleDoubleProperty, .SimpleIntegerProperty, .SimpleLongProperty, .SimpleObjectProperty, javafx.collections.ListChangeListener, .ObservableList, .WeakListChangeListener, javafx.util.StringConverter, javafx.util.converter.IntegerStringConverter, java.lang.ref.WeakReference, java.math.BigDecimal, java.text.DecimalFormat, .ParseException, java.time.Duration, .LocalDate, .LocalTime, java.time.format.DateTimeFormatter, .FormatStyle, java.time.temporal.ChronoUnit, .TemporalUnit, java.util.List

The SpinnerValueFactory is the model behind the JavaFX Spinner control - without a value factory installed a Spinner is unusable. It is the role of the value factory to handle almost all aspects of the Spinner, including:

Representing the current state of the value,
Incrementing and decrementing the value, with one or more steps per call,
Converting text input from the user (via the Spinner editor,
Converting objects to user-readable strings for display on screen

SpinnerValueFactory classes for some common types are provided with JavaFX, including:

Since: JavaFX 8u40
See Also: Spinner, SpinnerValueFactory.IntegerSpinnerValueFactory, SpinnerValueFactory.DoubleSpinnerValueFactory, SpinnerValueFactory.ListSpinnerValueFactory

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	SpinnerValueFactory.DoubleSpinnerValueFactory A `javafx.scene.control.SpinnerValueFactory` implementation designed to iterate through double values.
public static class	SpinnerValueFactory.IntegerSpinnerValueFactory A `javafx.scene.control.SpinnerValueFactory` implementation designed to iterate through integer values.
public static class	SpinnerValueFactory.ListSpinnerValueFactory< The type of the elements in the `java.util.List`. T> A `javafx.scene.control.SpinnerValueFactory` implementation designed to iterate through a list of values.
pack-priv static class	SpinnerValueFactory.LocalDateSpinnerValueFactory A `javafx.scene.control.SpinnerValueFactory` implementation designed to iterate through `java.time.LocalDate` values.
pack-priv static class	SpinnerValueFactory.LocalTimeSpinnerValueFactory A `javafx.scene.control.SpinnerValueFactory` implementation designed to iterate through `java.time.LocalTime` values.

Field Summary

Modifier and Type	Field and Description
private ObjectProperty<StringConverter<T>>	converter Converts the user-typed input (when the Spinner is `editable`) to an object of type T, such that the input may be retrieved via the `value` property.
private ObjectProperty<T>	value Represents the current value of the SpinnerValueFactory, or null if no value has been set.
private BooleanProperty	wrapAround The wrapAround property is used to specify whether the value factory should be circular.

Constructor Summary

Access	Constructor and Description
public	SpinnerValueFactory() Creates a default SpinnerValueFactory.

Method Summary

Modifier and Type	Method and Description
public final ObjectProperty<StringConverter<T>>	converterProperty()
public abstract void	decrement(int The number of decrements that should be performed on the value. steps) Attempts to decrement the `value` by the given number of steps.
public final StringConverter<T>	getConverter()
public final T	getValue()
public abstract void	increment(int The number of increments that should be performed on the value. steps) Attempts to omcrement the `value` by the given number of steps.
public final boolean	isWrapAround()
public final void	setConverter(StringConverter<T> newValue)
public final void	setValue(T newValue)
public final void	setWrapAround(boolean value)
public final ObjectProperty<T>	valueProperty()
public final BooleanProperty	wrapAroundProperty()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait