libjava/java/awt/Adjustable.java

   1 /* Adjustable.java -- Objects with a numeric adjustment scale.
   2    Copyright (C) 1999 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
  45   * can be adjusted within a bounded range.  For example, a scroll bar.
  46   *
  47   * @author Aaron M. Renn (arenn@urbanophile.com)
  48   */
  49 public interface Adjustable
  50 {
  51
  52 /*
  53  * Static Variables
  54  */
  55
  56 /**
  57   * Constant for a horizontal orientation
  58   */
  59 public static final int HORIZONTAL = 0;
  60
  61 /**
  62   * Constant for a vertical orientation
  63   */
  64 public static final int VERTICAL = 1;
  65
  66 /*************************************************************************/
  67
  68 /*
  69  * Instance Methods
  70  */
  71
  72 /**
  73   * Returns the current value of the object.
  74   *
  75   * @return The current value of the object.
  76   */
  77 public abstract int
  78 getValue();
  79
  80 /*************************************************************************/
  81
  82 /**
  83   * Sets the current value of the object.
  84   *
  85   * @param value The current value of the object.
  86   */
  87 public abstract void
  88 setValue(int value);
  89
  90 /*************************************************************************/
  91
  92 /**
  93   * Returns the orientation of the object, either <code>HORIZONTAL</code>
  94   * or <code>VERTICAL</code>.
  95   *
  96   * @return The orientation of this object.
  97   */
  98 public abstract int
  99 getOrientation();
 100
 101 /*************************************************************************/
 102
 103 /**
 104   * Returns the minimum value this object can take.
 105   *
 106   * @return The minimum value this object can take.
 107   */
 108 public abstract int
 109 getMinimum();
 110
 111 /*************************************************************************/
 112
 113 /**
 114   * Sets the minimum value this object can take to the specified value.
 115   *
 116   * @param minimum The new minimum value for this object.
 117   */
 118 public abstract void
 119 setMinimum(int minimum);
 120
 121 /*************************************************************************/
 122
 123 /**
 124   * Returns the maximum value this object can take.
 125   *
 126   * @return The maximum value this object can take.
 127   */
 128 public abstract int
 129 getMaximum();
 130
 131 /*************************************************************************/
 132
 133 /**
 134   * Sets the maximum value this object can take to the specified value.
 135   *
 136   * @param maximum The new maximum value for this object.
 137   */
 138 public abstract void
 139 setMaximum(int maximum);
 140
 141 /*************************************************************************/
 142
 143 /**
 144   * Returns the increment value for incrementing by units.
 145   *
 146   * @return The unit increment value.
 147   */
 148 public abstract int
 149 getUnitIncrement();
 150
 151 /*************************************************************************/
 152
 153 /**
 154   * Sets the increment value for incrementing by units to the specified value.
 155   *
 156   * @param increment The unit increment value.
 157   */
 158 public abstract void
 159 setUnitIncrement(int increment);
 160
 161 /*************************************************************************/
 162
 163 /**
 164   * Returns the increment value for incrementing by blocks.
 165   *
 166   * @return The block increment value.
 167   */
 168 public abstract int
 169 getBlockIncrement();
 170
 171 /*************************************************************************/
 172
 173 /**
 174   * Sets the increment value for incrementing by blocks to the specified value.
 175   *
 176   * @param increment The block increment value.
 177   */
 178 public abstract void
 179 setBlockIncrement(int increment);
 180
 181 /*************************************************************************/
 182
 183 /**
 184   * Returns the length of the indicator for this object.
 185   *
 186   * @return The indicator length.
 187   */
 188 public abstract int
 189 getVisibleAmount();
 190
 191 /*************************************************************************/
 192
 193 /**
 194   * Sets the length of the indicator for this object to the specified value.
 195   *
 196   * @param length The indicator length
 197   */
 198 public abstract void
 199 setVisibleAmount(int length);
 200
 201 /*************************************************************************/
 202
 203 /**
 204   * Adds a listener that will receive adjustment events for this object.
 205   *
 206   * @param listener The adjustment listener to add.
 207   */
 208 public abstract void
 209 addAdjustmentListener(AdjustmentListener listener);
 210
 211 /*************************************************************************/
 212
 213 /**
 214   * Removes an adjustment listener from this object.  It will no longer
 215   * receive adjustment events.
 216   *
 217   * @param listener The adjustment listener to remove.
 218   */
 219 public abstract void
 220 removeAdjustmentListener(AdjustmentListener listener);
 221
 222 } // interface Adjustable
 223