Source for javax.swing.SpinnerModel

   1: /* SpinnerModel.java --
   2:    Copyright (C) 2003, 2004  Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package javax.swing;
  40: 
  41: import javax.swing.event.ChangeListener;
  42: 
  43: /**
  44:  * The data model that is used in {@link JSpinner}s.
  45:  *
  46:  * @since 1.4
  47:  */
  48: public interface SpinnerModel
  49: {
  50:   /**
  51:    * Sets the current value of the model to that specified.
  52:    * Implementations can choose to refuse to accept the value
  53:    * and throw an exception instead.  For example, a date model
  54:    * may throw invalid dates, or a list model may throw out
  55:    * values which don't exist in the underlying list.  Models
  56:    * may also throw out unusual values, such as null.  The decision
  57:    * is left to the discretion of the implementator.  If the
  58:    * operation succeeds, the implementation should also notify
  59:    * any registered <code>ChangeListener</code>s.
  60:    *
  61:    * @param value The new value of the model.
  62:    * @throws IllegalArgumentException if the model does not accept
  63:    *         the given value.
  64:    */
  65:   void setValue(Object value);
  66: 
  67:   /**
  68:    * Returns the current value of the model.
  69:    *
  70:    * @return The current value.
  71:    */
  72:   Object getValue();
  73: 
  74:   /**
  75:    * Returns the next value from the model.  If the model is bounded,
  76:    * this method may return null when the upper bound is met.
  77:    * The current value is not changed.
  78:    *
  79:    * @return The next value, or null if there are no more values
  80:    *         to retrieve.
  81:    */
  82:   Object getNextValue();
  83: 
  84:   /**
  85:    * Returns the previous value from the model.  If the model is
  86:    * bounded, this method may return null when the lower bound is
  87:    * met.  The current value is not changed.
  88:    *
  89:    * @return The previous value, or null if there are no more
  90:    *         values to retrieve.
  91:    */
  92:   Object getPreviousValue();
  93: 
  94:   /**
  95:    * Adds a <code>ChangeListener</code> to the list of registered
  96:    * listeners.  Each listener is notified when the current value
  97:    * is changed.
  98:    *
  99:    * @param listener The new listener to register.
 100:    */
 101:   void addChangeListener(ChangeListener listener);
 102: 
 103:   /**
 104:    * Removes a given <code>ChangeListener</code> from the list
 105:    * of registered listeners.
 106:    *
 107:    * @param listener The listener to remove.
 108:    */
 109:   void removeChangeListener(ChangeListener listener);
 110: 
 111: }