javafx.scene.control

Class SpinnerValueFactory.ListSpinnerValueFactory<T>

java.lang.Object

javafx.scene.control.SpinnerValueFactory<T>

javafx.scene.control.SpinnerValueFactory.ListSpinnerValueFactory<T>

Type Parameters:

T - The type of the elements in the List.

Enclosing class:

SpinnerValueFactory<T>

public static class SpinnerValueFactory.ListSpinnerValueFactory<T>
extends SpinnerValueFactory<T>

A SpinnerValueFactory implementation designed to iterate through a list of 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<T>() {
     @Override public String toString(T value) {
         if (value == null) {
             return "";
         }
         return value.toString();
     }

     @Override public T fromString(String string) {
         return (T) string;
     }
 });

Since:

JavaFX 8u40

Nested Class Summary

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

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

Constructor Summary

Constructors

Constructor and Description
ListSpinnerValueFactory(ObservableList<T> items) Creates a new instance of the ListSpinnerValueFactory with the given list used as the list to step through.

Method Summary

Modifier and Type	Method and Description
void	decrement(int steps) Attempts to decrement the value by the given number of steps.
ObservableList<T>	getItems() Returns an ObservableList that contains the items currently able to be iterated through by the user.
void	increment(int steps) Attempts to omcrement the value by the given number of steps.
ObjectProperty<ObservableList<T>>	itemsProperty() The underlying data model for the ListView.
void	setItems(ObservableList<T> value) Sets the underlying data model for the ListSpinnerValueFactory.

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

Constructor Detail

ListSpinnerValueFactory

public ListSpinnerValueFactory(ObservableList<T> items)

Creates a new instance of the ListSpinnerValueFactory with the given list used as the list to step through.

Parameters:

items - The list of items to step through with the Spinner.

Method Detail

setItems

public final void setItems(ObservableList<T> value)

Sets the underlying data model for the ListSpinnerValueFactory. Note that it has a generic type that must match the type of the Spinner itself.

getItems

public final ObservableList<T> getItems()

Returns an ObservableList that contains the items currently able to be iterated through by the user. This may be null if setItems(javafx.collections.ObservableList) has previously been called, however, by default it is an empty ObservableList.

Returns:

An ObservableList containing the items to be shown to the user, or null if the items have previously been set to null.

itemsProperty

public final ObjectProperty<ObservableList<T>> itemsProperty()

The underlying data model for the ListView. Note that it has a generic type that must match the type of the ListView itself.

decrement

public void decrement(int steps)

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

Specified by:

decrement in class SpinnerValueFactory<T>

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

Parameters:

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