Liking cljdoc? Tell your friends :D

javax.swing.SpinnerNumberModel

A 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 = new Integer(50); Integer min = new Integer(0); Integer max = new Integer(100); Integer step = new Integer(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.

A 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 = new Integer(50);
Integer min = new Integer(0);
Integer max = new Integer(100);
Integer step = new Integer(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.
raw docstring

->spinner-number-modelclj

(->spinner-number-model)
(->spinner-number-model value minimum maximum step-size)

Constructor.

Constructs a SpinnerModel that represents a closed sequence of numbers from minimum to maximum. The nextValue and previousValue methods compute elements of the sequence by adding or subtracting stepSize respectively. All of the parameters must be mutually Comparable, value and stepSize must be instances of Integer Long, Float, or Double.

The minimum and maximum parameters can be null to indicate that the range doesn't have an upper or lower bound. If value or stepSize is null, or if both minimum and maximum are specified and minimum > maximum then an IllegalArgumentException is thrown. Similarly if (minimum <= value <= maximum) is false, an IllegalArgumentException is thrown.

value - the current (non null) value of the model - java.lang.Number minimum - the first number in the sequence or null - java.lang.Comparable maximum - the last number in the sequence or null - java.lang.Comparable step-size - the difference between elements of the sequence - java.lang.Number

throws: java.lang.IllegalArgumentException - if stepSize or value is null or if the following expression is false: minimum <= value <= maximum

Constructor.

Constructs a SpinnerModel that represents
 a closed sequence of
 numbers from minimum to maximum.  The
 nextValue and previousValue methods
 compute elements of the sequence by adding or subtracting
 stepSize respectively.  All of the parameters
 must be mutually Comparable, value
 and stepSize must be instances of Integer
 Long, Float, or Double.

 The minimum and maximum parameters
 can be null to indicate that the range doesn't
 have an upper or lower bound.
 If value or stepSize is null,
 or if both minimum and maximum
 are specified and minimum > maximum then an
 IllegalArgumentException is thrown.
 Similarly if (minimum <= value <= maximum) is false,
 an IllegalArgumentException is thrown.

value - the current (non null) value of the model - `java.lang.Number`
minimum - the first number in the sequence or null - `java.lang.Comparable`
maximum - the last number in the sequence or null - `java.lang.Comparable`
step-size - the difference between elements of the sequence - `java.lang.Number`

throws: java.lang.IllegalArgumentException - if stepSize or value is null or if the following expression is false: minimum <= value <= maximum
raw docstring

get-maximumclj

(get-maximum this)

Returns the last number in the sequence.

returns: the value of the maximum property - java.lang.Comparable

Returns the last number in the sequence.

returns: the value of the maximum property - `java.lang.Comparable`
raw docstring

get-minimumclj

(get-minimum this)

Returns the first number in this sequence.

returns: the value of the minimum property - java.lang.Comparable

Returns the first number in this sequence.

returns: the value of the minimum property - `java.lang.Comparable`
raw docstring

get-next-valueclj

(get-next-value this)

Returns the next number in the sequence.

returns: value stepSize or null if the sum exceeds maximum. - java.lang.Object

Returns the next number in the sequence.

returns: value  stepSize or null if the sum
     exceeds maximum. - `java.lang.Object`
raw docstring

get-numberclj

(get-number this)

Returns the value of the current element of the sequence.

returns: the value property - java.lang.Number

Returns the value of the current element of the sequence.

returns: the value property - `java.lang.Number`
raw docstring

get-previous-valueclj

(get-previous-value this)

Returns the previous number in the sequence.

returns: value - stepSize, or null if the sum is less than minimum. - java.lang.Object

Returns the previous number in the sequence.

returns: value - stepSize, or
     null if the sum is less
     than minimum. - `java.lang.Object`
raw docstring

get-step-sizeclj

(get-step-size this)

Returns the size of the value change computed by the getNextValue and getPreviousValue methods.

returns: the value of the stepSize property - java.lang.Number

Returns the size of the value change computed by the
 getNextValue
 and getPreviousValue methods.

returns: the value of the stepSize property - `java.lang.Number`
raw docstring

get-valueclj

(get-value this)

Returns the value of the current element of the sequence.

returns: the value property - java.lang.Object

Returns the value of the current element of the sequence.

returns: the value property - `java.lang.Object`
raw docstring

set-maximumclj

(set-maximum this maximum)

Changes the upper bound for numbers in this sequence. If maximum is null, then there is no upper bound. No bounds checking is done here; the new maximum 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 the next, previous, or setValue methods.

Typically this property is a Number of the same type as the value however it's possible to use any Comparable with a compareTo method for a Number with the same type as the value. See setMinimum for an example.

This method fires a ChangeEvent if the maximum has changed.

maximum - a Comparable that has a compareTo method for Numbers with the same type as value - java.lang.Comparable

Changes the upper bound for numbers in this sequence.
 If maximum is null, then there
 is no upper bound.  No bounds checking is done here; the new
 maximum 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 the next, previous,
 or setValue methods.

 Typically this property is a Number of the same type
 as the value however it's possible to use any
 Comparable with a compareTo
 method for a Number with the same type as the value.
 See
 setMinimum for an example.

 This method fires a ChangeEvent if the
 maximum has changed.

maximum - a Comparable that has a compareTo method for Numbers with the same type as value - `java.lang.Comparable`
raw docstring

set-minimumclj

(set-minimum this minimum)

Changes the lower bound for numbers in this sequence. If minimum is null, then there is no lower bound. No bounds checking is done here; the new minimum 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 the getNextValue, getPreviousValue, or setValue methods.

Typically this property is a Number of the same type as the value however it's possible to use any Comparable with a compareTo method for a Number with the same type as the value. For example if value was a Long, 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 the minimum has changed.

minimum - a Comparable that has a compareTo method for Numbers with the same type as value - java.lang.Comparable

Changes the lower bound for numbers in this sequence.
 If minimum is null,
 then there is no lower bound.  No bounds checking is done here;
 the new minimum 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 the getNextValue,
 getPreviousValue, or setValue methods.

 Typically this property is a Number of the same type
 as the value however it's possible to use any
 Comparable with a compareTo
 method for a Number with the same type as the value.
 For example if value was a Long,
 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 the minimum has changed.

minimum - a Comparable that has a compareTo method for Numbers with the same type as value - `java.lang.Comparable`
raw docstring

set-step-sizeclj

(set-step-size this step-size)

Changes the size of the value change computed by the getNextValue and getPreviousValue methods. An IllegalArgumentException is thrown if stepSize is null.

This method fires a ChangeEvent if the stepSize has changed.

step-size - the size of the value change computed by the getNextValue and getPreviousValue methods - java.lang.Number

Changes the size of the value change computed by the
 getNextValue and getPreviousValue
 methods.  An IllegalArgumentException
 is thrown if stepSize is null.

 This method fires a ChangeEvent if the
 stepSize has changed.

step-size - the size of the value change computed by the getNextValue and getPreviousValue methods - `java.lang.Number`
raw docstring

set-valueclj

(set-value this value)

Sets the current value for this sequence. If value is null, or not a Number, an IllegalArgumentException 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 the stepSize. 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 the next, previous, or setValue methods.

This method fires a ChangeEvent if the value has changed.

value - the current (non null) Number for this sequence - java.lang.Object

throws: java.lang.IllegalArgumentException - if value is null or not a Number

Sets the current value for this sequence.  If value is
 null, or not a Number, an
 IllegalArgumentException 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 the stepSize.
 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 the next, previous, or
 setValue methods.

 This method fires a ChangeEvent if the value has changed.

value - the current (non null) Number for this sequence - `java.lang.Object`

throws: java.lang.IllegalArgumentException - if value is null or not a Number
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close