libjava/java/awt/Adjustable.java

   1 /* Adjustable.java -- Objects with a numeric adjustment scale
   2    Copyright (C) 1999, 2002, 2005  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 java.awt;
  40
  41 import java.awt.event.AdjustmentListener;
  42
  43 /**
  44  * This interface is for objects that take a numeric value that can be
  45  * adjusted within a bounded range.  For example, a scroll bar.
  46  *
  47  * @author Aaron M. Renn (arenn@urbanophile.com)
  48  * @since 1.0
  49  * @status updated to 1.4
  50  */
  51 public interface Adjustable
  52 {
  53   /** Constant for an adjustable object with horizontal orientation. */
  54   int HORIZONTAL = 0;
  55
  56   /** Constant for an adjustable object with vertical orientation. */
  57   int VERTICAL = 1;
  58
  59   /** Constant for an adjustable object with no orientation. */
  60   int NO_ORIENTATION = 2;
  61
  62   /**
  63    * Returns a constant representing the orientation of the object.
  64    *
  65    * @return the orientation of this object
  66    * @see #HORIZONTAL
  67    * @see #VERTICAL
  68    * @see #NO_ORIENTATION
  69    */
  70   int getOrientation();
  71
  72   /**
  73    * Sets the minimum value this object can have.
  74    *
  75    * @param minimum the new minimum value
  76    */
  77   void setMinimum(int minimum);
  78
  79   /**
  80    * Returns the minimum value this object can have.
  81    *
  82    * @return the minimum value
  83    */
  84   int getMinimum();
  85
  86   /**
  87    * Sets the maximum value this object can have.
  88    *
  89    * @param maximum the new maximum value
  90    */
  91   void setMaximum(int maximum);
  92
  93   /**
  94    * Returns the maximum value this object can have.
  95    *
  96    * @return the maximum value
  97    */
  98   int getMaximum();
  99
 100   /**
 101    * Sets the increment value for incrementing the value by units.
 102    *
 103    * @param increment the unit increment value
 104    */
 105   void setUnitIncrement(int increment);
 106
 107   /**
 108    * Returns the increment value for incrementing the value by units.
 109    *
 110    * @return the unit increment value
 111    */
 112   int getUnitIncrement();
 113
 114   /**
 115    * Sets the increment value for incrementing the value by blocks.
 116    *
 117    * @param increment the block increment value
 118    */
 119   void setBlockIncrement(int increment);
 120
 121   /**
 122    * Returns the increment value for incrementing the value by blocks.
 123    *
 124    * @return the block increment value
 125    */
 126   int getBlockIncrement();
 127
 128   /**
 129    * Sets the length of the indicator for this object to the specified value.
 130    *
 131    * @param length the indicator length
 132    */
 133   void setVisibleAmount(int length);
 134
 135   /**
 136    * Returns the length of the indicator for this object.
 137    *
 138    * @return the indicator length
 139    */
 140   int getVisibleAmount();
 141
 142   /**
 143    * Sets the current value of the object.
 144    *
 145    * @param value the new value
 146    */
 147   void setValue(int value);
 148
 149   /**
 150    * Returns the current value of the object.
 151    *
 152    * @return the current value
 153    */
 154   int getValue();
 155
 156   /**
 157    * Adds a listener that will receive adjustment events for this object.
 158    *
 159    * @param listener the adjustment listener to add
 160    * @see java.awt.event.AdjustmentEvent
 161    */
 162   void addAdjustmentListener(AdjustmentListener listener);
 163
 164   /**
 165    * Removes an adjustment listener from this object.
 166    *
 167    * @param listener the adjustment listener to remove
 168    * @see java.awt.event.AdjustmentEvent
 169    */
 170   void removeAdjustmentListener(AdjustmentListener listener);
 171 } // interface Adjustable