Class SpinnerValueFactory.IntegerSpinnerValueFactory
java.lang.Object
javafx.scene.control.SpinnerValueFactory<Integer>
javafx.scene.control.SpinnerValueFactory.IntegerSpinnerValueFactory
- Enclosing class:
SpinnerValueFactory<T>
public static class SpinnerValueFactory.IntegerSpinnerValueFactory
extends SpinnerValueFactory<Integer>
A
SpinnerValueFactory
implementation designed to iterate through
integer values.
If wrapAround
is true
, the
IntegerSpinnerValueFactory
will step from the minimum value to the maximum value (and vice versa).
As a consequence of that, the number of steps required to wrap around to the same value is N+1
, where
N
is the number of steps between min
(inclusive) and max
(inclusive). The new value after a step is val = (val + amountToStepBy) % (max - min + 1)
.
Note that the default converter
is implemented
as an IntegerStringConverter
instance.
- Since:
- JavaFX 8u40
-
Nested Class Summary
Nested classes/interfaces declared in class javafx.scene.control.SpinnerValueFactory
SpinnerValueFactory.DoubleSpinnerValueFactory, SpinnerValueFactory.IntegerSpinnerValueFactory, SpinnerValueFactory.ListSpinnerValueFactory<T>
-
Property Summary
TypePropertyDescriptionfinal IntegerProperty
Sets the amount to increment or decrement by, per step.final IntegerProperty
Sets the maximum allowable value for this value factoryfinal IntegerProperty
Sets the minimum allowable value for this value factoryProperties declared in class javafx.scene.control.SpinnerValueFactory
converter, value, wrapAround
-
Constructor Summary
ConstructorDescriptionIntegerSpinnerValueFactory
(int min, int max) Constructs a new IntegerSpinnerValueFactory that sets the initial value to be equal to the min value, and a defaultamountToStepBy
of one.IntegerSpinnerValueFactory
(int min, int max, int initialValue) Constructs a new IntegerSpinnerValueFactory with a defaultamountToStepBy
of one.IntegerSpinnerValueFactory
(int min, int max, int initialValue, int amountToStepBy) Constructs a new IntegerSpinnerValueFactory. -
Method Summary
Modifier and TypeMethodDescriptionfinal IntegerProperty
Sets the amount to increment or decrement by, per step.void
decrement
(int steps) Attempts to decrement thevalue
by the given number of steps.final int
Gets the value of theamountToStepBy
property.final int
getMax()
Gets the value of themax
property.final int
getMin()
Gets the value of themin
property.void
increment
(int steps) Attempts to increment thevalue
by the given number of steps.final IntegerProperty
Sets the maximum allowable value for this value factoryfinal IntegerProperty
Sets the minimum allowable value for this value factoryfinal void
setAmountToStepBy
(int value) Sets the value of theamountToStepBy
property.final void
setMax
(int value) Sets the value of themax
property.final void
setMin
(int value) Sets the value of themin
property.Methods declared in class javafx.scene.control.SpinnerValueFactory
converterProperty, getConverter, getValue, isWrapAround, setConverter, setValue, setWrapAround, valueProperty, wrapAroundProperty
-
Property Details
-
min
Sets the minimum allowable value for this value factory- See Also:
-
max
Sets the maximum allowable value for this value factory- See Also:
-
amountToStepBy
Sets the amount to increment or decrement by, per step.- See Also:
-
-
Constructor Details
-
IntegerSpinnerValueFactory
public IntegerSpinnerValueFactory(int min, int max) Constructs a new IntegerSpinnerValueFactory that sets the initial value to be equal to the min value, and a defaultamountToStepBy
of one.- Parameters:
min
- The minimum allowed integer value for the Spinner.max
- The maximum allowed integer value for the Spinner.
-
IntegerSpinnerValueFactory
public IntegerSpinnerValueFactory(int min, int max, int initialValue) Constructs a new IntegerSpinnerValueFactory with a defaultamountToStepBy
of one.- Parameters:
min
- The minimum allowed integer value for the Spinner.max
- The maximum allowed integer value for the Spinner.initialValue
- The value of the Spinner when first instantiated, must be within the bounds of the min and max arguments, or else the min value will be used.
-
IntegerSpinnerValueFactory
public IntegerSpinnerValueFactory(int min, int max, int initialValue, int amountToStepBy) Constructs a new IntegerSpinnerValueFactory.- Parameters:
min
- The minimum allowed integer value for the Spinner.max
- The maximum allowed integer value for the Spinner.initialValue
- The value of the Spinner when first instantiated, must be within the bounds of the min and max arguments, or else the min value will be used.amountToStepBy
- The amount to increment or decrement by, per step.
-
-
Method Details
-
setMin
public final void setMin(int value) Sets the value of themin
property.- Property description:
- Sets the minimum allowable value for this value factory
- Parameters:
value
- the value for themin
property- See Also:
-
getMin
public final int getMin()Gets the value of themin
property.- Property description:
- Sets the minimum allowable value for this value factory
- Returns:
- the value of the
min
property - See Also:
-
minProperty
Sets the minimum allowable value for this value factory- Returns:
- the minimum allowable value for this value factory
- See Also:
-
setMax
public final void setMax(int value) Sets the value of themax
property.- Property description:
- Sets the maximum allowable value for this value factory
- Parameters:
value
- the value for themax
property- See Also:
-
getMax
public final int getMax()Gets the value of themax
property.- Property description:
- Sets the maximum allowable value for this value factory
- Returns:
- the value of the
max
property - See Also:
-
maxProperty
Sets the maximum allowable value for this value factory- Returns:
- the maximum allowable value for this value factory
- See Also:
-
setAmountToStepBy
public final void setAmountToStepBy(int value) Sets the value of theamountToStepBy
property.- Property description:
- Sets the amount to increment or decrement by, per step.
- Parameters:
value
- the value for theamountToStepBy
property- See Also:
-
getAmountToStepBy
public final int getAmountToStepBy()Gets the value of theamountToStepBy
property.- Property description:
- Sets the amount to increment or decrement by, per step.
- Returns:
- the value of the
amountToStepBy
property - See Also:
-
amountToStepByProperty
Sets the amount to increment or decrement by, per step.- Returns:
- the amount to increment or decrement by, per step
- See Also:
-
decrement
public void decrement(int steps) Attempts to decrement thevalue
by the given number of steps.- Specified by:
decrement
in classSpinnerValueFactory<Integer>
- Parameters:
steps
- The number of decrements that should be performed on the value. If the number is negative, the call is equivalent to callingSpinnerValueFactory.increment(int)
with the absolute value ofsteps
.
-
increment
public void increment(int steps) Attempts to increment thevalue
by the given number of steps.- Specified by:
increment
in classSpinnerValueFactory<Integer>
- Parameters:
steps
- The number of increments that should be performed on the value. If the number is negative, the call is equivalent to callingSpinnerValueFactory.decrement(int)
with the absolute number ofsteps
.
-