SpinnerListModel JDK 1.6)

Description

public class SpinnerListModel

A simple implementation of SpinnerModel whose values are defined by an array or a List.

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: JSpinner SpinnerModel AbstractSpinnerModel SpinnerNumberModel SpinnerDateModel

Constructors

public SpinnerListModel ()

Constructs an effectively empty SpinnerListModel.

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

public SpinnerListModel (List<Object> values)

Constructs a SpinnerModel whose sequence of values is defined by the specified List.

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:
- IllegalArugmentException - if values is null or zero size

public SpinnerListModel (Object values)

Constructs a SpinnerModel whose sequence of values is defined by the specified array.

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:
- IllegalArugmentException - if values is null or zero length

Methods

Hide/Show inherited methods

public void addChangeListener (ChangeListener l) [Inherited From AbstractSpinnerModel]

Adds a ChangeListener to the model's listener list.

pack-private Object findNextMatch (String substring)

Returns the next object that starts with substring.

Returns the next object that starts with substring.
Returns: the match
Parameters:
- substring - the string to be matched

protected void fireStateChanged () [Inherited From AbstractSpinnerModel]

Run each ChangeListeners stateChanged() method.

public ChangeListener getChangeListeners () [Inherited From AbstractSpinnerModel]

Returns an array of all the ChangeListeners added to this AbstractSpinnerModel with addChangeListener().

Returns an array of all the ChangeListeners added
to this AbstractSpinnerModel with addChangeListener().
Returns: all of the ChangeListeners added or an empty array if no listeners have been added
Since: 1.4

public List<Object> getList ()

Returns the List that defines the sequence for this model.

Returns the List that defines the sequence for this model.
Returns: the value of the list property
See Also: SpinnerListModel.setList(java.util.List),

public T getListeners (Class< T> listenerType) [Inherited From AbstractSpinnerModel]

Return an array of all the listeners of the given type that were added to this model.

Return an array of all the listeners of the given type that
were added to this model. For example to find all of the
ChangeListeners added to this model:


 myAbstractSpinnerModel.getListeners(ChangeListener.class);

Returns: all of the objects receiving listenerType notifications from this model
Parameters:
- listenerType - the type of listeners to return, e.g. ChangeListener.class

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.
Returns: the next legal value of the underlying sequence or null if value is already the last element
See Also: SpinnerModel.getNextValue(), SpinnerListModel.getPreviousValue(),

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.
Returns: the previous element of the underlying sequence or null if value is already the first element
See Also: SpinnerModel.getPreviousValue(), SpinnerListModel.getNextValue(),

public Object getValue ()

Returns the current element of the sequence.

Returns the current element of the sequence.
Returns: the value property
See Also: SpinnerModel.getValue(), SpinnerListModel.setValue(java.lang.Object),

public void removeChangeListener (ChangeListener l) [Inherited From AbstractSpinnerModel]

Removes a ChangeListener from the model's listener list.

public void setList (List<Object> list)

Changes the list that defines this sequence and resets the index of the models value to zero.

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: SpinnerListModel.getList(),

public void setValue (Object elt)

Changes the current element of the sequence and notifies ChangeListeners.

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: SpinnerModel.setValue(java.lang.Object), SpinnerListModel.getValue(),