SpinnerDateModel JDK 1.6)

Description

public class SpinnerDateModel

A SpinnerModel for sequences of Dates.

A SpinnerModel for sequences of Dates. The upper and lower bounds of the sequence are defined by properties called start and end and the size of the increase or decrease computed by the nextValue and previousValue methods is defined by a property called calendarField. The start and end properties can be null to indicate that the sequence has no lower or upper limit.

The value of the calendarField property must be one of the java.util.Calendar constants that specify a field within a Calendar. The getNextValue and getPreviousValue methods change the date forward or backwards by this amount. For example, if calendarField is Calendar.DAY_OF_WEEK, then nextValue produces a Date that's 24 hours after the current value, and previousValue produces a Date that's 24 hours earlier.

The legal values for calendarField are:

Calendar.ERA
Calendar.YEAR
Calendar.MONTH
Calendar.WEEK_OF_YEAR
Calendar.WEEK_OF_MONTH
Calendar.DAY_OF_MONTH
Calendar.DAY_OF_YEAR
Calendar.DAY_OF_WEEK
Calendar.DAY_OF_WEEK_IN_MONTH
Calendar.AM_PM
Calendar.HOUR
Calendar.HOUR_OF_DAY
Calendar.MINUTE
Calendar.SECOND
Calendar.MILLISECOND

However some UIs may set the calendarField before commiting the edit to spin the field under the cursor. If you only want one field to spin you can subclass and ignore the setCalendarField calls.

This model inherits a ChangeListener. The ChangeListeners are notified whenever the models value, calendarField, start, or end properties changes.

See also: JSpinner SpinnerModel AbstractSpinnerModel SpinnerListModel SpinnerNumberModel Calendar.add(int, int)

Constructors

public SpinnerDateModel ()

Constructs a SpinnerDateModel whose initial value is the current date, calendarField is equal to Calendar.DAY_OF_MONTH, and for which there are no start/end limits.

public SpinnerDateModel (Date value, Comparable start, Comparable end, int calendarField)

Creates a SpinnerDateModel that represents a sequence of dates between start and end.

Creates a SpinnerDateModel that represents a sequence of dates between start and end. The nextValue and previousValue methods compute elements of the sequence by advancing or reversing the current date value by the calendarField time unit. For a precise description of what it means to increment or decrement a Calendar field, see the add method in java.util.Calendar.

The start and end parameters can be null to indicate that the range doesn't have an upper or lower bound. If value or calendarField is null, or if both start and end are specified and mininum > maximum then an IllegalArgumentException is thrown. Similarly if (minimum <= value <= maximum) is false, an IllegalArgumentException is thrown.
Parameters:
- value - the current (non null) value of the model
- start - the first date in the sequence or null
- end - the last date in the sequence or null
- calendarField - one of

Calendar.ERA
Calendar.YEAR
Calendar.MONTH
Calendar.WEEK_OF_YEAR
Calendar.WEEK_OF_MONTH
Calendar.DAY_OF_MONTH
Calendar.DAY_OF_YEAR
Calendar.DAY_OF_WEEK
Calendar.DAY_OF_WEEK_IN_MONTH
Calendar.AM_PM
Calendar.HOUR
Calendar.HOUR_OF_DAY
Calendar.MINUTE
Calendar.SECOND
Calendar.MILLISECOND

Throws:
- IllegalArgumentException - if value or calendarField are null, if calendarField isn't valid, or if the following expression is false: (start <= value <= end).
See Also: Calendar.add(int, int), SpinnerDateModel.setValue(java.lang.Object), SpinnerDateModel.setStart(java.lang.Comparable), SpinnerDateModel.setEnd(java.lang.Comparable), SpinnerDateModel.setCalendarField(int),

Methods

Hide/Show inherited methods

public void addChangeListener (ChangeListener l) [Inherited From AbstractSpinnerModel]

Adds a ChangeListener to the model's listener list.

protected void fireStateChanged () [Inherited From AbstractSpinnerModel]

Run each ChangeListeners stateChanged() method.

public int getCalendarField ()

Returns the Calendar field that is added to or subtracted from by the nextValue and previousValue methods.

Returns the Calendar field that is added to or subtracted from
by the nextValue and previousValue methods.
Returns: the value of the calendarField property
See Also: SpinnerDateModel.setCalendarField(int),

public ChangeListener getChangeListeners () [Inherited From AbstractSpinnerModel]

Returns an array of all the ChangeListeners added to this AbstractSpinnerModel with addChangeListener().

Returns an array of all the ChangeListeners added
to this AbstractSpinnerModel with addChangeListener().
Returns: all of the ChangeListeners added or an empty array if no listeners have been added
Since: 1.4

public Date getDate ()

Returns the current element in this sequence of Dates.

Returns the current element in this sequence of Dates.
This method is equivalent to (Date)getValue.
Returns: the value property
See Also: SpinnerDateModel.setValue(java.lang.Object),

public Comparable getEnd ()

Returns the last Date in the sequence.

Returns the last Date in the sequence.
Returns: the value of the end property
See Also: SpinnerDateModel.setEnd(java.lang.Comparable),

public T getListeners (Class< T> listenerType) [Inherited From AbstractSpinnerModel]

Return an array of all the listeners of the given type that were added to this model.

Return an array of all the listeners of the given type that
were added to this model. For example to find all of the
ChangeListeners added to this model:


 myAbstractSpinnerModel.getListeners(ChangeListener.class);

Returns: all of the objects receiving listenerType notifications from this model
Parameters:
- listenerType - the type of listeners to return, e.g. ChangeListener.class

