OpenJDK 27 · javax.swing.SpinnerModel · APIdia, the JavaDoc alternative

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 necessarily 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 preceding element or null if value is the first element of the sequence.

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

Method Summary

Modifier and Type	Method and Description
public void	addChangeListener(ChangeListener the ChangeListener to add l) Adds a `ChangeListener` to the model's listener list.
public Object	Returns: the next legal value or null if one doesn't exist getNextValue() Return the object in the sequence that comes after the object returned by `getValue()`.
public Object	Returns: the previous legal value or null if one doesn't exist getPreviousValue() Return the object in the sequence that comes before the object returned by `getValue()`.
public Object	Returns: the current spinner value. getValue() The current element of the sequence.
public void	removeChangeListener(ChangeListener the ChangeListener to remove l) Removes a `ChangeListener` from the model's listener list.
public void	setValue(Object new value for the spinner value) Changes current value of the model, typically this value is displayed by the `editor` part of a `JSpinner`.

Method Detail

addChangeListener back to summary

addChangeListener	back to summary
public void addChangeListener(ChangeListener l) Adds a `ChangeListener` to the model's listener list. The `ChangeListeners` must be notified when models `value` changes. Parameters l:ChangeListener the ChangeListener to add See Also `removeChangeListener`

public void addChangeListener(ChangeListener l)

Adds a ChangeListener to the model's listener list. The ChangeListeners must be notified when models value changes.

Parameters

l:ChangeListener: the ChangeListener to add

See Also

removeChangeListener

getNextValue back to summary

getNextValue	back to summary
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`. Returns:Object the next legal value or null if one doesn't exist See Also `getValue`, `getPreviousValue`

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.

Returns:Object: the next legal value or null if one doesn't exist
See Also: getValue, getPreviousValue

getPreviousValue back to summary

getPreviousValue	back to summary
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`. Returns:Object the previous legal value or null if one doesn't exist See Also `getValue`, `getNextValue`

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.

Returns:Object: the previous legal value or null if one doesn't exist
See Also: getValue, getNextValue

getValue back to summary

getValue	back to summary
public Object getValue() The current element of the sequence. This element is usually displayed by the `editor` part of a `JSpinner`. Returns:Object the current spinner value. See Also `setValue`

public Object getValue()

The current element of the sequence. This element is usually displayed by the editor part of a JSpinner.

Returns:Object: the current spinner value.
See Also: setValue

removeChangeListener back to summary

removeChangeListener	back to summary
public void removeChangeListener(ChangeListener l) Removes a `ChangeListener` from the model's listener list. Parameters l:ChangeListener the ChangeListener to remove See Also `addChangeListener`

public void removeChangeListener(ChangeListener l)

Removes a ChangeListener from the model's listener list.

Parameters

l:ChangeListener: the ChangeListener to remove

See Also

addChangeListener

setValue back to summary

setValue	back to summary
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. Parameters value:Object new value for the spinner Exceptions IllegalArgumentException: if `value` isn't allowed See Also `getValue`

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.

Parameters

value:Object: new value for the spinner

Exceptions

IllegalArgumentException:: if value isn't allowed

See Also

getValue

public Interface SpinnerModel

Method Summary

Method Detail