javax.swing: public interface: SpinnerModel

javax.swing
public interface: SpinnerModel [javadoc | source]

All Known Implementing Classes:
AbstractSpinnerModel, SpinnerNumberModel, SpinnerDateModel, SpinnerListModel

A model for a potentially unbounded sequence of object values. This model is similar to ListModel however there are some important differences:

The number of sequence elements isn't neccessarily bounded.
The model doesn't support indexed random access to sequence elements. Only three sequence values are accessible at a time: current, next and previous.
The current sequence element, can be set.

A SpinnerModel has three properties, only the first is read/write.

value: The current element of the sequence.
nextValue: The following element or null if value is the last element of the sequence.
previousValue: The preceeding element or null if value is the first element of the sequence.

When the the value property changes, ChangeListeners are notified. SpinnerModel may choose to notify the ChangeListeners under other circumstances.

Also see:

author: Hans - Muller

since: 1.4 -

Method from javax.swing.SpinnerModel Summary:
addChangeListener, getNextValue, getPreviousValue, getValue, removeChangeListener, setValue

Method from javax.swing.SpinnerModel Detail:
public void addChangeListener(ChangeListener l) Adds a `ChangeListener` to the model's listener list. The `ChangeListeners` must be notified when models `value` changes.
public Object getNextValue() Return the object in the sequence that comes after the object returned by `getValue()`. If the end of the sequence has been reached then return null. Calling this method does not effect `value`.
public Object getPreviousValue() Return the object in the sequence that comes before the object returned by `getValue()`. If the end of the sequence has been reached then return null. Calling this method does not effect `value`.
public Object getValue() The current element of the sequence. This element is usually displayed by the `editor` part of a `JSpinner`.
public void removeChangeListener(ChangeListener l) Removes a `ChangeListener` from the model's listener list.
public void setValue(Object value) Changes current value of the model, typically this value is displayed by the `editor` part of a `JSpinner`. If the `SpinnerModel` implementation doesn't support the specified value then an `IllegalArgumentException` is thrown. For example a `SpinnerModel` for numbers might only support values that are integer multiples of ten. In that case, `model.setValue(new Number(11))` would throw an exception.