public Object getNextValue ()

Returns the next Date in the sequence, or null if the next date is after end.

Returns the next Date in the sequence, or null if
the next date is after end.
Returns: the next Date in the sequence, or null if the next date is after end.
See Also: SpinnerModel.getNextValue(), SpinnerDateModel.getPreviousValue(), SpinnerDateModel.setCalendarField(int),

public Object getPreviousValue ()

Returns the previous Date in the sequence, or null if the previous date is before start.

Returns the previous Date in the sequence, or null
if the previous date is before start.
Returns: the previous Date in the sequence, or null if the previous date is before start
See Also: SpinnerModel.getPreviousValue(), SpinnerDateModel.getNextValue(), SpinnerDateModel.setCalendarField(int),

public Comparable getStart ()

Returns the first Date in the sequence.

Returns the first Date in the sequence.
Returns: the value of the start property
See Also: SpinnerDateModel.setStart(java.lang.Comparable),

public Object getValue ()

Returns the current element in this sequence of Dates.

Returns the current element in this sequence of Dates.
Returns: the value property
See Also: SpinnerDateModel.setValue(java.lang.Object), SpinnerDateModel.getDate(),

public void removeChangeListener (ChangeListener l) [Inherited From AbstractSpinnerModel]

Removes a ChangeListener from the model's listener list.

public void setCalendarField (int calendarField)

Changes the size of the date value change computed by the nextValue and previousValue methods.

Changes the size of the date value change computed
by the nextValue and previousValue methods.
The calendarField parameter must be one of the
Calendar field constants like Calendar.MONTH
or Calendar.MINUTE.
The nextValue and previousValue methods
simply move the specified Calendar field forward or backward
by one unit with the Calendar.add method.
You should use this method with care as some UIs may set the
calendarField before commiting the edit to spin the field under
the cursor. If you only want one field to spin you can subclass
and ignore the setCalendarField calls.
Parameters:
- calendarField - one of

Calendar.ERA
Calendar.YEAR
Calendar.MONTH
Calendar.WEEK_OF_YEAR
Calendar.WEEK_OF_MONTH
Calendar.DAY_OF_MONTH
Calendar.DAY_OF_YEAR
Calendar.DAY_OF_WEEK
Calendar.DAY_OF_WEEK_IN_MONTH
Calendar.AM_PM
Calendar.HOUR
Calendar.HOUR_OF_DAY
Calendar.MINUTE
Calendar.SECOND
Calendar.MILLISECOND

This method fires a ChangeEvent if the calendarField has changed.
See Also: SpinnerDateModel.getCalendarField(), SpinnerDateModel.getNextValue(), SpinnerDateModel.getPreviousValue(), Calendar.add(int, int), AbstractSpinnerModel.addChangeListener(javax.swing.event.ChangeListener),

public void setEnd (Comparable end)

Changes the upper limit for Dates in this sequence.

Changes the upper limit for Dates in this sequence. If start is null, then there is no upper limit. No bounds checking is done here: the new start value may invalidate the (start <= value <= end) invariant enforced by the constructors. This is to simplify updating the model. Naturally, one should ensure that the invariant is true before calling the nextValue, previousValue, or setValue methods.

Typically this property is a Date however it's possible to use Comparable with a compareTo method for Dates. See setStart for an example.

This method fires a ChangeEvent if the end has changed.
Parameters:
- end - defines the last date in the sequence
See Also: SpinnerDateModel.getEnd(), SpinnerDateModel.setStart(java.lang.Comparable), AbstractSpinnerModel.addChangeListener(javax.swing.event.ChangeListener),

public void setStart (Comparable start)

Changes the lower limit for Dates in this sequence.

Changes the lower limit for Dates in this sequence. If start is null, then there is no lower limit. No bounds checking is done here: the new start value may invalidate the (start <= value <= end) invariant enforced by the constructors. This is to simplify updating the model. Naturally one should ensure that the invariant is true before calling the nextValue, previousValue, or setValue methods.

Typically this property is a Date however it's possible to use a Comparable with a compareTo method for Dates. For example start might be an instance of a class like this:

 MyStartDate implements Comparable { 
     long t = 12345;
     public int compareTo(Date d) {
            return (t < d.getTime() ? -1 : (t == d.getTime() ? 0 : 1));
     }
     public int compareTo(Object o) {
            return compareTo((Date)o);
     }
 }

Note that the above example will throw a ClassCastException if the Object passed to compareTo(Object) is not a Date.

This method fires a ChangeEvent if the start has changed.
Parameters:
- start - defines the first date in the sequence
See Also: SpinnerDateModel.getStart(), SpinnerDateModel.setEnd(java.lang.Comparable), AbstractSpinnerModel.addChangeListener(javax.swing.event.ChangeListener),

public void setValue (Object value)

Sets the current Date for this sequence.

Sets the current Date for this sequence. If value is null, an IllegalArgumentException is thrown. No bounds checking is done here: the new value may invalidate the (start <= value < end) invariant enforced by the constructors. Naturally, one should ensure that the (start <= value <= maximum) invariant is true before calling the nextValue, previousValue, or setValue methods.

This method fires a ChangeEvent if the value has changed.
Parameters:
- value - the current (non null) Date for this sequence
Throws:
- IllegalArgumentException - if value is null or not a Date
See Also: SpinnerDateModel.getDate(), SpinnerDateModel.getValue(), AbstractSpinnerModel.addChangeListener(javax.swing.event.ChangeListener),