File Doc Category Size Date Package
SpinnerModel.java API Doc Java SE 5 API 3981 Fri Aug 26 14:57:58 BST 2005 javax.swing

SpinnerModel

public interface SpinnerModel

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.

see: JSpinner
see: AbstractSpinnerModel
see: SpinnerListModel
see: SpinnerNumberModel
see: SpinnerDateModel
version: 1.6 12/19/03
author: Hans Muller
since: 1.4

Fields Summary
Constructors Summary
Methods Summary
public void addChangeListener(javax.swing.event.ChangeListener l)
Adds a ChangeListener to the model's listener list. The ChangeListeners must be notified when models value changes.
param
l the ChangeListener to add
see
#removeChangeListener
public java.lang.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.
return
the next legal value or null if one doesn't exist
see
#getValue
see
#getPreviousValue
public java.lang.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.
return
the previous legal value or null if one doesn't exist
see
#getValue
see
#getNextValue
public java.lang.Object getValue()
The current element of the sequence. This element is usually displayed by the editor part of a JSpinner.
return
the current spinner value.
see
#setValue
public void removeChangeListener(javax.swing.event.ChangeListener l)
Removes a ChangeListener from the model's listener list.
param
l the ChangeListener to remove
see
#addChangeListener
public void setValue(java.lang.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.
throws
IllegalArgumentException if value isn't allowed
see
#getValue