Source for javax.swing.BoundedRangeModel

   1: /* BoundedRangeModel.java --
   2:    Copyright (C) 2002, 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 components that display a range of values,
  45:  * like {@link JProgressBar} and {@link JSlider}.
  46:  *
  47:  * @author Andrew Selkirk
  48:  */
  49: public interface BoundedRangeModel
  50: {
  51:   /**
  52:    * getValue
  53:    * 
  54:    * @return int
  55:    *
  56:    * @see #setValue(int)
  57:    */
  58:   int getValue();
  59: 
  60:   /**
  61:    * setValue
  62:    * 
  63:    * @param value the value
  64:    *
  65:    * @see #getValue()
  66:    */
  67:   void setValue(int value);
  68: 
  69:   /**
  70:    * getMinimum
  71:    * 
  72:    * @return int
  73:    *
  74:    * @see #setMinimum(int)
  75:    */
  76:   int getMinimum();
  77: 
  78:   /**
  79:    * setMinimum
  80:    * 
  81:    * @param minimum the minimum value
  82:    *
  83:    * @see #getMinimum()
  84:    */
  85:   void setMinimum(int minimum);
  86: 
  87:   /**
  88:    * getMaximum
  89:    * 
  90:    * @return int
  91:    *
  92:    * @see #setMaximum(int)
  93:    */
  94:   int getMaximum();
  95: 
  96:   /**
  97:    * setMaximum
  98:    * 
  99:    * @param maximum the maximum value
 100:    *
 101:    * @see #getMaximum()
 102:    */
 103:   void setMaximum(int maximum);
 104: 
 105:   /**
 106:    * Returns the value of the <code>valueIsAdjusting</code> property.
 107:    * 
 108:    * @return <code>true</code> if value is adjusting,
 109:    * otherwise <code>false</code>
 110:    *
 111:    * @see setValueIsAdjusting(boolean)
 112:    */
 113:   boolean getValueIsAdjusting();
 114: 
 115:   /**
 116:    * setValueIsAdjusting
 117:    * 
 118:    * @param adjusting <code>true</code> if adjusting,
 119:    * <code>false</code> otherwise
 120:    *
 121:    * @see #getValueIsAdjusting()
 122:    */
 123:   void setValueIsAdjusting(boolean adjusting);
 124: 
 125:   /**
 126:    * Returns the current extent.
 127:    *
 128:    * @return the extent
 129:    *
 130:    * @see #setExtent(int)
 131:    */
 132:   int getExtent();
 133: 
 134:   /**
 135:    * setExtent
 136:    * 
 137:    * @param extent the extent
 138:    *
 139:    * @see #getExtent()
 140:    */
 141:   void setExtent(int extent);
 142: 
 143:   /**
 144:    * setRangeProperties
 145:    * @param value the value
 146:    * @param extent the extent
 147:    * @param minnimum the minimum value
 148:    * @param maximum the maximum value
 149:    * @param adjusting TODO
 150:    */
 151:   void setRangeProperties(int value, int extent, int minimum, int maximum,
 152:               boolean adjusting);
 153: 
 154:   /**
 155:    * Adds a <code>ChangeListener</code> to this object.
 156:    * 
 157:    * @param listener the listener to add
 158:    * 
 159:    * @see #removeChangeListener(javax.swing.event.ChangeListener)
 160:    */
 161:   void addChangeListener(ChangeListener listener);
 162: 
 163:   /**
 164:    * Removes a <code>ChangeListener</code> from this object.
 165:    * 
 166:    * @param listener the listener to remove
 167:    *
 168:    * @see #addChangeListener(javax.swing.event.ChangeListener)
 169:    */
 170:   void removeChangeListener(ChangeListener listener);
 171: }