javafx.scene.control

Class SpinnerValueFactory.DoubleSpinnerValueFactory

java.lang.Object

javafx.scene.control.SpinnerValueFactory<java.lang.Double>

javafx.scene.control.SpinnerValueFactory.DoubleSpinnerValueFactory

Enclosing class:

SpinnerValueFactory<T>

public static class SpinnerValueFactory.DoubleSpinnerValueFactory
extends SpinnerValueFactory<java.lang.Double>

A SpinnerValueFactory implementation designed to iterate through double 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). The main point to note is that this javafx.util.StringConverter embeds within it a DecimalFormat instance that shows the Double to two decimal places. This is used for both the toString and fromString methods:

 setConverter(new StringConverter<Double>() {
     private final DecimalFormat df = new DecimalFormat("#.##");

     @Override public String toString(Double value) {
         // If the specified value is null, return a zero-length String
         if (value == null) {
             return "";
         }

         return df.format(value);
     }

     @Override public Double fromString(String value) {
         try {
             // If the specified value is null or zero-length, return null
             if (value == null) {
                 return null;
             }

             value = value.trim();

             if (value.length() < 1) {
                 return null;
             }

             // Perform the requested parsing
             return df.parse(value).doubleValue();
         } catch (ParseException ex) {
             throw new RuntimeException(ex);
         }
     }
 });

Since:

JavaFX 8u40

Property Summary

Type	Property and Description
DoubleProperty	amountToStepBy Sets the amount to increment or decrement by, per step.
DoubleProperty	max Sets the maximum allowable value for this value factory
DoubleProperty	min Sets the minimum allowable value for this value factory

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 DoubleProperty	amountToStepBy
private DoubleProperty	max
private DoubleProperty	min * Properties * *

Constructor Summary

Constructors

Constructor and Description
DoubleSpinnerValueFactory(double min, double max) Constructs a new DoubleSpinnerValueFactory that sets the initial value to be equal to the min value, and a default amountToStepBy of one.
DoubleSpinnerValueFactory(double min, double max, double initialValue) Constructs a new DoubleSpinnerValueFactory with a default amountToStepBy of one.
DoubleSpinnerValueFactory(double min, double max, double initialValue, double amountToStepBy) Constructs a new DoubleSpinnerValueFactory.

Method Summary

Modifier and Type	Method and Description
DoubleProperty	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.
double	getAmountToStepBy() Gets the value of the property amountToStepBy.
double	getMax() Gets the value of the property max.
double	getMin() Gets the value of the property min.
void	increment(int steps) Attempts to omcrement the value by the given number of steps.
DoubleProperty	maxProperty() Sets the maximum allowable value for this value factory
DoubleProperty	minProperty() Sets the minimum allowable value for this value factory
void	setAmountToStepBy(double value) Sets the value of the property amountToStepBy.
void	setMax(double value) Sets the value of the property max.
void	setMin(double value) Sets the value of the property min.

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 DoubleProperty minProperty

Sets the minimum allowable value for this value factory

Returns:

the minimum allowable value for this value factory

max

public final DoubleProperty maxProperty

Sets the maximum allowable value for this value factory

See Also:

getMax(), setMax(double)

amountToStepBy

public final DoubleProperty amountToStepByProperty

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

See Also:

getAmountToStepBy(), setAmountToStepBy(double)

Field Detail

min

private DoubleProperty min

* Properties * *

max

private DoubleProperty max

amountToStepBy

private DoubleProperty amountToStepBy

Constructor Detail

DoubleSpinnerValueFactory

public DoubleSpinnerValueFactory(double min,
                                 double max)

Constructs a new DoubleSpinnerValueFactory that sets the initial value to be equal to the min value, and a default amountToStepBy of one.

Parameters:

min - The minimum allowed double value for the Spinner.

max - The maximum allowed double value for the Spinner.

DoubleSpinnerValueFactory

public DoubleSpinnerValueFactory(double min,
                                 double max,
                                 double initialValue)

Constructs a new DoubleSpinnerValueFactory with a default amountToStepBy of one.

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, must be within the bounds of the min and max arguments, or else the min value will be used.

DoubleSpinnerValueFactory

public DoubleSpinnerValueFactory(double min,
                                 double max,
                                 double initialValue,
                                 double amountToStepBy)

Constructs a new DoubleSpinnerValueFactory.

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

setMin

public final void setMin(double value)

Sets the value of the property min.

getMin

public final double getMin()

Gets the value of the property min.

minProperty

public final DoubleProperty minProperty()

Sets the minimum allowable value for this value factory

Returns:

the minimum allowable value for this value factory

setMax

public final void setMax(double value)

Sets the value of the property max.

getMax

public final double getMax()

Gets the value of the property max.

maxProperty

public final DoubleProperty maxProperty()

Sets the maximum allowable value for this value factory

See Also:

getMax(), setMax(double)

setAmountToStepBy

public final void setAmountToStepBy(double value)

Sets the value of the property amountToStepBy.

getAmountToStepBy

public final double getAmountToStepBy()

Gets the value of the property amountToStepBy.

amountToStepByProperty

public final DoubleProperty amountToStepByProperty()

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

See Also:

getAmountToStepBy(), setAmountToStepBy(double)

decrement

public void decrement(int steps)

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

Specified by:

decrement in class SpinnerValueFactory<java.lang.Double>

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.lang.Double>

Parameters:

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