libjava/javax/swing/BoundedRangeModel.java

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