public class

SpinnerListModel

extends AbstractSpinnerModel
implements Serializable
java.lang.Object
   ↳ javax.swing.AbstractSpinnerModel
     ↳ javax.swing.SpinnerListModel

Class Overview

A simple implementation of SpinnerModel whose values are defined by an array or a List. For example to create a model defined by an array of the names of the days of the week: 

 String[] days = new DateFormatSymbols().getWeekdays();
 SpinnerModel model = new SpinnerListModel(Arrays.asList(days).subList(1, 8));
This class only stores a reference to the array or List so if an element of the underlying sequence changes, it's up to the application to notify the ChangeListeners by calling fireStateChanged.

This model inherits a ChangeListener. The ChangeListeners are notified whenever the model's value or list properties changes.

See Also

Summary

[Expand]
Inherited Fields
From class javax.swing.AbstractSpinnerModel
Public Constructors
SpinnerListModel(List<?> values)
Constructs a SpinnerModel whose sequence of values is defined by the specified List.
SpinnerListModel(Object[] values)
Constructs a SpinnerModel whose sequence of values is defined by the specified array.
SpinnerListModel()
Constructs an effectively empty SpinnerListModel.
Public Methods
List<?> getList()
Returns the List that defines the sequence for this model.
Object getNextValue()
Returns the next legal value of the underlying sequence or null if value is already the last element.
Object getPreviousValue()
Returns the previous element of the underlying sequence or null if value is already the first element.
Object getValue()
Returns the current element of the sequence.
void setList(List<?> list)
Changes the list that defines this sequence and resets the index of the models value to zero.
void setValue(Object elt)
Changes the current element of the sequence and notifies ChangeListeners.
[Expand]
Inherited Methods
From class javax.swing.AbstractSpinnerModel
From class java.lang.Object
From interface javax.swing.SpinnerModel

Public Constructors

public SpinnerListModel (List<?> values)

Constructs a SpinnerModel whose sequence of values is defined by the specified List. The initial value (current element) of the model will be values.get(0). If values is null or has zero size, an IllegalArugmentException is thrown.

Parameters
values the sequence this model represents
Throws
if values is null or zero size

public SpinnerListModel (Object[] values)

Constructs a SpinnerModel whose sequence of values is defined by the specified array. The initial value of the model will be values[0]. If values is null or has zero length, an IllegalArugmentException is thrown.

Parameters
values the sequence this model represents
Throws
if values is null or zero length

public SpinnerListModel ()

Constructs an effectively empty SpinnerListModel. The model's list will contain a single "empty" string element.

Public Methods

public List<?> getList ()

Returns the List that defines the sequence for this model.

Returns
  • the value of the list property
See Also

public Object getNextValue ()

Returns the next legal value of the underlying sequence or null if value is already the last element.

Returns
  • the next legal value of the underlying sequence or null if value is already the last element
See Also

public Object getPreviousValue ()

Returns the previous element of the underlying sequence or null if value is already the first element.

Returns
  • the previous element of the underlying sequence or null if value is already the first element
See Also

public Object getValue ()

Returns the current element of the sequence.

Returns
  • the value property
See Also

public void setList (List<?> list)

Changes the list that defines this sequence and resets the index of the models value to zero. Note that list is not copied, the model just stores a reference to it.

This method fires a ChangeEvent if list is not equal to the current list.

Parameters
list the sequence that this model represents
Throws
IllegalArgumentException if list is null or zero length
See Also

public void setValue (Object elt)

Changes the current element of the sequence and notifies ChangeListeners. If the specified value is not equal to an element of the underlying sequence then an IllegalArgumentException is thrown. In the following example the setValue call would cause an exception to be thrown: 

 String[] values = {"one", "two", "free", "four"};
 SpinnerModel model = new SpinnerListModel(values);
 model.setValue("TWO");

Parameters
elt the sequence element that will be model's current value
Throws
IllegalArgumentException if the specified value isn't allowed
See Also