- All Implemented Interfaces:
Serializable
,SpinnerModel
public class SpinnerNumberModel extends AbstractSpinnerModel implements Serializable
SpinnerModel
for sequences of numbers.
The upper and lower bounds of the sequence are defined
by properties called minimum
and
maximum
. The size of the increase or decrease
computed by the nextValue
and
previousValue
methods is defined by a property called
stepSize
. The minimum
and
maximum
properties can be null
to indicate that the sequence has no lower or upper limit.
All of the properties in this class are defined in terms of two
generic types: Number
and
Comparable
, so that all Java numeric types
may be accommodated. Internally, there's only support for
values whose type is one of the primitive Number
types:
Double
, Float
, Long
,
Integer
, Short
, or Byte
.
To create a SpinnerNumberModel
for the integer
range zero to one hundred, with
fifty as the initial value, one could write:
Integer value = Integer.valueOf(50); Integer min = Integer.valueOf(0); Integer max = Integer.valueOf(100); Integer step = Integer.valueOf(1); SpinnerNumberModel model = new SpinnerNumberModel(value, min, max, step); int fifty = model.getNumber().intValue();
Spinners for integers and doubles are common, so special constructors for these cases are provided. For example to create the model in the previous example, one could also write:
SpinnerNumberModel model = new SpinnerNumberModel(50, 0, 100, 1);
This model inherits a ChangeListener
.
The ChangeListeners
are notified
whenever the model's value
, stepSize
,
minimum
, or maximum
properties changes.
- Since:
- 1.4
- See Also:
JSpinner
,SpinnerModel
,AbstractSpinnerModel
,SpinnerListModel
,SpinnerDateModel
-
Field Summary
Fields declared in class javax.swing.AbstractSpinnerModel
listenerList
-
Constructor Summary
Constructors Constructor Description SpinnerNumberModel()
Constructs aSpinnerNumberModel
with nominimum
ormaximum
value,stepSize
equal to one, and an initial value of zero.SpinnerNumberModel(double value, double minimum, double maximum, double stepSize)
Constructs aSpinnerNumberModel
with the specifiedvalue
,minimum
/maximum
bounds, andstepSize
.SpinnerNumberModel(int value, int minimum, int maximum, int stepSize)
Constructs aSpinnerNumberModel
with the specifiedvalue
,minimum
/maximum
bounds, andstepSize
.SpinnerNumberModel(Number value, Comparable<?> minimum, Comparable<?> maximum, Number stepSize)
Constructs aSpinnerModel
that represents a closed sequence of numbers fromminimum
tomaximum
. -
Method Summary
Modifier and Type Method Description Comparable<?>
getMaximum()
Returns the last number in the sequence.Comparable<?>
getMinimum()
Returns the first number in this sequence.Object
getNextValue()
Returns the next number in the sequence.Number
getNumber()
Returns the value of the current element of the sequence.Object
getPreviousValue()
Returns the previous number in the sequence.Number
getStepSize()
Returns the size of the value change computed by thegetNextValue
andgetPreviousValue
methods.Object
getValue()
Returns the value of the current element of the sequence.void
setMaximum(Comparable<?> maximum)
Changes the upper bound for numbers in this sequence.void
setMinimum(Comparable<?> minimum)
Changes the lower bound for numbers in this sequence.void
setStepSize(Number stepSize)
Changes the size of the value change computed by thegetNextValue
andgetPreviousValue
methods.void
setValue(Object value)
Sets the current value for this sequence.Methods declared in class javax.swing.AbstractSpinnerModel
addChangeListener, fireStateChanged, getChangeListeners, getListeners, removeChangeListener
-
Constructor Details
-
SpinnerNumberModel
public SpinnerNumberModel(Number value, Comparable<?> minimum, Comparable<?> maximum, Number stepSize)Constructs aSpinnerModel
that represents a closed sequence of numbers fromminimum
tomaximum
. ThenextValue
andpreviousValue
methods compute elements of the sequence by adding or subtractingstepSize
respectively. All of the parameters must be mutuallyComparable
,value
andstepSize
must be instances ofInteger
Long
,Float
, orDouble
.The
minimum
andmaximum
parameters can benull
to indicate that the range doesn't have an upper or lower bound. Ifvalue
orstepSize
isnull
, or if bothminimum
andmaximum
are specified andminimum > maximum
then anIllegalArgumentException
is thrown. Similarly if(minimum <= value <= maximum
) is false, anIllegalArgumentException
is thrown.- Parameters:
value
- the current (nonnull
) value of the modelminimum
- the first number in the sequence ornull
maximum
- the last number in the sequence ornull
stepSize
- the difference between elements of the sequence- Throws:
IllegalArgumentException
- if stepSize or value isnull
or if the following expression is false:minimum <= value <= maximum
-
SpinnerNumberModel
public SpinnerNumberModel(int value, int minimum, int maximum, int stepSize)Constructs aSpinnerNumberModel
with the specifiedvalue
,minimum
/maximum
bounds, andstepSize
.- Parameters:
value
- the current value of the modelminimum
- the first number in the sequencemaximum
- the last number in the sequencestepSize
- the difference between elements of the sequence- Throws:
IllegalArgumentException
- if the following expression is false:minimum <= value <= maximum
-
SpinnerNumberModel
public SpinnerNumberModel(double value, double minimum, double maximum, double stepSize)Constructs aSpinnerNumberModel
with the specifiedvalue
,minimum
/maximum
bounds, andstepSize
.- Parameters:
value
- the current value of the modelminimum
- the first number in the sequencemaximum
- the last number in the sequencestepSize
- the difference between elements of the sequence- Throws:
IllegalArgumentException
- if the following expression is false:minimum <= value <= maximum
-
SpinnerNumberModel
public SpinnerNumberModel()Constructs aSpinnerNumberModel
with nominimum
ormaximum
value,stepSize
equal to one, and an initial value of zero.
-
-
Method Details
-
setMinimum
Changes the lower bound for numbers in this sequence. Ifminimum
isnull
, then there is no lower bound. No bounds checking is done here; the newminimum
value may invalidate the(minimum <= value <= maximum)
invariant enforced by the constructors. This is to simplify updating the model, naturally one should ensure that the invariant is true before calling thegetNextValue
,getPreviousValue
, orsetValue
methods.Typically this property is a
Number
of the same type as thevalue
however it's possible to use anyComparable
with acompareTo
method for aNumber
with the same type as the value. For example if value was aLong
,minimum
might be a Date subclass defined like this:MyDate extends Date { // Date already implements Comparable public int compareTo(Long o) { long t = getTime(); return (t < o.longValue() ? -1 : (t == o.longValue() ? 0 : 1)); } }
This method fires a
ChangeEvent
if theminimum
has changed.- Parameters:
minimum
- aComparable
that has acompareTo
method forNumber
s with the same type asvalue
- See Also:
getMinimum()
,setMaximum(java.lang.Comparable<?>)
,SpinnerModel.addChangeListener(javax.swing.event.ChangeListener)
-
getMinimum
Returns the first number in this sequence.- Returns:
- the value of the
minimum
property - See Also:
setMinimum(java.lang.Comparable<?>)
-
setMaximum
Changes the upper bound for numbers in this sequence. Ifmaximum
isnull
, then there is no upper bound. No bounds checking is done here; the newmaximum
value may invalidate the(minimum <= value < maximum)
invariant enforced by the constructors. This is to simplify updating the model, naturally one should ensure that the invariant is true before calling thenext
,previous
, orsetValue
methods.Typically this property is a
Number
of the same type as thevalue
however it's possible to use anyComparable
with acompareTo
method for aNumber
with the same type as the value. SeesetMinimum(Comparable)
for an example.This method fires a
ChangeEvent
if themaximum
has changed.- Parameters:
maximum
- aComparable
that has acompareTo
method forNumber
s with the same type asvalue
- See Also:
getMaximum()
,setMinimum(java.lang.Comparable<?>)
,SpinnerModel.addChangeListener(javax.swing.event.ChangeListener)
-
getMaximum
Returns the last number in the sequence.- Returns:
- the value of the
maximum
property - See Also:
setMaximum(java.lang.Comparable<?>)
-
setStepSize
Changes the size of the value change computed by thegetNextValue
andgetPreviousValue
methods. AnIllegalArgumentException
is thrown ifstepSize
isnull
.This method fires a
ChangeEvent
if thestepSize
has changed.- Parameters:
stepSize
- the size of the value change computed by thegetNextValue
andgetPreviousValue
methods- See Also:
getNextValue()
,getPreviousValue()
,getStepSize()
,SpinnerModel.addChangeListener(javax.swing.event.ChangeListener)
-
getStepSize
Returns the size of the value change computed by thegetNextValue
andgetPreviousValue
methods.- Returns:
- the value of the
stepSize
property - See Also:
setStepSize(java.lang.Number)
-
getNextValue
Returns the next number in the sequence.- Specified by:
getNextValue
in interfaceSpinnerModel
- Returns:
value + stepSize
ornull
if the sum exceedsmaximum
.- See Also:
SpinnerModel.getNextValue()
,getPreviousValue()
,setStepSize(java.lang.Number)
-
getPreviousValue
Returns the previous number in the sequence.- Specified by:
getPreviousValue
in interfaceSpinnerModel
- Returns:
value - stepSize
, ornull
if the sum is less thanminimum
.- See Also:
SpinnerModel.getPreviousValue()
,getNextValue()
,setStepSize(java.lang.Number)
-
getNumber
Returns the value of the current element of the sequence.- Returns:
- the value property
- See Also:
setValue(java.lang.Object)
-
getValue
Returns the value of the current element of the sequence.- Specified by:
getValue
in interfaceSpinnerModel
- Returns:
- the value property
- See Also:
setValue(java.lang.Object)
,getNumber()
-
setValue
Sets the current value for this sequence. Ifvalue
isnull
, or not aNumber
, anIllegalArgumentException
is thrown. No bounds checking is done here; the new value may invalidate the(minimum <= value <= maximum)
invariant enforced by the constructors. It's also possible to set the value to be something that wouldn't naturally occur in the sequence, i.e. a value that's not modulo thestepSize
. This is to simplify updating the model, and to accommodate spinners that don't want to restrict values that have been directly entered by the user. Naturally, one should ensure that the(minimum <= value <= maximum)
invariant is true before calling thenext
,previous
, orsetValue
methods.This method fires a
ChangeEvent
if the value has changed.- Specified by:
setValue
in interfaceSpinnerModel
- Parameters:
value
- the current (nonnull
)Number
for this sequence- Throws:
IllegalArgumentException
- ifvalue
isnull
or not aNumber
- See Also:
getNumber()
,getValue()
,SpinnerModel.addChangeListener(javax.swing.event.ChangeListener)
-