Module MaterialFX

Package io.github.palexdev.materialfx.controls.models.spinner

Class ListSpinnerModel<T>

java.lang.Object

io.github.palexdev.materialfx.controls.models.spinner.AbstractSpinnerModel<T>

io.github.palexdev.materialfx.controls.models.spinner.ListSpinnerModel<T>

All Implemented Interfaces:

SpinnerModel<T>

public class ListSpinnerModel<T>
extends AbstractSpinnerModel<T>

Concrete implementation of AbstractSpinnerModel to work with lists of any type.

ListSpinnerModel adds the converterProperty() (since we know the kind of data the model will deal with), and three new properties, itemsProperty(), getCurrentIndex(), incrementProperty().

The model works by keeping the current value's index in the list and updating that index, even when the list is modified, see updateCurrentIndex(ListChangeListener.Change).

The constructor initializes the model with these values:

- The converter uses toString(T) on the value or empty string if the value is null

- The default value is an empty ObservableList

- The increment is 1

- The initial value is the first element of the list (if not empty)

Property Summary

Properties

Type	Property	Description
ObjectProperty<StringConverter<T>>	converter	Specifies the StringConverter used to convert the spinner value to a String.
IntegerProperty	increment	Specifies the increment/decrement value to add/subtract from the current index when calling next() or previous().
ListProperty<T>	items	Specifies the items list.

Properties inherited from class io.github.palexdev.materialfx.controls.models.spinner.AbstractSpinnerModel

defaultValue, value

Field Summary

Fields inherited from class io.github.palexdev.materialfx.controls.models.spinner.AbstractSpinnerModel

defaultValue, value, wrapAround

Constructor Summary

Constructors

Constructor	Description
ListSpinnerModel()
ListSpinnerModel(ObservableList<T> items)

Method Summary

Modifier and Type	Method	Description
ObjectProperty<StringConverter<T>>	converterProperty()	Specifies the StringConverter used to convert the spinner value to a String.
StringConverter<T>	getConverter()	Gets the value of the property converter.
int	getCurrentIndex()
int	getIncrement()	Gets the value of the property increment.
ObservableList<T>	getItems()	Gets the value of the property items.
IntegerProperty	incrementProperty()	Specifies the increment/decrement value to add/subtract from the current index when calling next() or previous().
ListProperty<T>	itemsProperty()	Specifies the items list.
void	next()	If the items list is empty exits immediately.
void	previous()	If the items list is empty exits immediately.
void	reset()	Resets the spinner's value to the value specified by AbstractSpinnerModel.defaultValueProperty(), and the current index to -1;
void	setConverter(StringConverter<T> converter)	Sets the value of the property converter.
void	setIncrement(int increment)	Sets the value of the property increment.
void	setItems(ObservableList<T> items)	Sets the value of the property items.

Methods inherited from class io.github.palexdev.materialfx.controls.models.spinner.AbstractSpinnerModel

defaultValueProperty, getDefaultValue, getValue, isWrapAround, setDefaultValue, setValue, setWrapAround, valueProperty

Methods inherited from class java.lang.Object

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

Property Details

converter

public ObjectProperty<StringConverter<T>> converterProperty

See Also:

• getConverter()
• setConverter(StringConverter)

items

public ListProperty<T> itemsProperty

Specifies the items list.

See Also:

• getItems()
• setItems(ObservableList)

increment

public IntegerProperty incrementProperty

Specifies the increment/decrement value to add/subtract from the current index when calling next() or previous().

See Also:

• getIncrement()
• setIncrement(int)

Constructor Details

ListSpinnerModel

public ListSpinnerModel()

ListSpinnerModel

public ListSpinnerModel(ObservableList<T> items)

Method Details

next

public void next()

If the items list is empty exits immediately.

Increments the current index by incrementProperty(), if the new index is greater than the list's last index and AbstractSpinnerModel.isWrapAround() is true, the new index will be set to 0, otherwise to items.size() - 1

At the end the value is updated with the new index.

previous

public void previous()

If the items list is empty exits immediately.

Decrements the current index by incrementProperty(), if the new index is lesser than 0 and AbstractSpinnerModel.isWrapAround() is true, the new index will be set to items.size() - 1, otherwise to 0

At the end the value is updated with the new index.

reset

public void reset()

Resets the spinner's value to the value specified by AbstractSpinnerModel.defaultValueProperty(), and the current index to -1;

Specified by:

reset in interface SpinnerModel<T>

Overrides:

reset in class AbstractSpinnerModel<T>

getConverter

public StringConverter<T> getConverter()

Gets the value of the property converter.

Property description:

converterProperty

public ObjectProperty<StringConverter<T>> converterProperty()

Description copied from interface: SpinnerModel

Specifies the StringConverter used to convert the spinner value to a String.

See Also:

• getConverter()
• setConverter(StringConverter)

setConverter

public void setConverter(StringConverter<T> converter)

Sets the value of the property converter.

Property description:

getCurrentIndex

public int getCurrentIndex()

Returns:

the current value's index in the items list

getItems

public ObservableList<T> getItems()

Gets the value of the property items.

Property description:

Specifies the items list.

itemsProperty

public ListProperty<T> itemsProperty()

Specifies the items list.

See Also:

• getItems()
• setItems(ObservableList)

setItems

public void setItems(ObservableList<T> items)

Sets the value of the property items.

Property description:

Specifies the items list.

getIncrement

public int getIncrement()

Gets the value of the property increment.

Property description:

Specifies the increment/decrement value to add/subtract from the current index when calling next() or previous().

incrementProperty

public IntegerProperty incrementProperty()

Specifies the increment/decrement value to add/subtract from the current index when calling next() or previous().

See Also:

• getIncrement()
• setIncrement(int)

setIncrement

public void setIncrement(int increment)

Sets the value of the property increment.

Property description:

Specifies the increment/decrement value to add/subtract from the current index when calling next() or previous().